Annotation of pkgsrc/doc/pkgsrc.html, revision 1.188
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.188 ! snj 511: <li class="listitem"><p><a href="http://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.188 ! snj 513: <li class="listitem"><p><a href="http://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.188 ! snj 515: <li class="listitem"><p><a href="http://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.188 ! snj 517: <li class="listitem"><p><a href="http://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
1.188 ! snj 565: find such bugs: Static analysis tools (<a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91 rillig 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.188 ! snj 935: <code class="literal">2014Q3</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>
1.148 asau 941: <div class="sect2">
1.75 rillig 942: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 943: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 944: <p>The primary download location for all pkgsrc files is
1.157 asau 945: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
946: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
947: (it points to the same location).
948: There are a number of subdirectories for different purposes,
949: 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>
950: <p>The tar archive for the current branch is in the directory
951: <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 952: It is autogenerated daily.</p>
1.157 asau 953: <p>To save download time we provide bzip2- and
954: xz-compressed archives which are published at
955: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
956: and
957: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
958: respectively.
959: </p>
960: <p>You can fetch the same files using FTP.</p>
1.188 ! snj 961: <p>The tar file for the stable branch 2014Q3 is in the
! 962: directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112 weinem 963: <p>To download a pkgsrc stable tarball, run:</p>
964: <pre class="screen">
1.166 jnemeth 965: <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 966: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 967: stable branch to be downloaded, for example,
1.188 ! snj 968: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
! 969: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 970: or your web browser.</p>
1.112 weinem 971: <p>Then, extract it with:</p>
1.188 ! snj 972: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 973: <p>This will create the directory <code class="filename">pkgsrc/</code>
974: in <code class="filename">/usr/</code> and all the package source will be
975: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
976: <p>To download pkgsrc-current, run:</p>
977: <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 978: </div>
1.148 asau 979: <div class="sect2">
1.75 rillig 980: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 981: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
982: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 983: <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 984: </pre>
985: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.188 ! snj 986: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.128 wiz 987: <p>This will create the directory <code class="filename">pkgsrc/</code>
988: in your <code class="filename">/usr/</code> directory and all the package source
989: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
990: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 991: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 992: </pre>
1.188 ! snj 993: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 994: <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 995: <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 996: </pre>
997: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
998: For Bourne shells, you can set it in your <code class="filename">.profile</code>
999: or better globally in <code class="filename">/etc/profile</code>:</p>
1000: <pre class="programlisting">
1001: # set CVS remote shell command
1002: CVS_RSH=ssh
1003: export CVS_RSH
1004: </pre>
1005: <p>By default, CVS doesn't do things like most people would expect it to do.
1006: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1007: in your home directory and saving the following lines to it.
1008: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1009: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1010: <pre class="programlisting">
1011: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1012: cvs -q -z2
1.101 rillig 1013: checkout -P
1.103 wiz 1014: update -dP
1015: diff -upN
1.101 rillig 1016: rdiff -u
1.128 wiz 1017: release -d
1.101 rillig 1018: </pre>
1.75 rillig 1019: </div>
1020: </div>
1.148 asau 1021: <div class="sect1">
1.75 rillig 1022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1023: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1024: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1025: (which also works if you have first installed it via a tar
1026: file). It saves bandwidth and hard disk activity, compared to
1027: downloading the tar file again.</p>
1.148 asau 1028: <div class="sect2">
1.75 rillig 1029: <div class="titlepage"><div><div><h3 class="title">
1030: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1031: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1032: <h3 class="title">Warning</h3>
1.77 rillig 1033: <p>When updating from a tar file, you first need to
1034: completely remove the old pkgsrc directory. Otherwise those
1035: files that have been removed from pkgsrc in the mean time will
1036: not be removed on your local disk, resulting in inconsistencies.
1037: When removing the old files, any changes that you have done to
1038: the pkgsrc files will be lost after updating. Therefore updating
1039: via CVS is strongly recommended.</p>
1.75 rillig 1040: </div>
1.82 rillig 1041: <p>Note that by default the distfiles and the binary packages
1042: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 ! snj 1043: before updating. You can also configure pkgsrc to store distfiles
! 1044: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1045: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1046: 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 1047: <p>To update pkgsrc from a tar file, download the tar file as
1048: explained above. Then, make sure that you have not made any
1049: changes to the files in the pkgsrc directory. Remove the pkgsrc
1050: directory and extract the new tar file. Done.</p>
1051: </div>
1.148 asau 1052: <div class="sect2">
1.75 rillig 1053: <div class="titlepage"><div><div><h3 class="title">
1054: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1055: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1056: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1057: </pre>
1058: <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>
1059: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1060: </pre>
1.148 asau 1061: <div class="sect3">
1.75 rillig 1062: <div class="titlepage"><div><div><h4 class="title">
1063: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1064: <p>When updating pkgsrc, the CVS program keeps track of the
1065: branch you selected. But if you, for whatever reason, want to
1066: switch from the stable branch to the current one, you can do it
1.128 wiz 1067: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1068: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1069: back to the stable branch, add the
1.188 ! snj 1070: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.75 rillig 1071: </div>
1.148 asau 1072: <div class="sect3">
1.75 rillig 1073: <div class="titlepage"><div><div><h4 class="title">
1074: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1075: <p>When you update pkgsrc, the CVS program will only touch
1076: those files that are registered in the CVS repository. That
1077: means that any packages that you created on your own will stay
1078: unmodified. If you change files that are managed by CVS, later
1079: updates will try to merge your changes with those that have been
1080: done by others. See the CVS manual, chapter
1.128 wiz 1081: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1082: </div>
1083: </div>
1084: </div>
1085: </div>
1.148 asau 1086: <div class="chapter">
1.75 rillig 1087: <div class="titlepage"><div><div><h2 class="title">
1088: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1089: <div class="toc">
1090: <p><b>Table of Contents</b></p>
1091: <dl>
1.82 rillig 1092: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1093: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1094: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1095: <dd><dl>
1.151 obache 1096: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1097: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1098: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 1099: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1100: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1101: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1102: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1103: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1104: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1105: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 1106: </dl></dd>
1107: </dl>
1108: </div>
1.148 asau 1109: <div class="sect1">
1.75 rillig 1110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1111: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1112: <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 1113: </div>
1.148 asau 1114: <div class="sect1">
1.82 rillig 1115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1116: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1117: <p>pkgsrc can be bootstrapped for use in two different modes:
1118: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1119: to privileged one all programs are installed under one particular user
1.149 asau 1120: and cannot utilise privileged operations (packages don't create
1121: special users and all special file permissions like setuid are ignored).
1122: </p>
1.82 rillig 1123: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1124: <pre class="screen">
1.167 asau 1125: <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 1126: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1127: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1128: </pre>
1.149 asau 1129: <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>
1130: <p>By default, in privileged mode pkgsrc uses
1131: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1132: where programs will be installed in,
1.87 wiz 1133: and <code class="filename">/var/db/pkg</code> for the package database
1.149 asau 1134: directory where pkgsrc will do its internal bookkeeping,
1135: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1136: where packages install their persistent data.
1137: In unprivileged mode pkgsrc uses
1138: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1139: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1140: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1141: </p>
1142: <p>You can change default layout using command-line arguments.
1143: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1144: </p>
1.148 asau 1145: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1146: <h3 class="title">Note</h3>
1.110 hubertf 1147: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1148: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1149: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1150: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1151: </div>
1.149 asau 1152: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1153: <h3 class="title">Note</h3>
1154: <p>It is possible to bootstrap multiple instances of pkgsrc
1155: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1156: corresponding to the installation you're working with to build
1157: and install packages.
1158: </p>
1159: </div>
1.75 rillig 1160: </div>
1.148 asau 1161: <div class="sect1">
1.75 rillig 1162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1163: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1164: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 asau 1165: <div class="sect2">
1.75 rillig 1166: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1167: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1168: <p>Cygwin 1.7.x and later are supported.</p>
1169: <p>You need to install minimal base packages in `Base' category
1170: plus any of compiler, gcc, gcc4, and/or clang.
1171: For gcc and gcc4, C and C++ compiler will be installed by default,
1172: but you can install Fortran compiler additionally
1173: because it will be required to use libtool.
1174: If it is not installed (or too old), Fortran compiler will be
1175: installed with pkgsrc automatically.</p>
1176: <p>As noted in
1177: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1178: su(1) command has been in Cygwin distribution, but it has never worked.
1179: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1180: </p>
1181: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1182: then pick "Run as administrator".</p></li></ul></div>
1183: </div>
1184: <div class="sect2">
1185: <div class="titlepage"><div><div><h3 class="title">
1186: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.148 asau 1187: <p>Darwin 5.x and up are supported.</p>
1188: <p>Before you start, you need to download and install
1189: the Mac OS X Developer Tools from Apple's Developer Connection.
1190: This requires (free) membership. See
1.126 jakllsch 1191: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 asau 1192: for details. Also, make sure you install X11 (an optional
1193: package included with the Developer Tools) if you intend
1194: to build packages that use the X11 Window System.
1195: (If you don't want or need the full Xcode GUI,
1196: download and install Command Line Tools for Xcode.)</p>
1.75 rillig 1197: </div>
1.148 asau 1198: <div class="sect2">
1.75 rillig 1199: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1200: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136 dholland 1201: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1202: other versions may work.</p>
1.75 rillig 1203: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1204: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1205: <div class="orderedlist"><ol class="orderedlist" type="1">
1206: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1207: <code class="filename">/var/db/pkg</code>. It is therefore
1208: recommended that you choose a different location (e.g.
1209: <code class="filename">/usr/pkgdb</code>) by
1210: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1211: <li class="listitem">
1.75 rillig 1212: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1213: good idea to move them out of the way to avoid confusion, e.g.</p>
1214: <pre class="screen">
1215: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1216: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1217: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1218: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1219: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1220: </pre>
1.75 rillig 1221: </li>
1.128 wiz 1222: <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 1223: <code class="filename">/etc/mk.conf.example</code> file
1224: when you use the bootstrap script.</p></li>
1.75 rillig 1225: </ol></div>
1226: </div>
1.148 asau 1227: <div class="sect2">
1.75 rillig 1228: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1229: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1230: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1231: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1232: <p> You should install ncurses (libncurses and libncurses-dev)
1233: packages.</p>
1234: </div>
1235: <div class="sect2">
1236: <div class="titlepage"><div><div><h3 class="title">
1237: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75 rillig 1238: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1239: providing a Unix-like environment with a tighter kernel integration than
1240: available with Cygwin. It is part of the Windows Services for Unix
1241: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1242: (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 1243: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1244: are not officially supported. (The main difference in 3.0/3.1 is lack
1245: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 wiz 1246: <p>Services for Unix Applications (aka SUA) is an integrated
1247: component of Windows Server 2003 R2 (5.2), Windows Vista and
1248: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1249: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1250: 6.1 (64bit) subsystems have been tested. Other versions may
1251: work as well. The Interix 5.x subsystem has not yet been tested
1252: with pkgsrc.</p>
1.148 asau 1253: <div class="sect3">
1.75 rillig 1254: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1255: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1256: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1257: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 asau 1258: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1259: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1260: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1261: <li class="listitem"><p>Remote Connectivity</p></li>
1262: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1263: </ul></div>
1264: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1265: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1266: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1267: pkgsrc (or from a binary package).</p>
1.75 rillig 1268: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1269: not need to be installed, but Remote Connectivity itself should be
1270: installed in order to have a working inetd.</p>
1.75 rillig 1271: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1272: behavior for Interix programs, and whether to make pathnames default to
1273: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1274: enabled. (Without case-sensitivity, a large number of packages including
1275: perl will not build.)</p>
1.75 rillig 1276: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1277: works (via the Data Execution Prevention feature). In order to use
1278: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1279: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1280: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1281: support contract; however, Debian Interix Port has made most Interix
1282: 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 1283: <p>In addition to the hotfix noted above, it may be necessary to
1284: disable Data Execution Prevention entirely to make Interix functional.
1285: This may happen only with certain types of CPUs; the cause is not fully
1286: understood at this time. If gcc or other applications still segfault
1287: repeatedly after installing one of the hotfixes note above, the
1288: following option can be added to the appropriate "boot.ini" line on the
1289: Windows boot drive: /NoExecute=AlwaysOff
1290: (WARNING, this will disable DEP completely, which may be a security
1291: risk if applications are often run as a user in the Administrators
1292: group!)</p>
1.75 rillig 1293: </div>
1.148 asau 1294: <div class="sect3">
1.75 rillig 1295: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1296: <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 1297: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1298: with pkgsrc, note the following things.</p>
1.148 asau 1299: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1300: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1301: Windows Services for UNIX, then click Change. In the installer, choose
1302: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1303: <li class="listitem">
1.75 rillig 1304: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1305: change the following registry key:</p>
1.75 rillig 1306: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1307: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1308: </li>
1.128 wiz 1309: <li class="listitem">
1.75 rillig 1310: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1311: following registry key:</p>
1.75 rillig 1312: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1313: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1314: </li>
1315: </ul></div>
1316: </div>
1.148 asau 1317: <div class="sect3">
1.75 rillig 1318: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1319: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1320: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1321: running "pkg_add") must be a member of the local Administrators
1322: group. Such a user must also be used to run the bootstrap. This is
1323: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1324: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1325: automatically complain if this is not the case. This ensures that
1326: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1327: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1328: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1329: NOT be used in conjunction with pkgsrc. If you choose to use them at
1330: the same time as the pkgsrc packages, ensure that you use the proper
1331: pkg_* tools for each type of binary package.</p>
1.75 rillig 1332: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1333: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1334: don't have a termcap/terminfo entry for it, but the following .termcap
1335: entry provides adequate emulation in most cases:</p>
1.75 rillig 1336: <pre class="programlisting">
1.100 rillig 1337: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1338: </pre>
1.75 rillig 1339: </div>
1.148 asau 1340: <div class="sect3">
1.75 rillig 1341: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1342: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1343: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1344: for a full Unix-like platform, it has some drawbacks that should
1345: be noted for those desiring to make the most of Interix.</p>
1.148 asau 1346: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1347: <li class="listitem">
1.75 rillig 1348: <p><span class="strong"><strong>X11:</strong></span></p>
1349: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1350: and can run X11 based applications, but it does
1351: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1352: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1353: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1354: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1355: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1356: and the free X11 server included with
1.110 hubertf 1357: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1358: </li>
1.128 wiz 1359: <li class="listitem">
1.75 rillig 1360: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1361: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1362: Win32 applications, it does not currently support various X11
1363: protocol extensions for acceleration (such as MIT-SHM or DGA).
1364: Most interactive applications to a local X server will run
1365: reasonably fast, but full motion video and other graphics
1366: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1367: </li>
1.128 wiz 1368: <li class="listitem">
1.75 rillig 1369: <p><span class="strong"><strong>Audio:</strong></span></p>
1370: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1371: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1372: audio system on Interix. Unlike on most platforms, the
1.188 ! snj 1373: <a href="http://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 1374: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1375: server component. To output audio via an Interix host, the
1.188 ! snj 1376: <a href="http://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 1377: must also be installed.</p>
1.75 rillig 1378: </li>
1.128 wiz 1379: <li class="listitem">
1.75 rillig 1380: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1381: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1382: is not currently possible to access CD/DVD drives, USB devices,
1383: or SCSI devices through non-filesystem means. Among other things,
1384: this makes it impossible to use Interix directly for CD/DVD
1385: burning.</p>
1.75 rillig 1386: </li>
1.128 wiz 1387: <li class="listitem">
1.75 rillig 1388: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1389: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1390: drives are also not directly accessible in Interix. However,
1391: support is in work to make tape drive access possible by using
1392: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1393: esound server).</p>
1.75 rillig 1394: </li>
1395: </ul></div>
1396: </div>
1.148 asau 1397: <div class="sect3">
1.75 rillig 1398: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1399: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1400: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1401: Windows system; any member of the local Administrators group will
1402: suffice. However, some packages currently assume that the user
1403: named "root" is the privileged user. To accommodate these, you
1404: may create such a user; make sure it is in the local group
1405: Administrators (or your language equivalent).</p>
1.110 hubertf 1406: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1407: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1408: time being, install packages as the local Administrator (or
1409: your language equivalent), or run the following command after
1410: installing a package to work around the issue:</p>
1.75 rillig 1411: <pre class="screen">
1.87 wiz 1412: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1413: </pre>
1.75 rillig 1414: </div>
1415: </div>
1.148 asau 1416: <div class="sect2">
1.75 rillig 1417: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1418: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75 rillig 1419: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1420: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1421: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1422: 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 1423: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.188 ! snj 1424: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-6.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-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87 wiz 1425: etc.</p>
1.86 schwarz 1426: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1427: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1428: you start out using "abi=n32", that's what all your packages will be built
1429: with.</p>
1430: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1431: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1432: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1433: try to link n32 object files with lib64 or vice versa. Check your
1434: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1435: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1436: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1437: as it appears that IRIX linker occasionally runs into issues when trying to
1438: link over a network-mounted file system.</p>
1.75 rillig 1439: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1440: as imake(1), but you may want to set some options depending on your local
1441: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1442: course, your compiler's man pages for details.</p>
1.75 rillig 1443: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1444:
1.87 wiz 1445: </p>
1.75 rillig 1446: <pre class="programlisting">
1.100 rillig 1447: PKGSRC_COMPILER= mipspro
1.87 wiz 1448: </pre>
1.75 rillig 1449: <p>
1.1 grant 1450:
1.110 hubertf 1451: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1452: are using gcc and may end up passing invalid flags to the compiler. Note that
1453: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1454: default.</p>
1.75 rillig 1455: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1456: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1457: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1458: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1459: '--preserve-path' flag.</p>
1.75 rillig 1460: </div>
1.148 asau 1461: <div class="sect2">
1.75 rillig 1462: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1463: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87 wiz 1464: <p>Some versions of Linux (for example Debian GNU/Linux) need
1465: either libtermcap or libcurses (libncurses). Installing the
1466: distributions libncurses-dev package (or equivalent) should fix
1467: the problem.</p>
1468: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1469: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1470: i386 have been tested.</p>
1.75 rillig 1471: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1472: directory:</p>
1.75 rillig 1473: <pre class="programlisting">
1.138 wiz 1474: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1475: </pre>
1.148 asau 1476: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1477: <h3 class="title">Note</h3>
1.138 wiz 1478: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1479: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1480: <p>For icc 10.1 neither of these appears to be necessary.</p>
1481: </div>
1482: <p>Use a value for ICCBASE that corresponds to the directory
1483: where icc is installed. After bootstrapping, set
1484: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137 wiz 1485: <pre class="programlisting">
1.138 wiz 1486: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1487: </pre>
1.138 wiz 1488: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1489: <code class="filename">/opt/intel_cc_80</code>. This is the default
1490: install directory for icc 8.0. If you are using a more recent
1491: version, be sure to set the correct path explicitly.
1492: </p>
1.75 rillig 1493: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1494: provided by icc, so binaries can be run on other systems which do not
1495: have the shared libraries installed.</p>
1496: <p>Libtool, however, extracts a list of libraries from the
1.188 ! snj 1497: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-6.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 1498: records it, throwing away the -Bstatic and -Bdynamic options
1499: interspersed between the libraries. This means that
1500: libtool-linked C++ shared libraries will have a runtime
1501: dependency on the icc libraries until this is fixed in
1502: libtool.</p>
1.75 rillig 1503: </div>
1.148 asau 1504: <div class="sect2">
1.75 rillig 1505: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1506: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163 bsiegert 1507: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1508: Older versions might also work. Releases before #10 are not
1509: supported.</p>
1510: <p>The package tools of the (older) native ports tree,
1511: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1512: have the same names as the ones used by pkgsrc. Care should be taken
1513: that the right tools are used. When installing packages from source,
1514: use the <code class="filename">bmake</code> command for pkgsrc and
1515: <code class="filename">mmake</code> for MirPorts.</p>
1516: <p>pkgsrc and MirPorts use the same location for the package
1517: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1518: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1519: tree is self-contained. This is also the default setting used in the
1520: binary package builds.</p>
1521: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1522: server. The bootstrap kit there already contains the
1523: <span class="command"><strong>pkgin</strong></span> package manager. See the
1524: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1525: page for more details.</p>
1526: </div>
1527: <div class="sect2">
1528: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1529: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136 dholland 1530: <p>OpenBSD 5.1 has been tested and supported,
1531: other versions may work.</p>
1.75 rillig 1532: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1533: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1534: <div class="orderedlist"><ol class="orderedlist" type="1">
1535: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1536: <code class="filename">/var/db/pkg</code>. It is therefore
1537: recommended that you choose a different location (e.g.
1538: <code class="filename">/usr/pkgdb</code>) by
1539: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1540: <li class="listitem">
1.75 rillig 1541: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1542: good idea to move them out of the way to avoid confusion, e.g.</p>
1543: <pre class="screen">
1544: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1545: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1546: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1547: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1548: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1549: </pre>
1.75 rillig 1550: </li>
1.128 wiz 1551: <li class="listitem">
1.110 hubertf 1552: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1553: <code class="filename">/etc/mk.conf.example</code> file
1554: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1555: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1556: as well. You can work around this by enclosing all the pkgsrc-specific parts
1557: of the file with:</p>
1558: <pre class="programlisting">
1.100 rillig 1559: .ifdef BSD_PKG_MK
1560: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1561: .else
1562: # OpenBSD stuff
1563: .endif
1.87 wiz 1564: </pre>
1.75 rillig 1565: </li>
1566: </ol></div>
1567: </div>
1.148 asau 1568: <div class="sect2">
1.75 rillig 1569: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1570: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142 wiz 1571: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1572: You will need a working C compiler. Both gcc 4.5.3 and
1.87 wiz 1573: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1574: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1575: process and to build packages.</p>
1.148 asau 1576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1577: <li class="listitem"><p>SUNWsprot</p></li>
1578: <li class="listitem"><p>SUNWarc</p></li>
1579: <li class="listitem"><p>SUNWbtool</p></li>
1580: <li class="listitem"><p>SUNWtoo</p></li>
1581: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1582: </ul></div>
1.78 rillig 1583: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1584: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1585: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1586: your $prefix are in your <code class="varname">PATH</code>. This includes
1587: <code class="filename">/usr/ccs/{bin,lib}</code>
1588: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148 asau 1589: <div class="sect3">
1.75 rillig 1590: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1591: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1592: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1593: for building all packages.</p>
1.75 rillig 1594: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1595: then either build gcc from
1.188 ! snj 1596: <a href="http://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 1597: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1598: <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 1599: </div>
1.148 asau 1600: <div class="sect3">
1.75 rillig 1601: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1602: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1603: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1604: 5.0)</p>
1.148 asau 1605: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1606: <li class="listitem"><p>SPROcc
1.87 wiz 1607: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1608: <li class="listitem"><p>SPROcpl
1.87 wiz 1609: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1610: <li class="listitem"><p>SPROild
1.87 wiz 1611: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1612: <li class="listitem"><p>SPROlang
1.87 wiz 1613: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1614: </ul></div>
1.96 rillig 1615: <p>You should set the following variables in your
1.110 hubertf 1616: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1617: <pre class="programlisting">
1.100 rillig 1618: CC= cc
1619: CXX= CC
1620: CPP= cc -E
1621: CXXCPP= CC -E
1.96 rillig 1622: </pre>
1.148 asau 1623: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1624: <h3 class="title">Note</h3>
1625: <p>The <code class="varname">CPP</code> setting might break some
1626: packages that use the C preprocessor for processing things other
1627: than C source code.</p>
1628: </div>
1.75 rillig 1629: </div>
1.148 asau 1630: <div class="sect3">
1.75 rillig 1631: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1632: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1633: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1634: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1635: <pre class="programlisting">
1.100 rillig 1636: PKGSRC_COMPILER= sunpro
1637: ABI= 64
1.96 rillig 1638: </pre>
1.148 asau 1639: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1640: <h3 class="title">Note</h3>
1641: <p>This setting has been tested for the SPARC
1642: architecture. Intel and AMD machines need some more
1643: work.</p>
1644: </div>
1.75 rillig 1645: </div>
1.148 asau 1646: <div class="sect3">
1.75 rillig 1647: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1648: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110 hubertf 1649: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1650: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1651: The workaround is to use another shell for the configure
1.188 ! snj 1652: scripts, for example by installing <a href="http://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 1653: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1654: <pre class="programlisting">
1.100 rillig 1655: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1656: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1657: </pre>
1.188 ! snj 1658: <p>Then, rebuild the <a href="http://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 1659: </div>
1660: </div>
1661: </div>
1662: </div>
1.148 asau 1663: <div class="chapter">
1.75 rillig 1664: <div class="titlepage"><div><div><h2 class="title">
1665: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1666: <div class="toc">
1667: <p><b>Table of Contents</b></p>
1668: <dl>
1669: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1670: <dd><dl>
1671: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1672: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1673: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1674: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1675: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1676: <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>
1677: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1678: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1679: </dl></dd>
1680: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1681: <dd><dl>
1682: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1683: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1684: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1685: </dl></dd>
1686: </dl>
1687: </div>
1688: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1689: is to only install the package tools and to use binary packages
1.128 wiz 1690: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1691: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1692: of pkgsrc, too. Then you are able to build your own packages,
1693: and you can still use binary packages from someone else.</p>
1.148 asau 1694: <div class="sect1">
1.75 rillig 1695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1696: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1697: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1698: server and its mirrors, there are collections of binary packages,
1699: ready to be installed. These binary packages have been built using the
1700: default settings for the directories, that is:</p>
1.148 asau 1701: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1702: <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>
1703: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1704: <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 1705: </ul></div>
1706: <p>If you cannot use these directories for whatever reasons (maybe
1707: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1708: 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 1709: <div class="sect2">
1.75 rillig 1710: <div class="titlepage"><div><div><h3 class="title">
1711: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1712: <p>To install binary packages, you first need to know from where
1713: to get them. The first place where you should look is on the main
1.110 hubertf 1714: 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 1715: <p>This directory contains binary packages for multiple
1716: platforms. First, select your operating system. (Ignore the
1717: directories with version numbers attached to it, they just exist for
1718: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1719: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1720: <p>In this directory, you often find a file called
1721: <code class="filename">bootstrap.tar.gz</code> which contains the package
1722: management tools. If the file is missing, it is likely that your
1723: operating system already provides those tools. Download the file and
1724: extract it in the <code class="filename">/</code> directory. It will create
1725: the directories <code class="filename">/usr/pkg</code> (containing the tools
1726: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1727: (the database of installed packages).</p>
1.75 rillig 1728: </div>
1.148 asau 1729: <div class="sect2">
1.75 rillig 1730: <div class="titlepage"><div><div><h3 class="title">
1731: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1732: <p>In the directory from the last section, there is a
1733: subdirectory called <code class="filename">All</code>, which contains all the
1734: binary packages that are available for the platform, excluding those
1735: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1736: medium you are using).</p>
1.109 rillig 1737: <p>To install packages directly from an FTP or HTTP server, run
1738: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1739: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1740: <pre class="screen">
1741: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1742: <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>
1743: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1744: </pre>
1745: <p>Instead of URLs, you can also use local paths, for example if
1746: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1747: repository. If you want to install packages from multiple sources,
1748: you can separate them by a semicolon in
1749: <code class="varname">PKG_PATH</code>.</p>
1750: <p>After these preparations, installing a package is very
1751: easy:</p>
1752: <pre class="screen">
1753: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1754: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1755: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1756: </pre>
1.75 rillig 1757: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1758: package in question will be installed, too, assuming they are
1759: present where you install from.</p>
1.128 wiz 1760: <p>Adding packages might install vulnerable packages.
1761: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1762: regularly, especially after installing new packages, and verify
1763: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1764: <p>After you've installed packages, be sure to have
1.88 wiz 1765: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1766: <code class="varname">PATH</code> so you can actually start the just
1767: installed program.</p>
1.75 rillig 1768: </div>
1.148 asau 1769: <div class="sect2">
1.75 rillig 1770: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1771: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1772: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1773: installed from source code or from a binary package. The
1.110 hubertf 1774: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1775: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1776: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1777: name can be given with or without version number. Wildcards can
1778: also be used to deinstall a set of packages, for example
1779: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1780: so that the shell does not expand them before
1781: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1782: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1783: removes all the packages that require the package in question
1784: and then removes the package itself. For example:
1.82 rillig 1785:
1.88 wiz 1786: </p>
1.82 rillig 1787: <pre class="screen">
1.88 wiz 1788: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1789: </pre>
1.82 rillig 1790: <p>
1791:
1.88 wiz 1792: will remove jpeg and all the packages that used it; this allows
1793: upgrading the jpeg package.</p>
1.82 rillig 1794: </div>
1.148 asau 1795: <div class="sect2">
1.82 rillig 1796: <div class="titlepage"><div><div><h3 class="title">
1797: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1798: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1799: installed packages or binary package files.</p>
1.82 rillig 1800: </div>
1.148 asau 1801: <div class="sect2">
1.82 rillig 1802: <div class="titlepage"><div><div><h3 class="title">
1803: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1804: <p>
1.88 wiz 1805: The NetBSD Security-Officer and Packages Groups maintain a list of
1806: known security vulnerabilities to packages which are (or have been)
1807: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1808: 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 1809: </p>
1.82 rillig 1810: <p>
1.125 wiz 1811: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1812: this list can be downloaded
1813: automatically, and a security audit of all packages installed on a system
1814: can take place.
1815: </p>
1.82 rillig 1816: <p>
1.125 wiz 1817: There are two components to auditing. The first
1818: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1819: is for downloading
1.88 wiz 1820: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1821: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1822: installed packages are vulnerable. If a package is vulnerable, you
1823: will see output similar to the following:
1824: </p>
1.82 rillig 1825: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1826: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1827: <p>
1.125 wiz 1828: You may wish to have the
1.110 hubertf 1829: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1830: file downloaded daily so that
1831: it remains current. This may be done by adding an appropriate entry
1.188 ! snj 1832: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1833: </p>
1834: <pre class="screen">
1835: # download vulnerabilities file
1836: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1837: </pre>
1838: <p>
1839: will update the vulnerability list every day at 3AM. You may wish to do
1840: this more often than once a day.
1841:
1842: In addition, you may wish to run the package audit from the daily
1843: security script. This may be accomplished by adding the following
1844: line to <code class="filename">/etc/security.local</code>:
1845: </p>
1846: <pre class="screen">
1847: /usr/sbin/pkg_admin audit
1848: </pre>
1849: <p>
1.88 wiz 1850: </p>
1.82 rillig 1851: </div>
1.148 asau 1852: <div class="sect2">
1.82 rillig 1853: <div class="titlepage"><div><div><h3 class="title">
1854: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1855: <p>
1.188 ! snj 1856: Install <a href="http://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 1857: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1858: argument to check if your packages are up-to-date, e.g.
1859: </p>
1860: <pre class="screen">
1861: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1862: ...
1.88 wiz 1863: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1864: </pre>
1.110 hubertf 1865: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1866: package on your system and rebuild any dependencies.
1867: </p>
1.82 rillig 1868: </div>
1.148 asau 1869: <div class="sect2">
1.82 rillig 1870: <div class="titlepage"><div><div><h3 class="title">
1871: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1872: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1873: administrative functions on the package system.</p>
1.82 rillig 1874: </div>
1.148 asau 1875: <div class="sect2">
1.82 rillig 1876: <div class="titlepage"><div><div><h3 class="title">
1877: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1878: <p>Please pay very careful attention to the warnings
1.188 ! snj 1879: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88 wiz 1880: inherent dangers of installing binary packages which you did
1881: not create yourself, and the security holes that can be
1882: introduced onto your system by indiscriminate adding of such
1883: files.</p>
1.75 rillig 1884: <p>The same warning of course applies to every package you
1.88 wiz 1885: install from source when you haven't completely read and
1886: understood the source code of the package, the compiler that
1887: is used to build the package and all the other tools that are
1888: involved.</p>
1.75 rillig 1889: </div>
1890: </div>
1.148 asau 1891: <div class="sect1">
1.75 rillig 1892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1893: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1894: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1895: directory now contains a set of packages, organized into
1896: categories. You can browse the online index of packages, or run
1.110 hubertf 1897: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1898: directory to build local <code class="filename">README.html</code> files for
1.188 ! snj 1899: all packages, viewable with any web browser such as <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88 wiz 1900: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1901: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1902: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1903: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1904: different <code class="varname">LOCALBASE</code> definitions on the same
1905: system (inside a chroot is an exception). </p>
1906: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1907: 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 1908: instructions how to create your own packages.</p>
1.148 asau 1909: <div class="sect2">
1.75 rillig 1910: <div class="titlepage"><div><div><h3 class="title">
1911: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1912: <p>To build packages from source, you need a working C
1.88 wiz 1913: compiler. On NetBSD, you need to install the
1.128 wiz 1914: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1915: sets. If you want to build X11-related packages, the
1.128 wiz 1916: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1917: sets are required, too.</p>
1.75 rillig 1918: </div>
1.148 asau 1919: <div class="sect2">
1.75 rillig 1920: <div class="titlepage"><div><div><h3 class="title">
1921: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1922: <p>The first step for building a package is downloading the
1.88 wiz 1923: distfiles (i.e. the unmodified source). If they have not yet been
1924: downloaded, pkgsrc will fetch them automatically.</p>
1925: <p>If you have all files that you need in the
1926: <code class="filename">distfiles</code> directory,
1927: you don't need to connect. If the distfiles are on CD-ROM, you can
1928: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1929: </p>
1.82 rillig 1930: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1931: <p>
1.110 hubertf 1932: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1933: <p>By default a list of distribution sites will be randomly
1934: intermixed to prevent huge load on servers which holding popular
1935: packages (for example, SourceForge.net mirrors). Thus, every
1936: time when you need to fetch yet another distfile all the mirrors
1937: will be tried in new (random) order. You can turn this feature
1938: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1939: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1940: <p>You can overwrite some of the major distribution sites to
1941: fit to sites that are close to your own. By setting one or two
1942: variables you can modify the order in which the master sites are
1943: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1944: delimited list of domain suffixes.
1945: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1946: contains a whitespace delimited list of regular expressions. It
1947: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1948: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1949: some examples. This may save some of your bandwidth and
1950: time.</p>
1.75 rillig 1951: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1952: if you want to keep the settings, by editing the
1.110 hubertf 1953: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1954: and adding the definitions there.</p>
1.82 rillig 1955: <p>
1.88 wiz 1956: If a package depends on many other packages (such as
1.188 ! snj 1957: <a href="http://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 1958: alternate between periods of
1959: downloading source, and compiling. To ensure you have all the source
1960: downloaded initially you can run the command:
1961: </p>
1.82 rillig 1962: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1963: <p>
1.88 wiz 1964: which will output and run a set of shell commands to fetch the
1965: necessary files into the <code class="filename">distfiles</code> directory. You can
1966: also choose to download the files manually.
1967: </p>
1.75 rillig 1968: </div>
1.148 asau 1969: <div class="sect2">
1.75 rillig 1970: <div class="titlepage"><div><div><h3 class="title">
1971: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1972: <p>
1.88 wiz 1973: Once the software has downloaded, any patches will be applied, then it
1974: will be compiled for you. This may take some time depending on your
1975: computer, and how many other packages the software depends on and their
1976: compile time.
1977: </p>
1.148 asau 1978: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1979: <h3 class="title">Note</h3>
1980: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1981: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1982: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1983: </div>
1.87 wiz 1984: <p>For example, type</p>
1.88 wiz 1985: <pre class="screen">
1986: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1987: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1988: </pre>
1.75 rillig 1989: <p>at the shell prompt to build the various components of the
1.88 wiz 1990: package.</p>
1.82 rillig 1991: <p>The next stage is to actually install the newly compiled
1.88 wiz 1992: program onto your system. Do this by entering:
1.82 rillig 1993:
1.88 wiz 1994: </p>
1.82 rillig 1995: <pre class="screen">
1.88 wiz 1996: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1997: </pre>
1.82 rillig 1998: <p>
1999:
1.88 wiz 2000: while you are still in the directory for whatever package you
2001: are installing.</p>
1.82 rillig 2002: <p>Installing the package on your system may require you to
1.88 wiz 2003: be root. However, pkgsrc has a
2004: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2005: to only become root for the actual installation step.</p>
1.82 rillig 2006: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2007: You can now enter:
1.82 rillig 2008:
1.88 wiz 2009: </p>
1.82 rillig 2010: <pre class="screen">
1.88 wiz 2011: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2012: </pre>
1.82 rillig 2013: <p>
2014:
1.88 wiz 2015: to remove the compiled files in the work directory, as you shouldn't need
2016: them any more. If other packages were also added to your system
2017: (dependencies) to allow your program to compile, you can tidy these up
2018: also with the command:</p>
1.82 rillig 2019: <pre class="screen">
1.88 wiz 2020: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2021: </pre>
1.75 rillig 2022: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2023: 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 2024: <p>The program is installed under the default root of the
2025: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2026: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2027: variable in your environment, and it will use that value as the
2028: root of your packages tree. So, to use
2029: <code class="filename">/usr/local</code>, set
2030: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2031: Please note that you should use a directory which is dedicated to
2032: packages and not shared with other programs (i.e., do not try and
2033: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2034: to add any of your own files or directories (such as
2035: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2036: <code class="filename">pkgsrc/</code>) below the
2037: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2038: conflicts between programs and other files installed by the
2039: package system and whatever else may have been installed
2040: there.</p>
1.110 hubertf 2041: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2042: alter some configuration options at build time. Have a look at
2043: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2044: of what will be set there by default. Environment variables such
2045: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2046: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2047: set them each time you want to use pkgsrc.</p>
1.128 wiz 2048: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2049: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 2050: or being installed. This may be for debugging purposes, or out of
2051: simple curiosity. A number of utility values have been added to
2052: help with this.</p>
1.128 wiz 2053: <div class="orderedlist"><ol class="orderedlist" type="1">
2054: <li class="listitem">
1.188 ! snj 2055: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 2056: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2057: information will be displayed. For example,</p>
1.75 rillig 2058: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2059: <p>will show all the commands that are invoked, up to and
1.128 wiz 2060: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 2061: </li>
1.128 wiz 2062: <li class="listitem">
1.188 ! snj 2063: <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-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2064: definition, then the <code class="varname">VARNAME</code> definition
2065: should be used, in conjunction with the show-var
1.188 ! snj 2066: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2067: variable <code class="varname">LOCALBASE</code>:</p>
2068: <pre class="screen">
2069: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2070: /usr/pkg
2071: <code class="prompt">%</code>
1.88 wiz 2072: </pre>
1.75 rillig 2073: </li>
2074: </ol></div>
2075: <p>If you want to install a binary package that you've either
1.88 wiz 2076: created yourself (see next section), that you put into
2077: pkgsrc/packages manually or that is located on a remote FTP
2078: server, you can use the "bin-install" target. This target will
1.188 ! snj 2079: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 2080: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2081: sites searched is kept in the variable
2082: <code class="varname">BINPKG_SITES</code>, which defaults to
1.188 ! snj 2083: 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-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 2084: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2085: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2086: details.</p>
2087: <p>A final word of warning: If you set up a system that has a
2088: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2089: set that before any packages are installed, as you cannot use
2090: several directories for the same purpose. Doing so will result in
2091: pkgsrc not being able to properly detect your installed packages,
2092: and fail miserably. Note also that precompiled binary packages are
2093: usually built with the default <code class="varname">LOCALBASE</code> of
2094: <code class="filename">/usr/pkg</code>, and that you should
2095: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2096: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2097: </div>
2098: </div>
2099: </div>
1.148 asau 2100: <div class="chapter">
1.75 rillig 2101: <div class="titlepage"><div><div><h2 class="title">
2102: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2103: <div class="toc">
2104: <p><b>Table of Contents</b></p>
2105: <dl>
2106: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2107: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2108: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2109: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2110: <dd><dl>
1.103 wiz 2111: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2112: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2113: <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 2114: </dl></dd>
1.103 wiz 2115: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2116: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2117: </dl>
2118: </div>
1.104 rillig 2119: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2120: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2121: that file depends on the installation. On NetBSD, when you use
1.188 ! snj 2122: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.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 2123: <code class="filename">/etc/</code>. In all other cases the default location is
2124: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2125: bootstrap program to install the binary packages.</p>
2126: <p>During the bootstrap, an example configuration file is created. To
2127: use that, you have to create the directory
2128: <code class="filename">${PREFIX}/etc</code> and copy the example file
2129: there.</p>
2130: <p>The format of the configuration file is that of the usual
2131: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2132: is done by setting variables in this file. Note that you can define all
2133: kinds of variables, and no special error checking (for example for
2134: spelling mistakes) takes place, so you have to try it out to see if it
2135: works.</p>
1.148 asau 2136: <div class="sect1">
1.75 rillig 2137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2138: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2139: <p>In this section, you can find some variables that apply to all
1.89 rillig 2140: pkgsrc packages. A complete list of the variables that can be
2141: configured by the user is available in
2142: <code class="filename">mk/defaults/mk.conf</code>, together with some
2143: comments that describe each variable's intent.</p>
1.148 asau 2144: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2145: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2146: packages will be installed. The default is
1.76 rillig 2147: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2148: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2149: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2150: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2151: installed. The default is
1.76 rillig 2152: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2153: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2154: X11 is installed on the system. The default is
1.76 rillig 2155: <code class="filename">/usr/X11R6</code>.</p></li>
1.128 wiz 2156: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2157: downloaded copies of the original source distributions used
2158: for building pkgsrc packages. The default is
1.76 rillig 2159: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2160: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2161: database about installed packages is stored. The default is
2162: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2163: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2164: If set, override the packages'
2165: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2166: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2167: Backup location(s) for distribution files and patch files
2168: if not found locally or in
1.76 rillig 2169: <code class="filename">${MASTER_SITES}</code> or
2170: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2171: The defaults are
1.132 spz 2172: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2173: and
1.76 rillig 2174: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2175: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2176: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2177: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2178: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2179: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2180: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2181: List of acceptable licenses. License names are case-sensitive.
2182: Whenever you try to build a package whose license is not in this
2183: list, you will get an error message. If the license condition is
2184: simple enough, the error message will include specific
2185: instructions on how to change this variable.</p></li>
1.75 rillig 2186: </ul></div>
2187: </div>
1.148 asau 2188: <div class="sect1">
1.75 rillig 2189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2190: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2191: <p>XXX
2192: </p>
1.148 asau 2193: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2194: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2195: directory for the binary packages. The default is
1.76 rillig 2196: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2197: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2198: The top level directory where, if defined, the separate
2199: working directories will get created, and symbolically
1.76 rillig 2200: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2201: This is useful for building packages on several
1.76 rillig 2202: architectures, then <code class="filename">${PKGSRCDIR}</code>
2203: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2204: is local to every architecture. (It should be noted that
2205: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2206: — it is an internal definition which refers to the
1.75 rillig 2207: root of the pkgsrc tree. It is possible to have many
2208: pkgsrc tree instances.)</p></li>
1.128 wiz 2209: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2210: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2211: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2212: information.</p></li>
1.128 wiz 2213: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2214: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2215: BSD-style Makefile. If this is not set,
2216: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2217: <code class="filename">/dev/null</code> to avoid picking up
2218: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2219: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2220: By default, dependencies are only installed, and no binary
2221: package is created for them. You can set this variable to
1.174 asau 2222: <code class="literal">package-install</code> to automatically create binary
1.82 rillig 2223: packages after installing dependencies.</p></li>
1.75 rillig 2224: </ul></div>
2225: </div>
1.148 asau 2226: <div class="sect1">
1.75 rillig 2227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2228: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2229: <p>Most packages support installation into a
1.103 wiz 2230: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2231: to be built, before the actual filesystem is touched. DESTDIR
2232: support exists in two variations:</p>
1.148 asau 2233: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2234: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 2235: installation and packaging is still run as root.</p></li>
2236: <li class="listitem"><p>Full DESTDIR support can run the complete
2237: build, installation and packaging as normal user. Root
2238: privileges are only needed to add packages.</p></li>
2239: </ul></div>
2240: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2241: you can set
2242: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2243: so it's preferable to convert a package to DESTDIR instead.</p>
1.103 wiz 2244: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2245: clean</code></strong> needs to be run as root.</p>
1.118 imil 2246: <p>Considering the <code class="filename">foo/bar</code> package,
2247: DESTDIR full support can be tested using the following commands
2248:
2249: </p>
2250: <pre class="programlisting">
2251: <code class="prompt">$</code> id
2252: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2253: <code class="prompt">$</code> mkdir $HOME/packages
2254: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2255: </pre>
2256: <p>
2257:
2258: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2259: should be needed
2260:
2261: </p>
2262: <pre class="programlisting">
1.174 asau 2263: <code class="prompt">$</code> make stage-install
1.118 imil 2264: </pre>
2265: <p>
2266:
2267: Create a package without root privileges
2268:
2269: </p>
2270: <pre class="programlisting">
1.174 asau 2271: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 2272: </pre>
2273: <p>
2274:
2275: For the following command, you must be able to gain root
1.188 ! snj 2276: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 2277:
2278: </p>
2279: <pre class="programlisting">
1.174 asau 2280: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 2281: </pre>
2282: <p>
2283:
2284: Then, as a simple user
2285:
2286: </p>
2287: <pre class="programlisting">
2288: <code class="prompt">$</code> make clean
2289: </pre>
2290: <p>
2291:
2292: </p>
1.103 wiz 2293: </div>
1.148 asau 2294: <div class="sect1">
1.103 wiz 2295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2296: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 2297: <div class="sect2">
1.78 rillig 2298: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2299: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2300: <p>By default, pkgsrc will use GCC to build packages. This may be
2301: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 2302: <div class="variablelist"><dl class="variablelist">
1.89 rillig 2303: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2304: <dd>
2305: <p>This is a list of values specifying the chain of
2306: compilers to invoke when building packages. Valid values
2307: are:</p>
1.148 asau 2308: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 2309: <li class="listitem"><p><code class="varname">ccc</code>:
2310: Compaq C Compilers (Tru64)</p></li>
2311: <li class="listitem"><p><code class="varname">ccache</code>:
2312: compiler cache (chainable)</p></li>
2313: <li class="listitem"><p><code class="varname">clang</code>:
2314: Clang C and Objective-C compiler</p></li>
1.128 wiz 2315: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2316: distributed C/C++ (chainable)</p></li>
1.174 asau 2317: <li class="listitem"><p><code class="varname">f2c</code>:
2318: Fortran 77 to C compiler (chainable)</p></li>
2319: <li class="listitem"><p><code class="varname">icc</code>:
2320: Intel C++ Compiler (Linux)</p></li>
2321: <li class="listitem"><p><code class="varname">ido</code>:
2322: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 2323: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2324: GNU C/C++ Compiler</p></li>
1.174 asau 2325: <li class="listitem"><p><code class="varname">hp</code>:
2326: HP-UX C/aC++ compilers</p></li>
1.128 wiz 2327: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2328: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 2329: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 2330: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2331: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2332: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 2333: <li class="listitem"><p><code class="varname">xlc</code>:
2334: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89 rillig 2335: </ul></div>
2336: <p>The default is
1.128 wiz 2337: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2338: <code class="varname">ccache</code> and/or
2339: <code class="varname">distcc</code> with an appropriate
2340: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2341: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2342: variable should always be terminated with a value for
2343: a real compiler. Note that only one real compiler
1.128 wiz 2344: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2345: is not allowed).</p>
1.89 rillig 2346: </dd>
2347: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2348: <dd><p>This specifies the minimum version of GCC to use
2349: when building packages. If the system GCC doesn't
2350: satisfy this requirement, then pkgsrc will build and
2351: install one of the GCC packages to use instead.</p></dd>
2352: </dl></div>
2353: </div>
1.148 asau 2354: <div class="sect2">
1.89 rillig 2355: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2356: <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 2357: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2358: please make sure to use the <code class="literal">+=</code> operator
2359: instead of the <code class="literal">=</code> operator:</p>
2360: <pre class="programlisting">
1.100 rillig 2361: CFLAGS+= -your -flags
1.78 rillig 2362: </pre>
2363: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2364: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2365: need to add their own flags. You may want to take a look
1.188 ! snj 2366: at the <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128 wiz 2367: package if you're interested in optimization specifically
2368: for the current CPU. </p>
1.78 rillig 2369: </div>
1.148 asau 2370: <div class="sect2">
1.88 wiz 2371: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2372: <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 2373: <p>If you want to pass flags to the linker, both in the configure
2374: step and the build step, you can do this in two ways. Either set
2375: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2376: between the two is that <code class="varname">LIBS</code> will be appended to
2377: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2378: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2379: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2380: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2381: <code class="varname">CFLAGS</code>, if you do not wish to override these
2382: settings, use the <code class="literal">+=</code> operator:</p>
2383: <pre class="programlisting">
1.100 rillig 2384: LDFLAGS+= -your -linkerflags
1.88 wiz 2385: </pre>
2386: </div>
1.78 rillig 2387: </div>
1.148 asau 2388: <div class="sect1">
1.78 rillig 2389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2390: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2391: <p>XXX
2392: </p>
1.148 asau 2393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2394: <li class="listitem">
1.75 rillig 2395: <p><code class="varname">PKG_DEVELOPER</code>:
2396: Run some sanity checks that package developers want:
2397: </p>
1.148 asau 2398: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2399: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2400: fuzz</p></li>
1.128 wiz 2401: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2402: binaries will find their shared libs.</p></li>
1.75 rillig 2403: </ul></div>
2404: <p>
1.87 wiz 2405: </p>
1.75 rillig 2406: </li>
1.128 wiz 2407: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2408: of debugging output which is displayed whilst making and
2409: installing the package. The default value for this is 0,
2410: which will not display the commands as they are executed
2411: (normal, default, quiet operation); the value 1 will display
2412: all shell commands before their invocation, and the value 2
2413: will display both the shell commands before their invocation,
1.110 hubertf 2414: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2415: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2416: </ul></div>
2417: <p>
2418: </p>
2419: </div>
1.148 asau 2420: <div class="sect1">
1.75 rillig 2421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2422: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2423: <p>Some packages have build time options, usually to select
2424: between different dependencies, enable optional support for big
2425: dependencies or enable experimental features.</p>
1.75 rillig 2426: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2427: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2428: show-options</strong></span>, for example:</p>
1.75 rillig 2429: <pre class="programlisting">
2430: The following options are supported by this package:
2431: ssl Enable SSL support.
2432: Exactly one of the following gecko options is required:
2433: firefox Use firefox as gecko rendering engine.
2434: mozilla Use mozilla as gecko rendering engine.
2435: At most one of the following database options may be selected:
2436: mysql Enable support for MySQL database.
2437: pgsql Enable support for PostgreSQL database.
1.1 grant 2438:
1.75 rillig 2439: These options are enabled by default: firefox
2440: These options are currently enabled: mozilla ssl
1.1 grant 2441: </pre>
1.75 rillig 2442: <p>The following variables can be defined in
1.110 hubertf 2443: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2444: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2445: which can be used to select or disable options for all packages
2446: that support them, and
2447: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2448: which can be used to select or disable options specifically for
2449: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2450: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2451: are disabled. A few examples:</p>
1.75 rillig 2452: <pre class="screen">
1.110 hubertf 2453: <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 2454: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2455: PKG_OPTIONS.kdebase= debug -sasl
2456: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2457: <p>It is important to note that options that were specifically
1.120 snj 2458: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2459: you do not wish to include the option. If you are unsure you can view
2460: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2461: <p>The following settings are consulted in the order given, and
2462: the last setting that selects or disables an option is
2463: used:</p>
1.128 wiz 2464: <div class="orderedlist"><ol class="orderedlist" type="1">
2465: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2466: maintainer</p></li>
1.128 wiz 2467: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2468: variables (see below)</p></li>
1.128 wiz 2469: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2470: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2471: </ol></div>
2472: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2473: selected is used, all others are automatically disabled. If an
2474: option of the group is explicitly disabled, the previously
2475: selected option, if any, is used. It is an error if no option
2476: from a required group of options is selected, and building the
2477: package will fail.</p>
2478: <p>Before the options framework was introduced, build options
2479: were selected by setting a variable (often named
2480: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2481: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2482: transition to the options framework for the user, these legacy
2483: variables are converted to the appropriate options setting
2484: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2485: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2486: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2487: directly. Support for the legacy variables will be removed
2488: eventually.</p>
1.75 rillig 2489: </div>
2490: </div>
1.148 asau 2491: <div class="chapter">
1.75 rillig 2492: <div class="titlepage"><div><div><h2 class="title">
2493: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2494: <div class="toc">
2495: <p><b>Table of Contents</b></p>
2496: <dl>
2497: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2498: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2499: </dl>
2500: </div>
1.148 asau 2501: <div class="sect1">
1.75 rillig 2502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2503: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2504: <p>Once you have built and installed a package, you can create
2505: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.188 ! snj 2506: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2507: the same package on a group of hosts and wasting CPU time. It also
2508: provides a simple means for others to install your package, should
2509: you distribute it.</p>
2510: <p>To create a binary package, change into the appropriate
1.110 hubertf 2511: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2512: package</strong></span>:</p>
2513: <pre class="screen">
2514: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2515: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2516: </pre>
2517: <p>This will build and install your package (if not already done),
2518: and then build a binary package from what was installed. You can
1.110 hubertf 2519: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2520: it. Binary packages are created by default in
2521: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2522: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.188 ! snj 2523: continuation of the above <a href="http://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 2524: <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 2525: such a binary package.</p>
1.75 rillig 2526: </div>
1.148 asau 2527: <div class="sect1">
1.75 rillig 2528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2529: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2530: <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 2531: </div>
2532: </div>
1.148 asau 2533: <div class="chapter">
1.106 rillig 2534: <div class="titlepage"><div><div><h2 class="title">
2535: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2536: builds)</h2></div></div></div>
2537: <div class="toc">
2538: <p><b>Table of Contents</b></p>
2539: <dl>
1.180 wiz 2540: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2541: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2542: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2543: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 2544: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2545: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2546: </dl>
2547: </div>
1.180 wiz 2548: <p>For a number of reasons you may want to build binary packages
2549: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2550: For instance, when you have multiple machines that should run the same software,
2551: it is wasted time if they all build their packages themselves from source.
2552: Or you may want to build a list of packages you want and check them before
2553: deploying onto production system.
2554: There is a way of getting a set of binary packages:
1.174 asau 2555: The bulk build system, or pbulk ("p" stands for "parallel).
2556: This chapter describes how to set it up so that the packages
1.106 rillig 2557: are most likely to be usable later.</p>
1.148 asau 2558: <div class="sect1">
1.106 rillig 2559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2560: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2561: <p>First of all, you have to decide whether you build all packages
2562: or a limited set of them. Full bulk builds usually consume a lot more resources,
2563: both space and time, than builds for some practical sets of packages.
2564: There exists a number of particularly heavy packages that are not actually
2565: interesting to a wide audience.
2566:
2567: For a limited bulk builds you need to make a list of packages you want to build.
2568: Note, that all their dependencies will be built, so you don't need to track them manually.
2569: </p>
2570: <p>During bulk builds various packages are installed and deinstalled
2571: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2572: so make sure that you don't need any package during the builds.
2573: Essentially, you should provide fresh system, either a chroot environment
2574: or something even more restrictive, depending on what the operating system provides,
2575: or dedicate the whole physical machine.
2576: As a useful side effect this makes sure that bulk builds cannot
2577: break anything in your system. There have been numerous cases where
1.106 rillig 2578: certain packages tried to install files outside the
2579: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2580: <code class="filename">/etc</code>.
2581: </p>
1.106 rillig 2582: </div>
1.148 asau 2583: <div class="sect1">
1.106 rillig 2584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2585: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2586: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2587: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2588: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2589: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2590: </ul></div>
1.148 asau 2591: <div class="sect2">
1.116 rillig 2592: <div class="titlepage"><div><div><h3 class="title">
1.180 wiz 2593: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.178 asau 2594: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2595: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2596: Configure network access to fetch distribution files.
2597: Create user with name "pbulk".</p>
2598: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2599: <pre class="screen">
1.181 wiz 2600: <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>
2601: <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>
2602: <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 2603: </pre>
2604: <p>Or any other way that fits (e.g., curl, wget).</p>
2605: <p>Deploy and configure pbulk tools, e.g.:</p>
2606: <pre class="screen">
2607: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2608: <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>
2609: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2610: </pre>
2611: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2612: <h3 class="title">Note</h3>
2613: <p><code class="filename">mk.conf.frag</code> is a fragment of
2614: <code class="filename">mk.conf</code> that contains settings you want to
2615: apply to packages you build. For instance,</p>
2616: <pre class="programlisting">
2617: PKG_DEVELOPER= yes # perform more checks
2618: X11_TYPE= modular # use pkgsrc X11
2619: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2620: </pre>
2621: </div>
2622: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2623: with your list of packages one per line without empty lines or comments. E.g.:</p>
2624: <pre class="programlisting">
2625: www/firefox
2626: mail/thunderbird
2627: misc/libreoffice4
2628: </pre>
1.179 asau 2629: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2630: and make final amendments, if wanted.</p>
1.178 asau 2631: <p>Start it:</p>
2632: <pre class="screen">
2633: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2634: </pre>
2635: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2636: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2637: </p>
2638: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2639: <h3 class="title">Note</h3>
2640: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2641: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2642: The script is kept small enough for better understanding.</p>
2643: </div>
2644: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2645: <h3 class="title">Note</h3>
2646: <p>The <code class="filename">pbulk.sh</code> script supports running
2647: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2648: </div>
1.106 rillig 2649: </div>
2650: </div>
1.148 asau 2651: <div class="sect1">
1.106 rillig 2652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2653: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2654: <p>A complete bulk build requires lots of disk space. Some of the
2655: disk space can be read-only, some other must be writable. Some can be on
2656: remote filesystems (such as NFS) and some should be local. Some can be
2657: temporary filesystems, others must survive a sudden reboot.</p>
2658: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2659: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2660: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2661: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2662: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2663: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2664: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2665: </ul></div>
2666: </div>
2667: <div class="sect1">
2668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2669: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2670: <p>After your pkgsrc bulk-build has completed, you may wish to
2671: create a CD-ROM set of the resulting binary packages to assist
2672: in installing packages on other machines. The
1.188 ! snj 2673: <a href="http://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 2674: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2675: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2676: way that keeps all the dependencies for a given package on the same
2677: CD as that package.</p>
1.148 asau 2678: <div class="sect2">
1.75 rillig 2679: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2680: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2681: <p>Complete documentation for cdpack is found in the cdpack(1)
2682: man page. The following short example assumes that the binary
2683: packages are left in
2684: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2685: sufficient disk space exists in <code class="filename">/u2</code> to
2686: hold the ISO 9660 images.</p>
2687: <pre class="screen">
2688: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2689: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2690: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2691: </pre>
2692: <p>If you wish to include a common set of files
2693: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2694: etc.) on each CD in the collection, then you need to create a
2695: directory which contains these files. e.g.</p>
2696: <pre class="screen">
2697: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2698: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2699: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2700: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2701: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2702: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2703: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2704: </pre>
1.75 rillig 2705: <p>Now create the images:</p>
2706: <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 2707: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2708: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2709: in their root directories.</p>
1.75 rillig 2710: </div>
2711: </div>
2712: </div>
1.148 asau 2713: <div class="chapter">
1.75 rillig 2714: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2715: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2716: <div class="toc">
2717: <p><b>Table of Contents</b></p>
2718: <dl>
1.128 wiz 2719: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2720: <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 2721: </dl>
2722: </div>
2723: <p>The files that are installed by pkgsrc are organized in a way that
2724: is similar to what you find in the <code class="filename">/usr</code> directory
2725: of the base system. But some details are different. This is because
2726: pkgsrc initially came from FreeBSD and had adopted its file system
2727: hierarchy. Later it was largely influenced by NetBSD. But no matter
2728: which operating system you are using pkgsrc with, you can expect the
2729: same layout for pkgsrc.</p>
1.91 rillig 2730: <p>There are mainly four root directories for pkgsrc, which are all
2731: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2732: When pkgsrc has been installed as root, the default locations
2733: are:</p>
2734: <pre class="programlisting">
1.100 rillig 2735: LOCALBASE= /usr/pkg
2736: PKG_SYSCONFBASE= /usr/pkg/etc
2737: VARBASE= /var
2738: PKG_DBDIR= /var/db/pkg
1.91 rillig 2739: </pre>
2740: <p>In unprivileged mode (when pkgsrc has been installed as any other
2741: user), the default locations are:</p>
2742: <pre class="programlisting">
1.100 rillig 2743: LOCALBASE= ${HOME}/pkg
2744: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2745: VARBASE= ${HOME}/pkg/var
2746: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 2747: </pre>
2748: <p>What these four directories are for, and what they look like is
2749: explained below.</p>
1.148 asau 2750: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2751: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2752: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2753: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2754: the well-known subdirectories like <code class="filename">bin</code>,
2755: <code class="filename">include</code>, <code class="filename">lib</code>,
2756: <code class="filename">share</code> and
2757: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2758: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2759: <code class="filename">/var</code> in the base system. Some programs (especially
2760: games, network daemons) need write access to it during normal
2761: operation.</p></li>
1.128 wiz 2762: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2763: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2764: 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 2765: itself.</p></li>
2766: </ul></div>
1.148 asau 2767: <div class="sect1">
1.90 rillig 2768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2769: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2770: </h2></div></div></div>
1.90 rillig 2771: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2772: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2773: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2774: <dt><span class="term"><code class="filename">bin</code></span></dt>
2775: <dd><p>Contains executable programs that are intended to be
2776: directly used by the end user.</p></dd>
2777: <dt><span class="term"><code class="filename">emul</code></span></dt>
2778: <dd><p>Contains files for the emulation layers of various other
2779: operating systems, especially for
2780: NetBSD.</p></dd>
2781: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2782: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2783: <dd><p>Contains
2784: the configuration files.</p></dd>
2785: <dt><span class="term"><code class="filename">include</code></span></dt>
2786: <dd><p>Contains headers for the C and C++ programming
2787: languages.</p></dd>
2788: <dt><span class="term"><code class="filename">info</code></span></dt>
2789: <dd><p>Contains GNU info files of various
2790: packages.</p></dd>
2791: <dt><span class="term"><code class="filename">lib</code></span></dt>
2792: <dd><p>Contains shared and static
2793: libraries.</p></dd>
2794: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2795: <dd><p>Contains data files that don't change after
2796: installation. Other data files belong into
2797: <code class="filename">${VARBASE}</code>.</p></dd>
2798: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2799: <dd><p>Contains programs that are not intended to be used by
2800: end users, such as helper programs or network
2801: daemons.</p></dd>
2802: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2803: <dd><p>Contains programs that are intended to be executed as
2804: CGI scripts by a web server.</p></dd>
2805: <dt><span class="term"><code class="filename">man</code> (the usual value of
2806: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2807: <dd><p>Contains brief
2808: documentation in form of manual pages.</p></dd>
2809: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2810: <dd><p>Contains programs that are intended to be used only by
2811: the super-user.</p></dd>
2812: <dt><span class="term"><code class="filename">share</code></span></dt>
2813: <dd><p>Contains platform-independent data files that don't
2814: change after installation.</p></dd>
2815: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2816: <dd><p>Contains documentation files provided by the
2817: packages.</p></dd>
2818: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2819: <dd><p>Contains example files provided by the packages. Among
2820: others, the original configuration files are saved here and copied to
2821: <code class="filename">${PKG_SYSCONFDIR}</code> during
2822: installation.</p></dd>
2823: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2824: <dd><p>Contains the original files for rc.d
2825: scripts.</p></dd>
2826: <dt><span class="term"><code class="filename">var</code> (the usual location of
2827: <code class="filename">${VARBASE}</code>)</span></dt>
2828: <dd><p>Contains files
2829: that may be modified after
2830: installation.</p></dd>
2831: </dl></div>
2832: </div>
1.148 asau 2833: <div class="sect1">
1.90 rillig 2834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2835: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2836: </h2></div></div></div>
1.148 asau 2837: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2838: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2839: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2840: <dd><p>Contains
2841: information about the currently installed
2842: packages.</p></dd>
2843: <dt><span class="term"><code class="filename">games</code></span></dt>
2844: <dd><p>Contains highscore
2845: files.</p></dd>
2846: <dt><span class="term"><code class="filename">log</code></span></dt>
2847: <dd><p>Contains log files.</p></dd>
2848: <dt><span class="term"><code class="filename">run</code></span></dt>
2849: <dd><p>Contains informational files about daemons that are
2850: currently running.</p></dd>
2851: </dl></div>
2852: </div>
2853: </div>
1.148 asau 2854: <div class="chapter">
1.90 rillig 2855: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2856: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2857: <div class="toc">
2858: <p><b>Table of Contents</b></p>
2859: <dl>
1.106 rillig 2860: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2861: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
2862: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
2863: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
2864: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
2865: <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>
2866: <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 2867: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
2868: <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>
2869: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
2870: <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 2871: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.173 wiz 2872: <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>
2873: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
2874: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
2875: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
2876: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2877: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
2878: <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 2879: </dl>
2880: </div>
2881: <p>This section contains hints, tips & tricks on special things in
2882: pkgsrc that we didn't find a better place for in the previous chapters, and
2883: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2884: <div class="sect1">
1.75 rillig 2885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2886: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2887: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2888: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2889: <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 2890: This is a general purpose list for most issues regarding
2891: pkgsrc, regardless of platform, e.g. soliciting user help
2892: for pkgsrc configuration, unexpected build failures, using
2893: particular packages, upgrading pkgsrc installations,
2894: questions regarding the pkgsrc release branches, etc. General announcements or
2895: proposals for changes that impact the pkgsrc user community,
2896: e.g. major infrastructure changes, new features, package
2897: removals, etc., may also be posted.</p></li>
1.128 wiz 2898: <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 2899: A list where the results of pkgsrc bulk builds are sent and
2900: discussed.</p></li>
1.128 wiz 2901: <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 2902: This list is for those who are interested in getting a
2903: commit message for every change committed to pkgsrc. It is
2904: also available in digest form, meaning one daily message
2905: containing all commit messages for changes to the package
2906: source tree in that 24 hour period.</p></li>
2907: </ul></div>
2908: <p>To subscribe, do:</p>
2909: <pre class="programlisting">
1.100 rillig 2910: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2911: </pre>
2912: <p>Archives for all these mailing lists are available from
1.110 hubertf 2913: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2914: </div>
1.148 asau 2915: <div class="sect1">
1.75 rillig 2916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2917: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 2918: <p>Pkgviews is tightly integrated with buildlink. You can find a
2919: pkgviews User's guide in
1.76 rillig 2920: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 2921: </div>
1.148 asau 2922: <div class="sect1">
1.75 rillig 2923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2924: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2925: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2926: a number of useful utilities for both users and developers of pkgsrc. This
2927: section attempts only to make the reader aware of the utilities and when
2928: they might be useful, and not to duplicate the documentation that comes
2929: with each package.</p>
2930: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.188 ! snj 2931: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="http://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 2932: Symlinks for use by buildlink.</p></li></ul></div>
2933: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2934: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.188 ! snj 2935: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75 rillig 2936: Calculates various kinds of checksums (including SHA1).</p></li>
1.188 ! snj 2937: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75 rillig 2938: Compatibility library for pkgsrc tools.</p></li>
1.188 ! snj 2939: <li class="listitem"><p><a href="http://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 2940: non-BSD systems due to lack of native mtree.</p></li>
1.188 ! snj 2941: <li class="listitem"><p><a href="http://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 2942: Up-to-date replacement for
1.76 rillig 2943: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2944: systems where pkg_install is not present.</p></li>
2945: </ul></div>
2946: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2947: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.188 ! snj 2948: <li class="listitem"><p><a href="http://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 2949: Create a binary package from an
1.110 hubertf 2950: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2951: save the old package.</p></li>
1.188 ! snj 2952: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75 rillig 2953: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2954: from multiple locations. It currently supports the following
2955: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.188 ! snj 2956: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117 jnemeth 2957: the best compiler flags to optimise code for your current
1.128 wiz 2958: CPU and compiler. </p></li>
1.75 rillig 2959: </ul></div>
2960: <p>Utilities for keeping track of installed packages, being up to date,
2961: etc:</p>
1.148 asau 2962: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.188 ! snj 2963: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173 wiz 2964: update tool similar to apt(1). Download, install, and upgrade
2965: binary packages easily.</p></li>
1.188 ! snj 2966: <li class="listitem"><p><a href="http://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 2967: packages whose installed versions do not match the latest pkgsrc
2968: entries.</p></li>
1.188 ! snj 2969: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75 rillig 2970: dependency graphs of packages, to aid in choosing a strategy for
2971: updating.</p></li>
1.188 ! snj 2972: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
! 2973: graphs from the output of <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
! 2974: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112 weinem 2975: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.188 ! snj 2976: <li class="listitem"><p><a href="http://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 2977: does various checks on the complete pkgsrc system.</p></li>
1.188 ! snj 2978: <li class="listitem"><p><a href="http://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 2979: packages you have installed.</p></li>
2980: </ul></div>
2981: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2982: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.188 ! snj 2983: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75 rillig 2984: making and maintaining patches for a package (includes pkgdiff,
2985: pkgvi, mkpatches, etc.).</p></li>
1.188 ! snj 2986: <li class="listitem"><p><a href="http://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 2987: converting to pkgsrc.</p></li>
2988: </ul></div>
2989: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2990: utilities)</p>
1.148 asau 2991: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.188 ! snj 2992: <li class="listitem"><p><a href="http://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 2993: packages in a chrooted area.</p></li>
1.188 ! snj 2994: <li class="listitem"><p><a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75 rillig 2995: kernel version for chrooted cross builds.</p></li>
2996: </ul></div>
2997: </div>
1.148 asau 2998: <div class="sect1">
1.75 rillig 2999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3000: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3001: <p>If you want to use pkgsrc as non-root user, you can set some
3002: variables to make pkgsrc work under these conditions. At the very least,
1.128 wiz 3003: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 3004: will turn on unprivileged mode and set multiple related variables to allow
3005: installation of packages as non-root.</p>
3006: <p>In case the defaults are not enough, you may want to tune some other
3007: variables used. For example, if the automatic user/group detection leads
3008: to incorrect values (or not the ones you would like to use), you can change
3009: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3010: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3011: <p>As regards bootstrapping, please note that the
1.110 hubertf 3012: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3013: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3014: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3015: installation targets. These directories can be overridden by the
1.128 wiz 3016: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3017: that allow finer tuning of the tree layout.</p>
3018: </div>
1.148 asau 3019: <div class="sect1">
1.75 rillig 3020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3021: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3022: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3023: enable this feature by adding the option
3024: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3025: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3026: distfile is found, pkgsrc will try to resume it.</p>
3027: <p>You can also
1.168 wiz 3028: use a different program than the platform default program by changing the
1.117 jnemeth 3029: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3030: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3031: by using the value manual. A value of custom disables the system defaults
3032: and dependency tracking for the fetch program. In that case you have to
3033: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3034: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3035: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3036: <p>For example, if you want to use
1.117 jnemeth 3037: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3038: like:</p>
3039: <pre class="programlisting">
1.117 jnemeth 3040: FETCH_USING= wget
1.1 grant 3041: </pre>
1.75 rillig 3042: </div>
1.148 asau 3043: <div class="sect1">
1.75 rillig 3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3045: <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 3046: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3047: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3048: you will have to add the following line into
1.110 hubertf 3049: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3050: <pre class="programlisting">
1.103 wiz 3051: X11_TYPE=modular
1.1 grant 3052: </pre>
1.148 asau 3053: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3054: <h3 class="title">Note</h3>
1.103 wiz 3055: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3056: </p>
1.75 rillig 3057: </div>
3058: </div>
1.148 asau 3059: <div class="sect1">
1.75 rillig 3060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3061: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3062: <p>If you are sitting behind a firewall which does not allow direct
3063: connections to Internet hosts (i.e. non-NAT), you may specify the
3064: relevant proxy hosts. This is done using an environment variable in the
3065: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 3066: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3067: port 80 as the proxy port number. So the proxy environment variables
3068: are:</p>
3069: <pre class="programlisting">
1.100 rillig 3070: ftp_proxy=ftp://orpheus.amdahl.com:80/
3071: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3072: </pre>
1.75 rillig 3073: </div>
1.148 asau 3074: <div class="sect1">
1.75 rillig 3075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3076: <a name="fetch-https"></a>9.8. How to fetch files from HTTPS sites</h2></div></div></div>
3077: <p>Some fetch tools are not prepared to support HTTPS by default
3078: (for example, the one in NetBSD 6.0), or the one installed by the
3079: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3080: dependency graph).</p>
3081: <p>Usually you won't notice, because distribution files are
3082: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3083: be often enough if you are following pkgsrc-current. In that case, set
3084: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3085: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3086: with HTTPS support by default. Of course, these tools need to be
3087: installed before you can use them this way.</p>
3088: </div>
3089: <div class="sect1">
3090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3091: <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 3092: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3093: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3094: the first available command from the following list:</p>
1.148 asau 3095: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3096: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3097: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3098: </ul></div>
3099: <p>On a default NetBSD installation, this will be
1.76 rillig 3100: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3101: connections first, and falls back to active connections if the server
3102: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3103: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3104: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3105: <p>Having that option present will prevent
1.76 rillig 3106: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3107: transfers.</p>
3108: </div>
1.148 asau 3109: <div class="sect1">
1.75 rillig 3110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3111: <a name="fetching-all-distfiles"></a>9.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3112: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3113: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3114: 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 3115: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3116: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3117: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3118: resulting list to your machine at work/school and use it there. If you
1.188 ! snj 3119: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 3120: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3121: URL:</p>
3122: <p>At home:</p>
3123: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3124: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3125: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3126: <p>At work:</p>
3127: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3128: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3129: home.</p>
3130: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3131: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3132: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3133: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3134: directly by running:</p>
1.75 rillig 3135: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3136: <p>If you even decide to ignore
3137: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3138: by running:</p>
3139: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3140: </div>
1.148 asau 3141: <div class="sect1">
1.75 rillig 3142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3143: <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 3144: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.188 ! snj 3145: <p>When compiling the <a href="http://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 3146: package, you get the error from make that it doesn't know how to make
1.76 rillig 3147: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3148: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3149: the NetBSD base distribution on your machine. It is recommended to do
3150: that to format man pages.</p>
1.188 ! snj 3151: <p>In the case of the <a href="http://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 3152: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3153: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3154: </div>
1.148 asau 3155: <div class="sect1">
1.75 rillig 3156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3157: <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 3158: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3159: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3160: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3161: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3162: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3163: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3164: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3165: -r</strong></span>).</p>
3166: </div>
1.148 asau 3167: <div class="sect1">
1.75 rillig 3168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3169: <a name="using-sudo-with-pkgsrc"></a>9.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3170: <p>When installing packages as non-root user and using the just-in-time
1.188 ! snj 3171: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-6.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 3172: password for each required package installed. To avoid this, the sudo
3173: package can be used, which does password caching over a limited time. To
3174: use it, install sudo (either as binary package or from
1.188 ! snj 3175: <a href="http://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 3176: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3177: <span class="emphasis"><em>after</em></span> the definition of the
3178: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3179: <pre class="programlisting">
1.100 rillig 3180: .if exists(${LOCALBASE}/bin/sudo)
3181: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3182: .endif
1.1 grant 3183: </pre>
1.75 rillig 3184: </div>
1.148 asau 3185: <div class="sect1">
1.75 rillig 3186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3187: <a name="faq.conf"></a>9.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3188: <p>As the system administrator, you can choose where configuration files
3189: are installed. The default settings make all these files go into
1.76 rillig 3190: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3191: be suboptimal depending on your expectations (e.g., a read-only,
3192: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3193: configuration of the provided packages).</p>
3194: <p>In order to change the defaults, you can modify the
3195: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3196: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3197: directory; some common examples include <code class="filename">/etc</code> or
3198: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3199: <p>Furthermore, you can change this value on a per-package basis by
3200: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3201: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3202: package you would like to modify, that is, the contents of
3203: <code class="varname">PKGBASE</code>.</p>
3204: <p>Note that after changing these settings, you must rebuild and
3205: reinstall any affected packages.</p>
3206: </div>
1.148 asau 3207: <div class="sect1">
1.75 rillig 3208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3209: <a name="audit-packages"></a>9.15. Automated security checks</h2></div></div></div>
1.75 rillig 3210: <p>Please be aware that there can often be bugs in third-party software,
3211: and some of these bugs can leave a machine vulnerable to exploitation by
3212: attackers. In an effort to lessen the exposure, the NetBSD packages team
3213: maintains a database of known-exploits to packages which have at one time
3214: been included in pkgsrc. The database can be downloaded automatically, and
3215: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3216: do this, refer to the following two tools (installed as part of the
1.188 ! snj 3217: <a href="http://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 3218: <div class="orderedlist"><ol class="orderedlist" type="1">
3219: <li class="listitem">
1.122 reed 3220: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3221: download a list of the security vulnerabilities information. This list
1.132 spz 3222: is kept up to date by the pkgsrc security team, and is distributed
3223: from the NetBSD ftp server:</p>
3224: <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 3225: </li>
1.128 wiz 3226: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3227: current machine, checking each known vulnerability. If a
1.75 rillig 3228: vulnerable package is installed, it will be shown by output to stdout,
3229: including a description of the type of vulnerability, and a URL
3230: containing more information.</p></li>
3231: </ol></div>
1.114 jmcneill 3232: <p>Use of these tools is strongly recommended! After
1.128 wiz 3233: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3234: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3235: pkg_install</code></strong>.</p>
1.87 wiz 3236: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3237: 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 3238: check.</p>
1.75 rillig 3239: </div>
1.148 asau 3240: <div class="sect1">
1.75 rillig 3241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3242: <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 3243: <p>When you add your own preferences to the
3244: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3245: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3246: environment variables to the <code class="filename">./configure</code>
1.188 ! snj 3247: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3248: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3249: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3250: package.</p>
3251: <p>Currently there is no solution to this problem. If you
3252: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3253: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3254: directory and then inspect any <code class="filename">Makefile</code> and
3255: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3256: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3257: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3258: programmers write so bad code that it only works for the
3259: specific combination of <code class="varname">CFLAGS</code> they have
3260: chosen.</p>
3261: </div>
1.148 asau 3262: <div class="sect1">
1.80 rillig 3263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3264: <a name="ufaq-fail"></a>9.17. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3265: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3266: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3267: case that occurs often is that people only update pkgsrc in
3268: parts, because of performance reasons. Since pkgsrc is one large
3269: system, not a collection of many small systems, there are
3270: sometimes changes that only work when the whole pkgsrc tree is
3271: updated.</p></li>
1.148 asau 3272: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3273: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3274: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3275: files.</p></li>
1.148 asau 3276: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3277: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3278: verify this.</p></li>
1.148 asau 3279: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3280: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3281: </ol></div>
3282: </div>
1.148 asau 3283: <div class="sect1">
1.88 wiz 3284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3285: <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 3286: <p>You have modified a file from pkgsrc, and someone else has
3287: modified that same file afterwards in the CVS repository. Both changes
3288: are in the same region of the file, so when you updated pkgsrc, the
3289: <code class="literal">cvs</code> command marked the conflicting changes in the
3290: file. Because of these markers, the file is no longer a valid
3291: <code class="filename">Makefile</code>.</p>
3292: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3293: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3294: -dP</strong></span> in that directory to download the current version.</p>
3295: </div>
1.75 rillig 3296: </div>
3297: </div>
1.148 asau 3298: <div class="part">
1.75 rillig 3299: <div class="titlepage"><div><div><h1 class="title">
3300: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3301: <div class="partintro">
1.77 rillig 3302: <div></div>
3303: <p>This part of the book deals with creating and
1.128 wiz 3304: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3305: guide on creating a new package. The remaining chapters are more
3306: like a reference manual for pkgsrc.</p>
1.75 rillig 3307: <div class="toc">
3308: <p><b>Table of Contents</b></p>
3309: <dl>
1.106 rillig 3310: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3311: <dd><dl>
1.106 rillig 3312: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3313: <dd><dl>
1.106 rillig 3314: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3315: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3316: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3317: </dl></dd>
1.106 rillig 3318: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3319: <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>
3320: </dl></dd>
3321: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3322: <dd><dl>
1.128 wiz 3323: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3324: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3325: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3326: <dd><dl>
3327: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3328: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3329: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3330: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3331: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3332: </dl></dd>
3333: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3334: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3335: <dd><dl>
3336: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3337: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3338: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3339: </dl></dd>
1.128 wiz 3340: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3341: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3342: </dl></dd>
1.128 wiz 3343: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3344: <dd><dl>
3345: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3346: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3347: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3348: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3349: <dd><dl>
3350: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3351: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3352: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3353: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3354: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3355: </dl></dd>
3356: </dl></dd>
3357: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3358: <dd><dl>
3359: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 3360: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3361: <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 3362: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3363: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 3364: <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 3365: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3366: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3367: </dl></dd>
3368: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3369: <dd><dl>
3370: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 3371: <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 3372: <dd><dl>
3373: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 3374: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3375: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3376: and
3377: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3378: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3379: </dl></dd>
1.128 wiz 3380: <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 3381: <dd><dl>
1.128 wiz 3382: <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 3383: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3384: </dl></dd>
3385: </dl></dd>
3386: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3387: <dd><dl>
3388: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3389: <dd><dl>
3390: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3391: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3392: </dl></dd>
3393: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3394: <dd><dl>
1.128 wiz 3395: <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 3396: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3397: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3398: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3399: </dl></dd>
3400: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3401: <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>
3402: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3403: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3404: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3405: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3406: <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>
3407: </dl></dd>
3408: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3409: <dd><dl>
3410: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3411: <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 3412: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3413: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3414: </dl></dd>
3415: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3416: <dd><dl>
3417: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3418: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3419: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3420: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3421: <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 3422: <dd><dl>
3423: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3424: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3425: </dl></dd>
1.128 wiz 3426: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3427: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3428: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3429: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3430: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3431: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3432: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3433: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3434: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3435: <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 3436: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3437: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3438: </dl></dd>
3439: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3440: <dd><dl>
3441: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3442: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3443: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3444: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3445: </dl></dd>
3446: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3447: <dd><dl>
3448: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3449: <dd><dl>
3450: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3451: <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 3452: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3453: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3454: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3455: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3456: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3457: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3458: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3459: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3460: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3461: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3462: </dl></dd>
1.128 wiz 3463: <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 3464: <dd><dl>
3465: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3466: <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>
3467: </dl></dd>
1.128 wiz 3468: <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 3469: <dd><dl>
3470: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3471: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3472: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3473: </dl></dd>
3474: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3475: <dd><dl>
3476: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3477: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3478: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 3479: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3480: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 3481: </dl></dd>
1.128 wiz 3482: <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 3483: <dd><dl>
3484: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3485: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3486: <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 3487: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3488: </dl></dd>
1.128 wiz 3489: <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 3490: <dd><dl>
3491: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3492: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3493: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3494: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3495: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3496: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3497: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3498: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3499: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3500: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3501: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3502: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3503: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3504: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3505: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3506: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3507: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3508: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3509: emulation</a></span></dt>
1.106 rillig 3510: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3511: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3512: </dl></dd>
1.106 rillig 3513: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3514: </dl></dd>
1.106 rillig 3515: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3516: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3517: <dd><dl>
1.106 rillig 3518: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3519: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3520: <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 3521: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3522: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3523: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3524: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3525: </dl></dd>
3526: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3527: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3528: <dd><dl>
3529: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3530: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3531: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3532: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3533: </dl></dd>
1.75 rillig 3534: </dl>
3535: </div>
1.77 rillig 3536: </div>
1.148 asau 3537: <div class="chapter">
1.77 rillig 3538: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3539: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3540: <div class="toc">
3541: <p><b>Table of Contents</b></p>
3542: <dl>
1.106 rillig 3543: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3544: <dd><dl>
1.106 rillig 3545: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3546: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3547: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3548: </dl></dd>
1.106 rillig 3549: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3550: <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 3551: </dl>
3552: </div>
1.77 rillig 3553: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3554: most likely have a URL from where you can download the source
3555: code. Starting with this URL, creating a package involves only a
3556: few steps.</p>
1.128 wiz 3557: <div class="procedure"><ol class="procedure" type="1">
1.188 ! snj 3558: <li class="step"><p>First, install the packages <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148 asau 3559: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3560: category in which you want to place your package. You can also create a
3561: directory of your own (maybe called <code class="filename">local</code>). In that
3562: category directory, create another directory for your package and change
3563: into it.</p></li>
1.148 asau 3564: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3565: you for a URL. Enter the URL of the distribution file (in most cases a
3566: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3567: of your package are created automatically. The distribution file is
3568: extracted automatically to fill in some details in the
3569: <code class="filename">Makefile</code> that would otherwise have to be done
3570: manually.</p></li>
1.148 asau 3571: <li class="step">
1.91 rillig 3572: <p>Examine the extracted files to determine the dependencies of
3573: your package. Ideally, this is mentioned in some
3574: <code class="filename">README</code> file, but things may differ. For each of
3575: these dependencies, look where it exists in pkgsrc, and if there is a
3576: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3577: line to your package <code class="filename">Makefile</code> which includes that
3578: file just before the last line. If the
1.132 spz 3579: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3580: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3581: <p>If you just need binaries from a package, add a
1.91 rillig 3582: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3583: version of the dependency and where it can be found in pkgsrc. This line
3584: should be placed in the third paragraph. If the dependency is only
3585: needed for building the package, but not when using it, use
3586: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3587: Your package may then look like this:</p>
1.77 rillig 3588: <pre class="programlisting">
1.100 rillig 3589: [...]
1.77 rillig 3590:
1.174 asau 3591: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3592: DEPENDS+= screen-[0-9]*:../../misc/screen
3593: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3594:
1.100 rillig 3595: [...]
1.77 rillig 3596:
1.100 rillig 3597: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3598: .include "../../devel/glib2/buildlink3.mk"
3599: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3600: </pre>
3601: </li>
1.148 asau 3602: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3603: 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 3604: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3605: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3606: -e</strong></span>, which outputs additional
3607: explanations.</p></li>
1.148 asau 3608: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3609: 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 3610: over there, you can hopefully continue here.</p></li>
1.148 asau 3611: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3612: directory from the extracted files. Besides these files, a lot of cache
3613: files and other system information has been saved in the working
3614: directory, which may become wrong after you edited the
3615: <code class="filename">Makefile</code>.</p></li>
1.148 asau 3616: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3617: 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 3618: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3619: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3620: everything works.</p></li>
1.148 asau 3621: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3622: contains a list of the files that are installed by the package, is
1.110 hubertf 3623: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3624: >PLIST</strong></span> to generate a probably correct list. Check
3625: the file using your preferred text editor to see if the list of
3626: files looks plausible.</p></li>
1.148 asau 3627: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3628: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3629: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3630: has been registered in the database of installed files, but with an
1.110 hubertf 3631: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3632: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3633: registered with the list of files from
3634: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3635: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3636: package from the set of installed files.</p></li>
1.77 rillig 3637: </ol></div>
1.148 asau 3638: <div class="sect1">
1.91 rillig 3639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3640: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3641: <div class="sect2">
1.91 rillig 3642: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3643: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3644: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3645: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3646: </div>
1.148 asau 3647: <div class="sect2">
1.91 rillig 3648: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 3649: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3650: <p>KDE3 applications should always include
1.91 rillig 3651: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174 asau 3652: settings that are typical of KDE3 packages.</p>
1.91 rillig 3653: </div>
1.148 asau 3654: <div class="sect2">
1.118 imil 3655: <div class="titlepage"><div><div><h3 class="title">
3656: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3657: <p>Python modules and programs packages are easily created using a
3658: set of predefined variables.</p>
3659: <p>
1.171 wiz 3660: If some Python versions are not supported by the software, set the
3661: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3662: that are not supported, e.g.
1.118 imil 3663: </p>
3664: <pre class="programlisting">
1.172 wiz 3665: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.118 imil 3666: </pre>
3667: <p>
3668: If the packaged software is a Python module, include
1.128 wiz 3669: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3670: In this case, the package directory should be called
1.128 wiz 3671: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3672: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3673: </p>
3674: <pre class="programlisting">
3675: DISTNAME= foopymodule-1.2.10
3676: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3677: </pre>
1.171 wiz 3678: <p>If it is an application, include
3679: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3680: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3681: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3682: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3683: For example:
1.118 imil 3684: </p>
3685: <pre class="programlisting">
1.142 wiz 3686: REPLACE_PYTHON= *.py
1.118 imil 3687: </pre>
1.171 wiz 3688: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3689: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3690: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3691: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3692: so pkgsrc will use this framework.
3693: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3694: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3695: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3696: to the name of the script.</p>
3697: <p>Otherwise, if the packaged software is egg-aware, you only need
3698: to include
3699: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3700: <p>Some Python modules have separate distributions for Python-2.x
3701: and Python-3.x support. In pkgsrc this is handled by the
3702: <code class="filename">versioned_dependencies.mk</code> file. Set
3703: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3704: packages that should be depended upon and include
3705: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3706: then the pkgsrc infrastructure will depend on the appropriate package
3707: version. For example:
3708: </p>
3709: <pre class="programlisting">
3710: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3711: </pre>
3712: <p>
3713: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3714: of supported packages.</p>
1.118 imil 3715: </div>
1.91 rillig 3716: </div>
1.148 asau 3717: <div class="sect1">
1.91 rillig 3718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3719: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3720: <div class="sect2">
1.91 rillig 3721: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3722: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3723: <div class="sect3">
1.91 rillig 3724: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3725: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3726: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3727: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3728: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3729: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3730: <pre class="programlisting">
1.100 rillig 3731: <code class="prompt">$</code> mkdir www/nvu
3732: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3733: </pre>
3734: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3735: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3736: <pre class="programlisting">
1.100 rillig 3737: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3738: </pre>
3739: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3740: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3741: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3742: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3743: <code class="varname">COMMENT</code> fields. Then the package
3744: <code class="filename">Makefile</code> looked like that:</p>
3745: <pre class="programlisting">
1.100 rillig 3746: # $NetBSD$
3747: #
1.91 rillig 3748:
1.100 rillig 3749: DISTNAME= nvu-1.0-sources
3750: PKGNAME= nvu-1.0
3751: CATEGORIES= www
3752: MASTER_SITES= http://cvs.nvu.com/download/
3753: EXTRACT_SUFX= .tar.bz2
3754:
3755: MAINTAINER= rillig@NetBSD.org
3756: HOMEPAGE= http://cvs.nvu.com/
3757: COMMENT= Web Authoring System
1.91 rillig 3758:
1.100 rillig 3759: # url2pkg-marker (please do not remove this line.)
3760: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3761: </pre>
3762: <p>Then, I quit the editor and watched pkgsrc downloading a large
3763: source archive:</p>
3764: <pre class="programlisting">
1.100 rillig 3765: url2pkg> Running "make makesum" ...
3766: => Required installed package digest>=20010302: digest-20060826 found
3767: => Fetching nvu-1.0-sources.tar.bz2
3768: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3769: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3770: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3771: url2pkg> Running "make extract" ...
3772: => Required installed package digest>=20010302: digest-20060826 found
3773: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3774: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3775: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3776: ===> Installing dependencies for nvu-1.0
3777: ===> Overriding tools for nvu-1.0
3778: ===> Extracting for nvu-1.0
3779: url2pkg> Adjusting the Makefile.
1.91 rillig 3780:
1.100 rillig 3781: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3782:
1.100 rillig 3783: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3784: </pre>
3785: </div>
1.148 asau 3786: <div class="sect3">
1.91 rillig 3787: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3788: <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 3789: <p>Now that the package has been extracted, let's see what's inside
3790: it. The package has a <code class="filename">README.txt</code>, but that only
3791: says something about mozilla, so it's probably useless for seeing what
3792: dependencies this package has. But since there is a GNU configure script
3793: in the package, let's hope that it will complain about everything it
3794: needs.</p>
3795: <pre class="programlisting">
1.100 rillig 3796: <code class="prompt">$</code> bmake
3797: => Required installed package digest>=20010302: digest-20060826 found
3798: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3799: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3800: ===> Patching for nvu-1.0
3801: ===> Creating toolchain wrappers for nvu-1.0
3802: ===> Configuring for nvu-1.0
3803: [...]
3804: configure: error: Perl 5.004 or higher is required.
3805: [...]
3806: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3807: [...]
1.91 rillig 3808: </pre>
3809: <p>That worked quite well. So I opened the package Makefile in my
3810: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3811: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3812: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3813: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3814: from scratch.</p>
3815: <pre class="programlisting">
1.100 rillig 3816: <code class="prompt">$</code> bmake clean
3817: ===> Cleaning for nvu-1.0
3818: <code class="prompt">$</code> bmake
3819: [...]
3820: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3821: GNU Make. You will not be able to build Mozilla without GNU Make.
3822: [...]
1.91 rillig 3823: </pre>
1.128 wiz 3824: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3825: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3826: <pre class="programlisting">
1.100 rillig 3827: [...]
3828: checking for GTK - version >= 1.2.0... no
3829: *** Could not run GTK test program, checking why...
3830: [...]
1.91 rillig 3831: </pre>
3832: <p>Now to the other dependencies. The first question is: Where is the
3833: GTK package hidden in pkgsrc?</p>
3834: <pre class="programlisting">
1.100 rillig 3835: <code class="prompt">$</code> echo ../../*/gtk*
3836: [many packages ...]
3837: <code class="prompt">$</code> echo ../../*/gtk
3838: ../../x11/gtk
3839: <code class="prompt">$</code> echo ../../*/gtk2
3840: ../../x11/gtk2
3841: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3842: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3843: </pre>
3844: <p>The first try was definitely too broad. The second one had exactly
3845: one result, which is very good. But there is one pitfall with GNOME
3846: packages. Before GNOME 2 had been released, there were already many
3847: GNOME 1 packages in pkgsrc. To be able to continue to use these
3848: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3849: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3850: whether this was the case here, and indeed it was.</p>
3851: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3852: file, adding the dependency is very easy. I just inserted an
3853: <code class="literal">.include</code> line before the last line of the package
3854: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3855: <pre class="programlisting">
1.100 rillig 3856: [...]
3857: .include "../../x11/gtk2/buildlink3.mk"
3858: .include "../../mk/bsd.pkg.mk
1.91 rillig 3859: </pre>
1.110 hubertf 3860: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3861: was:</p>
3862: <pre class="programlisting">
1.100 rillig 3863: [...]
3864: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3865: checking for GTK - version >= 1.2.0... no
3866: *** Could not run GTK test program, checking why...
3867: *** The test program failed to compile or link. See the file config.log for the
3868: *** exact error that occured. This usually means GTK was incorrectly installed
3869: *** or that you have moved GTK since it was installed. In the latter case, you
3870: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3871: configure: error: Test for GTK failed.
3872: [...]
1.91 rillig 3873: </pre>
1.128 wiz 3874: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3875: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3876: told me that this package really wanted to have the GNOME 1 version of
3877: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3878: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3879: So I changed the <code class="literal">x11/gtk2</code> to
3880: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3881: and tried again.</p>
3882: <pre class="programlisting">
1.100 rillig 3883: [...]
1.166 jnemeth 3884: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3885: In file included from xpidl.c:42:
3886: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3887: In file included from xpidl.c:42:
3888: xpidl.h:132: error: parse error before "IDL_ns"
3889: [...]
1.91 rillig 3890: </pre>
3891: <p>The package still does not find all of its dependencies. Now the
3892: question is: Which package provides the
3893: <code class="filename">libIDL/IDL.h</code> header file?</p>
3894: <pre class="programlisting">
1.100 rillig 3895: <code class="prompt">$</code> echo ../../*/*idl*
3896: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3897: <code class="prompt">$</code> echo ../../*/*IDL*
3898: ../../net/libIDL
1.91 rillig 3899: </pre>
3900: <p>Let's take the one from the second try. So I included the
3901: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3902: again. But the error didn't change. After digging through some of the
3903: code, I concluded that the build process of the package was broken and
3904: couldn't have ever worked, but since the Mozilla source tree is quite
3905: large, I didn't want to fix it. So I added the following to the package
3906: <code class="filename">Makefile</code> and tried again:</p>
3907: <pre class="programlisting">
1.100 rillig 3908: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3909: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 3910: </pre>
3911: <p>The latter line is needed because the package expects the library
3912: <code class="filename">libIDL.so</code>, but only
3913: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3914: wrapper to rewrite that on the fly.</p>
3915: <p>The next problem was related to a recent change of the FreeType
1.188 ! snj 3916: interface. I looked up in <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.91 rillig 3917: which patch files were relevant for this issue and copied them to the
3918: <code class="filename">patches</code> directory. Then I retried, fixed the
3919: patches so that they applied cleanly and retried again. This time,
3920: everything worked.</p>
3921: </div>
1.148 asau 3922: <div class="sect3">
1.91 rillig 3923: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3924: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3925: <pre class="programlisting">
1.100 rillig 3926: <code class="prompt">$</code> bmake CHECK_FILES=no install
3927: [...]
3928: <code class="prompt">$</code> bmake print-PLIST >PLIST
3929: <code class="prompt">$</code> bmake deinstall
3930: <code class="prompt">$</code> bmake install
1.91 rillig 3931: </pre>
3932: </div>
3933: </div>
3934: </div>
1.77 rillig 3935: </div>
1.148 asau 3936: <div class="chapter">
1.75 rillig 3937: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3938: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3939: <div class="toc">
3940: <p><b>Table of Contents</b></p>
3941: <dl>
1.128 wiz 3942: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3943: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3944: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3945: <dd><dl>
3946: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3947: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3948: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3949: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3950: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3951: </dl></dd>
3952: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3953: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3954: <dd><dl>
3955: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3956: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3957: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3958: </dl></dd>
1.128 wiz 3959: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3960: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 3961: </dl>
3962: </div>
1.87 wiz 3963: <p>Whenever you're preparing a package, there are a number of
3964: files involved which are described in the following
3965: sections.</p>
1.148 asau 3966: <div class="sect1">
1.75 rillig 3967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3968: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 3969: </h2></div></div></div>
1.75 rillig 3970: <p>Building, installation and creation of a binary package are all
1.87 wiz 3971: controlled by the package's <code class="filename">Makefile</code>.
3972: The <code class="filename">Makefile</code> describes various things about
3973: a package, for example from where to get it, how to configure,
3974: build, and install it.</p>
1.76 rillig 3975: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3976: sections that describe the package.</p>
1.75 rillig 3977: <p>In the first section there are the following variables, which
1.87 wiz 3978: should appear exactly in the order given here. The order and
3979: grouping of the variables is mostly historical and has no further
3980: meaning.</p>
1.148 asau 3981: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3982: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3983: distribution file to be downloaded from the package's
3984: website.</p></li>
1.128 wiz 3985: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3986: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3987: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 3988: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3989: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 3990: directory name together with the version number. It must match the
3991: regular expression
3992: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3993: starts with a letter or digit, and contains only letters, digits,
3994: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 3995: <li class="listitem">
1.75 rillig 3996: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 3997: which the package fits in. You can choose any of the top-level
3998: directories of pkgsrc for it.</p>
1.75 rillig 3999: <p>Currently the following values are available for
1.87 wiz 4000: <code class="varname">CATEGORIES</code>. If more than
4001: one is used, they need to be separated by spaces:</p>
1.75 rillig 4002: <pre class="programlisting">
1.100 rillig 4003: archivers cross geography meta-pkgs security
4004: audio databases graphics misc shells
4005: benchmarks devel ham multimedia sysutils
4006: biology editors inputmethod net textproc
4007: cad emulators lang news time
4008: chat finance mail parallel wm
4009: comms fonts math pkgtools www
4010: converters games mbone print x11
4011: </pre>
1.75 rillig 4012: </li>
1.128 wiz 4013: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4014: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4015: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4016: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4017: <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 4018: </ul></div>
4019: <p>The second section contains information about separately
1.87 wiz 4020: downloaded patches, if any.
4021: </p>
1.148 asau 4022: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4023: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4024: Name(s) of additional files that contain distribution patches.
4025: There is no default. pkgsrc will look for them at
4026: <code class="varname">PATCH_SITES</code>.
4027: They will automatically be uncompressed before patching if
4028: the names end with <code class="filename">.gz</code> or
4029: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4030: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4031: Primary location(s) for distribution patch files (see
4032: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4033: </ul></div>
4034: <p>The third section contains the following variables.
1.87 wiz 4035: </p>
1.148 asau 4036: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4037: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4038: address of the person who feels responsible for this package,
4039: and who is most likely to look at problems or questions regarding
1.188 ! snj 4040: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114 jmcneill 4041: Other developers may contact the <code class="varname">MAINTAINER</code>
4042: before making changes to the package, but are not required to
4043: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4044: to yourself. If you really can't maintain the package for future
4045: updates, set it to
1.110 hubertf 4046: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4047: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4048: of <code class="varname">MAINTAINER</code> when you do not want other
4049: developers to update or change the package without contacting
4050: you first. A package Makefile should contain one of
4051: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4052: not both. </p></li>
1.128 wiz 4053: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4054: find more information about the package.</p></li>
1.128 wiz 4055: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4056: description of the package (should not include the package
4057: name).</p></li>
1.75 rillig 4058: </ul></div>
4059: <p>Other variables that affect the build:
1.87 wiz 4060: </p>
1.148 asau 4061: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4062: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4063: interesting distribution files of the package are found. The
4064: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4065: works for most packages.</p>
1.75 rillig 4066: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4067: (most GNU software does, for instance), but extracts itself in
4068: the current directory, you should set
4069: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4070: <p>If a package doesn't create a subdirectory with the
4071: name of <code class="varname">DISTNAME</code> but some different name,
4072: set <code class="varname">WRKSRC</code> to point to the proper name in
4073: <code class="filename">${WRKDIR}</code>, for example
4074: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.188 ! snj 4075: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="http://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 4076: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4077: taken from the <code class="varname">WRKDIR_BASENAME</code>
4078: variable. By default, its value is
4079: <code class="filename">work</code>. If you want to use the same
4080: pkgsrc tree for building different kinds of binary packages,
4081: you can change the variable according to your needs. Two
4082: other variables handle common cases of setting
4083: <code class="varname">WRKDIR_BASENAME</code> individually. If
4084: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4085: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4086: the host's name is attached to the directory name. If
4087: <code class="varname">OBJMACHINE</code> is defined, the platform name
4088: is attached, which might look like
4089: <code class="filename">work.i386</code> or
4090: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4091: </li></ul></div>
4092: <p>Please pay attention to the following gotchas:</p>
1.148 asau 4093: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4094: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4095: installed in compressed form by the package. For packages using
4096: BSD-style makefiles which honor MANZ, there is
4097: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4098: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4099: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4100: below).</p></li>
1.128 wiz 4101: <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 4102: </ul></div>
4103: </div>
1.148 asau 4104: <div class="sect1">
1.75 rillig 4105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4106: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4107: </h2></div></div></div>
1.76 rillig 4108: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4109: digest, or checksum, of each distfile needed for the package. This
4110: ensures that the distfiles retrieved from the Internet have not been
4111: corrupted during transfer or altered by a malign force to introduce
4112: a security hole. Due to recent rumor about weaknesses of digest
4113: algorithms, all distfiles are protected using both SHA1 and RMD160
4114: message digests, as well as the file size.</p>
1.76 rillig 4115: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4116: checksums for all the patches found in the
1.110 hubertf 4117: <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 4118: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4119: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4120: command.</p>
1.75 rillig 4121: <p>Some packages have different sets of distfiles depending on
1.188 ! snj 4122: the platform, for example <a href="http://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 4123: <code class="filename">distinfo</code> file and care should be taken when
4124: upgrading such a package to ensure distfile information is not
4125: lost.</p>
1.75 rillig 4126: </div>
1.148 asau 4127: <div class="sect1">
1.75 rillig 4128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4129: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4130: <p>Many packages still don't work out-of-the box on the various
4131: platforms that are supported by pkgsrc. Therefore, a number of custom
4132: patch files are needed to make the package work. These patch files are
4133: found in the <code class="filename">patches/</code> directory.</p>
4134: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4135: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4136: 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 4137: order</a>.</p>
1.148 asau 4138: <div class="sect2">
1.93 rillig 4139: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4140: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4141: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4142: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4143: problems. (To force patches to apply with fuzz you can set
4144: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4145: should contain only changes for a single file, and no file should be
1.93 rillig 4146: patched by more than one patch file. This helps to keep future
4147: modifications simple.</p>
4148: <p>Each patch file is structured as follows: In the first line,
4149: there is the RCS Id of the patch itself. The second line should be
4150: empty for aesthetic reasons. After that, there should be a comment for
4151: each change that the patch does. There are a number of standard
4152: cases:</p>
1.148 asau 4153: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4154: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4155: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4156: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4157: platform and other environment (for example, the compiler) that the
4158: patch is needed for.</p></li>
4159: </ul></div>
1.130 wiz 4160: <p>In all, the patch should be commented so that any
1.93 rillig 4161: developer who knows the code of the application can make some use of
4162: the patch. Special care should be taken for the upstream developers,
4163: since we generally want that they accept our patches, so we have less
4164: work in the future.</p>
4165: </div>
1.148 asau 4166: <div class="sect2">
1.93 rillig 4167: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4168: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4169: <p>One important thing to mention is to pay attention that no RCS
4170: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4171: later checked into the NetBSD CVS tree. Use the
1.188 ! snj 4172: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="http://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 4173: problems.</p>
1.87 wiz 4174: <p>For even more automation, we recommend using
1.110 hubertf 4175: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4176: whole set of patches. You just have to backup files before you
4177: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4178: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4179: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4180: you upgrade a package this way, you can easily compare the new
4181: set of patches with the previously existing one with
1.130 wiz 4182: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4183: are replaced by new files, so carefully check if you want to take all
4184: the changes.</p>
1.87 wiz 4185: <p>When you have finished a package, remember to generate
1.110 hubertf 4186: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4187: 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 4188: <p>When adding a patch that corrects a problem in the
4189: distfile (rather than e.g. enforcing pkgsrc's view of where
4190: man pages should go), send the patch as a bug report to the
4191: maintainer. This benefits non-pkgsrc users of the package,
4192: and usually makes it possible to remove the patch in future
4193: version.</p>
1.101 rillig 4194: <p>The file names of the patch files are usually of the form
1.130 wiz 4195: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4196: Many packages still use the previous convention
4197: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4198: but new patches should be of the form containing the filename.
1.188 ! snj 4199: <span class="command"><strong>mkpatches</strong></span> included in <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.130 wiz 4200: automatically.</p>
1.93 rillig 4201: </div>
1.148 asau 4202: <div class="sect2">
1.93 rillig 4203: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4204: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4205: <p>If you want to share patches between multiple packages
4206: in pkgsrc, e.g. because they use the same distfiles, set
4207: <code class="varname">PATCHDIR</code> to the path where the patch files
4208: can be found, e.g.:</p>
4209: <pre class="programlisting">
1.100 rillig 4210: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4211: </pre>
1.75 rillig 4212: <p>Patch files that are distributed by the author or other
1.87 wiz 4213: maintainers can be listed in
4214: <code class="varname">PATCHFILES</code>.</p>
4215: <p>If it is desired to store any patches that should not be
4216: committed into pkgsrc, they can be kept outside the pkgsrc
4217: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4218: directory tree there is expected to have the same
1.128 wiz 4219: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4220: patches are expected to be stored inside these dirs (also
4221: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4222: example, if you want to keep a private patch for
4223: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4224: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4225: files in the named directory are expected to be patch files,
4226: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4227: applied</em></span>.</p>
1.93 rillig 4228: </div>
1.148 asau 4229: <div class="sect2">
1.85 jmmv 4230: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4231: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4232: <p>When fixing a portability issue in the code do not use
4233: preprocessor magic to check for the current operating system nor
4234: platform. Doing so hurts portability to other platforms because
4235: the OS-specific details are not abstracted appropriately.</p>
4236: <p>The general rule to follow is: instead of checking for the
4237: operating system the application is being built on, check for the
4238: specific <span class="emphasis"><em>features</em></span> you need. For example,
4239: instead of assuming that kqueue is available under NetBSD and
4240: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4241: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4242: yes, this generally involves patching the
1.110 hubertf 4243: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4244: that prevents some OSes from adopting interfaces from other OSes
4245: (e.g. Linux implementing kqueue), something that the above checks
4246: cannot take into account.</p>
4247: <p>Of course, checking for features generally involves more
4248: work on the developer's side, but the resulting changes are
1.87 wiz 4249: cleaner and there are chances they will work on many other
1.85 jmmv 4250: platforms. Not to mention that there are higher chances of being
4251: later integrated into the mainstream sources. Remember:
4252: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4253: <p>Some typical examples:</p>
4254: <div class="table">
1.106 rillig 4255: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4256: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4257: <colgroup>
4258: <col>
4259: <col>
4260: <col>
4261: </colgroup>
4262: <thead><tr>
4263: <th>Where</th>
4264: <th>Incorrect</th>
4265: <th>Correct</th>
4266: </tr></thead>
4267: <tbody>
4268: <tr>
4269: <td>configure script</td>
4270: <td>
1.100 rillig 4271: <pre class="programlisting">
4272: case ${target_os} in
4273: netbsd*) have_kvm=yes ;;
4274: *) have_kvm=no ;;
4275: esac
4276: </pre>
1.85 jmmv 4277: </td>
4278: <td>
1.100 rillig 4279: <pre class="programlisting">
4280: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4281: </pre>
1.85 jmmv 4282: </td>
4283: </tr>
4284: <tr>
4285: <td>C source file</td>
4286: <td>
1.100 rillig 4287: <pre class="programlisting">
4288: #if defined(__NetBSD__)
4289: # include <sys/event.h>
4290: #endif
4291: </pre>
1.85 jmmv 4292: </td>
4293: <td>
1.100 rillig 4294: <pre class="programlisting">
4295: #if defined(HAVE_SYS_EVENT_H)
4296: # include <sys/event.h>
4297: #endif
4298: </pre>
1.85 jmmv 4299: </td>
4300: </tr>
4301: <tr>
4302: <td>C source file</td>
4303: <td>
1.100 rillig 4304: <pre class="programlisting">
4305: int
4306: monitor_file(...)
4307: {
4308: #if defined(__NetBSD__)
4309: int fd = kqueue();
4310: ...
4311: #else
4312: ...
4313: #endif
4314: }
4315: </pre>
1.85 jmmv 4316: </td>
4317: <td>
1.100 rillig 4318: <pre class="programlisting">
4319: int
4320: monitor_file(...)
4321: {
4322: #if defined(HAVE_KQUEUE)
4323: int fd = kqueue();
4324: ...
4325: #else
4326: ...
4327: #endif
4328: }
4329: </pre>
1.85 jmmv 4330: </td>
4331: </tr>
4332: </tbody>
1.91 rillig 4333: </table></div>
1.85 jmmv 4334: </div>
1.91 rillig 4335: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4336: 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
4337: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4338: 2</a>). It summarizes multiple details on how to make
4339: software easier to package; all the suggestions in it were
4340: collected from our experience in pkgsrc work, so they are possibly
4341: helpful when creating patches too.</p>
4342: </div>
1.148 asau 4343: <div class="sect2">
1.85 jmmv 4344: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4345: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4346: <p>Always, always, <span class="strong"><strong>always</strong></span>
4347: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4348: improvements you do to a package to the mainstream developers.
4349: This is the only way to get their attention on portability issues
4350: and to ensure that future versions can be built out-of-the box on
4351: NetBSD. Furthermore, any user that gets newer distfiles will get
4352: the fixes straight from the packaged code.</p>
1.93 rillig 4353: <p>This generally involves cleaning up the patches
4354: (because sometimes the patches that are
1.147 wiz 4355: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4356: appropriate trackers for the projects and working with the
4357: mainstream authors to accept your changes. It is
4358: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4359: the packages in pkgsrc are kept simple and thus further changes
4360: can be done without much hassle.</p>
1.130 wiz 4361: <p>When you have done this, please add a URL to the upstream
4362: bug report to the patch comment.</p>
1.85 jmmv 4363: <p>Support the idea of free software!</p>
4364: </div>
1.75 rillig 4365: </div>
1.148 asau 4366: <div class="sect1">
1.75 rillig 4367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4368: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 4369: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4370: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4371: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4372: any credits where they are due. Please bear in mind that others do not
4373: share your sense of humour (or spelling idiosyncrasies), and that others
4374: will read everything that you write here.</p></dd>
1.76 rillig 4375: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4376: <dd><p>This file governs the files that are installed on your
4377: system: all the binaries, manual pages, etc. There are other
4378: directives which may be entered in this file, to control the
4379: creation and deletion of directories, and the location of
1.110 hubertf 4380: 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 4381: information.</p></dd>
1.75 rillig 4382: </dl></div>
4383: </div>
1.148 asau 4384: <div class="sect1">
1.75 rillig 4385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4386: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 4387: <div class="sect2">
1.78 rillig 4388: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4389: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 4390: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4391: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4392: <dd>
1.188 ! snj 4393: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 4394: First time after package extraction and before files are
4395: moved in place, the second time after the files to install
4396: are moved in place. This can be used to do any custom
4397: procedures not possible with @exec commands in
1.188 ! snj 4398: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
! 4399: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-6.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 4400: Please note that you can modify variables in it easily by using
4401: <code class="varname">FILES_SUBST</code> in the package's
4402: <code class="filename">Makefile</code>:</p>
4403: <pre class="programlisting">
4404: FILES_SUBST+= SOMEVAR="somevalue"
4405: </pre>
4406: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4407: <code class="filename">INSTALL</code>. By default, substitution is
4408: performed for <code class="varname">PREFIX</code>,
4409: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4410: <code class="varname">VARBASE</code>, and a few others, type
4411: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4412: complete list.</p>
4413: </dd>
1.76 rillig 4414: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4415: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4416: this script's responsibility to clean up any additional messy details
4417: around the package's installation, since all pkg_delete knows is how to
4418: delete the files created in the original distribution.
1.188 ! snj 4419: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
! 4420: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135 wiz 4421: The same methods to replace variables can be used as for
4422: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4423: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4424: <dd>
4425: <p>This file is displayed after installation of the package.
1.87 wiz 4426: Useful for things like legal notices on almost-free
4427: software and hints for updating config files after
4428: installing modules for apache, PHP etc.
4429: Please note that you can modify variables in it easily by using
4430: <code class="varname">MESSAGE_SUBST</code> in the package's
4431: <code class="filename">Makefile</code>:</p>
1.75 rillig 4432: <pre class="programlisting">
1.100 rillig 4433: MESSAGE_SUBST+= SOMEVAR="somevalue"
4434: </pre>
1.128 wiz 4435: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4436: <code class="filename">MESSAGE</code>. By default, substitution is
4437: performed for <code class="varname">PKGNAME</code>,
4438: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4439: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4440: <code class="varname">X11BASE</code>,
4441: <code class="varname">PKG_SYSCONFDIR</code>,
4442: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4443: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4444: <p>You can display a different or additional files by
4445: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4446: default is <code class="filename">MESSAGE</code>, if the file
4447: exists.</p>
1.75 rillig 4448: </dd>
1.78 rillig 4449: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 4450: <dd>
4451: <p>This file is used by the alternatives framework.
4452: It creates, configures, and destroys generic wrappers used to
4453: run programs with similar interfaces.
4454: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4455: for more information.</p>
4456: <p>Each line of the file contains two filenames, first
4457: the wrapper and then the alternative provided by the package.
4458: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4459: </dd>
1.78 rillig 4460: </dl></div>
4461: </div>
1.148 asau 4462: <div class="sect2">
1.78 rillig 4463: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4464: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4465: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4466: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4467: <dd><p>This file contains arbitrary things that could
4468: also go into a <code class="filename">Makefile</code>, but its purpose is
4469: to be used by more than one package. This file should only be
4470: used when the packages that will use the file are known in
4471: advance. For other purposes it is often better to write a
4472: <code class="filename">*.mk</code> file and give it a good name that
4473: describes what it does.</p></dd>
4474: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4475: <dd><p>This file contains the dependency information
1.110 hubertf 4476: 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 4477: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4478: <dd><p>This file contains workarounds for compiler bugs
4479: and similar things. It is included automatically by the pkgsrc
4480: infrastructure, so you don't need an extra
4481: <code class="literal">.include</code> line for
4482: it.</p></dd>
4483: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4484: <dd><p>This file contains the code for the
1.110 hubertf 4485: 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 4486: selected by the user. If a package has only one or two options,
4487: it is equally acceptable to put the code directly into the
4488: <code class="filename">Makefile</code>.</p></dd>
4489: </dl></div>
4490: </div>
1.148 asau 4491: <div class="sect2">
1.78 rillig 4492: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4493: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4494: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4495: <dt><span class="term"><code class="filename">README*</code></span></dt>
4496: <dd><p>These files do not take place in the creation of
4497: a package and thus are purely informative to the package
4498: developer.</p></dd>
4499: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4500: <dd><p>This file contains things that need to be done
4501: to make the package even
4502: better.</p></dd>
1.75 rillig 4503: </dl></div>
4504: </div>
1.78 rillig 4505: </div>
1.148 asau 4506: <div class="sect1">
1.75 rillig 4507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4508: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4509: </h2></div></div></div>
1.110 hubertf 4510: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4511: unpacked into the directory denoted by
4512: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4513: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4514: directory is also used to keep various timestamp files.
4515: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4516: The default is <code class="filename">${.CURDIR}/work</code>
4517: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4518: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4519: </div>
1.148 asau 4520: <div class="sect1">
1.75 rillig 4521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4522: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4523: </h2></div></div></div>
1.75 rillig 4524: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4525: to configuration or building, you could place these files here and use
1.110 hubertf 4526: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4527: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4528: this. Alternatively, you could simply diff the file against
4529: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4530: the creation of this file.</p>
4531: <p>If you want to share files in this way with other
4532: packages, set the <code class="varname">FILESDIR</code> variable to point
4533: to the other package's <code class="filename">files</code> directory,
4534: e.g.:</p>
4535: <pre class="programlisting">
1.100 rillig 4536: FILESDIR=${.CURDIR}/../xemacs/files
4537: </pre>
1.75 rillig 4538: </div>
4539: </div>
1.148 asau 4540: <div class="chapter">
1.75 rillig 4541: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4542: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4543: <div class="toc">
4544: <p><b>Table of Contents</b></p>
4545: <dl>
1.106 rillig 4546: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4547: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4548: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4549: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4550: <dd><dl>
4551: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4552: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4553: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4554: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4555: <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 4556: </dl></dd>
4557: </dl>
4558: </div>
1.76 rillig 4559: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4560: each of which forms a well-defined part of the pkgsrc system. Using
1.188 ! snj 4561: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.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 4562: like pkgsrc requires some discipline to keep the code correct and
4563: understandable.</p>
1.76 rillig 4564: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4565: programming are variables (which are actually macros) and shell
4566: commands. Among these shell commands may even be more complex ones
1.188 ! snj 4567: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-6.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 4568: as intended it is necessary to quote all variables correctly when they
4569: are used.</p>
4570: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4571: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4572: with them.</p>
1.148 asau 4573: <div class="sect1">
1.75 rillig 4574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4575: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4577: <p>When you are creating a file as a
4578: target of a rule, always write the data to a temporary file first
4579: and finally rename that file. Otherwise there might occur an error
4580: in the middle of generating the file, and when the user runs
1.188 ! snj 4581: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.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 4582: regenerated properly. Example:</p>
4583: <pre class="programlisting">
1.100 rillig 4584: wrong:
4585: @echo "line 1" > ${.TARGET}
4586: @echo "line 2" >> ${.TARGET}
4587: @false
4588:
4589: correct:
4590: @echo "line 1" > ${.TARGET}.tmp
4591: @echo "line 2" >> ${.TARGET}.tmp
4592: @false
4593: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4594: </pre>
1.110 hubertf 4595: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4596: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4597: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4598: correct</strong></span> gives an error message twice, as expected.</p>
1.188 ! snj 4599: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4600: <code class="literal">${.TARGET}</code> in case of error, but this only
4601: happens when it is interrupted, for example by pressing
4602: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.188 ! snj 4603: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4604: </li></ul></div>
4605: </div>
1.148 asau 4606: <div class="sect1">
1.97 rillig 4607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4608: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4609: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4610: can be processed using the five operators ``='', ``+='', ``?='',
1.188 ! snj 4611: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4612: page.</p>
4613: <p>When a variable's value is parsed from a
1.76 rillig 4614: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4615: backslash character ``\'' are handled specially. If a backslash is
4616: followed by a newline, any whitespace immediately in front of the
4617: backslash, the backslash, the newline, and any whitespace
4618: immediately behind the newline are replaced with a single space. A
4619: backslash character and an immediately following hash character are
4620: replaced with a single hash character. Otherwise, the backslash is
4621: passed as is. In a variable assignment, any hash character that is
4622: not preceded by a backslash starts a comment that continues upto the
4623: end of the logical line.</p>
4624: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4625: the only way to create a variable consisting of a single backslash
4626: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4627: <p>So far for defining variables. The other thing you can do with
4628: variables is evaluating them. A variable is evaluated when it is
4629: part of the right side of the ``:='' or the ``!='' operator, or
4630: directly before executing a shell command which the variable is part
1.188 ! snj 4631: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75 rillig 4632: is, variables are not evaluated until there's no other way. The
4633: ``modifiers'' mentioned in the man page also evaluate the
4634: variable.</p>
4635: <p>Some of the modifiers split the string into words and then
4636: operate on the words, others operate on the string as a whole. When
4637: a string is split into words, it is split as you would expect
1.188 ! snj 4638: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.126 jakllsch 4639: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4640: loop does not follow the shell quoting rules but splits at sequences
4641: of whitespace.</p>
4642: <p>There are several types of variables that should be handled
4643: differently. Strings and two types of lists.</p>
1.148 asau 4644: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4645: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4646: characters. Nevertheless, you should restrict yourself to only
4647: using printable characters. Examples are
4648: <code class="varname">PREFIX</code> and
4649: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4650: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4651: are never exported to any shell command. Their elements are
4652: separated by whitespace. Therefore, the elements themselves cannot
4653: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4654: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4655: Examples are <code class="varname">DEPENDS</code> and
4656: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4657: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4658: may be exported to a shell command. Their elements can contain any
4659: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4660: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4661: <code class="varname">DISTFILES</code> and
4662: <code class="varname">MASTER_SITES</code>.</p></li>
4663: </ul></div>
1.148 asau 4664: <div class="sect2">
1.75 rillig 4665: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4666: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4667: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4668: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4669: are reserved for use by the pkgsrc infrastructure. They shall
4670: not be used by package
1.76 rillig 4671: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4672: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4673: lowercase variable names for the iteration
4674: variables.</p></li>
1.128 wiz 4675: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4676: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4677: <code class="varname">DISTFILES</code>.</p></li>
4678: </ul></div>
4679: </div>
4680: </div>
1.148 asau 4681: <div class="sect1">
1.75 rillig 4682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4683: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4684: <p>This section presents you with some code snippets you should
4685: use in your own code. If you don't find anything appropriate here,
4686: you should test your code and add it here.</p>
1.148 asau 4687: <div class="sect2">
1.75 rillig 4688: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4689: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4690: <pre class="programlisting">
1.100 rillig 4691: STRING= foo * bar `date`
4692: INT_LIST= # empty
4693: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4694: EXT_LIST= # empty
4695: ANOTHER_EXT_LIST= a=b c=d
4696:
4697: INT_LIST+= ${STRING} # 1
4698: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4699: EXT_LIST+= ${STRING:Q} # 3
4700: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4701: </pre>
1.75 rillig 4702: <p>When you add a string to an external list (example 3), it
4703: must be quoted. In all other cases, you must not add a quoting
4704: level. You must not merge internal and external lists, unless you
4705: are sure that all entries are correctly interpreted in both
4706: lists.</p>
4707: </div>
1.148 asau 4708: <div class="sect2">
1.75 rillig 4709: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4710: <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 4711: <pre class="programlisting">
1.100 rillig 4712: EXT_LIST= # empty
4713: .for i in ${INT_LIST}
4714: EXT_LIST+= ${i:Q}""
4715: .endfor
1.1 grant 4716: </pre>
1.75 rillig 4717: <p>This code converts the internal list
4718: <code class="varname">INT_LIST</code> into the external list
4719: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4720: are unquoted they must be quoted here. The reason for appending
4721: <code class="varname">""</code> is explained below.</p>
4722: </div>
1.148 asau 4723: <div class="sect2">
1.75 rillig 4724: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4725: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4726: <p>Sometimes you may want to print an arbitrary string. There
4727: are many ways to get it wrong and only few that can handle every
4728: nastiness.</p>
1.75 rillig 4729: <pre class="programlisting">
1.100 rillig 4730: STRING= foo bar < > * `date` $$HOME ' "
4731: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4732:
1.100 rillig 4733: all:
4734: echo ${STRING} # 1
4735: echo "${STRING}" # 2
4736: echo "${STRING:Q}" # 3
4737: echo ${STRING:Q} # 4
4738: echo x${STRING:Q} | sed 1s,.,, # 5
4739: printf "%s\\n" ${STRING:Q}"" # 6
4740: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4741: </pre>
1.75 rillig 4742: <p>Example 1 leads to a syntax error in the shell, as the
4743: characters are just copied.</p>
4744: <p>Example 2 leads to a syntax error too, and if you leave out
4745: the last " character from <code class="varname">${STRING}</code>,
1.188 ! snj 4746: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-6.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 4747: variable would be evaluated, too.</p>
4748: <p>Example 3 outputs each space character preceded by a
4749: backslash (or not), depending on the implementation of the
1.188 ! snj 4750: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75 rillig 4751: <p>Example 4 handles correctly every string that does not start
4752: with a dash. In that case, the result depends on the
1.188 ! snj 4753: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75 rillig 4754: guarantee that your input does not start with a dash, this form is
4755: appropriate.</p>
4756: <p>Example 5 handles even the case of a leading dash
4757: correctly.</p>
1.79 rillig 4758: <p>Example 6 also works with every string and is the
4759: light-weight solution, since it does not involve a pipe, which has
4760: its own problems.</p>
1.75 rillig 4761: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4762: because the quoting has already been done when adding elements to
4763: the list.</p>
4764: <p>As internal lists shall not be passed to the shell, there is
4765: no example for it.</p>
4766: </div>
1.148 asau 4767: <div class="sect2">
1.75 rillig 4768: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4769: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4770: <p>There are many possible sources of wrongly quoted variables.
4771: This section lists some of the commonly known ones.</p>
1.148 asau 4772: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4773: <li class="listitem">
1.75 rillig 4774: <p>Whenever you use the value of a list, think
4775: about what happens to leading or trailing whitespace. If the
4776: list is a well-formed shell expression, you can apply the
4777: <code class="varname">:M*</code> modifier to strip leading and trailing
4778: whitespace from each word. The <code class="varname">:M</code> operator
4779: first splits its argument according to the rules of the shell,
4780: and then creates a new list consisting of all words that match
4781: the shell glob expression <code class="varname">*</code>, that is: all.
4782: One class of situations where this is needed is when adding a
4783: variable like <code class="varname">CPPFLAGS</code> to
4784: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4785: invokes other configure scripts, it strips the leading and
4786: trailing whitespace from the variable and then passes it to the
4787: other configure scripts. But these configure scripts expect the
4788: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4789: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4790: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4791: here is how we do it:</p>
4792: <pre class="programlisting">
1.100 rillig 4793: CPPFLAGS= # empty
4794: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4795: CPPFLAGS+= ${MY_CPPFLAGS}
4796:
4797: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4798:
4799: all:
4800: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4801: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4802: </pre>
1.75 rillig 4803: </li>
1.128 wiz 4804: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 4805: <code class="varname">${PREFIX}</code> is a properly quoted shell
4806: expression, but there is the C compiler after it, which also
4807: expects a properly quoted string (this time in C syntax). The
4808: version above is therefore only correct if
4809: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4810: or double quotes. If you want to allow these, you have to add
4811: another layer of quoting to each variable that is used as a C
4812: string literal. You cannot use the <code class="varname">:Q</code>
4813: operator for it, as this operator only works for the
4814: shell.</p></li>
1.128 wiz 4815: <li class="listitem">
1.75 rillig 4816: <p>Whenever a variable can be empty, the
4817: <code class="varname">:Q</code> operator can have surprising results. Here
4818: are two completely different cases which can be solved with the
4819: same trick.</p>
4820: <pre class="programlisting">
1.100 rillig 4821: EMPTY= # empty
4822: empty_test:
4823: for i in a ${EMPTY:Q} c; do \
4824: echo "$$i"; \
4825: done
4826:
4827: for_test:
4828: .for i in a:\ a:\test.txt
4829: echo ${i:Q}
4830: echo "foo"
4831: .endfor
1.1 grant 4832: </pre>
1.75 rillig 4833: <p>The first example will only print two of the three lines
4834: we might have expected. This is because
4835: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4836: the shell cannot see. The workaround is to write
4837: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4838: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4839: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4840: <p>The second example will only print three lines instead of
4841: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4842: This is because the backslash of the value
4843: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.188 ! snj 4844: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
! 4845: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-6.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 4846: <code class="varname">${i:Q}""</code>.</p>
4847: </li>
4848: </ul></div>
4849: </div>
1.148 asau 4850: <div class="sect2">
1.75 rillig 4851: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4852: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 4853: <p>The pkgsrc bmake program does not handle the following
4854: assignment correctly. In case <code class="varname">_othervar_</code>
4855: contains a ``-'' character, one of the closing braces is included
4856: in <code class="varname">${VAR}</code> after this code executes.</p>
4857: <pre class="programlisting">
1.100 rillig 4858: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 4859: </pre>
1.75 rillig 4860: <p>For a more complex code snippet and a workaround, see the
1.188 ! snj 4861: package <a href="http://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 4862: <code class="varname">bug1</code>.</p>
4863: </div>
4864: </div>
4865: </div>
1.148 asau 4866: <div class="chapter">
1.75 rillig 4867: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4868: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4869: <div class="toc">
4870: <p><b>Table of Contents</b></p>
4871: <dl>
1.106 rillig 4872: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4873: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4874: <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 4875: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4876: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4877: <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 4878: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
4879: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 4880: </dl>
4881: </div>
1.87 wiz 4882: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4883: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4884: the package (relative to the <code class="filename">${PREFIX}</code>
4885: directory it's been installed in) plus some additional statements
1.188 ! snj 4886: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 4887: This chapter addresses some issues that need attention when
4888: dealing with the <code class="filename">PLIST</code> file (or files, see
4889: below!).</p>
1.148 asau 4890: <div class="sect1">
1.75 rillig 4891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4892: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4893: <p>Be sure to add a RCS ID line as the first thing in any
4894: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4895: <pre class="programlisting">
1.100 rillig 4896: @comment $NetBSD$
1.87 wiz 4897: </pre>
1.75 rillig 4898: </div>
1.148 asau 4899: <div class="sect1">
1.75 rillig 4900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4901: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4902: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4903: to output a PLIST that matches any new files since the package
1.110 hubertf 4904: 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 4905: more information on this target.</p>
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.110 hubertf 4909: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4910: </h2></div></div></div>
1.87 wiz 4911: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 4912: <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
4913: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 4914: <code class="varname">@comment</code>s instead of real
4915: <code class="varname">@dirrm</code> lines. You can also do this for
4916: specific directories and files, so that the results of that
4917: command are very close to reality. This helps <span class="emphasis"><em>a
4918: lot</em></span> during the update of packages.</p>
4919: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4920: of AWK patterns and actions that are used to filter the output of
4921: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4922: scripting you like to it, but be careful with quoting.</p>
4923: <p>For example, to get all files inside the
4924: <code class="filename">libdata/foo</code> directory removed from the
4925: resulting PLIST:</p>
4926: <pre class="programlisting">
1.100 rillig 4927: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 4928: </pre>
4929: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4930: to a specific (shared) directory converted to
4931: <code class="varname">@comment</code>s:</p>
1.75 rillig 4932: <pre class="programlisting">
1.100 rillig 4933: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 4934: </pre>
1.75 rillig 4935: </div>
1.148 asau 4936: <div class="sect1">
1.75 rillig 4937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4938: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4939: <p>A number of variables are substituted automatically in
4940: PLISTs when a package is installed on a system. This includes the
4941: following variables:</p>
1.148 asau 4942: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4943: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4944: <dd>
4945: <p>Some packages like emacs and perl embed information
1.87 wiz 4946: about which architecture they were built on into the
4947: pathnames where they install their files. To handle this
4948: case, PLIST will be preprocessed before actually used, and
4949: the symbol
1.128 wiz 4950: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4951: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4952: same is done if the string
4953: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4954: PLIST somewhere - use this on packages that have GNU
4955: autoconf-created configure scripts.</p>
1.148 asau 4956: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4957: <h3 class="title">Legacy note</h3>
4958: <p>There used to be a symbol
1.128 wiz 4959: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4960: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4961: -m</strong></span>, but that's no longer supported and has
4962: been removed.</p>
1.75 rillig 4963: </div>
4964: </dd>
4965: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4966: <dd>
4967: <p>Some packages want to embed the OS name and version
1.87 wiz 4968: into some paths. To do this, use these variables in the
4969: <code class="filename">PLIST</code>:
4970: </p>
1.148 asau 4971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4972: <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>
4973: <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>
4974: <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 4975: </ul></div>
4976: </dd>
4977: </dl></div>
1.87 wiz 4978: <p>For a complete list of values which are replaced by
4979: default, please look in <code class="filename">bsd.pkg.mk</code> (and
4980: search for <code class="varname">PLIST_SUBST</code>).</p>
4981: <p>If you want to change other variables not listed above, you
4982: can add variables and their expansions to this variable in the
1.110 hubertf 4983: 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 4984: <pre class="programlisting">
1.100 rillig 4985: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 4986: </pre>
1.128 wiz 4987: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4988: in the <code class="filename">PLIST</code> with
1.128 wiz 4989: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4990: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4991: the common case of conditionally including some
4992: <code class="filename">PLIST</code> entries. It can be done by adding
4993: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 4994: setting the corresponding <code class="varname">PLIST.foo</code> variable
4995: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 4996: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 4997: in the <code class="filename">PLIST</code> with either
1.128 wiz 4998: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4999: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5000: For example, in <code class="filename">Makefile</code>:</p>
5001: <pre class="programlisting">
5002: PLIST_VARS+= foo
5003: .if <em class="replaceable"><code>condition</code></em>
5004: PLIST.foo= yes
5005: .else
5006: </pre>
5007: <p>And then in <code class="filename">PLIST</code>:</p>
5008: <pre class="programlisting">
5009: @comment $NetBSD$
5010: bin/bar
5011: man/man1/bar.1
5012: ${PLIST.foo}bin/foo
5013: ${PLIST.foo}man/man1/foo.1
5014: ${PLIST.foo}share/bar/foo.data
5015: ${PLIST.foo}@dirrm share/bar
5016: </pre>
1.75 rillig 5017: </div>
1.148 asau 5018: <div class="sect1">
1.75 rillig 5019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5020: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5021: <p>Man pages should be installed in compressed form if
1.87 wiz 5022: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5023: and uncompressed otherwise. To handle this in the
1.128 wiz 5024: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5025: appended/removed automatically for man pages according to
5026: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5027: or not, see above for details. This modification of the
5028: <code class="filename">PLIST</code> file is done on a copy of it, not
5029: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5030: </div>
1.148 asau 5031: <div class="sect1">
1.75 rillig 5032: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5033: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5034: </h2></div></div></div>
1.76 rillig 5035: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5036: in generating the binary package, set the variable
5037: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.188 ! snj 5038: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 5039: important. The default for <code class="varname">PLIST_SRC</code> is
5040: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5041: </div>
1.148 asau 5042: <div class="sect1">
1.75 rillig 5043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5044: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5045: <p>Some packages decide to install a different set of files based on
1.87 wiz 5046: the operating system being used. These differences can be
5047: automatically handled by using the following files:</p>
1.148 asau 5048: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5049: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5050: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5051: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5052: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5053: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5054: </ul></div>
5055: </div>
1.148 asau 5056: <div class="sect1">
1.75 rillig 5057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5058: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5059: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5060: multiple (and unrelated) packages install files. These
1.125 wiz 5061: directories were problematic because you had to add special
5062: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5063: centralized package handle them.</p>
1.125 wiz 5064: <p>In pkgsrc, it is now easy: Each package should create
5065: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5066: will remove any directories left empty after uninstalling a
5067: package.</p>
5068: <p>If a package needs an empty directory to work, create
5069: the directory during installation as usual, and also add an
5070: entry to the PLIST:
5071: </p>
1.87 wiz 5072: <pre class="programlisting">
1.125 wiz 5073: @pkgdir path/to/empty/directory
1.87 wiz 5074: </pre>
1.125 wiz 5075: <p>
5076: </p>
1.75 rillig 5077: </div>
5078: </div>
1.148 asau 5079: <div class="chapter">
1.75 rillig 5080: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5081: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5082: <div class="toc">
5083: <p><b>Table of Contents</b></p>
5084: <dl>
1.106 rillig 5085: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5086: <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 5087: <dd><dl>
1.106 rillig 5088: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5089: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5090: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5091: and
5092: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5093: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5094: </dl></dd>
1.128 wiz 5095: <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 5096: <dd><dl>
1.128 wiz 5097: <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 5098: <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 5099: </dl></dd>
5100: </dl>
5101: </div>
5102: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5103: are seen by a package's configure and build processes. This is implemented
5104: in a two step process:</p>
1.128 wiz 5105: <div class="orderedlist"><ol class="orderedlist" type="1">
5106: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5107: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5108: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5109: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5110: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5111: <code class="option">-L${LOCALBASE}/lib</code> into references to
5112: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5113: native compiler on some operating systems look like GCC, so that
5114: packages that expect GCC won't require modifications to build with
5115: those native compilers.</p></li>
1.75 rillig 5116: </ol></div>
5117: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5118: package may be built consistently despite what other software may be
5119: installed. Please note that the normal system header and library paths,
5120: e.g. <code class="filename">/usr/include</code>,
5121: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5122: designed to insulate the package build from non-system-supplied
5123: software.</p>
1.148 asau 5124: <div class="sect1">
1.75 rillig 5125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5126: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5127: <p>The process of converting packages to use the buildlink3
1.128 wiz 5128: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5129: The things to keep in mind are:</p>
1.128 wiz 5130: <div class="orderedlist"><ol class="orderedlist" type="1">
5131: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5132: instead of the actual toolchain. Some packages are tricky,
5133: and the only way to know for sure is the check
5134: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5135: wrappers are being invoked.</p></li>
1.128 wiz 5136: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5137: the package Makefile, e.g. Java VMs, standalone shells,
5138: etc., because the code to symlink files into
5139: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5140: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5141: </p></li>
1.128 wiz 5142: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5143: <code class="filename">buildlink3.mk</code> files that you list in a
5144: package's Makefile are added as dependencies for that package.
5145: </p></li>
1.75 rillig 5146: </ol></div>
1.87 wiz 5147: <p>If a dependency on a particular package is required for its libraries and
5148: headers, then we replace:</p>
1.75 rillig 5149: <pre class="programlisting">
1.100 rillig 5150: DEPENDS+= foo>=1.1.0:../../category/foo
5151: </pre>
1.75 rillig 5152: <p>with</p>
5153: <pre class="programlisting">
1.100 rillig 5154: .include "../../category/foo/buildlink3.mk"
5155: </pre>
1.75 rillig 5156: <p>The buildlink3.mk files usually define the required dependencies.
5157: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5158: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5159: <pre class="programlisting">
1.100 rillig 5160: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5161: .include "../../category/foo/buildlink3.mk"
5162: </pre>
1.76 rillig 5163: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5164: files in <code class="filename">pkgsrc/mk</code>
5165: that handle special package issues:</p>
1.148 asau 5166: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5167: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5168: the native or a pkgsrc Berkeley DB implementation based on
5169: the values of <code class="varname">BDB_ACCEPTED</code> and
5170: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5171: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5172: comes with neither Curses nor NCurses, this will take care
1.188 ! snj 5173: to install the <a href="http://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 5174: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5175: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5176: adding a dependency on Heimdal or MIT-krb5 for packages that
5177: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5178: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5179: system-provided Motif installation or adds a dependency on
1.188 ! snj 5180: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a> or <a href="http://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 5181: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.151 obache 5182: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5183: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5184: which Motif version will be used.</p></li>
1.161 ryoon 5185: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 5186: system-provided GNU readline or editline (libedit) installation,
1.188 ! snj 5187: or adds a dependency on <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
! 5188: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.161 ryoon 5189: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5190: If your package really needs GNU readline library, its Makefile
5191: should include <code class="filename">devel/readline/buildlink3.mk</code>
5192: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 5193: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5194: variables that may be used by packages that use the
5195: Open Sound System (OSS) API.</p></li>
1.128 wiz 5196: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5197: any of the Postgres versions in the variable
5198: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5199: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5200: the file for more information.</p></li>
1.128 wiz 5201: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5202: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.188 ! snj 5203: a dependency on <a href="http://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 5204: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5205: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5206: library.</p></li>
1.75 rillig 5207: </ul></div>
1.76 rillig 5208: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5209: files provide a more complete
5210: description of how to use them properly.</p>
1.75 rillig 5211: </div>
1.148 asau 5212: <div class="sect1">
1.75 rillig 5213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5214: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5215: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5216: included by Makefiles to indicate the need to compile and link
5217: against header files and libraries provided by the package. A
5218: <code class="filename">buildlink3.mk</code> file should always provide
5219: enough information to add the correct type of dependency
5220: relationship and include any other
5221: <code class="filename">buildlink3.mk</code> files that it needs to find
5222: headers and libraries that it needs in turn.</p>
5223: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.188 ! snj 5224: file for further editing, Rene Hexel's <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87 wiz 5225: package is highly recommended. For most packages, the following
5226: command will generate a good starting point for
5227: <code class="filename">buildlink3.mk</code> files:</p>
5228: <pre class="screen">
5229: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5230: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5231: </pre>
1.148 asau 5232: <div class="sect2">
1.75 rillig 5233: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5234: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5235: <p>The following real-life example
1.87 wiz 5236: <code class="filename">buildlink3.mk</code> is taken
5237: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5238: <pre class="programlisting">
1.120 snj 5239: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5240:
1.120 snj 5241: BUILDLINK_TREE+= tiff
1.1 grant 5242:
1.120 snj 5243: .if !defined(TIFF_BUILDLINK3_MK)
5244: TIFF_BUILDLINK3_MK:=
1.87 wiz 5245:
1.120 snj 5246: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5247: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5248: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5249:
1.100 rillig 5250: .include "../../devel/zlib/buildlink3.mk"
5251: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5252: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5253:
1.120 snj 5254: BUILDLINK_TREE+= -tiff
1.100 rillig 5255: </pre>
1.87 wiz 5256: <p>The header and footer manipulate
1.120 snj 5257: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5258: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5259: the dependency tree.</p>
5260: <p>The main section is protected from multiple inclusion
1.87 wiz 5261: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5262: added. Several important variables are set in the section:</p>
1.148 asau 5263: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5264: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5265: is the actual dependency recorded in the installed
5266: package; this should always be set using
1.110 hubertf 5267: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5268: we're appending to any pre-existing list of values. This
5269: variable should be set to the first version of the
1.133 wiz 5270: package that had an backwards-incompatible API change.
1.87 wiz 5271: </p></li>
1.128 wiz 5272: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5273: is the location of the <em class="replaceable"><code>pkg</code></em>
5274: pkgsrc directory.</p></li>
1.128 wiz 5275: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5276: (not shown above) controls whether we use
5277: <code class="varname">BUILD_DEPENDS</code> or
5278: <code class="varname">DEPENDS</code> to add the dependency on
5279: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5280: selected by setting
5281: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5282: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5283: used.</p></li>
1.128 wiz 5284: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5285: and
5286: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5287: (not shown above) are lists of subdirectories of
1.76 rillig 5288: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5289: to add to the header and library search paths. These
1.128 wiz 5290: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5291: respectively.</p></li>
1.128 wiz 5292: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5293: (not shown above) is the list of preprocessor flags to add
5294: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5295: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5296: should be avoided and instead be handled using
5297: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5298: above.</p></li>
1.75 rillig 5299: </ul></div>
1.87 wiz 5300: <p>The following variables are all optionally defined within
5301: this second section (protected against multiple inclusion) and
5302: control which package files are symlinked into
5303: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5304: transformed during the symlinking:</p>
1.148 asau 5305: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5306: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5307: (not shown above) is a shell glob pattern relative to
1.76 rillig 5308: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5309: to be symlinked into
1.76 rillig 5310: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5311: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5312: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5313: (not shown above) is a shell pipeline that
5314: outputs to stdout a list of files relative to
5315: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5316: The resulting files are to be symlinked
5317: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5318: this takes the <code class="filename">+CONTENTS</code> of a
5319: <em class="replaceable"><code>pkg</code></em> and filters it through
5320: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5321: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5322: (not shown above) is a filter command that filters
1.76 rillig 5323: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5324: relative to
1.76 rillig 5325: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5326: on stdout. By default for overwrite packages,
5327: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5328: outputs the contents of the <code class="filename">include</code>
5329: and <code class="filename">lib</code> directories in the package
5330: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5331: it outputs any libtool archives in
1.87 wiz 5332: <code class="filename">lib</code> directories.</p></li>
1.128 wiz 5333: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5334: (not shown above) is a list of sed arguments used to
5335: transform the name of the source filename into a
1.110 hubertf 5336: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5337: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5338: </ul></div>
1.120 snj 5339: <p>This section can additionally include any
1.87 wiz 5340: <code class="filename">buildlink3.mk</code> needed for
5341: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5342: Including these <code class="filename">buildlink3.mk</code> files
5343: means that the headers and libraries for these
5344: dependencies are also symlinked into
5345: <code class="filename">${BUILDLINK_DIR}</code>
5346: whenever the <em class="replaceable"><code>pkg</code></em>
5347: <code class="filename">buildlink3.mk</code>
1.120 snj 5348: file is included. Dependencies are only added for directly
5349: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 5350: <p>When providing a <code class="filename">buildlink3.mk</code> and
5351: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 5352: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 5353: header files are automatically exposed when the package is
5354: use.</p>
5355: <p>In particular, if only an executable
5356: (<code class="filename">bin/foo</code>) is linked against a library, that
5357: library does not need to be propagated in the
5358: <code class="filename">buildlink3.mk</code> file.</p>
5359: <p>The following steps should help you decide if a
5360: <code class="filename">buildlink3.mk</code> file needs to be included:
5361: </p>
5362: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5363: <li class="listitem"><p>Look at the installed header files: What
5364: headers do they include? The packages providing these files
5365: must be buildlinked.</p></li>
1.155 wiz 5366: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5367: libraries and look against what other libraries they link.
5368: Some of the packages providing these probably need to be
5369: buildlinked; however, it's not automatic, since e.g. GTK on
5370: some systems pulls in the X libraries, so they will show up in
5371: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 5372: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 5373: used as a hint.</p></li>
1.153 wiz 5374: </ul></div>
5375: <p>
5376: </p>
1.75 rillig 5377: </div>
1.148 asau 5378: <div class="sect2">
1.75 rillig 5379: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5380: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5381: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5382: and
5383: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5384: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5385: <p>These two variables differ in that one describes source
5386: compatibility (API) and the other binary compatibility (ABI).
5387: The difference is that a change in the API breaks compilation of
5388: programs while changes in the ABI stop compiled programs from
5389: running.</p>
5390: <p>Changes to the
1.134 wiz 5391: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5392: variable in a <code class="filename">buildlink3.mk</code> file happen
5393: very rarely. One possible reason is that all packages depending
5394: on this already need a newer version. In case it is bumped see
5395: the description below.</p>
5396: <p>The most common example of an ABI change is that the major
5397: version of a shared library is increased. In this case,
5398: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5399: should be adjusted to require at least the new package version.
5400: Then the packages that depend on this package need their
5401: <code class="varname">PKGREVISION</code>s increased and, if they have
5402: <code class="filename">buildlink3.mk</code> files, their
5403: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5404: adjusted, too. This is needed so pkgsrc will require the correct
5405: package dependency and not settle for an older one when building
5406: the source.</p>
1.110 hubertf 5407: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5408: more information about dependencies on other packages,
5409: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5410: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5411: <p>Please take careful consideration before adjusting
5412: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5413: or
5414: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5415: as we don't want to cause unneeded package deletions and
5416: rebuilds. In many cases, new versions of packages work just
5417: fine with older dependencies.</p>
5418: <p>Also it is not needed to set
1.133 wiz 5419: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5420: when it is identical to
1.87 wiz 5421: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5422: </div>
5423: </div>
1.148 asau 5424: <div class="sect1">
1.75 rillig 5425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5426: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5427: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5428: coincide with headers and libraries present in the base system.
1.76 rillig 5429: Aside from a <code class="filename">buildlink3.mk</code> file, these
5430: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5431: file that includes the necessary checks to decide whether using
5432: the built-in software or the pkgsrc software is
1.87 wiz 5433: appropriate.</p>
5434: <p>The only requirements of a builtin.mk file for
5435: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5436: <div class="orderedlist"><ol class="orderedlist" type="1">
5437: <li class="listitem"><p>It should set
1.87 wiz 5438: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5439: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5440: after it is included.</p></li>
1.128 wiz 5441: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5442: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5443: which is already set before the
5444: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5445: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5446: is <span class="emphasis"><em>very</em></span> important and takes careful
5447: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5448: </ol></div>
1.148 asau 5449: <div class="sect2">
1.75 rillig 5450: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5451: <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 5452: <p>The following is the recommended template for builtin.mk
1.87 wiz 5453: files:</p>
1.75 rillig 5454: <pre class="programlisting">
1.100 rillig 5455: .if !defined(IS_BUILTIN.foo)
5456: #
5457: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5458: # genuinely exists in the system or not.
5459: #
5460: IS_BUILTIN.foo?= no
5461:
5462: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5463: # version can be determined.
5464: #
5465: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5466: BUILTIN_PKG.foo?= foo-1.0
5467: . endif
5468: .endif # IS_BUILTIN.foo
5469:
5470: .if !defined(USE_BUILTIN.foo)
5471: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5472: . if defined(BUILTIN_PKG.foo)
5473: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5474: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5475: USE_BUILTIN.foo!= \
5476: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5477: && ${ECHO} "yes" || ${ECHO} "no"
5478: . endif
5479: . endfor
5480: . endif
5481: .endif # USE_BUILTIN.foo
5482:
5483: CHECK_BUILTIN.foo?= no
5484: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5485: #
5486: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5487: # "yes" or "no".
5488: #
5489: .endif # CHECK_BUILTIN.foo
5490: </pre>
1.87 wiz 5491: <p>The first section sets
5492: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5493: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5494: in the base system. This should not be a base system software
5495: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5496: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5497: included as part of the base system. This variable is only
5498: used internally within the <code class="filename">builtin.mk</code>
5499: file.</p>
5500: <p>The second section sets
5501: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5502: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5503: system if it exists (if
5504: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5505: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5506: within the <code class="filename">builtin.mk</code> file.</p>
5507: <p>The third section sets
5508: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5509: and is <span class="emphasis"><em>required</em></span> in all
5510: <code class="filename">builtin.mk</code> files. The code in this
5511: section must make the determination whether the built-in
5512: software is adequate to satisfy the dependencies listed in
5513: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5514: This is typically done by comparing
5515: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5516: against each of the dependencies in
5517: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5518: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5519: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5520: end of the <code class="filename">builtin.mk</code> file. Note that
5521: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5522: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5523: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5524: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5525: that the built-in version of the software is similar enough to
5526: be used as a replacement.</p>
5527: <p>The last section is guarded by
5528: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5529: and includes code that uses the value of
5530: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5531: set in the previous section. This typically includes, e.g.,
5532: adding additional dependency restrictions and listing additional
5533: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5534: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5535: </div>
1.148 asau 5536: <div class="sect2">
1.75 rillig 5537: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5538: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5539: <p>When building packages, it's possible to choose whether to set
5540: a global preference for using either the built-in (native)
5541: version or the pkgsrc version of software to satisfy a
5542: dependency. This is controlled by setting
5543: <code class="varname">PREFER_PKGSRC</code> and
5544: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5545: 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 5546: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5547: use the pkgsrc versions of software, while
5548: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5549: built-in versions. Preferences are determined by the most
5550: specific instance of the package in either
5551: <code class="varname">PREFER_PKGSRC</code> or
5552: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5553: in neither or in both variables, then
5554: <code class="varname">PREFER_PKGSRC</code> has precedence over
5555: <code class="varname">PREFER_NATIVE</code>. For example, to require
5556: using pkgsrc versions of software for all but the most basic
5557: bits on a NetBSD system, you can set:</p>
5558: <pre class="programlisting">
1.100 rillig 5559: PREFER_PKGSRC= yes
5560: PREFER_NATIVE= getopt skey tcp_wrappers
5561: </pre>
1.87 wiz 5562: <p>A package <span class="emphasis"><em>must</em></span> have a
5563: <code class="filename">builtin.mk</code>
5564: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5565: otherwise it is simply ignored in that list.</p>
1.75 rillig 5566: </div>
5567: </div>
5568: </div>
1.148 asau 5569: <div class="chapter">
1.75 rillig 5570: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5571: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5572: <div class="toc">
5573: <p><b>Table of Contents</b></p>
5574: <dl>
1.106 rillig 5575: <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 5576: <dd><dl>
1.106 rillig 5577: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5578: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5579: </dl></dd>
1.106 rillig 5580: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5581: <dd><dl>
1.128 wiz 5582: <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 5583: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5584: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5585: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5586: </dl></dd>
5587: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5588: <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>
5589: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5590: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5591: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5592: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5593: <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 5594: </dl>
5595: </div>
5596: <p>This chapter describes the framework known as
5597: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5598: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5599: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5600: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5601: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5602: provided that packages are correctly designed.</p></li>
1.128 wiz 5603: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5604: <li class="listitem"><p>Registration of system users and groups.</p></li>
5605: <li class="listitem"><p>Registration of system shells.</p></li>
5606: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5607: </ul></div>
5608: <p>The following sections inspect each of the above points in detail.</p>
5609: <p>You may be thinking that many of the things described here could be
5610: easily done with simple code in the package's post-installation target
5611: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5612: as the code in them is only executed when building from source. Machines
5613: using binary packages could not benefit from it at all (as the code itself
5614: could be unavailable). Therefore, the only way to achieve any of the items
5615: described above is by means of the installation scripts, which are
5616: automatically generated by pkginstall.</p>
1.148 asau 5617: <div class="sect1">
1.75 rillig 5618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5619: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5620: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5621: of files and directories that belong to a package. The names used in it
1.76 rillig 5622: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5623: which means that it cannot register files outside this directory (absolute
5624: path names are not allowed). Despite this restriction, some packages need
5625: to install files outside this location; e.g., under
1.76 rillig 5626: <code class="filename">${VARBASE}</code> or
1.87 wiz 5627: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5628: is to create such files during installation time by using
5629: installation scripts.</p>
5630: <p>The generic installation scripts are shell scripts that can
5631: contain arbitrary code. The list of scripts to execute is taken from
5632: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5633: <code class="filename">INSTALL</code>. A similar variable exists for package
5634: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5635: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5636: commands, so they have the potential to create and manage files
5637: anywhere in the file system.</p>
5638: <p>Using these general installation files is not recommended, but
5639: may be needed in some special cases. One reason for avoiding them is
5640: that the user has to trust the packager that there is no unwanted or
5641: simply erroneous code included in the installation script. Also,
5642: previously there were many similar scripts for the same functionality,
5643: and fixing a common error involved finding and changing all of
5644: them.</p>
5645: <p>The pkginstall framework offers another, standardized way. It
5646: provides generic scripts to abstract the manipulation of such files
5647: and directories based on variables set in the package's
5648: <code class="filename">Makefile</code>. The rest of this section describes
5649: these variables.</p>
1.148 asau 5650: <div class="sect2">
1.75 rillig 5651: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5652: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5653: <p>The following variables can be set to request the creation of
5654: directories anywhere in the file system:</p>
1.148 asau 5655: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5656: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5657: contain a list of directories that should be created and should attempt
5658: to be destroyed by the installation scripts. The difference between
5659: the two is that the latter prompts the administrator to remove any
5660: directories that may be left after deinstallation (because they were
5661: not empty), while the former does not.</p></li>
1.128 wiz 5662: <li class="listitem">
1.75 rillig 5663: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5664: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5665: which directories should be created and should attempt to be destroyed
5666: by the installation scripts. Each tuple holds the following values,
5667: separated by spaces: the directory name, its owner, its group and its
5668: numerical mode. For example:</p>
5669: <pre class="programlisting">
1.100 rillig 5670: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5671: </pre>
1.75 rillig 5672: <p>The difference between the two is exactly the same as their
5673: non-<code class="varname">PERMS</code> counterparts.</p>
5674: </li>
5675: </ul></div>
5676: </div>
1.148 asau 5677: <div class="sect2">
1.75 rillig 5678: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5679: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5680: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5681: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5682: To overcome this problem, the only solution is to extract the file in the
5683: known place (i.e., inside the installation prefix) and copy it to the
5684: appropriate location during installation (done by the installation scripts
5685: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5686: file</em></span> in the following paragraphs, which describe the variables
5687: that can be used to automatically and consistently handle files outside the
5688: installation prefix:</p>
1.148 asau 5689: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5690: <li class="listitem">
1.75 rillig 5691: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5692: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5693: During installation time, the master file is copied to the target one
5694: if and only if the latter does not exist. Upon deinstallation, the
5695: target file is removed provided that it was not modified by the
5696: installation.</p>
5697: <p>The difference between the two is that the latter prompts the
5698: administrator to remove any files that may be left after
5699: deinstallation (because they were not empty), while the former does
5700: not.</p>
5701: </li>
1.128 wiz 5702: <li class="listitem">
1.75 rillig 5703: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5704: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5705: files as well as their target locations. For each of them, it also
5706: specifies their owner, their group and their numeric permissions, in
5707: this order. For example:</p>
5708: <pre class="programlisting">
1.137 wiz 5709: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5710: </pre>
1.75 rillig 5711: <p>The difference between the two is exactly the same as their
5712: non-<code class="varname">PERMS</code> counterparts.</p>
5713: </li>
5714: </ul></div>
5715: </div>
5716: </div>
1.148 asau 5717: <div class="sect1">
1.75 rillig 5718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5719: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5720: <p>Configuration files are special in the sense that they are installed
5721: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5722: need special treatment during installation (most of which is automated by
5723: pkginstall). The main concept you must bear in mind is that files marked
5724: as configuration files are automatically copied to the right place (somewhere
5725: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5726: and only if</em></span> they didn't exist before. Similarly, they will not
5727: be removed if they have local modifications. This ensures that
5728: administrators never lose any custom changes they may have made.</p>
1.148 asau 5729: <div class="sect2">
1.75 rillig 5730: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5731: <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 5732: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5733: specifies where configuration files shall be installed. Its contents are
5734: set based upon the following variables:</p>
1.148 asau 5735: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5736: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5737: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5738: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5739: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5740: Packages must not use it directly.</p></li>
1.128 wiz 5741: <li class="listitem">
1.75 rillig 5742: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5743: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5744: for the package being built shall be installed. The definition of this
5745: variable only makes sense in the package's
1.76 rillig 5746: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5747: <p>As an example, consider the Apache package,
1.188 ! snj 5748: <a href="http://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 5749: configuration files under the
1.76 rillig 5750: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5751: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5752: Makefile.</p>
5753: </li>
1.128 wiz 5754: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5755: variable that holds this package's configuration directory (if
5756: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5757: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5758: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5759: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5760: directory where the configuration files for the package identified by
5761: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5762: </ul></div>
5763: <p>Based on the above variables, pkginstall determines the value of
5764: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5765: variable that can be used within a package to refer to its configuration
5766: directory. The algorithm used to set its value is basically the
5767: following:</p>
1.128 wiz 5768: <div class="orderedlist"><ol class="orderedlist" type="1">
5769: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5770: its value is used.</p></li>
1.128 wiz 5771: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5772: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5773: <code class="filename">Makefile</code>, the resulting value is
5774: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5775: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5776: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5777: </ol></div>
1.76 rillig 5778: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5779: 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
5780: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5781: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5782: </div>
1.148 asau 5783: <div class="sect2">
1.75 rillig 5784: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5785: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5786: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5787: known place, you need to teach each package where it shall install its
5788: files. In some cases you will have to patch the package Makefiles to
5789: achieve it. If you are lucky, though, it may be as easy as passing an
5790: extra flag to the configuration script; this is the case of GNU Autoconf-
5791: generated files:</p>
5792: <pre class="programlisting">
1.100 rillig 5793: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5794: </pre>
1.75 rillig 5795: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5796: for</em></span> its configuration files, not where they will be originally
5797: installed (although the difference is never explicit,
5798: unfortunately).</p>
5799: </div>
1.148 asau 5800: <div class="sect2">
1.75 rillig 5801: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5802: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5803: <p>As said before, pkginstall automatically handles configuration files.
5804: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5805: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5806: directly</strong></span>. Bad news is that many software installation scripts
5807: will, out of the box, mess with the contents of that directory. So what is
5808: the correct procedure to fix this issue?</p>
5809: <p>You must teach the package (usually by manually patching it) to
5810: install any configuration files under the examples hierarchy,
1.76 rillig 5811: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5812: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5813: has the original copies available.</p>
5814: <p>Once the required configuration files are in place (i.e., under the
5815: examples hierarchy), the pkginstall framework can use them as master copies
5816: during the package installation to update what is in
1.76 rillig 5817: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5818: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5819: 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 5820: about their syntax and their purpose. Here is an example, taken from the
1.188 ! snj 5821: <a href="http://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 5822: <pre class="programlisting">
1.100 rillig 5823: EGDIR= ${PREFIX}/share/doc/mutt/samples
5824: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5825: </pre>
1.75 rillig 5826: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5827: package and has no meaning outside it.</p>
5828: </div>
1.148 asau 5829: <div class="sect2">
1.75 rillig 5830: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5831: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5832: <p>The automatic copying of config files can be toggled by setting the
5833: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5834: installation.</p>
5835: </div>
5836: </div>
1.148 asau 5837: <div class="sect1">
1.75 rillig 5838: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5839: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5840: <p>System startup scripts are special files because they must be
5841: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5842: 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 5843: can be used. However, pkginstall provides a special mechanism to handle
5844: these files.</p>
5845: <p>In order to provide system startup scripts, the package has
5846: to:</p>
1.128 wiz 5847: <div class="orderedlist"><ol class="orderedlist" type="1">
5848: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5849: the <code class="literal">.sh</code> suffix appended. Considering the
1.188 ! snj 5850: <a href="http://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 5851: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5852: <li class="listitem">
1.75 rillig 5853: <p>Tell pkginstall to handle it, appending the name of the script,
5854: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5855: Continuing the previous example:</p>
5856: <pre class="programlisting">
1.100 rillig 5857: RCD_SCRIPTS+= cupsd
1.1 grant 5858: </pre>
1.75 rillig 5859: </li>
5860: </ol></div>
5861: <p>Once this is done, pkginstall will do the following steps for each
5862: script in an automated fashion:</p>
1.128 wiz 5863: <div class="orderedlist"><ol class="orderedlist" type="1">
5864: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5865: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5866: variable.</p></li>
1.128 wiz 5867: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5868: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5869: that this master file must be explicitly registered in the
1.76 rillig 5870: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5871: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5872: from the examples hierarchy into the system-wide startup scripts
5873: directory.</p></li>
5874: </ol></div>
1.148 asau 5875: <div class="sect2">
1.75 rillig 5876: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5877: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5878: <p>The automatic copying of config files can be toggled by setting the
5879: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5880: installation. Note that the scripts will be always copied inside the
1.76 rillig 5881: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5882: matter what the value of this variable is.</p>
5883: </div>
5884: </div>
1.148 asau 5885: <div class="sect1">
1.75 rillig 5886: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5887: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5888: <p>If a package needs to create special users and/or groups during
5889: installation, it can do so by using the pkginstall framework.</p>
5890: <p>Users can be created by adding entries to the
5891: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5892: syntax:</p>
5893: <pre class="programlisting">
1.100 rillig 5894: user:group
1.1 grant 5895: </pre>
1.87 wiz 5896: <p>Further specification of user details may be done by setting
5897: per-user variables.
5898: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5899: numeric UID for the user.
5900: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5901: user's description or comment.
5902: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5903: user's home directory, and defaults to
5904: <code class="filename">/nonexistent</code> if not specified.
5905: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5906: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5907: not specified.</p>
1.75 rillig 5908: <p>Similarly, groups can be created by adding entries to the
5909: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5910: <pre class="programlisting">
1.100 rillig 5911: group
1.1 grant 5912: </pre>
1.93 rillig 5913: <p>The numeric GID of the group may be set by defining
1.75 rillig 5914: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5915: <p>If a package needs to create the users and groups at an earlier
5916: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5917: either <code class="literal">configure</code> or <code class="literal">build</code> to
5918: indicate the phase before which the users and groups are created. In
5919: this case, the numeric UIDs and GIDs of the created users and groups
5920: are automatically hardcoded into the final installation scripts.</p>
5921: </div>
1.148 asau 5922: <div class="sect1">
1.75 rillig 5923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5924: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5925: <p>Packages that install system shells should register them in the shell
1.76 rillig 5926: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5927: administrator. This must be done from the installation scripts to keep
5928: binary packages working on any system. pkginstall provides an easy way to
5929: accomplish this task.</p>
5930: <p>When a package provides a shell interpreter, it has to set the
5931: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5932: add some hooks to the installation scripts to handle it. Consider the
1.188 ! snj 5933: following example, taken from <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75 rillig 5934: <pre class="programlisting">
1.100 rillig 5935: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5936: </pre>
1.148 asau 5937: <div class="sect2">
1.75 rillig 5938: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5939: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5940: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5941: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5942: environment variable to <code class="literal">NO</code>.</p>
5943: </div>
5944: </div>
1.148 asau 5945: <div class="sect1">
1.75 rillig 5946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5947: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5948: <p>Packages that install X11 fonts should update the database files
5949: that index the fonts within each fonts directory. This can easily be
5950: accomplished within the pkginstall framework.</p>
5951: <p>When a package installs X11 fonts, it must list the directories in
5952: which fonts are installed in the
5953: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5954: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5955: <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 5956: installation scripts to run the appropriate commands to update the fonts
5957: database files within each of those directories. For convenience, if the
5958: directory path is relative, it is taken to be relative to the package's
1.188 ! snj 5959: installation prefix. Consider the following example, taken from <a href="http://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 5960: <pre class="programlisting">
1.175 wiz 5961: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5962: </pre>
1.148 asau 5963: <div class="sect2">
1.75 rillig 5964: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5965: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5966: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5967: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5968: environment variable to <code class="literal">NO</code>.</p>
5969: </div>
5970: </div>
5971: </div>
1.148 asau 5972: <div class="chapter">
1.75 rillig 5973: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5974: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 5975: <div class="toc">
5976: <p><b>Table of Contents</b></p>
5977: <dl>
1.106 rillig 5978: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 5979: <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 5980: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 5981: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 5982: </dl>
5983: </div>
5984: <p>Many packages have the ability to be built to support different
1.76 rillig 5985: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 5986: in pkgsrc that provides generic handling of those options that
5987: determine different ways in which the packages can be built. It's
5988: possible for the user to specify exactly which sets of options will be
5989: built into a package or to allow a set of global default options
5990: apply.</p>
1.107 rillig 5991: <p>There are two broad classes of behaviors that one might want to
5992: control via options. One is whether some particular feature is
5993: enabled in a program that will be built anyway, often by including or
5994: not including a dependency on some other package. The other is
5995: whether or not an additional program will be built as part of the
5996: package. Generally, it is better to make a split package for such
5997: additional programs instead of using options, because it enables
5998: binary packages to be built which can then be added separately. For
5999: example, the foo package might have minimal dependencies (those
6000: packages without which foo doesn't make sense), and then the foo-gfoo
6001: package might include the GTK frontend program gfoo. This is better
6002: than including a gtk option to foo that adds gfoo, because either that
6003: option is default, in which case binary users can't get foo without
6004: gfoo, or not default, in which case they can't get gfoo. With split
6005: packages, they can install foo without having GTK, and later decide to
6006: install gfoo (pulling in GTK at that time). This is an advantage to
6007: source users too, avoiding the need for rebuilds.</p>
6008: <p>Plugins with widely varying dependencies should usually be split
6009: instead of options.</p>
6010: <p>It is often more work to maintain split packages, especially if
6011: the upstream package does not support this. The decision of split
6012: vs. option should be made based on the likelihood that users will want
6013: or object to the various pieces, the size of the dependencies that are
6014: included, and the amount of work.</p>
6015: <p>A further consideration is licensing. Non-free parts, or parts
6016: that depend on non-free dependencies (especially plugins) should
6017: almost always be split if feasible.</p>
1.148 asau 6018: <div class="sect1">
1.75 rillig 6019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6020: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6021: <p>Global default options are listed in
6022: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6023: that should be built into every package if that option is supported.
1.110 hubertf 6024: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6025: </div>
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="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6029: </h2></div></div></div>
1.75 rillig 6030: <p>The following example shows how
1.76 rillig 6031: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6032: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6033: <code class="filename">Makefile</code>, or in a file,
6034: e.g. <code class="filename">options.mk</code>, that is included by the
6035: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6036: <pre class="programlisting">
1.100 rillig 6037: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6038: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6039: PKG_OPTIONS_OPTIONAL_GROUPS= database
6040: PKG_OPTIONS_GROUP.database= mysql pgsql
6041: PKG_SUGGESTED_OPTIONS= wibble-foo
6042: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6043: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6044:
6045: .include "../../mk/bsd.prefs.mk"
6046:
6047: # this package was previously named wibble2
6048: .if defined(PKG_OPTIONS.wibble2)
6049: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6050: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6051: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6052: .endif
6053:
6054: .include "../../mk/bsd.options.mk"
6055:
6056: # Package-specific option-handling
6057:
6058: ###
6059: ### FOO support
6060: ###
6061: .if !empty(PKG_OPTIONS:Mwibble-foo)
6062: CONFIGURE_ARGS+= --enable-foo
6063: .endif
6064:
6065: ###
6066: ### LDAP support
6067: ###
6068: .if !empty(PKG_OPTIONS:Mldap)
6069: . include "../../databases/openldap-client/buildlink3.mk"
6070: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6071: .endif
6072:
6073: ###
6074: ### database support
6075: ###
6076: .if !empty(PKG_OPTIONS:Mmysql)
6077: . include "../../mk/mysql.buildlink3.mk"
6078: .endif
6079: .if !empty(PKG_OPTIONS:Mpgsql)
6080: . include "../../mk/pgsql.buildlink3.mk"
6081: .endif
1.75 rillig 6082: </pre>
6083: <p>The first section contains the information about which build
6084: options are supported by the package, and any default options settings
6085: if needed.</p>
1.128 wiz 6086: <div class="orderedlist"><ol class="orderedlist" type="1">
6087: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.188 ! snj 6088: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.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 6089: options. It should be set to
1.78 rillig 6090: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6091: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6092: at the point where the options are processed.</p></li>
1.128 wiz 6093: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6094: build options supported by the package.</p></li>
1.128 wiz 6095: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6096: list of names of groups of mutually exclusive options. The options in
6097: each group are listed in
6098: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6099: The most specific setting of any option from the group takes
6100: precedence over all other options in the group. Options from the
6101: groups will be automatically added to
6102: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6103: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6104: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6105: packages will fail if no option from the group is
6106: selected.</p></li>
1.128 wiz 6107: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6108: of names of sets of options. At least one option from each set must
6109: be selected. The options in each set are listed in
6110: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6111: Options from the sets will be automatically added to
6112: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6113: fail if no option from the set is selected.</p></li>
1.128 wiz 6114: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6115: build options which are enabled by default.</p></li>
1.128 wiz 6116: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6117: of
1.128 wiz 6118: <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 6119: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6120: their option counterparts. Pairs should be added with
1.128 wiz 6121: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6122: warning will be issued if the user uses a legacy
6123: variable.</p></li>
1.128 wiz 6124: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6125: of
1.128 wiz 6126: <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 6127: pairs that map options that have been renamed to their new
1.128 wiz 6128: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6129: the listing of global legacy options. A warning will be issued if
6130: the user uses a legacy option.</p></li>
1.128 wiz 6131: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6132: options implied by deprecated variables used. This can be used for
6133: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6134: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6135: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6136: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6137: a list of warnings about deprecated variables or options used, and
6138: what to use instead.</p></li>
6139: </ol></div>
6140: <p>A package should never modify
6141: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6142: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6143: To suggest a default set of options, use
6144: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6145: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6146: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6147: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6148: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6149: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6150: happen with platform-specific options if none of them is supported on
6151: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6152: empty list and the package is otherwise treated as not using the
6153: options framework.</p>
1.76 rillig 6154: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6155: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6156: build options, properly filtered to remove unsupported and duplicate
6157: options.</p>
6158: <p>The remaining sections contain the logic that is specific to
6159: each option. The correct way to check for an option is to check
6160: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6161: <pre class="programlisting">
1.100 rillig 6162: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6163: </pre>
6164: </div>
1.148 asau 6165: <div class="sect1">
1.75 rillig 6166: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6167: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6168: <p>Options that enable similar features in different packages (like
6169: optional support for a library) should use a common name in all
6170: packages that support it (like the name of the library). If another
6171: package already has an option with the same meaning, use the same
6172: name.</p>
6173: <p>Options that enable features specific to one package, where it's
6174: unlikely that another (unrelated) package has the same (or a similar)
6175: optional feature, should use a name prefixed with
6176: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6177: <p>If a group of related packages share an optional feature
6178: specific to that group, prefix it with the name of the
1.128 wiz 6179: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6180: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6181: <p>For new options, add a line to
1.76 rillig 6182: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6183: fields, separated by tab. The first field is the option name, the
6184: second its description. The description should be a whole sentence
6185: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6186: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6187: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6188: </div>
1.148 asau 6189: <div class="sect1">
1.107 rillig 6190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6191: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6192: <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 6193: different dependencies based on the options with which the package was
6194: built. For querying these options, the file
6195: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6196: typical example looks like this:</p>
6197: <pre class="programlisting">
6198: pkgbase := libpurple
6199: .include "../../mk/pkg-build-options.mk"
6200:
6201: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6202: ...
6203: .endif
6204: </pre>
6205: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6206: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6207: options of the libpurple package, which can then be queried like
6208: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6209: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6210: details.</p>
6211: </div>
1.75 rillig 6212: </div>
1.148 asau 6213: <div class="chapter">
1.75 rillig 6214: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6215: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6216: <div class="toc">
6217: <p><b>Table of Contents</b></p>
6218: <dl>
1.106 rillig 6219: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6220: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6221: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6222: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6223: <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 6224: <dd><dl>
6225: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6226: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6227: </dl></dd>
1.128 wiz 6228: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6229: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6230: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6231: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6232: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6233: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6234: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6235: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6236: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6237: <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 6238: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6239: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6240: </dl>
6241: </div>
1.148 asau 6242: <div class="sect1">
1.75 rillig 6243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6244: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6245: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6246: built. Building a package is separated into different
6247: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6248: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6249: described in the following sections. Each phase is split into
1.87 wiz 6250: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6251: containing phase, prefixed by one of <code class="varname">pre-</code>,
6252: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6253: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6254: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6255: <p>Never override the regular targets (like
6256: <code class="varname">fetch</code>), if you have to, override the
6257: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6258: <p>The basic steps for building a program are always the same. First
1.87 wiz 6259: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6260: the local system and then extracted. After any pkgsrc-specific patches
6261: to compile properly are applied, the software can be configured, then
6262: built (usually by compiling), and finally the generated binaries, etc.
6263: can be put into place on the system.</p>
1.97 rillig 6264: <p>To get more details about what is happening at each step,
6265: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6266: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6267: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6268: </div>
1.148 asau 6269: <div class="sect1">
1.75 rillig 6270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6271: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6272: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6273: the next section, here's a brief discussion on where programs are
6274: installed, and which variables influence this.</p>
1.75 rillig 6275: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6276: where all files of the final program shall be installed. It is
6277: usually set to <code class="varname">LOCALBASE</code>
6278: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6279: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6280: <code class="varname">PREFIX</code> needs to be put
6281: into the various places in the program's source where paths to
1.110 hubertf 6282: 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 6283: <p>When choosing which of these variables to use,
1.87 wiz 6284: follow the following rules:</p>
1.148 asau 6285: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6286: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6287: where the current pkg will be installed. When referring to a
6288: pkg's own installation path, use
1.128 wiz 6289: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6290: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6291: are installed. If you need to construct a -I or -L argument
6292: to the compiler to find includes and libraries installed by
1.128 wiz 6293: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6294: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6295: installed all packages in <code class="filename">/usr/local</code>. As
6296: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6297: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6298: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6299: distribution (from xsrc, etc.) is installed. When looking for
6300: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6301: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6302: <li class="listitem">
1.88 wiz 6303: <p>X11-based packages are special in that they may be
6304: installed in either <code class="varname">X11BASE</code> or
6305: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6306: <p>Usually, X11 packages should be installed under
1.88 wiz 6307: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6308: will need to include
6309: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6310: request the presence of X11 and to get the right compilation
6311: flags.</p>
1.75 rillig 6312: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6313: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6314: files. These packages are special and they must be placed under
6315: <code class="varname">X11BASE</code>. To accomplish this, set either
6316: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6317: your package.</p>
1.75 rillig 6318: <p>Some notes: If you need
1.87 wiz 6319: to find includes or libraries installed by a pkg that has
6320: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6321: its pkg <code class="filename">Makefile</code>, you need to look in
6322: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6323: <code class="filename">${LOCALBASE}</code>. To force installation of
6324: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.188 ! snj 6325: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87 wiz 6326: is enabled by default.</p>
1.75 rillig 6327: </li>
1.128 wiz 6328: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6329: the installed location of an X11
6330: package. <code class="varname">X11PREFIX</code> will be set to
6331: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6332: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6333: installed.</p></li>
1.128 wiz 6334: <li class="listitem">
1.88 wiz 6335: <p>If xpkgwedge is installed, it is possible to have some
6336: packages installed in <code class="varname">X11BASE</code> and some in
6337: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6338: installed package, the <code class="varname">EVAL_PREFIX</code>
6339: definition can be used. It takes pairs in the format
1.188 ! snj 6340: <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-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 6341: variable <code class="varname">DIRNAME</code> will be set to the prefix
6342: of the installed package <package>, or
1.128 wiz 6343: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6344: installed.</p>
1.75 rillig 6345: <p>This is best illustrated by example.</p>
6346: <p>The following lines are taken from
1.87 wiz 6347: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6348: <pre class="programlisting">
1.100 rillig 6349: EVAL_PREFIX+= GTKDIR=gtk+
6350: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6351: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6352: CONFIGURE_ARGS+= --enable-multibyte
6353: </pre>
1.88 wiz 6354: <p>Specific defaults can be defined for the packages
6355: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6356: definition of the form:</p>
1.75 rillig 6357: <pre class="programlisting">
1.100 rillig 6358: GTKDIR_DEFAULT= ${LOCALBASE}
6359: </pre>
1.75 rillig 6360: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6361: to the first definition in
6362: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6363: </li>
1.128 wiz 6364: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.188 ! snj 6365: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 6366: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6367: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6368: </ul></div>
6369: </div>
1.148 asau 6370: <div class="sect1">
1.75 rillig 6371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6372: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6373: <p>When building a package, various directories are used to store
1.87 wiz 6374: source files, temporary files, pkgsrc-internal files, and so on. These
6375: directories are explained here.</p>
1.75 rillig 6376: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6377: are two common base directories for these relative directories:
6378: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6379: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6380: inside the package itself.</p>
1.148 asau 6381: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6382: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6383: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6384: root directory. Generally, you don't need
6385: it.</p></dd>
1.97 rillig 6386: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6387: <dd><p>This is an absolute pathname that points to the
6388: current package.</p></dd>
1.75 rillig 6389: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6390: <dd><p>This is a pathname relative to
1.87 wiz 6391: <code class="varname">PKGSRCDIR</code> that points to the current
6392: package.</p></dd>
1.75 rillig 6393: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6394: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6395: where all work takes place. The distfiles are extracted to this
1.87 wiz 6396: directory. It also contains temporary directories and log files used by
6397: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6398: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6399: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6400: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6401: where the distfiles are extracted. It is usually a direct subdirectory
6402: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6403: that isn't hidden. This variable may be changed by a package
6404: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6405: </dl></div>
1.114 jmcneill 6406: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6407: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6408: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6409: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6410: If users would like to have their pkgsrc trees behave in a
6411: read-only manner, then the value of
6412: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6413: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6414: </div>
1.148 asau 6415: <div class="sect1">
1.75 rillig 6416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6417: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6418: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6419: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6420: phase. This will automatically run all phases that are required for this
6421: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6422: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6423: the package will be built, but not installed.</p>
1.75 rillig 6424: </div>
1.148 asau 6425: <div class="sect1">
1.75 rillig 6426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6427: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6428: <p>The first step in building a package is to fetch the
1.88 wiz 6429: distribution files (distfiles) from the sites that are providing
6430: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6431: phase.</p>
1.148 asau 6432: <div class="sect2">
1.81 rillig 6433: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6434: <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 6435: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6436: defines all URLs from where the distfile, whose name is
6437: derived from the <code class="varname">DISTNAME</code> variable, is
6438: fetched. The more complicated cases are described
6439: below.</p>
6440: <p>The variable <code class="varname">DISTFILES</code> specifies
6441: the list of distfiles that have to be fetched. Its value
1.174 asau 6442: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6443: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 6444: so that most packages don't need to define it at all.
6445: <code class="varname">EXTRACT_SUFX</code> is
6446: <code class="literal">.tar.gz</code> by default, but can be changed
6447: freely. Note that if your package requires additional
6448: distfiles to the default one, you cannot just append the
6449: additional filenames using the <code class="literal">+=</code>
6450: operator, but you have write for example:</p>
1.81 rillig 6451: <pre class="programlisting">
1.174 asau 6452: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 6453: </pre>
1.88 wiz 6454: <p>Each distfile is fetched from a list of sites, usually
6455: <code class="varname">MASTER_SITES</code>. If the package has multiple
6456: <code class="varname">DISTFILES</code> or multiple
6457: <code class="varname">PATCHFILES</code> from different sites, you can
6458: set
6459: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6460: to the list of URLs where the file
6461: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6462: (including the suffix) can be found.</p>
6463: <pre class="programlisting">
1.100 rillig 6464: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6465: DISTFILES+= foo-file.tar.gz
6466: SITES.foo-file.tar.gz= \
6467: http://www.somewhere.com/somehow/ \
6468: http://www.somewhereelse.com/mirror/somehow/
6469: </pre>
1.81 rillig 6470: <p>When actually fetching the distfiles, each item from
1.88 wiz 6471: <code class="varname">MASTER_SITES</code> or
6472: <code class="varname">SITES.*</code> gets the name of each distfile
6473: appended to it, without an intermediate slash. Therefore,
6474: all site values have to end with a slash or other separator
6475: character. This allows for example to set
6476: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6477: that gets the name of the distfile as a parameter. In this
6478: case, the definition would look like:</p>
1.81 rillig 6479: <pre class="programlisting">
1.100 rillig 6480: MASTER_SITES= http://www.example.com/download.cgi?file=
6481: </pre>
1.125 wiz 6482: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 6483: In that case the URL is taken as is, fetched and the result
6484: stored under the name of the distfile. You can use this style
6485: for the case when the download URL style does not match the
6486: above common case. For example, if permanent download URL is a
6487: redirector to the real download URL, or the download file name
6488: is offered by an HTTP Content-Disposition header. In the
6489: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6490: created instead of the default
6491: <code class="filename">v1.0.0.tar.gz</code>.</p>
6492: <pre class="programlisting">
6493: DISTNAME= foo-1.0.0
6494: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6495: </pre>
1.81 rillig 6496: <p>There are some predefined values for
1.88 wiz 6497: <code class="varname">MASTER_SITES</code>, which can be used in
6498: packages. The names of the variables should speak for
6499: themselves.</p>
6500: <pre class="programlisting">
1.100 rillig 6501: ${MASTER_SITE_APACHE}
6502: ${MASTER_SITE_BACKUP}
6503: ${MASTER_SITE_CYGWIN}
6504: ${MASTER_SITE_DEBIAN}
6505: ${MASTER_SITE_FREEBSD}
6506: ${MASTER_SITE_FREEBSD_LOCAL}
6507: ${MASTER_SITE_GENTOO}
6508: ${MASTER_SITE_GNOME}
6509: ${MASTER_SITE_GNU}
6510: ${MASTER_SITE_GNUSTEP}
1.174 asau 6511: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 6512: ${MASTER_SITE_IFARCHIVE}
6513: ${MASTER_SITE_KDE}
6514: ${MASTER_SITE_MOZILLA}
1.174 asau 6515: ${MASTER_SITE_MOZILLA_ALL}
6516: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 6517: ${MASTER_SITE_MYSQL}
1.174 asau 6518: ${MASTER_SITE_NETLIB}
1.100 rillig 6519: ${MASTER_SITE_OPENOFFICE}
6520: ${MASTER_SITE_PERL_CPAN}
6521: ${MASTER_SITE_PGSQL}
1.174 asau 6522: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 6523: ${MASTER_SITE_R_CRAN}
6524: ${MASTER_SITE_SOURCEFORGE}
6525: ${MASTER_SITE_SOURCEFORGE_JP}
6526: ${MASTER_SITE_SUNSITE}
6527: ${MASTER_SITE_SUSE}
6528: ${MASTER_SITE_TEX_CTAN}
6529: ${MASTER_SITE_XCONTRIB}
6530: ${MASTER_SITE_XEMACS}
1.174 asau 6531: ${MASTER_SITE_XORG}
1.100 rillig 6532: </pre>
1.88 wiz 6533: <p>Some explanations for the less self-explaining ones:
6534: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6535: 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 6536: 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 6537: <p>If you choose one of these predefined sites, you may
6538: want to specify a subdirectory of that site. Since these
6539: macros may expand to more than one actual site, you
6540: <span class="emphasis"><em>must</em></span> use the following construct to
6541: specify a subdirectory:</p>
1.81 rillig 6542: <pre class="programlisting">
1.100 rillig 6543: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6544: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6545: </pre>
1.81 rillig 6546: <p>Note the trailing slash after the subdirectory
1.88 wiz 6547: name.</p>
1.81 rillig 6548: </div>
1.148 asau 6549: <div class="sect2">
1.81 rillig 6550: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6551: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6552: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6553: all the distfiles exist in a local directory
1.93 rillig 6554: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6555: user). If the files do not exist, they are fetched using
6556: commands of the form</p>
1.75 rillig 6557: <pre class="programlisting">
1.100 rillig 6558: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6559: </pre>
1.88 wiz 6560: <p>where <code class="literal">${site}</code> varies through
6561: several possibilities in turn: first,
6562: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6563: sites specified in either <code class="varname">SITES.file</code> if
6564: defined, else <code class="varname">MASTER_SITES</code> or
6565: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6566: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6567: all except the first and the last can be optionally sorted
6568: by the user, via setting either
6569: <code class="varname">MASTER_SORT_RANDOM</code>, and
6570: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6571: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6572: <p> The specific command and arguments used depend on the
6573: <code class="varname">FETCH_USING</code> parameter. The example above is
6574: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6575: <p>The distfiles mirror run by the NetBSD Foundation uses the
6576: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6577: distfiles, if they are freely distributable. Packages setting
6578: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6579: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6580: mirrored.</p>
1.81 rillig 6581: </div>
1.75 rillig 6582: </div>
1.148 asau 6583: <div class="sect1">
1.75 rillig 6584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6585: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6586: <p>After the distfile(s) are fetched, their checksum is
6587: generated and compared with the checksums stored in the
6588: distinfo file. If the checksums don't match, the build is
6589: aborted. This is to ensure the same distfile is used for
6590: building, and that the distfile wasn't changed, e.g. by some
6591: malign force, deliberately changed distfiles on the master
6592: distribution site or network lossage.</p>
1.75 rillig 6593: </div>
1.148 asau 6594: <div class="sect1">
1.75 rillig 6595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6596: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6597: <p>When the distfiles are present on the local system, they
1.88 wiz 6598: need to be extracted, as they usually come in the form of some
6599: compressed archive format.</p>
1.75 rillig 6600: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6601: extracted. If you only need some of them, you can set the
6602: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6603: files.</p>
6604: <p>Extracting the files is usually done by a little
1.93 rillig 6605: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6606: already knows how to extract various archive formats, so most
6607: likely you will not need to change anything here. But if you
6608: need, the following variables may help you:</p>
1.148 asau 6609: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6610: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6611: <dd><p>Use these variables to override the default
1.88 wiz 6612: options for an extract command, which are defined in
1.93 rillig 6613: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6614: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6615: <dd><p>This variable can be set to
1.114 jmcneill 6616: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6617: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6618: absolute pathname pointing to the command with which tar
1.114 jmcneill 6619: archives should be extracted. It is preferred to choose bsdtar over gtar
6620: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6621: </dl></div>
1.88 wiz 6622: <p>If the <code class="filename">extract</code> program doesn't
6623: serve your needs, you can also override the
6624: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6625: command used for extracting the files. This command is
6626: executed in the <code class="filename">${WRKSRC}</code>
6627: directory. During execution of this command, the shell
6628: variable <code class="varname">extract_file</code> holds the absolute
6629: pathname of the file that is going to be extracted.</p>
1.75 rillig 6630: <p>And if that still does not suffice, you can override the
1.88 wiz 6631: <code class="varname">do-extract</code> target in the package
6632: Makefile.</p>
1.75 rillig 6633: </div>
1.148 asau 6634: <div class="sect1">
1.75 rillig 6635: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6636: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6637: <p>After extraction, all the patches named by the
1.88 wiz 6638: <code class="varname">PATCHFILES</code>, those present in the patches
6639: subdirectory of the package as well as in
6640: $LOCALPATCHES/$PKGPATH (e.g.
6641: <code class="filename">/usr/local/patches/graphics/png</code>) are
6642: applied. Patchfiles ending in <code class="filename">.Z</code> or
6643: <code class="filename">.gz</code> are uncompressed before they are
6644: applied, files ending in <code class="filename">.orig</code> or
6645: <code class="filename">.rej</code> are ignored. Any special options to
1.188 ! snj 6646: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.110 hubertf 6647: <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.188 ! snj 6648: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 6649: it fail if the patches apply with some lines of fuzz. Please
6650: fix (regen) the patches so that they apply cleanly. The
6651: rationale behind this is that patches that don't apply cleanly
6652: may end up being applied in the wrong place, and cause severe
6653: harm there.</p>
1.75 rillig 6654: </div>
1.148 asau 6655: <div class="sect1">
1.75 rillig 6656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6657: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6658: <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 6659: </p>
1.75 rillig 6660: </div>
1.148 asau 6661: <div class="sect1">
1.75 rillig 6662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6663: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6664: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6665: linkers. The following variables can be used to tweak the
6666: wrappers.</p>
1.148 asau 6667: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6668: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6669: <dd><p>The command used to print progress
1.88 wiz 6670: messages. Does nothing by default. Set to
6671: <code class="literal">${ECHO}</code> to see the progress
6672: messages.</p></dd>
1.75 rillig 6673: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6674: <dd><p>This variable can be set to
1.88 wiz 6675: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6676: depending on whether you want additional information in the
6677: wrapper log file.</p></dd>
1.75 rillig 6678: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6679: <dd><p>This variable can be set to
1.88 wiz 6680: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6681: on whether the wrapper should use its cache, which will
6682: improve the speed. The default value is
6683: <code class="literal">yes</code>, but is forced to
6684: <code class="literal">no</code> if the platform does not support
6685: it.</p></dd>
1.75 rillig 6686: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6687: <dd><p>A list of reordering commands. A reordering
6688: command has the form
6689: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6690: It ensures that that
6691: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6692: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6693: </p></dd>
1.75 rillig 6694: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6695: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6696: investigate further]</p></dd>
1.75 rillig 6697: </dl></div>
6698: </div>
1.148 asau 6699: <div class="sect1">
1.75 rillig 6700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6701: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6702: <p>Most pieces of software need information on the header
6703: files, system calls, and library routines which are available
6704: on the platform they run on. The process of determining this
6705: information is known as configuration, and is usually
6706: automated. In most cases, a script is supplied with the
6707: distfiles, and its invocation results in generation of header
6708: files, Makefiles, etc.</p>
6709: <p>If the package contains a configure script, this can be
6710: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6711: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6712: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6713: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6714: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6715: <pre class="programlisting">
1.100 rillig 6716: .for d in ${CONFIGURE_DIRS}
6717: cd ${WRKSRC} \
6718: && cd ${d} \
6719: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6720: .endfor
6721: </pre>
1.88 wiz 6722: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6723: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6724: <code class="varname">WRKSRC</code>. In each of these directories, the
6725: configure script is run with the environment
6726: <code class="varname">CONFIGURE_ENV</code> and arguments
6727: <code class="varname">CONFIGURE_ARGS</code>. The variables
6728: <code class="varname">CONFIGURE_ENV</code>,
6729: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6730: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6731: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6732: package.</p>
1.144 wiz 6733: <p>If the program uses the Perl way of configuration (mainly Perl
6734: modules, but not only), i.e. a file called
6735: <code class="filename">Makefile.PL</code>, it should include
6736: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6737: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6738: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6739: <p>If the program uses an <code class="filename">Imakefile</code>
6740: for configuration, the appropriate steps can be invoked by
6741: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6742: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6743: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6744: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6745: xmkmf's environment by adding them to the
6746: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6747: <p>If the program uses <code class="filename">cmake</code>
6748: for configuration, the appropriate steps can be invoked by
1.128 wiz 6749: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6750: You can add variables to cmake's environment by adding them to the
6751: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6752: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6753: The top directory argument is given by the
6754: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6755: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6756: <p>If there is no configure step at all, set
1.128 wiz 6757: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6758: </div>
1.148 asau 6759: <div class="sect1">
1.75 rillig 6760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6761: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6762: <p>For building a package, a rough equivalent of the
6763: following code is executed.</p>
1.75 rillig 6764: <pre class="programlisting">
1.100 rillig 6765: .for d in ${BUILD_DIRS}
6766: cd ${WRKSRC} \
6767: && cd ${d} \
6768: && env ${MAKE_ENV} \
6769: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6770: -f ${MAKE_FILE} \
6771: ${BUILD_TARGET}
6772: .endfor
6773: </pre>
1.88 wiz 6774: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6775: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6776: <code class="varname">WRKSRC</code>. In each of these directories,
6777: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6778: <code class="varname">MAKE_ENV</code> and arguments
6779: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6780: <code class="varname">MAKE_ENV</code>,
6781: <code class="varname">BUILD_MAKE_FLAGS</code>,
6782: <code class="varname">MAKE_FILE</code> and
6783: <code class="varname">BUILD_TARGET</code> may all be changed by the
6784: package.</p>
1.75 rillig 6785: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6786: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6787: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6788: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6789: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6790: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6791: <p>If there is no build step at all, set
1.128 wiz 6792: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6793: </div>
1.148 asau 6794: <div class="sect1">
1.75 rillig 6795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6796: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6797: <p>[TODO]</p>
6798: </div>
1.148 asau 6799: <div class="sect1">
1.75 rillig 6800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6801: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6802: <p>Once the build stage has completed, the final step is to
1.88 wiz 6803: install the software in public directories, so users can
6804: access the programs and files.</p>
1.75 rillig 6805: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6806: equivalent of the following code is executed. Additionally,
6807: before and after this code, much magic is performed to do
6808: consistency checks, registering the package, and so on.</p>
6809: <pre class="programlisting">
1.100 rillig 6810: .for d in ${INSTALL_DIRS}
6811: cd ${WRKSRC} \
6812: && cd ${d} \
6813: && env ${MAKE_ENV} \
6814: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6815: -f ${MAKE_FILE} \
6816: ${INSTALL_TARGET}
6817: .endfor
6818: </pre>
1.75 rillig 6819: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6820: <span class="emphasis"><em>build</em></span> phase.
6821: <code class="varname">INSTALL_DIRS</code> defaults to
6822: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6823: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6824: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6825: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6826: defined.</p>
1.75 rillig 6827: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6828: variables are useful. They are all variations of the
1.188 ! snj 6829: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 6830: permissions preset. <code class="varname">INSTALL</code> is the plain
6831: install command. The specialized variants, together with their
6832: intended use, are:</p>
1.148 asau 6833: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6834: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6835: <dd><p>directories that contain
6836: binaries</p></dd>
1.75 rillig 6837: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6838: <dd><p>directories that contain
6839: scripts</p></dd>
1.75 rillig 6840: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6841: <dd><p>directories that contain shared and static
6842: libraries</p></dd>
1.75 rillig 6843: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6844: <dd><p>directories that contain data
6845: files</p></dd>
1.75 rillig 6846: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6847: <dd><p>directories that contain man
6848: pages</p></dd>
1.75 rillig 6849: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6850: <dd><p>binaries that can be stripped from debugging
6851: symbols</p></dd>
1.75 rillig 6852: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6853: <dd><p>binaries that cannot be
6854: stripped</p></dd>
1.75 rillig 6855: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6856: <dd><p>game
6857: binaries</p></dd>
1.75 rillig 6858: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6859: <dd><p>shared and static
6860: libraries</p></dd>
1.75 rillig 6861: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6862: <dd><p>data files</p></dd>
6863: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6864: <dd><p>data files for
6865: games</p></dd>
1.75 rillig 6866: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6867: <dd><p>man pages</p></dd>
6868: </dl></div>
6869: <p>Some other variables are:</p>
1.148 asau 6870: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6871: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6872: <dd><p>A list of directories relative to
1.88 wiz 6873: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6874: beginning of the <span class="emphasis"><em>install</em></span> phase.
6875: The package is supposed to create all needed directories itself
6876: before installing files to it and list all other directories here.
6877: </p></dd>
1.75 rillig 6878: </dl></div>
1.97 rillig 6879: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6880: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6881: mostly relevant for packages in the <code class="filename">regress</code>
6882: category.</p>
1.75 rillig 6883: </div>
1.148 asau 6884: <div class="sect1">
1.75 rillig 6885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6886: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6887: <p>Once the install stage has completed, a binary package of
6888: the installed files can be built. These binary packages can be
6889: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6890: the <span class="command"><strong>make bin-install</strong></span> or by using
6891: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6892: <p>By default, the binary packages are created in
6893: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6894: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6895: one for each category in the <code class="varname">CATEGORIES</code>
6896: variable. <code class="varname">PACKAGES</code> defaults to
6897: <code class="filename">pkgsrc/packages</code>.</p>
6898: </div>
1.148 asau 6899: <div class="sect1">
1.88 wiz 6900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6901: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6902: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6903: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6904: to clean the work directories of all dependencies too, use
1.110 hubertf 6905: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6906: </div>
1.148 asau 6907: <div class="sect1">
1.75 rillig 6908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6909: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6910: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6911: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6912: <dd><p>For any of the main targets described in the
6913: previous section, two auxiliary targets exist with
1.128 wiz 6914: <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 6915: prefix for the main target's name. These targets are
1.88 wiz 6916: invoked before and after the main target is called,
6917: allowing extra configuration or installation steps be
6918: performed from a package's Makefile, for example, which
6919: a program's configure script or install target
6920: omitted.</p></dd>
1.75 rillig 6921: <dt><span class="term">do-*</span></dt>
1.88 wiz 6922: <dd><p>Should one of the main targets do the wrong thing,
6923: and should there be no variable to fix this, you can
6924: redefine it with the do-* target. (Note that redefining
6925: the target itself instead of the do-* target is a bad
6926: idea, as the pre-* and post-* targets won't be called
6927: anymore, etc.) You will not usually need to do
6928: this.</p></dd>
1.75 rillig 6929: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6930: <dd>
1.110 hubertf 6931: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6932: you noticed some file was not installed properly, you
6933: can repeat the installation with this target, which will
1.128 wiz 6934: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6935: <p>This is the default value of
6936: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6937: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6938: package</strong></span>, where the defaults are
1.128 wiz 6939: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6940: respectively.</p>
6941: </dd>
1.75 rillig 6942: <dt><span class="term">deinstall</span></dt>
6943: <dd>
1.188 ! snj 6944: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 6945: current directory, effectively de-installing the
6946: package. The following variables can be used to tune the
6947: behaviour:</p>
1.148 asau 6948: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6949: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.188 ! snj 6950: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 6951: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6952: <dd><p>Remove all packages that require (depend on)
6953: the given package. This can be used to remove any
6954: packages that may have been pulled in by a given
1.110 hubertf 6955: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6956: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6957: <code class="filename">pkgsrc/x11/kde</code>, this is
6958: likely to remove whole KDE. Works by adding
1.188 ! snj 6959: <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-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 6960: command line.</p></dd>
1.75 rillig 6961: </dl></div>
6962: </dd>
1.88 wiz 6963: <dt><span class="term">bin-install</span></dt>
6964: <dd><p>Install a binary package from local disk and via FTP
6965: from a list of sites (see the
6966: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6967: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6968: available anywhere. The arguments given to
1.110 hubertf 6969: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6970: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6971: operation, etc.</p></dd>
1.75 rillig 6972: <dt><span class="term">update</span></dt>
6973: <dd>
1.88 wiz 6974: <p>This target causes the current package to be
6975: updated to the latest version. The package and all
6976: depending packages first get de-installed, then current
6977: versions of the corresponding packages get compiled and
6978: installed. This is similar to manually noting which
6979: packages are currently installed, then performing a
1.110 hubertf 6980: series of <span class="command"><strong>make deinstall</strong></span> and
6981: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 6982: <code class="varname">UPDATE_TARGET</code> is set to) for these
6983: packages.</p>
1.128 wiz 6984: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 6985: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 6986: update</strong></span> was interrupted for some reason.
6987: However, in this case, make sure you don't call
1.110 hubertf 6988: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 6989: list of dependent packages in <code class="varname">WRKDIR</code>.
6990: Otherwise, you lose the ability to automatically update
6991: the current package along with the dependent packages
6992: you have installed.</p>
1.110 hubertf 6993: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 6994: update</strong></span> will only work as long as the package
6995: tree remains unchanged. If the source code for one of
6996: the packages to be updated has been changed, resuming
1.110 hubertf 6997: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 6998: fail!</p>
6999: <p>The following variables can be used either on the
1.110 hubertf 7000: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7001: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7002: update</strong></span>:</p>
1.148 asau 7003: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7004: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7005: <dd><p>Install target to recursively use for the
7006: updated package and the dependent packages.
7007: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7008: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7009: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7010: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7011: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7012: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7013: endless loop!</p></dd>
1.75 rillig 7014: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7015: <dd><p>Don't clean up after updating. Useful if
7016: you want to leave the work sources of the updated
7017: packages around for inspection or other purposes.
7018: Be sure you eventually clean up the source tree
1.128 wiz 7019: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7020: or you may run into troubles with old source code
7021: still lying around on your next
1.110 hubertf 7022: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7023: update</strong></span>.</p></dd>
1.75 rillig 7024: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7025: <dd><p>Deinstall each package before installing
7026: (making <code class="varname">DEPENDS_TARGET</code>). This
7027: may be necessary if the
1.128 wiz 7028: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7029: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7030: update</strong></span>.</p></dd>
1.75 rillig 7031: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7032: <dd><p>Allows you to disable recursion and hardcode
7033: the target for packages. The default is
1.128 wiz 7034: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7035: facilitating a recursive update of prerequisite
7036: packages. Only set
7037: <code class="varname">DEPENDS_TARGET</code> if you want to
7038: disable recursive updates. Use
7039: <code class="varname">UPDATE_TARGET</code> instead to just
7040: set a specific target for each package to be
1.110 hubertf 7041: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7042: (see above).</p></dd>
1.75 rillig 7043: </dl></div>
7044: </dd>
7045: <dt><span class="term">clean-update</span></dt>
7046: <dd>
1.88 wiz 7047: <p>Clean the source tree for all packages that would
1.110 hubertf 7048: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7049: from the current directory. This target should not be
7050: used if the current package (or any of its depending
7051: packages) have already been de-installed (e.g., after
1.110 hubertf 7052: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7053: some packages you intended to update. As a rule of
7054: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7055: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7056: and only if you have a dirty package tree (e.g., if you
7057: used <code class="varname">NOCLEAN</code>).</p>
7058: <p>If you are unsure about whether your tree is
1.110 hubertf 7059: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7060: clean</strong></span> at the top of the tree, or use the
7061: following sequence of commands from the directory of the
7062: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7063: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7064: time, otherwise you lose all the packages you wanted to
7065: update!):</p>
1.87 wiz 7066: <pre class="screen">
7067: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7068: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7069: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7070: </pre>
1.88 wiz 7071: <p>The following variables can be used either on the
1.110 hubertf 7072: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7073: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 7074: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7075: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7076: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7077: reconstruct the list of directories to update for
1.110 hubertf 7078: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7079: update</strong></span> successfully installed all
7080: packages you wanted to update. Normally, this is
1.110 hubertf 7081: done automatically on <span class="command"><strong>make
1.88 wiz 7082: update</strong></span>, but may have been suppressed by
7083: the <code class="varname">NOCLEAN</code> variable (see
7084: above).</p></dd>
1.75 rillig 7085: </dl></div>
7086: </dd>
1.88 wiz 7087: <dt><span class="term">replace</span></dt>
7088: <dd>
7089: <p>Update the installation of the current package. This
7090: differs from update in that it does not replace dependent
1.188 ! snj 7091: packages. You will need to install <a href="http://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 7092: target to work.</p>
7093: <p><span class="emphasis"><em>Be careful when using this
7094: target!</em></span> There are no guarantees that dependent
7095: packages will still work, in particular they will most
1.110 hubertf 7096: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7097: library package whose shared library major version changed
7098: between your installed version and the new one. For this
7099: reason, this target is not officially supported and only
7100: recommended for advanced users.</p>
7101: </dd>
1.75 rillig 7102: <dt><span class="term">info</span></dt>
1.188 ! snj 7103: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 7104: package. You can use this to check which version of a
7105: package is installed.</p></dd>
7106: <dt><span class="term">index</span></dt>
7107: <dd>
7108: <p>This is a top-level command, i.e. it should be used in
7109: the <code class="filename">pkgsrc</code> directory. It creates a
7110: database of all packages in the local pkgsrc tree, including
7111: dependencies, comment, maintainer, and some other useful
7112: information. Individual entries are created by running
1.110 hubertf 7113: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7114: directories. This index file is saved as
7115: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7116: verbose format by running <span class="command"><strong>make
1.88 wiz 7117: print-index</strong></span>. You can search in it with
1.110 hubertf 7118: <span class="command"><strong>make search
1.88 wiz 7119: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7120: extract a list of all packages that depend on a particular
1.110 hubertf 7121: one by running <span class="command"><strong>make show-deps
1.88 wiz 7122: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7123: <p>Running this command takes a very long time, some
7124: hours even on fast machines!</p>
7125: </dd>
1.75 rillig 7126: <dt><span class="term">readme</span></dt>
1.88 wiz 7127: <dd>
7128: <p>This target generates a
7129: <code class="filename">README.html</code> file, which can be
1.188 ! snj 7130: viewed using a browser such as <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="http://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 7131: contain references to any packages which are in the
7132: <code class="varname">PACKAGES</code> directory on the local
7133: host. The generated files can be made to refer to URLs
7134: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7135: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7136: wanted to generate <code class="filename">README.html</code>
7137: files which pointed to binary packages on the local
7138: machine, in the directory
7139: <code class="filename">/usr/packages</code>, set
7140: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7141: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7142: <code class="varname">${PACKAGES}</code> directory and its
7143: subdirectories will be searched for all the binary
7144: packages.</p>
7145: <p>The target can be run at the toplevel or in category
7146: directories, in which case it descends recursively.</p>
7147: </dd>
1.75 rillig 7148: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7149: <dd><p>This is a top-level command, run it in
7150: <code class="filename">pkgsrc</code>. Use this target to create a
7151: file <code class="filename">README-all.html</code> which contains a
7152: list of all packages currently available in the NetBSD
7153: Packages Collection, together with the category they belong
7154: to and a short description. This file is compiled from the
7155: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7156: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7157: readme</strong></span>.</p></dd>
1.75 rillig 7158: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7159: <dd><p>This is very much the same as the
1.128 wiz 7160: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7161: used when generating a pkgsrc tree to be written to a
7162: CD-ROM. This target also produces
7163: <code class="filename">README.html</code> files, and can be made
7164: to refer to URLs based on
7165: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7166: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7167: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7168: <dd><p>This target shows which distfiles and patchfiles
7169: are needed to build the package
7170: (<code class="varname">ALLFILES</code>, which contains all
7171: <code class="varname">DISTFILES</code> and
1.87 wiz 7172: <code class="varname">PATCHFILES</code>, but not
7173: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7174: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7175: <dd><p>This target shows nothing if the package is not
7176: installed. If a version of this package is installed,
7177: but is not the version provided in this version of
7178: pkgsrc, then a warning message is displayed. This target
7179: can be used to show which of your installed packages are
7180: downlevel, and so the old versions can be deleted, and
7181: the current ones added.</p></dd>
1.75 rillig 7182: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7183: <dd><p>This target shows the directory in the pkgsrc
7184: hierarchy from which the package can be built and
7185: installed. This may not be the same directory as the one
7186: from which the package was installed. This target is
7187: intended to be used by people who may wish to upgrade
7188: many packages on a single host, and can be invoked from
7189: the top-level pkgsrc Makefile by using the
1.128 wiz 7190: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7191: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7192: <dd><p>This target shows which installed packages match
7193: the current package's <code class="varname">DEPENDS</code>. Useful
7194: if out of date dependencies are causing build
7195: problems.</p></dd>
1.75 rillig 7196: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7197: <dd><p>After a package is installed, check all its
7198: binaries and (on ELF platforms) shared libraries to see
7199: if they find the shared libs they need. Run by default
1.110 hubertf 7200: 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 7201: <dt><span class="term">print-PLIST</span></dt>
7202: <dd>
1.128 wiz 7203: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7204: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7205: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7206: -newer work/.extract_done</strong></span>. An attempt is made
7207: to care for shared libs etc., but it is
1.87 wiz 7208: <span class="emphasis"><em>strongly</em></span> recommended to review the
7209: result before putting it into
7210: <code class="filename">PLIST</code>. On upgrades, it's useful to
7211: diff the output of this command against an already
7212: existing <code class="filename">PLIST</code> file.</p>
1.188 ! snj 7213: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 7214: other methods that don't update file access times, be
7215: sure to add these files manually to your
1.128 wiz 7216: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7217: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7218: them!</p>
1.128 wiz 7219: <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 7220: information on this target.</p>
1.75 rillig 7221: </dd>
7222: <dt><span class="term">bulk-package</span></dt>
7223: <dd>
1.88 wiz 7224: <p>Used to do bulk builds. If an appropriate binary
7225: package already exists, no action is taken. If not, this
7226: target will compile, install and package it (and its
7227: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 7228: 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
7229: builds)</i></a>).
1.88 wiz 7230: After creating the binary package, the sources, the
7231: just-installed package and its required packages are
7232: removed, preserving free disk space.</p>
7233: <p><span class="emphasis"><em>Beware that this target may deinstall
7234: all packages installed on a system!</em></span></p>
1.75 rillig 7235: </dd>
7236: <dt><span class="term">bulk-install</span></dt>
7237: <dd>
1.88 wiz 7238: <p>Used during bulk-installs to install required
7239: packages. If an up-to-date binary package is available,
1.188 ! snj 7240: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110 hubertf 7241: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7242: but the installed binary won't be removed.</p>
1.88 wiz 7243: <p>A binary package is considered
1.128 wiz 7244: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.188 ! snj 7245: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148 asau 7246: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7247: <li class="listitem"><p>None of the package's files
1.88 wiz 7248: (<code class="filename">Makefile</code>, ...) were modified
7249: since it was built.</p></li>
1.128 wiz 7250: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7251: packages were modified since it was built.</p></li>
1.75 rillig 7252: </ul></div>
1.88 wiz 7253: <p><span class="emphasis"><em>Beware that this target may deinstall
7254: all packages installed on a system!</em></span></p>
1.75 rillig 7255: </dd>
7256: </dl></div>
7257: </div>
7258: </div>
1.148 asau 7259: <div class="chapter">
1.75 rillig 7260: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7261: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7262: <div class="toc">
7263: <p><b>Table of Contents</b></p>
7264: <dl>
1.106 rillig 7265: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7266: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7267: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7268: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7269: </dl>
7270: </div>
1.87 wiz 7271: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7272: by pkgsrc and also for individual packages to define what commands
7273: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7274: or for later run-time of an installed packaged (such as
7275: <code class="varname">DEPENDS</code>).
7276: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7277: package will not be used.</p>
7278: <p>When building a package, the replacement tools are
1.75 rillig 7279: made available in a directory (as symlinks or wrapper scripts)
7280: that is early in the executable search path. Just like the buildlink
1.87 wiz 7281: system, this helps with consistent builds.</p>
7282: <p>A tool may be needed to help build a specific package. For example,
7283: perl, GNU make (gmake) or yacc may be needed.</p>
7284: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7285: tool may be inefficient for building a package with pkgsrc.
7286: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7287: yacc) or a better sed.</p>
7288: <p>The tools used by a package can be listed by running
1.110 hubertf 7289: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 7290: <div class="sect1">
1.75 rillig 7291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7292: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7293: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7294: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7295: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7296: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7297: These can be seen by running:
1.110 hubertf 7298: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7299: <p>If a package needs a specific program to build
1.75 rillig 7300: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7301: to define the tools needed.</p>
1.75 rillig 7302: </div>
1.148 asau 7303: <div class="sect1">
1.75 rillig 7304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7305: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7306: <p>In the following examples, the :run means that it is needed at
7307: run-time (and becomes a DEPENDS).
1.75 rillig 7308: The default is a build dependency which can be set with
7309: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7310: and pkg-config:build.)</p>
1.75 rillig 7311: <pre class="programlisting">
7312: USE_TOOLS+= gmake perl:run pkg-config
7313: </pre>
1.87 wiz 7314: <p>When using the tools framework, a
1.75 rillig 7315: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7316: which contains the full path to the appropriate tool. For example,
1.128 wiz 7317: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7318: on Linux systems.</p>
7319: <p>If you always need a pkgsrc version of the
1.75 rillig 7320: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7321: </p>
7322: </div>
1.148 asau 7323: <div class="sect1">
1.75 rillig 7324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7325: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7326: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7327: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7328: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7329: the name of the common tools. For example:</p>
7330: <pre class="programlisting">
7331: .if exists(/usr/bin/bzcat)
7332: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7333: .elif exists(/usr/bin/bzip2)
7334: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7335: .endif
1.69 rillig 7336:
1.75 rillig 7337: TOOLS_PLATFORM.true?= true # shell builtin
7338: </pre>
7339: </div>
1.148 asau 7340: <div class="sect1">
1.97 rillig 7341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7342: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 asau 7343: <div class="qandaset">
1.188 ! snj 7344: <a name="idm76283024"></a><dl>
1.106 rillig 7345: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7346: </dt>
1.106 rillig 7347: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7348: tools?</a>
7349: </dt>
1.106 rillig 7350: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7351: package is using while being built? I want to know whether it
7352: uses sed or not.</a>
7353: </dt>
7354: </dl>
1.148 asau 7355: <table border="0" style="width: 100%;">
7356: <colgroup>
1.97 rillig 7357: <col align="left" width="1%">
1.128 wiz 7358: <col>
1.148 asau 7359: </colgroup>
1.97 rillig 7360: <tbody>
1.148 asau 7361: <tr class="question">
1.97 rillig 7362: <td align="left" valign="top">
1.188 ! snj 7363: <a name="tools.new"></a><a name="idm76282640"></a><p><b>18.4.1.</b></p>
1.97 rillig 7364: </td>
7365: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7366: </tr>
7367: <tr class="answer">
7368: <td align="left" valign="top"></td>
7369: <td align="left" valign="top"><p>TODO</p></td>
7370: </tr>
1.148 asau 7371: <tr class="question">
1.97 rillig 7372: <td align="left" valign="top">
1.188 ! snj 7373: <a name="tools.listall"></a><a name="idm76281616"></a><p><b>18.4.2.</b></p>
1.97 rillig 7374: </td>
7375: <td align="left" valign="top"><p>How do I get a list of all available
7376: tools?</p></td>
7377: </tr>
7378: <tr class="answer">
7379: <td align="left" valign="top"></td>
7380: <td align="left" valign="top"><p>TODO</p></td>
7381: </tr>
1.148 asau 7382: <tr class="question">
1.97 rillig 7383: <td align="left" valign="top">
1.188 ! snj 7384: <a name="tools.used"></a><a name="idm76280592"></a><p><b>18.4.3.</b></p>
1.97 rillig 7385: </td>
7386: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7387: package is using while being built? I want to know whether it
7388: uses sed or not.</p></td>
7389: </tr>
7390: <tr class="answer">
7391: <td align="left" valign="top"></td>
7392: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7393: to do it.)</p></td>
7394: </tr>
7395: </tbody>
7396: </table>
7397: </div>
7398: </div>
1.75 rillig 7399: </div>
1.148 asau 7400: <div class="chapter">
1.75 rillig 7401: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7402: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7403: <div class="toc">
7404: <p><b>Table of Contents</b></p>
7405: <dl>
1.106 rillig 7406: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7407: <dd><dl>
1.106 rillig 7408: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7409: <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 7410: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7411: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7412: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7413: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7414: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7415: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7416: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7417: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7418: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7419: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7420: </dl></dd>
1.128 wiz 7421: <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 7422: <dd><dl>
7423: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7424: <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>
7425: </dl></dd>
1.128 wiz 7426: <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 7427: <dd><dl>
7428: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7429: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7430: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7431: </dl></dd>
7432: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7433: <dd><dl>
7434: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7435: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7436: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7437: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7438: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7439: </dl></dd>
1.128 wiz 7440: <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 7441: <dd><dl>
7442: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7443: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7444: <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 7445: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7446: </dl></dd>
1.128 wiz 7447: <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 7448: <dd><dl>
7449: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7450: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7451: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7452: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7453: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7454: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7455: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7456: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7457: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7458: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7459: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7460: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7461: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7462: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7463: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7464: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7465: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7466: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7467: emulation</a></span></dt>
1.106 rillig 7468: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7469: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7470: </dl></dd>
1.106 rillig 7471: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7472: </dl>
7473: </div>
1.148 asau 7474: <div class="sect1">
1.75 rillig 7475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7476: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 asau 7477: <div class="sect2">
1.75 rillig 7478: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7479: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7480: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7481: different platforms. As a result, it is important to ensure,
7482: where possible, that packages in pkgsrc are portable. This
7483: chapter mentions some particular details you should pay
7484: attention to while working on pkgsrc.</p>
1.78 rillig 7485: </div>
1.148 asau 7486: <div class="sect2">
1.78 rillig 7487: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7488: <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 7489: </h3></div></div></div>
1.78 rillig 7490: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7491: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7492: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7493: want to use those variables in the preprocessor directives of
1.188 ! snj 7494: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.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 7495: <code class="literal">.for</code>), you need to include the file
7496: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7497: loads the user preferences.</p>
1.78 rillig 7498: <p>But note that some variables may not be completely defined
1.87 wiz 7499: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7500: included, as they may contain references to variables that are
7501: not yet defined. In shell commands this is no problem, since
7502: variables are actually macros, which are only expanded when they
7503: are used. But in the preprocessor directives mentioned above and
7504: in dependency lines (of the form <code class="literal">target:
7505: dependencies</code>) the variables are expanded at load
7506: time.</p>
1.148 asau 7507: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7508: <h3 class="title">Note</h3>
7509: <p>Currently there is no exhaustive list of all
1.87 wiz 7510: variables that tells you whether they can be used at load time
7511: or only at run time, but it is in preparation.</p>
1.78 rillig 7512: </div>
7513: </div>
1.148 asau 7514: <div class="sect2">
1.78 rillig 7515: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7516: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7517: <p>Occasionally, packages require interaction from the user,
7518: and this can be in a number of ways:</p>
1.148 asau 7519: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7520: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7521: interaction such as entering username/password or accepting a
7522: license on a web page.</p></li>
1.128 wiz 7523: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7524: passwords.</p></li>
1.128 wiz 7525: <li class="listitem"><p>help to configure the package before it is built</p></li>
7526: <li class="listitem"><p>help during the build process</p></li>
7527: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7528: </ul></div>
1.88 wiz 7529: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7530: provided to notify the pkgsrc mechanism of an interactive stage
7531: which will be needed, and this should be set in the package's
7532: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7533: <pre class="programlisting">
1.100 rillig 7534: INTERACTIVE_STAGE= build
1.87 wiz 7535: </pre>
1.78 rillig 7536: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7537: <pre class="programlisting">
1.100 rillig 7538: INTERACTIVE_STAGE= configure install
1.87 wiz 7539: </pre>
1.88 wiz 7540: <p>The user can then decide to skip this package by setting the
7541: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7542: </div>
1.148 asau 7543: <div class="sect2">
1.75 rillig 7544: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7545: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7546: <p>Authors of software can choose the licence under which
7547: software can be copied. This is due to copyright law, and reasons
7548: for license choices are outside the scope of pkgsrc. The pkgsrc
7549: system recognizes that there are a number of licenses which some
7550: users may find objectionable or difficult or impossible to comply
7551: with. The Free Software Foundation has declared some licenses
7552: "Free", and the Open Source Initiative has a definition of "Open
7553: Source". The pkgsrc system, as a policy choice, does not label
7554: packages which have licenses that are Free or Open Source.
7555: However, packages without a license meeting either of those tests
7556: are labeled with a license tag denoting the license. Note that a
7557: package with no license to copy trivially does not meet either the
7558: Free or Open Source test.</p>
7559: <p>For packages which are not Free or Open Source, pkgsrc will
7560: not build the package unless the user has indicated to pkgsrc that
7561: packages with that particular license may be built. Note that
7562: this documentation avoids the term "accepted the license". The
7563: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7564: accidentally building a package with a non-free license;
1.98 wiz 7565: judgement and responsibility remain with the user. (Installation
7566: of binary packages are not currently subject to this mechanism;
7567: this is a bug.)</p>
7568: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7569: or the GPL, and not the other. The free licenses are added to the
7570: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7571: user can override the default by setting the
7572: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7573: of "+=". The licenses accepted by default are:
7574: </p>
7575: <pre class="programlisting">
1.154 rodent 7576: apache-1.1 apache-2.0
7577: arphic-public
7578: artistic artistic-2.0
7579: boost-license
7580: cc-by-sa-v3.0
1.161 ryoon 7581: cc0-1.0-universal
1.154 rodent 7582: cddl-1.0
7583: cpl-1.0
7584: epl-v1.0
7585: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7586: gnu-gpl-v1
7587: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7588: gnu-gpl-v3 gnu-lgpl-v3
7589: ibm-public-license-1.0
7590: ipafont
7591: isc
7592: lppl-1.3c
7593: lucent
7594: miros
7595: mit
7596: mpl-1.0 mpl-1.1 mpl-2.0
7597: mplusfont
7598: ofl-v1.0 ofl-v1.1
7599: original-bsd modified-bsd 2-clause-bsd
7600: php
7601: png-license
7602: postgresql-license
7603: public-domain
7604: python-software-foundation
7605: qpl-v1.0
1.158 rodent 7606: sgi-free-software-b-v2.0
1.154 rodent 7607: sleepycat-public
7608: unlicense
7609: x11
7610: zlib
7611: zpl
1.121 jnemeth 7612: </pre>
7613: <p>
7614: </p>
1.78 rillig 7615: <p>The license tag mechanism is intended to address
1.87 wiz 7616: copyright-related issues surrounding building, installing and
7617: using a package, and not to address redistribution issues (see
7618: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7619: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7620: Packages with redistribution restrictions should set these
7621: tags.</p>
1.98 wiz 7622: <p>Denoting that a package may be copied according to a
7623: particular license is done by placing the license in
1.87 wiz 7624: <code class="filename">pkgsrc/licenses</code> and setting the
7625: <code class="varname">LICENSE</code> variable to a string identifying the
1.188 ! snj 7626: license, e.g. in <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87 wiz 7627: <pre class="programlisting">
1.100 rillig 7628: LICENSE= xv-license
1.87 wiz 7629: </pre>
7630: <p>When trying to build, the user will get a notice that the
1.98 wiz 7631: package is covered by a license which has not been placed in the
7632: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7633: <pre class="programlisting">
1.100 rillig 7634: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7635: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7636: ===> To view the license, enter "/usr/bin/make show-license".
7637: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7638: ===> ACCEPTABLE_LICENSES+=xv-license
7639: *** Error code 1
1.87 wiz 7640: </pre>
1.110 hubertf 7641: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7642: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7643: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7644: convey to pkgsrc that it should not in the future fail because of
7645: that license:</p>
1.78 rillig 7646: <pre class="programlisting">
1.100 rillig 7647: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7648: </pre>
1.154 rodent 7649: <p>When adding a package with a new license, the following steps
7650: are required:</p>
7651: <div class="orderedlist"><ol class="orderedlist" type="1">
7652: <li class="listitem">
7653: <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>
7654: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7655: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7656: <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 7657: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154 rodent 7658: </ul></div>
7659: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7660: </li>
7661: <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>
7662: </ol></div>
1.98 wiz 7663: <p>When the license changes (in a way other than formatting),
7664: please make sure that the new license has a different name (e.g.,
7665: append the version number if it exists, or the date). Just
7666: because a user told pkgsrc to build programs under a previous
7667: version of a license does not mean that pkgsrc should build
1.99 rillig 7668: programs under the new licenses. The higher-level point is that
1.98 wiz 7669: pkgsrc does not evaluate licenses for reasonableness; the only
7670: test is a mechanistic test of whether a particular text has been
7671: approved by either of two bodies.</p>
1.78 rillig 7672: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7673: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7674: is deprecated because it does not crisply refer to a particular
7675: license text. Another problem with such usage is that it does not
7676: enable a user to tell pkgsrc to proceed for a single package
7677: without also telling pkgsrc to proceed for all packages with that
7678: tag.</p>
1.75 rillig 7679: </div>
1.148 asau 7680: <div class="sect2">
1.75 rillig 7681: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7682: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7683: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7684: Because a license tag is required unless the package is Free or
7685: Open Source, all packages with restrictions should have license
7686: tags. By declaring the restrictions, package tools can
7687: automatically refrain from e.g. placing binary packages on FTP
7688: sites.</p>
7689: <p>There are four restrictions that may be encoded, which are
7690: the cross product of sources (distfiles) and binaries not being
7691: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7692: language in any license, and because non-Free licenses tend to be
7693: different from each other, pkgsrc adopts a definition of FTP and
7694: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7695: should not be made available over the Internet at no charge.
7696: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7697: made available on some kind of media, together with other source
7698: and binary packages, and which is sold for a distribution charge.
7699: </p>
7700: <p>In order to encode these restrictions, the package system
1.87 wiz 7701: defines five make variables that can be set to note these
7702: restrictions:</p>
1.148 asau 7703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7704: <li class="listitem">
1.75 rillig 7705: <p><code class="varname">RESTRICTED</code></p>
7706: <p>This variable should be set whenever a restriction
1.87 wiz 7707: exists (regardless of its kind). Set this variable to a
1.98 wiz 7708: string containing the reason for the restriction. It should
7709: be understood that those wanting to understand the restriction
7710: will have to read the license, and perhaps seek advice of
7711: counsel.</p>
1.75 rillig 7712: </li>
1.128 wiz 7713: <li class="listitem">
1.75 rillig 7714: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7715: <p>Binaries may not be placed on CD-ROM containing other
7716: binary packages, for which a distribution charge may be made.
7717: In this case, set this variable to
7718: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7719: </li>
1.128 wiz 7720: <li class="listitem">
1.75 rillig 7721: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7722: <p>Binaries may not made available on the Internet without
7723: charge. In this case, set this variable to
7724: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7725: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7726: </li>
1.128 wiz 7727: <li class="listitem">
1.75 rillig 7728: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7729: <p>Distfiles may not be placed on CD-ROM, together with
7730: other distfiles, for which a fee may be charged. In this
7731: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7732: </p>
1.75 rillig 7733: </li>
1.128 wiz 7734: <li class="listitem">
1.75 rillig 7735: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7736: <p>Distfiles may not made available via FTP at no charge.
7737: In this case, set this variable to
7738: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7739: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7740: </li>
7741: </ul></div>
1.139 wiz 7742: <p>Please note that packages will to be removed from pkgsrc
7743: when the distfiles are not distributable and cannot be obtained
7744: for a period of one full quarter branch. Packages with manual /
7745: interactive fetch must have a maintainer and it is his/her
7746: responsibility to ensure this.</p>
1.75 rillig 7747: </div>
1.148 asau 7748: <div class="sect2">
1.75 rillig 7749: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7750: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7751: <p>Your package may depend on some other package being present
1.88 wiz 7752: - and there are various ways of expressing this dependency.
7753: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7754: <code class="varname">DEPENDS</code> definitions, the
7755: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7756: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7757: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7758: 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 7759: <p>The basic difference between the two variables is as
1.87 wiz 7760: follows: The <code class="varname">DEPENDS</code> definition registers
7761: that pre-requisite in the binary package so it will be pulled in
7762: when the binary package is later installed, whilst the
7763: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7764: dependency that is only needed for building the package.</p>
1.75 rillig 7765: <p>This means that if you only need a package present whilst
1.87 wiz 7766: you are building, it should be noted as a
7767: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7768: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7769: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7770: <pre class="programlisting">
1.100 rillig 7771: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7772: </pre>
1.128 wiz 7773: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7774: may include any of the wildcard version numbers recognized by
1.188 ! snj 7775: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7776: <div class="orderedlist"><ol class="orderedlist" type="1">
7777: <li class="listitem">
1.75 rillig 7778: <p>If your package needs another package's binaries or
1.160 wiz 7779: libraries to build and run, and if that package has a
1.87 wiz 7780: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7781: <pre class="programlisting">
1.100 rillig 7782: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7783: </pre>
1.75 rillig 7784: </li>
1.128 wiz 7785: <li class="listitem">
1.160 wiz 7786: <p>If your package needs another package's binaries or
7787: libraries only for building, and if that package has a
7788: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7789: <pre class="programlisting">
7790: .include "../../graphics/jpeg/buildlink3.mk"
7791: </pre>
7792: <p>but set
7793: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7794: to make it a build dependency only. This case is rather
7795: rare.</p>
7796: </li>
7797: <li class="listitem">
1.132 spz 7798: <p>If your package needs binaries from another package to build,
7799: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7800: <pre class="programlisting">
1.132 spz 7801: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 7802: </pre>
1.75 rillig 7803: </li>
1.132 spz 7804: <li class="listitem"><p>If your package needs a library with which to link and
7805: there is no <code class="filename">buildlink3.mk</code> file
7806: available, create one. Using
7807: <code class="varname">DEPENDS</code> won't be sufficient because the
7808: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7809: <li class="listitem">
1.132 spz 7810: <p>If your package needs some executable to be able to run
7811: correctly and if there's no
7812: <code class="filename">buildlink3.mk</code> file, this is specified
7813: using the <code class="varname">DEPENDS</code> variable. The
1.188 ! snj 7814: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.132 spz 7815: be able to execute the latex binary from the teTeX package
7816: when it runs, and that is specified:</p>
1.75 rillig 7817: <pre class="programlisting">
1.132 spz 7818: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7819: </pre>
1.132 spz 7820: </li>
7821: <li class="listitem">
7822: <p>You can use wildcards in package dependencies. Note that
7823: such wildcard dependencies are retained when creating binary
7824: packages. The dependency is checked when installing the binary
7825: package and any package which matches the pattern will be
7826: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7827: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7828: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7829: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7830: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7831: <p>Wildcards can also be used to specify that a package
1.87 wiz 7832: will only build against a certain minimum version of a
7833: pre-requisite:</p>
1.75 rillig 7834: <pre class="programlisting">
1.132 spz 7835: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 7836: </pre>
1.132 spz 7837: <p>This means that the package will build using version 6.0
7838: of ImageMagick or newer. Such a dependency may be warranted
7839: if, for example, the command line options of an executable
7840: have changed.</p>
7841: <p>If you need to depend on minimum versions of libraries,
7842: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7843: <p>For security fixes, please update the package
1.110 hubertf 7844: 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 7845: information.</p>
1.75 rillig 7846: </li>
1.165 bsiegert 7847: <li class="listitem">
7848: <p>If the package depends on either one of two (or more)
7849: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7850: comma-separated list between curly braces.</p>
7851: <p>As an example, take a package that depends on the Perl
7852: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7853: itself since version 5.10.0. This either/or dependency is
7854: expressed as:</p>
7855: <pre class="programlisting">
7856: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7857: </pre>
7858: </li>
1.75 rillig 7859: </ol></div>
7860: <p>If your package needs files from another package to build,
1.87 wiz 7861: add the relevant distribution files to
7862: <code class="varname">DISTFILES</code>, so they will be extracted
1.188 ! snj 7863: automatically. See the <a href="http://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 7864: (It relies on the jpeg sources being present in source form
7865: during the build.)</p>
1.75 rillig 7866: </div>
1.148 asau 7867: <div class="sect2">
1.75 rillig 7868: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7869: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7870: <p>Your package may conflict with other packages a user might
1.87 wiz 7871: already have installed on his system, e.g. if your package
1.88 wiz 7872: installs the same set of files as another package in the pkgsrc
7873: tree.</p>
1.75 rillig 7874: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7875: space-separated list of packages (including version string) your
7876: package conflicts with.</p>
1.188 ! snj 7877: <p>For example, <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw3d/README.html" target="_top"><code class="filename">x11/Xaw3d</code></a>
! 7878: and <a href="http://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 7879: install the same shared library, thus you set in
7880: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7881: <pre class="programlisting">
1.100 rillig 7882: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 7883: </pre>
7884: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7885: <pre class="programlisting">
1.100 rillig 7886: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 7887: </pre>
1.75 rillig 7888: <p>Packages will automatically conflict with other packages
1.87 wiz 7889: with the name prefix and a different version
1.128 wiz 7890: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
7891: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.75 rillig 7892: </div>
1.148 asau 7893: <div class="sect2">
1.75 rillig 7894: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7895: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7896: <p>There are several reasons why a package might be
1.88 wiz 7897: instructed to not build under certain circumstances. If the
1.87 wiz 7898: package builds and runs on most platforms, the exceptions
7899: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7900: the package builds and runs on a small handful of platforms,
7901: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7902: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7903: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7904: (OS-version-platform) that can use glob-style
7905: wildcards.</p>
1.88 wiz 7906: <p>Some packages are tightly bound to a specific version of an
1.188 ! snj 7907: operating system, e.g. LKMs or <a href="http://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 7908: backwards compatible with other versions of the OS, and should be
7909: uploaded to a version specific directory on the FTP server. Mark
7910: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7911: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7912: the package system internals, but may be used in the
7913: future.</p>
1.75 rillig 7914: <p>If the package should be skipped (for example, because it
1.87 wiz 7915: provides functionality already provided by the system), set
1.88 wiz 7916: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7917: the package should fail because some preconditions are not met,
7918: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7919: message.</p>
1.75 rillig 7920: </div>
1.148 asau 7921: <div class="sect2">
1.75 rillig 7922: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7923: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7924: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7925: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7926: be set in the package Makefile. This will be carried into any
7927: binary package that is made from this pkgsrc entry. A
1.128 wiz 7928: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.188 ! snj 7929: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7930: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7931: </div>
1.148 asau 7932: <div class="sect2">
1.75 rillig 7933: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7934: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7935: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7936: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7937: and after committing that file, ask pkgsrc-security@NetBSD.org to
7938: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7939: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7940: <code class="varname">PKGREVISION</code> should be increased (this is of
7941: course not necessary if the problem is fixed by using a newer
7942: release of the software), and the pattern in the
7943: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7944: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7945: branch, be sure to submit a pullup request!</p>
1.75 rillig 7946: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7947: semi-automatically by a weekly cron job.</p>
1.75 rillig 7948: </div>
1.148 asau 7949: <div class="sect2">
1.75 rillig 7950: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7951: <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 7952: <p>When making fixes to an existing package it can be useful
1.87 wiz 7953: to change the version number in <code class="varname">PKGNAME</code>. To
7954: avoid conflicting with future versions by the original author, a
1.128 wiz 7955: <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 7956: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7957: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7958: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7959: <pre class="programlisting">
1.100 rillig 7960: DISTNAME= foo-17.42
7961: PKGREVISION= 9
1.87 wiz 7962: </pre>
1.75 rillig 7963: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7964: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7965: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7966: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7967: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7968: <p>When a new release of the package is released, the
1.87 wiz 7969: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7970: minor release of the above package, things should be like:</p>
1.75 rillig 7971: <pre class="programlisting">
1.100 rillig 7972: DISTNAME= foo-17.43
1.87 wiz 7973: </pre>
7974: <p><code class="varname">PKGREVISION</code> should be incremented for any
7975: non-trivial change in the resulting binary package. Without a
7976: <code class="varname">PKGREVISION</code> bump, someone with the previous
7977: version installed has no way of knowing that their package is out
7978: of date. Thus, changes without increasing
7979: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7980: trivial that no reasonable person would want to upgrade", and this
7981: is the rough test for when increasing
7982: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7983: changes that do not merit increasing
7984: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7985: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7986: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 7987: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 7988: or comments in Makefile.</p></li>
1.128 wiz 7989: <li class="listitem"><p>
1.100 rillig 7990: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 7991: <li class="listitem"><p>
1.100 rillig 7992: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 7993: <li class="listitem"><p>
1.100 rillig 7994: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7995: </ul></div>
1.87 wiz 7996: <p>Examples of changes that do merit an increase to
7997: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7998: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7999: <li class="listitem"><p>
1.100 rillig 8000: Security fixes</p></li>
1.128 wiz 8001: <li class="listitem"><p>
1.100 rillig 8002: Changes or additions to a patch file</p></li>
1.128 wiz 8003: <li class="listitem"><p>
1.100 rillig 8004: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8005: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8006: </ul></div>
1.78 rillig 8007: <p>PKGREVISION must also be incremented when dependencies have ABI
8008: changes.</p>
1.75 rillig 8009: </div>
1.148 asau 8010: <div class="sect2">
1.79 rillig 8011: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8012: <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 8013: <p>When you want to replace the same text in multiple files
1.87 wiz 8014: or when the replacement text varies, patches alone cannot help.
8015: This is where the SUBST framework comes in. It provides an
8016: easy-to-use interface for replacing text in files.
8017: Example:</p>
8018: <pre class="programlisting">
1.100 rillig 8019: SUBST_CLASSES+= fix-paths
8020: SUBST_STAGE.fix-paths= pre-configure
8021: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8022: SUBST_FILES.fix-paths= src/*.c
8023: SUBST_FILES.fix-paths+= scripts/*.sh
8024: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8025: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8026: </pre>
1.79 rillig 8027: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8028: that are used to identify the different SUBST blocks that are
8029: defined. The SUBST framework is heavily used by pkgsrc, so it is
8030: important to always use the <code class="literal">+=</code> operator with
8031: this variable. Otherwise some substitutions may be
8032: skipped.</p>
1.79 rillig 8033: <p>The remaining variables of each SUBST block are
1.87 wiz 8034: parameterized with the identifier from the first line
8035: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8036: parameters to a function call.</p>
1.79 rillig 8037: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8038: which the replacement will take place. All combinations of
8039: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8040: <code class="literal">post-</code> together with a phase name are
8041: possible, though only few are actually used. Most commonly used
8042: are <code class="literal">post-patch</code> and
8043: <code class="literal">pre-configure</code>. Of these two,
8044: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8045: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8046: have the state after applying the patches but before making any
8047: other changes. This is especially useful when you are debugging
8048: a package in order to create new patches for it. Similarly,
8049: <code class="literal">post-build</code> is preferred over
8050: <code class="literal">pre-install</code>, because the install phase should
8051: generally be kept as simple as possible. When you use
8052: <code class="literal">post-build</code>, you have the same files in the
8053: working directory that will be installed later, so you can check
8054: if the substitution has succeeded.</p>
1.79 rillig 8055: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8056: that is printed just before the substitution is done.</p>
1.79 rillig 8057: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8058: globbing patterns that specifies the files in which the
8059: substitution will take place. The patterns are interpreted
8060: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8061: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.188 ! snj 8062: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87 wiz 8063: command should be prefixed with <code class="literal">-e</code>, so that
8064: all SUBST blocks look uniform.</p>
1.79 rillig 8065: <p>There are some more variables, but they are so seldomly
1.87 wiz 8066: used that they are only documented in the
8067: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8068: </div>
1.75 rillig 8069: </div>
1.148 asau 8070: <div class="sect1">
1.75 rillig 8071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8072: <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 8073: <div class="sect2">
1.75 rillig 8074: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8075: <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 8076: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8077: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8078: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8079: with the name of each file to download as an argument, expecting
8080: it to output the URL of the directory from which to download
1.188 ! snj 8081: it. <a href="http://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 8082: example of this usage.</p>
1.75 rillig 8083: <p>If the download can't be automated, because the user must
1.87 wiz 8084: submit personal information to apply for a password, or must pay
8085: for the source, or whatever, you can set
8086: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8087: displayed to the user before aborting the build. Example:</p>
8088: <pre class="programlisting">
1.100 rillig 8089: FETCH_MESSAGE= "Please download the files"
8090: FETCH_MESSAGE+= " "${DISTFILES:Q}
8091: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8092: </pre>
1.75 rillig 8093: </div>
1.148 asau 8094: <div class="sect2">
1.75 rillig 8095: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8096: <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 8097: <p>Sometimes authors of a software package make some
1.87 wiz 8098: modifications after the software was released, and they put up a
8099: new distfile without changing the package's version number. If a
8100: package is already in pkgsrc at that time, the checksum will
8101: no longer match. The contents of the new distfile should be
8102: compared against the old one before changing anything, to make
8103: sure the distfile was really updated on purpose, and that
8104: no trojan horse or so crept in.
1.97 rillig 8105: Please mention that the distfiles were compared and what was found
1.159 rodent 8106: in your commit message.</p>
8107: <p>Then, the correct way to work around this is to
1.87 wiz 8108: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8109: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8110: <code class="varname">DISTFILES</code> and
1.93 rillig 8111: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8112: subdirectory of the local distfiles directory.
1.110 hubertf 8113: (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 8114: In case this
1.87 wiz 8115: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8116: including the <code class="filename">nbX</code> suffix) or a date stamp
1.159 rodent 8117: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8118: <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>
8119: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8120: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8121: path in the filenames.
1.159 rodent 8122: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8123: Furthermore, a mail to the package's authors seems appropriate
8124: telling them that changing distfiles after releases without
8125: changing the file names is not good practice.</p>
1.75 rillig 8126: </div>
8127: </div>
1.148 asau 8128: <div class="sect1">
1.75 rillig 8129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8130: <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 8131: <div class="sect2">
1.75 rillig 8132: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8133: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8134: <p>pkgsrc supports many different machines, with different
1.87 wiz 8135: object formats like a.out and ELF, and varying abilities to do
8136: shared library and dynamic loading at all. To accompany this,
8137: varying commands and options have to be passed to the
8138: compiler, linker, etc. to get the Right Thing, which can be
8139: pretty annoying especially if you don't have all the machines
8140: at your hand to test things. The
1.188 ! snj 8141: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128 wiz 8142: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8143: both static and dynamic libraries from a set of source files,
8144: thus being platform-independent.</p>
8145: <p>Here's how to use libtool in a package in seven simple
8146: steps:</p>
1.128 wiz 8147: <div class="orderedlist"><ol class="orderedlist" type="1">
8148: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8149: Makefile.</p></li>
1.128 wiz 8150: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8151: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8152: add it to the definition of <code class="varname">CC</code>, if only
8153: libraries are being built in a given Makefile. This one command
8154: will build both PIC and non-PIC library objects, so you need not
8155: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8156: <li class="listitem">
1.75 rillig 8157: <p>For the linking of the library, remove any
1.128 wiz 8158: <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
8159: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8160: <pre class="programlisting">
1.100 rillig 8161: ${LIBTOOL} --mode=link \
8162: ${CC} -o ${.TARGET:.a=.la} \
8163: ${OBJS:.o=.lo} \
8164: -rpath ${PREFIX}/lib \
8165: -version-info major:minor
1.87 wiz 8166: </pre>
1.75 rillig 8167: <p>Note that the library is changed to have a
1.87 wiz 8168: <code class="filename">.la</code> extension, and the objects are
8169: changed to have a <code class="filename">.lo</code>
8170: extension. Change <code class="varname">OBJS</code> as
8171: necessary. This automatically creates all of the
8172: <code class="filename">.a</code>,
8173: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8174: necessary) in the build directory. Be sure to include
1.128 wiz 8175: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8176: minor are zero, as libtool will otherwise strip off the
8177: shared library version.</p>
1.75 rillig 8178: <p>From the libtool manual:</p>
8179: <pre class="programlisting">
1.100 rillig 8180: So, libtool library versions are described by three integers:
1.69 rillig 8181:
1.100 rillig 8182: CURRENT
8183: The most recent interface number that this library implements.
1.69 rillig 8184:
1.100 rillig 8185: REVISION
8186: The implementation number of the CURRENT interface.
1.69 rillig 8187:
1.100 rillig 8188: AGE
8189: The difference between the newest and oldest interfaces that
8190: this library implements. In other words, the library implements
8191: all the interface numbers in the range from number `CURRENT -
8192: AGE' to `CURRENT'.
1.1 grant 8193:
1.100 rillig 8194: If two libraries have identical CURRENT and AGE numbers, then the
8195: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8196: </pre>
1.128 wiz 8197: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8198: different results for a.out and ELF (excluding symlinks)
8199: in only one case. An ELF library of the form
1.128 wiz 8200: <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 8201: will have a symlink of
1.128 wiz 8202: <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 8203: on an a.out platform. This is handled
8204: automatically.</p>
1.128 wiz 8205: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8206: directory of the library being built.</p>
1.76 rillig 8207: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8208: <code class="filename">.la</code> file, the other files will be
8209: added automatically.</p>
1.75 rillig 8210: </li>
1.128 wiz 8211: <li class="listitem">
1.76 rillig 8212: <p>When linking shared object (<code class="filename">.so</code>)
1.188 ! snj 8213: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8214: shared libraries, use <span class="quote">“<span class="quote">-module
8215: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8216: tacked on.</p>
1.76 rillig 8217: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8218: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8219: </li>
1.128 wiz 8220: <li class="listitem">
1.75 rillig 8221: <p>When linking programs that depend on these libraries
1.87 wiz 8222: <span class="emphasis"><em>before</em></span> they are installed, preface
1.188 ! snj 8223: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-6.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-6.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 8224: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8225: libraries (static or shared), but please be aware that
8226: libtool will not allow you to specify a relative path in
1.128 wiz 8227: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8228: expects you to change that argument to be the
8229: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8230: <pre class="programlisting">
1.100 rillig 8231: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8232: </pre>
1.75 rillig 8233: <p>should be changed to:</p>
8234: <pre class="programlisting">
1.100 rillig 8235: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8236: </pre>
1.75 rillig 8237: <p>and it will do the right thing with the libraries.</p>
8238: </li>
1.128 wiz 8239: <li class="listitem">
1.188 ! snj 8240: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
! 8241: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-6.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 8242: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8243: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8244: <pre class="programlisting">
1.126 jakllsch 8245: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8246: </pre>
1.76 rillig 8247: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8248: shared library, any needed symlinks, and run
1.188 ! snj 8249: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8250: </li>
1.128 wiz 8251: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8252: the <code class="filename">.la</code>
8253: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8254: </ol></div>
8255: </div>
1.148 asau 8256: <div class="sect2">
1.75 rillig 8257: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8258: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8259: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8260: package Makefile. This will override the package's own libtool
8261: in most cases. For older libtool using packages, libtool is
8262: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8263: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8264: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8265: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8266: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8267: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8268: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8269: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8270: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8271: libraries built and installed, then use
8272: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8273: <p>If your package makes use of the platform-independent library
1.87 wiz 8274: for loading dynamic shared objects, that comes with libtool
8275: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8276: <p>Some packages use libtool incorrectly so that the package
8277: may not work or build in some circumstances. Some of the more
8278: common errors are:</p>
1.148 asau 8279: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8280: <li class="listitem">
1.75 rillig 8281: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8282: executable or library. This in itself isn't a problem if one of two things
8283: has been done:</p>
1.128 wiz 8284: <div class="orderedlist"><ol class="orderedlist" type="1">
8285: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8286: <code class="filename">libfoo.la</code>, not
8287: <code class="filename">foo.la</code></p></li>
1.128 wiz 8288: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8289: </ol></div>
8290: </li>
1.128 wiz 8291: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8292: The function lt_dlinit() should be called and the macro
8293: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8294: executables.</p></li>
1.75 rillig 8295: </ul></div>
8296: </div>
1.148 asau 8297: <div class="sect2">
1.75 rillig 8298: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8299: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8300: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8301: to regenerate the configure script and Makefile.in makefile
8302: templates, then they should be executed in a pre-configure
8303: target.</p>
1.75 rillig 8304: <p>For packages that need only autoconf:</p>
8305: <pre class="programlisting">
1.100 rillig 8306: AUTOCONF_REQD= 2.50 # if default version is not good enough
8307: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8308: ...
1.1 grant 8309:
1.100 rillig 8310: pre-configure:
8311: cd ${WRKSRC} && autoconf
1.1 grant 8312:
1.100 rillig 8313: ...
1.87 wiz 8314: </pre>
1.75 rillig 8315: <p>and for packages that need automake and autoconf:</p>
8316: <pre class="programlisting">
1.100 rillig 8317: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8318: USE_TOOLS+= automake # use "automake14" for automake-1.4
8319: ...
8320:
8321: pre-configure:
8322: set -e; cd ${WRKSRC}; \
8323: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8324:
1.100 rillig 8325: ...
1.87 wiz 8326: </pre>
1.75 rillig 8327: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8328: require GNU Make.</p>
1.75 rillig 8329: <p>There are times when the configure process makes
1.87 wiz 8330: additional changes to the generated files, which then causes
8331: the build process to try to re-execute the automake sequence.
8332: This is prevented by touching various files in the configure
8333: stage. If this causes problems with your package you can set
8334: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8335: Makefile.</p>
1.75 rillig 8336: </div>
8337: </div>
1.148 asau 8338: <div class="sect1">
1.75 rillig 8339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8340: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 8341: <div class="sect2">
1.87 wiz 8342: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8343: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8344: <p>Compilers for the C, C++, and Fortran languages comes with
8345: the NetBSD base system. By default, pkgsrc assumes that a package
8346: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8347: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8348: <p>To declare which language's compiler a package needs, set
8349: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8350: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8351: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8352: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8353: written in C++, usually need a C compiler for the configure
8354: phase.</p>
8355: </div>
1.148 asau 8356: <div class="sect2">
1.87 wiz 8357: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8358: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8359: <p>If a program is written in Java, use the Java framework in
8360: pkgsrc. The package must include
8361: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8362: provides the following variables:</p>
1.148 asau 8363: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8364: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8365: dependency on the JDK is added. If
1.128 wiz 8366: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8367: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8368: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8369: JDK.</p></li>
1.128 wiz 8370: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8371: a package needs a Java2 implementation. The supported values
1.128 wiz 8372: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8373: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8374: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8375: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8376: above. This variable is not set by default.</p></li>
1.130 wiz 8377: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8378: automatically set to the runtime location of the used Java
8379: implementation dependency. It may be used to set
8380: <code class="varname">JAVA_HOME</code> to a good value if the program
8381: needs this variable to be defined.
8382: </p></li>
1.87 wiz 8383: </ul></div>
8384: </div>
1.148 asau 8385: <div class="sect2">
1.87 wiz 8386: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8387: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8388: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8389: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8390: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8391: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8392: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8393: that you want adjusted. Every occurrence of
8394: <code class="filename">*/bin/perl</code> in a she-bang line will be
8395: replaced with the full path to the perl executable.</p>
1.87 wiz 8396: <p>If a particular version of perl is needed, set the
8397: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8398: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8399: <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 8400: about handling perl modules.</p>
8401: </div>
1.148 asau 8402: <div class="sect2">
1.87 wiz 8403: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8404: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8405: <p><code class="varname">REPLACE_SH</code>,
8406: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8407: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8408: hash bangs in files. Please use the appropriate one, prefering
8409: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8410: Each should contain a list of scripts, relative to
8411: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8412: occurrence of the matching shell in a she-bang line will be
8413: replaced with the full path to the shell executable.
1.147 wiz 8414: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8415: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8416: </div>
1.148 asau 8417: <div class="sect2">
1.147 wiz 8418: <div class="titlepage"><div><div><h3 class="title">
8419: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8420: <p>Currently, there is no special handling for other languages
8421: in pkgsrc. If a compiler package provides a
8422: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8423: just add a (build) dependency on the appropriate compiler
8424: package.</p>
8425: </div>
8426: </div>
1.148 asau 8427: <div class="sect1">
1.87 wiz 8428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8429: <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 8430: <p>The most common failures when building a package are that
8431: some platforms do not provide certain header files, functions or
8432: libraries, or they provide the functions in a library that the
8433: original package author didn't know. To work around this, you
8434: can rewrite the source code in most cases so that it does not
8435: use the missing functions or provides a replacement function.</p>
1.148 asau 8436: <div class="sect2">
1.77 rillig 8437: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8438: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8439: <p>If a package already comes with a GNU configure script, the
8440: preferred way to fix the build failure is to change the
8441: configure script, not the code. In the other cases, you can
8442: utilize the C preprocessor, which defines certain macros
8443: depending on the operating system and hardware architecture it
8444: compiles for. These macros can be queried using for example
8445: <code class="varname">#if defined(__i386)</code>. Almost every operating
8446: system, hardware architecture and compiler has its own macro.
8447: For example, if the macros <code class="varname">__GNUC__</code>,
8448: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8449: are all defined, you know that you are using NetBSD on an i386
8450: compatible CPU, and your compiler is GCC.</p>
8451: <p>The list of the following macros for hardware and
8452: operating system depends on the compiler that is used. For
8453: example, if you want to conditionally compile code on Solaris,
8454: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8455: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8456: <div class="sect3">
1.75 rillig 8457: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8458: <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 8459: <p>To distinguish between 4.4 BSD-derived systems and the
8460: rest of the world, you should use the following code.</p>
8461: <pre class="programlisting">
1.100 rillig 8462: #include <sys/param.h>
8463: #if (defined(BSD) && BSD >= 199306)
8464: /* BSD-specific code goes here */
8465: #else
8466: /* non-BSD-specific code goes here */
8467: #endif
1.75 rillig 8468: </pre>
1.77 rillig 8469: <p>If this distinction is not fine enough, you can also test
8470: for the following macros.</p>
1.75 rillig 8471: <pre class="programlisting">
1.151 obache 8472: Cygwin __CYGWIN__
8473: DragonFly __DragonFly__
1.100 rillig 8474: FreeBSD __FreeBSD__
1.151 obache 8475: Haiku __HAIKU__
1.100 rillig 8476: Interix __INTERIX
8477: IRIX __sgi (TODO: get a definite source for this)
8478: Linux linux, __linux, __linux__
1.151 obache 8479: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8480: Minix3 __minix
1.100 rillig 8481: NetBSD __NetBSD__
8482: OpenBSD __OpenBSD__
8483: Solaris sun, __sun
1.75 rillig 8484: </pre>
8485: </div>
1.148 asau 8486: <div class="sect3">
1.75 rillig 8487: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8488: <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 8489: <pre class="programlisting">
1.100 rillig 8490: i386 i386, __i386, __i386__
8491: MIPS __mips
8492: SPARC sparc, __sparc
1.75 rillig 8493: </pre>
8494: </div>
1.148 asau 8495: <div class="sect3">
1.75 rillig 8496: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8497: <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 8498: <pre class="programlisting">
1.100 rillig 8499: GCC __GNUC__ (major version), __GNUC_MINOR__
8500: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8501: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8502: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8503: </pre>
8504: </div>
8505: </div>
1.148 asau 8506: <div class="sect2">
1.78 rillig 8507: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8508: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8509: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8510: combinations of compiler version and architecture and almost
8511: always relation to optimisation being enabled. Common symptoms
8512: are gcc internal errors or never finishing compiling a
1.78 rillig 8513: file.</p>
8514: <p>Typically, a workaround involves testing the
8515: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8516: optimisation for that combination of file,
8517: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8518: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8519: number of examples.</p>
8520: </div>
1.148 asau 8521: <div class="sect2">
1.78 rillig 8522: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8523: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8524: </h3></div></div></div>
1.92 rillig 8525: <p>This error message often means that a package did not
1.78 rillig 8526: link to a shared library it needs. The following functions are
8527: known to cause this error message over and over.</p>
8528: <div class="informaltable">
8529: <a name="undefined-reference-functions"></a><table border="1">
8530: <colgroup>
8531: <col>
8532: <col>
8533: <col>
8534: </colgroup>
8535: <thead><tr>
8536: <th>Function</th>
8537: <th>Library</th>
8538: <th>Affected platforms</th>
8539: </tr></thead>
8540: <tbody>
8541: <tr>
8542: <td>accept, bind, connect</td>
8543: <td>-lsocket</td>
8544: <td>Solaris</td>
8545: </tr>
8546: <tr>
8547: <td>crypt</td>
8548: <td>-lcrypt</td>
8549: <td>DragonFly, NetBSD</td>
8550: </tr>
8551: <tr>
8552: <td>dlopen, dlsym</td>
8553: <td>-ldl</td>
8554: <td>Linux</td>
8555: </tr>
8556: <tr>
8557: <td>gethost*</td>
8558: <td>-lnsl</td>
8559: <td>Solaris</td>
8560: </tr>
8561: <tr>
8562: <td>inet_aton</td>
8563: <td>-lresolv</td>
8564: <td>Solaris</td>
8565: </tr>
8566: <tr>
8567: <td>nanosleep, sem_*, timer_*</td>
8568: <td>-lrt</td>
8569: <td>Solaris</td>
8570: </tr>
8571: <tr>
8572: <td>openpty</td>
8573: <td>-lutil</td>
8574: <td>Linux</td>
8575: </tr>
8576: </tbody>
8577: </table>
8578: </div>
8579: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8580: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8581: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8582: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8583: bmake</strong></span>.</p>
1.148 asau 8584: <div class="sect3">
1.92 rillig 8585: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8586: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8587: <p>When you are using the SunPro compiler, there is another
8588: possibility. That compiler cannot handle the following code:</p>
8589: <pre class="programlisting">
1.100 rillig 8590: extern int extern_func(int);
1.93 rillig 8591:
1.100 rillig 8592: static inline int
8593: inline_func(int x)
8594: {
1.92 rillig 8595: return extern_func(x);
1.100 rillig 8596: }
1.93 rillig 8597:
1.100 rillig 8598: int main(void)
8599: {
1.92 rillig 8600: return 0;
1.100 rillig 8601: }
1.92 rillig 8602: </pre>
8603: <p>It generates the code for <code class="function">inline_func</code> even if
8604: that function is never used. This code then refers to
8605: <code class="function">extern_func</code>, which can usually not be resolved. To
8606: solve this problem you can try to tell the package to disable inlining
8607: of functions.</p>
8608: </div>
1.87 wiz 8609: </div>
1.148 asau 8610: <div class="sect2">
1.87 wiz 8611: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8612: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8613: <p>Sometimes packages fail to build because the compiler runs
8614: into an operating system specific soft limit. With the
8615: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8616: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8617: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8618: Setting this variable is similar to running the shell builtin
1.110 hubertf 8619: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8620: segment size or maximum stack size of a process, respectively, to
8621: their hard limits.</p>
1.78 rillig 8622: </div>
1.75 rillig 8623: </div>
1.148 asau 8624: <div class="sect1">
1.75 rillig 8625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8626: <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 8627: <div class="sect2">
1.75 rillig 8628: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8629: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8630: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8631: with some operating systems cannot create more than one
8632: directory at a time. As such, you should call
8633: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8634: <pre class="programlisting">
1.100 rillig 8635: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8636: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8637: </pre>
1.128 wiz 8638: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8639: dir2</code></span>”</span> to the
1.87 wiz 8640: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8641: automatically do the right thing.</p>
1.75 rillig 8642: </div>
1.148 asau 8643: <div class="sect2">
1.75 rillig 8644: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8645: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8646: <p>In general, documentation should be installed into
1.87 wiz 8647: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8648: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8649: includes the version number of the package).</p>
1.84 wiz 8650: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8651: directory where HTML documentation is installed with the
1.128 wiz 8652: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8653: is needed because otherwise the documentation ends up in
8654: <code class="filename">${PREFIX}/share/doc/html</code> or other
8655: places.</p>
8656: <p>An exception to the above is that library API documentation
1.188 ! snj 8657: generated with the <a href="http://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 8658: browsers (devhelp) should be left at their default location, which
8659: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8660: documentation can be recognized from files ending in
8661: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8662: (It is also acceptable to install such files in
8663: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8664: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8665: <code class="filename">.devhelp*</code> file must be directly in that
8666: directory then, no additional subdirectory level is allowed in
8667: this case. This is usually achieved by using
1.128 wiz 8668: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8669: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8670: though.)</p>
1.75 rillig 8671: </div>
1.148 asau 8672: <div class="sect2">
1.75 rillig 8673: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8674: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8675: <p>Certain packages, most of them in the games category, install
1.87 wiz 8676: a score file that allows all users on the system to record their
8677: highscores. In order for this to work, the binaries need to be
8678: installed setgid and the score files owned by the appropriate
1.142 wiz 8679: group and/or owner (traditionally the "games" user/group). Set
8680: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8681: following variables, documented in more detail in
8682: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8683: behaviour: <code class="varname">GAMEDATAMODE</code>,
8684: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8685: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 8686: <p>A package should therefore never hard code file ownership or
1.87 wiz 8687: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8688: <code class="varname">INSTALL_GAME_DATA</code> to set these
8689: correctly.</p>
1.75 rillig 8690: </div>
1.148 asau 8691: <div class="sect2">
1.75 rillig 8692: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8693: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8694: <p><code class="varname">DESTDIR</code> support means that a package
8695: installs into a staging directory, not the final location of the
8696: files. Then a binary package is created which can be used for
8697: installation as usual. There are two ways: Either the package must
1.128 wiz 8698: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8699: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8700: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8701: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 8702: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8703: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8704: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8705: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8706: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8707: the inclusion.</p></li>
1.128 wiz 8708: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8709: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8710: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8711: automatically. Many manual rules and pre/post-install often are
8712: incorrect; fix them.</p></li>
1.128 wiz 8713: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8714: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8715: <li class="listitem"><p>In general, packages should support
1.103 wiz 8716: <code class="varname">UNPRIVILEGED</code> to be able to use
8717: DESTDIR.</p></li>
8718: </ul></div>
8719: </div>
1.148 asau 8720: <div class="sect2">
1.103 wiz 8721: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8722: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8723: <p>Your package may also contain scripts with hardcoded paths to
8724: other interpreters besides (or as well as) perl. To correct the
8725: full pathname to the script interpreter, you need to set the
8726: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8727: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8728: <pre class="programlisting">
1.100 rillig 8729: REPLACE_INTERPRETER+= tcl
8730: REPLACE.tcl.old= .*/bin/tclsh
8731: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8732: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8733: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8734: </pre>
1.148 asau 8735: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8736: <h3 class="title">Note</h3>
8737: <p>Before March 2006, these variables were called
1.87 wiz 8738: <code class="varname">_REPLACE.*</code> and
8739: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8740: </div>
8741: </div>
1.148 asau 8742: <div class="sect2">
1.75 rillig 8743: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8744: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8745: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8746: the Makefile fragment
8747: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8748: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8749: configuration for such modules as well as various hooks to tune
8750: this configuration. See comments in this file for
8751: details.</p>
1.75 rillig 8752: <p>Perl5 modules will install into different places depending
1.87 wiz 8753: on the version of perl used during the build process. To
8754: address this, pkgsrc will append lines to the
8755: <code class="filename">PLIST</code> corresponding to the files listed in
8756: the installed <code class="filename">.packlist</code> file generated by
8757: most perl5 modules. This is invoked by defining
8758: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8759: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8760: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8761: e.g.:</p>
1.75 rillig 8762: <pre class="programlisting">
1.153 wiz 8763: PERL5_PACKLIST= auto/Pg/.packlist
1.87 wiz 8764: </pre>
1.153 wiz 8765: <p>The perl5 config variables
8766: <code class="varname">installarchlib</code>,
8767: <code class="varname">installscript</code>,
8768: <code class="varname">installvendorbin</code>,
8769: <code class="varname">installvendorscript</code>,
8770: <code class="varname">installvendorarch</code>,
8771: <code class="varname">installvendorlib</code>,
8772: <code class="varname">installvendorman1dir</code>, and
8773: <code class="varname">installvendorman3dir</code> represent those
8774: locations in which components of perl5 modules may be installed,
8775: provided as variable with uppercase and prefixed with
8776: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8777: and may be used by perl5 packages that don't have a packlist.
8778: These variables are also substituted for in the
8779: <code class="filename">PLIST</code> as uppercase prefixed with
8780: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8781: </div>
1.148 asau 8782: <div class="sect2">
1.75 rillig 8783: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8784: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8785: <p>Some packages install info files or use the
1.128 wiz 8786: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8787: commands. <code class="varname">INFO_FILES</code> should be defined in
8788: the package Makefile so that <code class="filename">INSTALL</code> and
8789: <code class="filename">DEINSTALL</code> scripts will be generated to
8790: handle registration of the info files in the Info directory
1.128 wiz 8791: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8792: files registration is either provided by the system, or by a
8793: special purpose package automatically added as dependency if
8794: needed.</p>
1.75 rillig 8795: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8796: <code class="filename">${PREFIX}</code> where info files are primarily
8797: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8798: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8799: <p>The info files for the package should be listed in the
1.87 wiz 8800: package <code class="filename">PLIST</code>; however any split info files
8801: need not be listed.</p>
1.128 wiz 8802: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8803: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8804: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8805: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8806: should be noted with the <code class="varname">TEXINFO_REQD</code>
8807: variable in the package <code class="filename">Makefile</code>. By
8808: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8809: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8810: does not match the required minimum, a build dependency on the
1.188 ! snj 8811: <a href="http://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 8812: be added automatically.</p>
1.75 rillig 8813: <p>The build and installation process of the software provided
1.87 wiz 8814: by the package should not use the
1.110 hubertf 8815: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8816: info files is the task of the package
8817: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8818: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8819: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8820: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8821: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8822: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8823: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8824: no effect except the logging of a message. The script overriding
1.110 hubertf 8825: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8826: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8827: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8828: </div>
1.148 asau 8829: <div class="sect2">
1.75 rillig 8830: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8831: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8832: <p>All packages that install manual pages should install them
1.87 wiz 8833: into the same directory, so that there is one common place to look
8834: for them. In pkgsrc, this place is
8835: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8836: should be used in packages. The default for
8837: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8838: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8839: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8840: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8841: <h3 class="title">Note</h3>
1.87 wiz 8842: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8843: is far from complete.</p>
1.75 rillig 8844: </div>
1.81 rillig 8845: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8846: <code class="filename">man/</code> as the top level directory for the man
8847: page file entries, and the pkgsrc framework will convert as
8848: needed. In all other places, the correct
8849: <code class="varname">PKGMANDIR</code> must be used.</p>
8850: <p>Packages that are
8851: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8852: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8853: <code class="filename">./configure</code>
8854: --mandir switch to set where the man pages should be installed.
8855: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8856: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8857: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8858: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8859: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8860: Or if the <code class="filename">./configure</code> script uses
8861: a non-standard use of --mandir, you can set
8862: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8863: <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 8864: information on installation of compressed manual pages.</p>
1.75 rillig 8865: </div>
1.148 asau 8866: <div class="sect2">
1.75 rillig 8867: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8868: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8869: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8870: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8871: you need to take some extra steps to make sure they get registered
8872: in the database:</p>
1.128 wiz 8873: <div class="orderedlist"><ol class="orderedlist" type="1">
8874: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8875: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8876: takes care of rebuilding the GConf database at installation and
1.87 wiz 8877: deinstallation time, and tells the package where to install
1.107 rillig 8878: GConf data files using some standard configure arguments. It
1.87 wiz 8879: also disallows any access to the database directly from the
8880: package.</p></li>
1.128 wiz 8881: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8882: <code class="filename">.schemas</code> files under
8883: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8884: installed under <code class="filename">${PREFIX}/etc</code>, you will
8885: need to manually patch the package.</p></li>
1.128 wiz 8886: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8887: directory, as they will be handled automatically. See
1.173 wiz 8888: <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 8889: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8890: your <code class="filename">Makefile</code> with a list of all
8891: <code class="filename">.schemas</code> files installed by the package, if
8892: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8893: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8894: your <code class="filename">Makefile</code> with a
8895: list of all <code class="filename">.entries</code> files installed by the
8896: package, if any. Names must not contain any directories in
8897: them.</p></li>
1.75 rillig 8898: </ol></div>
8899: </div>
1.148 asau 8900: <div class="sect2">
1.75 rillig 8901: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 8902: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8903: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8904: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8905: get registered in the database:</p>
1.128 wiz 8906: <div class="orderedlist"><ol class="orderedlist" type="1">
8907: <li class="listitem"><p>Include
1.119 mishka 8908: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8909: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8910: takes care of rebuilding the scrollkeeper database at
8911: installation and deinstallation time, and disallows any access
8912: to it directly from the package.</p></li>
1.128 wiz 8913: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8914: <code class="filename">libdata/scrollkeeper</code> directory, as they
8915: will be handled automatically.</p></li>
1.128 wiz 8916: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 8917: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8918: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 8919: </ol></div>
8920: </div>
1.148 asau 8921: <div class="sect2">
1.75 rillig 8922: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8923: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8924: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8925: the fonts database in the directory where they get installed at
8926: installation and deinstallation time. This can be automatically
8927: done by using the pkginstall framework.</p>
1.75 rillig 8928: <p>You can list the directories where fonts are installed in the
1.87 wiz 8929: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8930: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 8931: <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 8932: Also make sure that the database file
8933: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8934: <p>Note that you should not create new directories for fonts;
1.87 wiz 8935: instead use the standard ones to avoid that the user needs to
8936: manually configure his X server to find them.</p>
1.75 rillig 8937: </div>
1.148 asau 8938: <div class="sect2">
1.75 rillig 8939: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8940: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8941: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8942: take some extra steps to get them registered in the GTK2 database
8943: properly:</p>
1.128 wiz 8944: <div class="orderedlist"><ol class="orderedlist" type="1">
8945: <li class="listitem"><p>Include
1.87 wiz 8946: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8947: <code class="filename">buildlink3.mk</code> file. This takes care of
8948: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 8949: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 8950: your package installs GTK2 immodules.</p></li>
1.128 wiz 8951: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 8952: GTK2 loaders.</p></li>
1.128 wiz 8953: <li class="listitem">
1.87 wiz 8954: <p>Patch the package to not touch any of the GTK2
8955: databases directly. These are:</p>
1.148 asau 8956: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8957: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8958: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8959: </ul></div>
8960: </li>
1.128 wiz 8961: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 8962: any entries under the <code class="filename">libdata/gtk-2.0</code>
8963: directory, as they will be handled automatically.</p></li>
1.75 rillig 8964: </ol></div>
8965: </div>
1.148 asau 8966: <div class="sect2">
1.75 rillig 8967: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8968: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8969: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8970: registered in system-wide catalogs (like DTDs, sub-catalogs,
8971: etc.), you need to take some extra steps:</p>
1.128 wiz 8972: <div class="orderedlist"><ol class="orderedlist" type="1">
8973: <li class="listitem"><p>Include
1.87 wiz 8974: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8975: your <code class="filename">Makefile</code>, which takes care of
8976: registering those files in system-wide catalogs at
8977: installation and deinstallation time.</p></li>
1.128 wiz 8978: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8979: any SGML catalogs installed by the package.</p></li>
1.128 wiz 8980: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 8981: any XML catalogs installed by the package.</p></li>
1.128 wiz 8982: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 8983: to be added to the SGML catalog. These come in groups of
8984: three strings; see xmlcatmgr(1) for more information
8985: (specifically, arguments recognized by the 'add' action).
8986: Note that you will normally not use this variable.</p></li>
1.128 wiz 8987: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 8988: to be added to the XML catalog. These come in groups of three
8989: strings; see xmlcatmgr(1) for more information (specifically,
8990: arguments recognized by the 'add' action). Note that you will
8991: normally not use this variable.</p></li>
1.75 rillig 8992: </ol></div>
8993: </div>
1.148 asau 8994: <div class="sect2">
1.75 rillig 8995: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8996: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 8997: <p>If a package provides extensions to the MIME database by
1.87 wiz 8998: installing <code class="filename">.xml</code> files inside
8999: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9000: need to take some extra steps to ensure that the database is kept
9001: consistent with respect to these new files:</p>
1.128 wiz 9002: <div class="orderedlist"><ol class="orderedlist" type="1">
9003: <li class="listitem"><p>Include
1.87 wiz 9004: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9005: (avoid using the <code class="filename">buildlink3.mk</code> file from
9006: this same directory, which is reserved for inclusion from
9007: other <code class="filename">buildlink3.mk</code> files). It takes
9008: care of rebuilding the MIME database at installation and
9009: deinstallation time, and disallows any access to it directly
9010: from the package.</p></li>
1.128 wiz 9011: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9012: <code class="filename">share/mime</code> directory,
9013: <span class="emphasis"><em>except</em></span> for files saved under
9014: <code class="filename">share/mime/packages</code>. The former are
9015: handled automatically by
9016: the update-mime-database program, but the latter are
9017: package-dependent and must be removed by the package that
9018: installed them in the first place.</p></li>
1.128 wiz 9019: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9020: from the PLIST. They will be handled by the shared-mime-info
9021: package.</p></li>
1.75 rillig 9022: </ol></div>
9023: </div>
1.148 asau 9024: <div class="sect2">
1.75 rillig 9025: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9026: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9027: <p>If a package uses intltool during its build, add
9028: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9029: which forces it to use the intltool package provided by pkgsrc,
9030: instead of the one bundled with the distribution file.</p>
1.75 rillig 9031: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9032: latest available version; this way, the package benefits of any
9033: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9034: </div>
1.148 asau 9035: <div class="sect2">
1.75 rillig 9036: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9037: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9038: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9039: the startup directory by default, but you can enable it, by adding
9040: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9041: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9042: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9043: it will automatically remove the scripts when the package is
9044: deinstalled.</p>
1.75 rillig 9045: </div>
1.148 asau 9046: <div class="sect2">
1.75 rillig 9047: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9048: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9049: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9050: the <code class="filename">ls-R</code> database of the tree needs to be
9051: updated.</p>
1.148 asau 9052: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9053: <h3 class="title">Note</h3>
1.125 wiz 9054: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9055: packages should install files
1.125 wiz 9056: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9057: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9058: </div>
1.128 wiz 9059: <div class="orderedlist"><ol class="orderedlist" type="1">
9060: <li class="listitem"><p>Include
1.125 wiz 9061: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9062: takes care of rebuilding the <code class="filename">ls-R</code>
9063: database at installation and deinstallation time.</p></li>
1.128 wiz 9064: <li class="listitem">
1.75 rillig 9065: <p>If your package installs files into a texmf
1.87 wiz 9066: tree other than the one
1.125 wiz 9067: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9068: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9069: trees that need database update.</p>
1.75 rillig 9070: <p>If your package also installs font map files that need
1.110 hubertf 9071: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9072: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9073: set <code class="varname">TEX_MAP_FILES</code> and/or
9074: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9075: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9076: be run automatically at installation/deinstallation to
9077: enable/disable font map files for TeX output
9078: drivers.</p>
1.75 rillig 9079: </li>
1.128 wiz 9080: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9081: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9082: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9083: </ol></div>
9084: </div>
1.148 asau 9085: <div class="sect2">
1.85 jmmv 9086: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9087: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9088: emulation</h3></div></div></div>
9089: <p>There are some packages that provide libraries and
9090: executables for running binaries from a one operating system
9091: on a different one (if the latter supports it). One example
9092: is running Linux binaries on NetBSD.</p>
1.188 ! snj 9093: <p>The <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87 wiz 9094: helps in extracting and packaging Linux rpm packages.</p>
9095: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9096: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9097: if all libraries for each installed executable can be found by
9098: the dynamic linker. Since the standard dynamic linker is run,
9099: this fails for emulation packages, because the libraries used
9100: by the emulation are not in the standard directories.</p>
9101: </div>
1.148 asau 9102: <div class="sect2">
1.87 wiz 9103: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9104: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9105: <p>If a package installs images under the
1.87 wiz 9106: <code class="filename">share/icons/hicolor</code> and/or updates the
9107: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9108: database, you need to take some extra steps to make sure that the
9109: shared theme directory is handled appropriately and that the cache
9110: database is rebuilt:</p>
1.128 wiz 9111: <div class="orderedlist"><ol class="orderedlist" type="1">
9112: <li class="listitem"><p>Include
1.87 wiz 9113: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9114: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9115: entry that refers to the theme cache.</p></li>
1.128 wiz 9116: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9117: directories from the <code class="filename">share/icons/hicolor</code>
9118: hierarchy because they will be handled automatically.</p></li>
9119: </ol></div>
9120: <p>The best way to verify that the PLIST is correct with
9121: respect to the last two points is to regenerate it using
1.110 hubertf 9122: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9123: </div>
1.148 asau 9124: <div class="sect2">
1.85 jmmv 9125: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9126: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9127: <p>If a package installs <code class="filename">.desktop</code> files
9128: under <code class="filename">share/applications</code> and these include
1.159 rodent 9129: MIME information (MimeType key), you need to take extra steps to
9130: ensure that they are registered into the MIME database:</p>
1.128 wiz 9131: <div class="orderedlist"><ol class="orderedlist" type="1">
9132: <li class="listitem"><p>Include
1.85 jmmv 9133: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9134: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9135: <code class="filename">share/applications/mimeinfo.cache</code> file.
9136: It will be handled automatically.</p></li>
9137: </ol></div>
9138: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9139: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9140: print-PLIST</strong></span>.</p>
1.75 rillig 9141: </div>
9142: </div>
1.148 asau 9143: <div class="sect1">
1.87 wiz 9144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9145: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9146: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9147: immediately. In this case, one can plainly mark a package as broken. For
9148: this, one just sets the variable <code class="varname">BROKEN</code> to the
9149: reason why the package is broken (similar to the
9150: <code class="varname">RESTRICTED</code> variable). A user trying to build
9151: the package will immediately be shown this message, and the build
9152: will not be even tried.</p>
9153: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9154: intervals.</p>
9155: </div>
1.75 rillig 9156: </div>
1.148 asau 9157: <div class="chapter">
1.75 rillig 9158: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9159: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9160: <p>To check out all the gotchas when building a package, here are
9161: the steps that I do in order to get a package working. Please note
9162: this is basically the same as what was explained in the previous
9163: sections, only with some debugging aids.</p>
1.148 asau 9164: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9165: <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>
9166: <li class="listitem">
1.188 ! snj 9167: <p>Install <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88 wiz 9168: create a directory for a new package, change into it, then run
1.110 hubertf 9169: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9170: <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>
9171: <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>
9172: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9173: </li>
1.128 wiz 9174: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9175: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9176: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9177: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9178: configure step to the package's
9179: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9180: <li class="listitem">
1.75 rillig 9181: <p>Make the package compile, doing multiple rounds of</p>
9182: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9183: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9184: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9185: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9186: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9187: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9188: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9189: <p>Doing this step as non-root user will ensure that no files
9190: are modified that shouldn't be, especially during the build
1.110 hubertf 9191: phase. <span class="command"><strong>mkpatches</strong></span>,
9192: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.188 ! snj 9193: from the <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88 wiz 9194: package.</p>
1.75 rillig 9195: </li>
1.128 wiz 9196: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9197: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9198: <li class="listitem">
1.76 rillig 9199: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9200: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9201: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9202: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9203: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9204: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9205: <p>You usually need to be <code class="username">root</code> to do
9206: this. Look if there are any files left:</p>
1.75 rillig 9207: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9208: <p>If this reveals any files that are missing in
1.88 wiz 9209: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9210: </li>
1.128 wiz 9211: <li class="listitem">
1.88 wiz 9212: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9213: package again and make a binary package:</p>
1.75 rillig 9214: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9215: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9216: </li>
1.128 wiz 9217: <li class="listitem">
1.75 rillig 9218: <p>Delete the installed package:</p>
1.88 wiz 9219: <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 9220: </li>
1.128 wiz 9221: <li class="listitem">
1.110 hubertf 9222: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9223: command, which shouldn't find anything now:</p>
1.75 rillig 9224: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9225: </li>
1.128 wiz 9226: <li class="listitem">
1.75 rillig 9227: <p>Reinstall the binary package:</p>
1.93 rillig 9228: <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 9229: </li>
1.128 wiz 9230: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9231: <li class="listitem">
1.188 ! snj 9232: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="http://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 9233: reports:</p>
1.75 rillig 9234: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9235: </li>
1.128 wiz 9236: <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 9237: </ul></div>
9238: </div>
1.148 asau 9239: <div class="chapter">
1.75 rillig 9240: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9241: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9242: <div class="toc">
9243: <p><b>Table of Contents</b></p>
9244: <dl>
1.106 rillig 9245: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9246: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9247: <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 9248: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9249: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9250: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9251: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9252: </dl>
9253: </div>
1.148 asau 9254: <div class="sect1">
1.75 rillig 9255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9256: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9257: <p>Our policy is that we accept binaries only from pkgsrc
9258: developers to guarantee that the packages don't contain any
9259: trojan horses etc. This is not to annoy anyone but rather to
9260: protect our users! You're still free to put up your home-made
9261: binary packages and tell the world where to get them. NetBSD
9262: developers doing bulk builds and wanting to upload them please
1.174 asau 9263: 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
9264: builds)</i></a>.</p>
1.75 rillig 9265: </div>
1.148 asau 9266: <div class="sect1">
1.75 rillig 9267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9268: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9269: <p>First, check that your package is complete, compiles and
1.110 hubertf 9270: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.188 ! snj 9271: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9272: archive that contains all files that make up the package.
1.87 wiz 9273: Finally, send this package to the pkgsrc bug tracking system,
1.188 ! snj 9274: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-6.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 9275: that, go to the web page
1.110 hubertf 9276: <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 9277: which contains some instructions and a link to a form where you
9278: can submit packages. The
1.188 ! snj 9279: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124 snj 9280: also available as a substitute for either of the above two tools.
9281: </p>
1.87 wiz 9282: <p>In the form of the problem report, the category should be
1.128 wiz 9283: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9284: and version number, and the description field should contain a
9285: short description of your package (contents of the COMMENT
9286: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9287: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9288: <p>If you want to submit several packages, please send a
9289: separate PR for each one, it's easier for us to track things
9290: that way.</p>
9291: <p>Alternatively, you can also import new packages into
1.128 wiz 9292: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9293: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9294: for details.</p>
9295: </div>
1.148 asau 9296: <div class="sect1">
1.75 rillig 9297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9298: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9299: <p>Please note all package additions, updates, moves, and
1.93 rillig 9300: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9301: important to keep this file up to date and conforming to the
9302: existing format, because it will be used by scripts to
1.110 hubertf 9303: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9304: sites. Additionally, check the
1.76 rillig 9305: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9306: for the package you updated or removed, in case it was mentioned
9307: there.</p>
9308: <p>When the <code class="varname">PKGREVISION</code> of a package is
9309: bumped, the change should appear in
1.93 rillig 9310: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9311: related or otherwise relevant. Mass bumps that result from a
9312: dependency being updated should not be mentioned. In all other
9313: cases it's the developer's decision.</p>
9314: <p>There is a make target that helps in creating proper
1.110 hubertf 9315: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9316: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9317: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9318: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9319: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9320: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9321: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9322: For new packages, or package moves or removals, set the
9323: <code class="varname">CTYPE</code> variable on the command line to "Added",
9324: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9325: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9326: not the same as your NetBSD login name. The target also automatically
9327: removes possibly existing entries for the package in the
9328: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9329: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9330: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9331: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9332: makes the cvs commands use the main repository.
9333: </p>
1.75 rillig 9334: </div>
1.148 asau 9335: <div class="sect1">
1.75 rillig 9336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9337: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9338: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9339: access to the pkgsrc repository.</p>
9340: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9341: Start by adding the directory and then files in the directory. Don't
9342: forget to add the new package to the category's
9343: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9344: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9345: <pre class="programlisting">
9346: <code class="prompt">$</code> cd .../pkgsrc/category
9347: <code class="prompt">$</code> cvs add pkgname
9348: <code class="prompt">$</code> cd pkgname
9349: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9350: <code class="prompt">$</code> cvs add patches/p*
9351: <code class="prompt">$</code> cvs status | less
1.141 wiz 9352: <code class="prompt">$</code> cvs commit
1.140 wiz 9353: <code class="prompt">$</code> cd ..
9354: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9355: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9356: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9357: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9358: </pre>
1.87 wiz 9359: <p>The commit message of the initial import should include part of the
1.76 rillig 9360: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9361: what the package is/does.</p>
1.140 wiz 9362: <p>Also mention the new package in
9363: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9364: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9365: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9366: </div>
1.148 asau 9367: <div class="sect1">
1.75 rillig 9368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9369: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9370: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9371: changes between old and new versions into the commit log when updating
1.87 wiz 9372: a package. There are various reasons for this:</p>
1.148 asau 9373: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9374: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9375: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9376: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9377: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9378: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9379: repository is very useful for people who read the pkgsrc-changes mailing
9380: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9381: the package.</p></li>
1.75 rillig 9382: </ul></div>
1.87 wiz 9383: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9384: has been released, it should not automatically be upgraded in the CVS
9385: repository. We prefer to be conservative in the packages that are
9386: included in pkgsrc - development or beta packages are not really the
9387: best thing for most places in which pkgsrc is used. Please use your
9388: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9389: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9390: </div>
1.148 asau 9391: <div class="sect1">
1.75 rillig 9392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9393: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9394: <p>Renaming packages is not recommended.</p>
9395: <p>When renaming packages, be sure to fix any references to old name
9396: in other Makefiles, options, buildlink files, etc.</p>
9397: <p>Also When renaming a package, please define
9398: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9399: pattern(s) of the previous package name.
9400: This may be repeated for multiple renames.
9401: The new package would be an exact replacement.
9402: </p>
1.128 wiz 9403: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9404: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9405: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9406: not be an exact replacement but is a suggestion for the replaced
9407: functionality.</p>
9408: </div>
1.148 asau 9409: <div class="sect1">
1.122 reed 9410: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9411: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9412: <p>It is preferred that packages are not renamed or moved, but if needed
9413: please follow these steps.
9414: </p>
1.128 wiz 9415: <div class="orderedlist"><ol class="orderedlist" type="1">
9416: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9417: <li class="listitem">
1.75 rillig 9418: <p>Remove all CVS dirs.</p>
1.87 wiz 9419: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9420: <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 9421: <p>and use that for further work.</p>
1.75 rillig 9422: </li>
1.128 wiz 9423: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9424: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9425: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9426: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9427: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9428: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9429: for doing an update using pkgsrc building; for example, it can
1.188 ! snj 9430: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-6.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 9431: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9432: new <code class="varname">PKGPATH</code> for that moved package. Note that
9433: it may have multiple matches, so the tool should also check on the
9434: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9435: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9436: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9437: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9438: place.</p></li>
1.128 wiz 9439: <li class="listitem">
1.75 rillig 9440: <p>Check if any package depends on it:
9441: </p>
9442: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9443: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9444: </li>
1.128 wiz 9445: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9446: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9447: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9448: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9449: <li class="listitem">
1.75 rillig 9450: <p>Commit the changed and removed files:</p>
9451: <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 9452: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9453: </li>
9454: </ol></div>
9455: </div>
9456: </div>
1.148 asau 9457: <div class="chapter">
1.75 rillig 9458: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9459: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9460: <p>This section contains the answers to questions that may
9461: arise when you are writing a package. If you don't find your
9462: question answered here, first have a look in the other chapters,
9463: and if you still don't have the answer, ask on the
9464: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9465: <div class="qandaset">
1.188 ! snj 9466: <a name="idm77825808"></a><dl>
1.106 rillig 9467: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9468: MAKEFLAGS, .MAKEFLAGS and
9469: MAKE_FLAGS?</a>
9470: </dt>
1.106 rillig 9471: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9472: MAKE, GMAKE and
9473: MAKE_PROGRAM?</a>
9474: </dt>
1.106 rillig 9475: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9476: CC, PKG_CC and
9477: PKGSRC_COMPILER?</a>
9478: </dt>
1.106 rillig 9479: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9480: BUILDLINK_LDFLAGS,
9481: BUILDLINK_LDADD and
9482: BUILDLINK_LIBS?</a>
9483: </dt>
1.106 rillig 9484: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9485: VARNAME=BUILDLINK_PREFIX.foo
9486: say it's empty?</a>
9487: </dt>
1.106 rillig 9488: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9489: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9490: don't understand the := inside
9491: it.</a>
9492: </dt>
1.106 rillig 9493: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9494: developers?</a>
9495: </dt>
1.106 rillig 9496: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9497: documentation?</a>
9498: </dt>
1.106 rillig 9499: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9500: do?</a>
9501: </dt>
1.75 rillig 9502: </dl>
1.148 asau 9503: <table border="0" style="width: 100%;">
9504: <colgroup>
1.75 rillig 9505: <col align="left" width="1%">
1.128 wiz 9506: <col>
1.148 asau 9507: </colgroup>
1.75 rillig 9508: <tbody>
1.148 asau 9509: <tr class="question">
1.75 rillig 9510: <td align="left" valign="top">
1.188 ! snj 9511: <a name="devfaq.makeflags"></a><a name="idm77825424"></a><p><b>22.1.</b></p>
1.75 rillig 9512: </td>
9513: <td align="left" valign="top"><p>What is the difference between
9514: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9515: <code class="varname">MAKE_FLAGS</code>?</p></td>
9516: </tr>
9517: <tr class="answer">
1.91 rillig 9518: <td align="left" valign="top"></td>
1.75 rillig 9519: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.188 ! snj 9520: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 9521: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9522: the <code class="varname">MAKE_PROGRAM</code> when building the
9523: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9524: </tr>
1.148 asau 9525: <tr class="question">
1.75 rillig 9526: <td align="left" valign="top">
1.188 ! snj 9527: <a name="devfaq.make"></a><a name="idm77817232"></a><p><b>22.2.</b></p>
1.75 rillig 9528: </td>
9529: <td align="left" valign="top"><p>What is the difference between
9530: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9531: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9532: </tr>
9533: <tr class="answer">
1.91 rillig 9534: <td align="left" valign="top"></td>
1.75 rillig 9535: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.188 ! snj 9536: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 9537: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9538: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9539: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9540: Make program that is used for building the
9541: package.</p></td>
9542: </tr>
1.148 asau 9543: <tr class="question">
1.75 rillig 9544: <td align="left" valign="top">
1.188 ! snj 9545: <a name="devfaq.cc"></a><a name="idm77812880"></a><p><b>22.3.</b></p>
1.75 rillig 9546: </td>
9547: <td align="left" valign="top"><p>What is the difference between
9548: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9549: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9550: </tr>
9551: <tr class="answer">
1.91 rillig 9552: <td align="left" valign="top"></td>
1.75 rillig 9553: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9554: compiler, which can be configured by the pkgsrc user.
9555: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9556: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9557: path to a compiler, but the type of compiler that should be
1.76 rillig 9558: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9559: information about the latter variable.</p></td>
9560: </tr>
1.148 asau 9561: <tr class="question">
1.75 rillig 9562: <td align="left" valign="top">
1.188 ! snj 9563: <a name="devfaq.bl3flags"></a><a name="idm77808656"></a><p><b>22.4.</b></p>
1.75 rillig 9564: </td>
9565: <td align="left" valign="top"><p>What is the difference between
9566: <code class="varname">BUILDLINK_LDFLAGS</code>,
9567: <code class="varname">BUILDLINK_LDADD</code> and
9568: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9569: </tr>
9570: <tr class="answer">
1.91 rillig 9571: <td align="left" valign="top"></td>
1.75 rillig 9572: <td align="left" valign="top"><p>[FIXME]</p></td>
9573: </tr>
1.148 asau 9574: <tr class="question">
1.75 rillig 9575: <td align="left" valign="top">
1.188 ! snj 9576: <a name="devfaq.bl3prefix"></a><a name="idm77806480"></a><p><b>22.5.</b></p>
1.75 rillig 9577: </td>
1.110 hubertf 9578: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9579: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9580: say it's empty?</p></td>
9581: </tr>
9582: <tr class="answer">
1.91 rillig 9583: <td align="left" valign="top"></td>
1.75 rillig 9584: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9585: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9586: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9587: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9588: command.</p></td>
9589: </tr>
1.148 asau 9590: <tr class="question">
1.78 rillig 9591: <td align="left" valign="top">
1.188 ! snj 9592: <a name="devfaq.master_sites"></a><a name="idm77803408"></a><p><b>22.6.</b></p>
1.78 rillig 9593: </td>
9594: <td align="left" valign="top"><p>What does
9595: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9596: don't understand the <code class="literal">:=</code> inside
9597: it.</p></td>
9598: </tr>
9599: <tr class="answer">
1.91 rillig 9600: <td align="left" valign="top"></td>
1.78 rillig 9601: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9602: assignment operator, like you might expect at first sight.
9603: Instead, it is a degenerate form of
9604: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.188 ! snj 9605: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78 rillig 9606: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9607: case of <code class="varname">MASTER_SITE_*</code>,
9608: <em class="replaceable"><code>old_string</code></em> is the empty string and
9609: <em class="replaceable"><code>new_string</code></em> is
9610: <code class="literal">package/</code>. That's where the
9611: <code class="literal">:</code> and the <code class="literal">=</code> fall
9612: together.</p></td>
9613: </tr>
1.148 asau 9614: <tr class="question">
1.78 rillig 9615: <td align="left" valign="top">
1.188 ! snj 9616: <a name="devfaq.mailinglists"></a><a name="idm77795344"></a><p><b>22.7.</b></p>
1.78 rillig 9617: </td>
9618: <td align="left" valign="top"><p>Which mailing lists are there for package
9619: developers?</p></td>
9620: </tr>
9621: <tr class="answer">
1.91 rillig 9622: <td align="left" valign="top"></td>
1.148 asau 9623: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9624: <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 9625: <dd><p>This is a list for technical discussions related
9626: to pkgsrc development, e.g. soliciting feedback for changes to
9627: pkgsrc infrastructure, proposed new features, questions related
9628: to porting pkgsrc to a new platform, advice for maintaining a
9629: package, patches that affect many packages, help requests moved
9630: from pkgsrc-users when an infrastructure bug is found,
9631: etc.</p></dd>
1.110 hubertf 9632: <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 9633: <dd><p>All bug reports in category "pkg" sent with
1.188 ! snj 9634: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-6.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 9635: directly; use one of the other mailing
9636: lists.</p></dd>
9637: </dl></div></td>
9638: </tr>
1.148 asau 9639: <tr class="question">
1.80 rillig 9640: <td align="left" valign="top">
1.188 ! snj 9641: <a name="devfaq.documentation"></a><a name="idm77791504"></a><p><b>22.8.</b></p>
1.80 rillig 9642: </td>
9643: <td align="left" valign="top"><p>Where is the pkgsrc
9644: documentation?</p></td>
9645: </tr>
9646: <tr class="answer">
1.91 rillig 9647: <td align="left" valign="top"></td>
1.80 rillig 9648: <td align="left" valign="top">
9649: <p>There are many places where you can find
9650: documentation about pkgsrc:</p>
1.148 asau 9651: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9652: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9653: of chapters that explain large parts of pkgsrc, but some
9654: chapters tend to be outdated. Which ones they are is hard to
9655: say.</p></li>
1.128 wiz 9656: <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 9657: about certain features, announcements of new parts of the pkgsrc
9658: infrastructure and sometimes even announcements that a certain
9659: feature has been marked as obsolete. The benefit here is that
9660: each message has a date appended to it.</p></li>
1.128 wiz 9661: <li class="listitem"><p>Many of the files in the
1.80 rillig 9662: <code class="filename">mk/</code> directory start with a comment that
9663: describes the purpose of the file and how it can be used by the
1.92 rillig 9664: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9665: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9666: help</strong></span>.</p></li>
1.128 wiz 9667: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9668: information, but they tend to be highly abbreviated, especially
9669: for actions that occur often. Some contain a detailed
9670: description of what has changed, but they are geared towards the
9671: other pkgsrc developers, not towards an average pkgsrc user.
9672: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9673: don't know what has been before, these messages may not be worth
9674: too much to you.</p></li>
1.128 wiz 9675: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9676: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9677: mind of the developer who wrote the code. To get this
1.110 hubertf 9678: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9679: to see who has written it and ask on the
9680: <code class="literal">tech-pkg</code> mailing list, so that others can
9681: find your questions later (see above). To be sure that the
9682: developer in charge reads the mail, you may CC him or
9683: her.</p></li>
9684: </ul></div>
9685: </td>
9686: </tr>
1.148 asau 9687: <tr class="question">
1.92 rillig 9688: <td align="left" valign="top">
1.188 ! snj 9689: <a name="devfaq.too-much-time"></a><a name="idm77785104"></a><p><b>22.9.</b></p>
1.92 rillig 9690: </td>
9691: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9692: do?</p></td>
9693: </tr>
9694: <tr class="answer">
9695: <td align="left" valign="top"></td>
9696: <td align="left" valign="top">
1.93 rillig 9697: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9698: anyway.</p>
1.148 asau 9699: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9700: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.188 ! snj 9701: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.92 rillig 9702: will tell you about newer versions of installed packages that are
9703: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9704: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9705: — it contains a list of suggested new packages and a list of
1.92 rillig 9706: cleanups and enhancements for pkgsrc that would be nice to
9707: have.</p></li>
1.128 wiz 9708: <li class="listitem"><p>Review packages for which review was requested on
1.180 wiz 9709: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92 rillig 9710: mailing list.</p></li>
9711: </ul></div>
9712: </td>
9713: </tr>
1.75 rillig 9714: </tbody>
9715: </table>
9716: </div>
9717: </div>
1.148 asau 9718: <div class="chapter">
1.85 jmmv 9719: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9720: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9721: <div class="toc">
9722: <p><b>Table of Contents</b></p>
9723: <dl>
1.106 rillig 9724: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9725: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9726: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9727: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9728: </dl>
9729: </div>
1.110 hubertf 9730: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9731: site</a>:</p>
9732: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9733: environment, an intuitive and attractive desktop for users, and the
9734: GNOME development platform, an extensive framework for building
9735: applications that integrate into the rest of the desktop.</p></blockquote></div>
9736: <p>pkgsrc provides a seamless way to automatically build and install
9737: a complete GNOME environment <span class="emphasis"><em>under many different
9738: platforms</em></span>. We can say with confidence that pkgsrc is one of
9739: the most advanced build and packaging systems for GNOME due to its
9740: included technologies buildlink3, the wrappers and tools framework and
9741: automatic configuration file management. Lots of efforts are put into
9742: achieving a completely clean deinstallation of installed software
9743: components.</p>
1.110 hubertf 9744: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9745: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9746: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9747: pkgsrc as its preferred packaging system, contributing lots of
9748: portability fixes to make GNOME build and install under it.</p>
9749: <p>This chapter is aimed at pkgsrc developers and other people
9750: interested in helping our GNOME porting and packaging efforts. It
9751: provides instructions on how to manage the existing packages and some
9752: important information regarding their internals.</p>
1.148 asau 9753: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9754: <h3 class="title">We need your help!</h3>
9755: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9756: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9757: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9758: work</a> list! There is still a long way to go to get a
9759: fully-functional GNOME desktop under NetBSD and we need your help to
9760: achieve it!</p>
9761: </div>
1.148 asau 9762: <div class="sect1">
1.85 jmmv 9763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9764: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9765: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9766: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.188 ! snj 9767: <li class="listitem"><p><a href="http://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 9768: the core GNOME desktop environment. It only includes the necessary
9769: bits to get it to boot correctly, although it may lack important
9770: functionality for daily operation. The idea behind this package is
9771: to let end users build their own configurations on top of this one,
9772: first installing this meta package to achieve a functional setup and
9773: then adding individual applications.</p></li>
1.188 ! snj 9774: <li class="listitem"><p><a href="http://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 9775: complete installation of the GNOME platform and desktop as defined
9776: by the GNOME project; this is based on the components distributed in
9777: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9778: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9779: official FTP server. Developer-only tools found in those
9780: directories are not installed unless required by some other
9781: component to work properly. Similarly, packages from the bindings
9782: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9783: in unless required as a dependency for an end-user component. This
1.188 ! snj 9784: package "extends" <a href="http://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>
! 9785: <li class="listitem"><p><a href="http://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 9786: Installs all the tools required to build a GNOME component when
9787: fetched from the CVS repository. These are required to let the
1.110 hubertf 9788: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9789: </ul></div>
9790: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9791: sorted in a way that eases updates: a package may depend on other
9792: packages listed before it but not on any listed after it. It is very
9793: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9794: change it to alphabetical sorting!</em></span></p>
9795: </div>
1.148 asau 9796: <div class="sect1">
1.85 jmmv 9797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9798: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9799: <p>Almost all GNOME applications are written in C and use a common
9800: set of tools as their build system. Things get different with the new
9801: bindings to other languages (such as Python), but the following will
9802: give you a general idea on the minimum required tools:</p>
1.148 asau 9803: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9804: <li class="listitem">
1.85 jmmv 9805: <p>Almost all GNOME applications use the GNU Autotools as their
9806: build system. As a general rule you will need to tell this to your
9807: package:</p>
1.100 rillig 9808: <pre class="programlisting">
9809: GNU_CONFIGURE=yes
1.85 jmmv 9810: USE_LIBTOOL=yes
1.100 rillig 9811: USE_TOOLS+=gmake
9812: </pre>
1.85 jmmv 9813: </li>
1.128 wiz 9814: <li class="listitem">
1.85 jmmv 9815: <p>If the package uses pkg-config to detect dependencies, add this
9816: tool to the list of required utilities:</p>
9817: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.188 ! snj 9818: <p>Also use <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85 jmmv 9819: the end of the build process to ensure that you did not miss to
9820: specify any dependency in your package and that the version
9821: requirements are all correct.</p>
9822: </li>
1.128 wiz 9823: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9824: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9825: to handle dependencies and to force the package to use the latest
9826: available version.</p></li>
1.128 wiz 9827: <li class="listitem">
1.85 jmmv 9828: <p>If the package uses gtk-doc (a documentation generation
9829: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9830: tool is rather big and the distfile should come with pregenerated
9831: documentation anyway; if it does not, it is a bug that you ought to
9832: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9833: the default):</p>
9834: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9835: <p>The default location of installed HTML files
9836: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9837: and should not be changed unless the package insists on installing
9838: them somewhere else. Otherwise programs as
1.110 hubertf 9839: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9840: do that with an entry similar to:</p>
9841: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9842: </li>
9843: </ul></div>
9844: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9845: files under the installation prefix to maintain databases. In this
9846: context, shared means that those exact same directories and files are
9847: used among several different packages, leading to conflicts in the
9848: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9849: handle the most common cases, so you have to forget about using
9850: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9851: omitting shared files from them. If you find yourself doing those,
9852: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9853: <p>The following table lists the common situations that result in
9854: using shared directories or files. For each of them, the appropriate
9855: solution is given. After applying the solution be sure to
9856: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9857: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9858: <div class="table">
1.106 rillig 9859: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9860: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9861: <colgroup>
9862: <col>
9863: <col>
9864: </colgroup>
9865: <thead><tr>
9866: <th>If the package...</th>
9867: <th>Then...</th>
9868: </tr></thead>
9869: <tbody>
9870: <tr>
9871: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9872: <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 9873: </tr>
9874: <tr>
9875: <td>Installs icons under the
9876: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9877: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9878: <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 9879: </tr>
9880: <tr>
9881: <td>Installs files under
9882: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9883: <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 9884: </tr>
9885: <tr>
9886: <td>Installs <code class="filename">.desktop</code> files under
9887: <code class="filename">share/applications</code> and these include MIME
9888: information.</td>
1.110 hubertf 9889: <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 9890: </tr>
9891: </tbody>
1.91 rillig 9892: </table></div>
1.85 jmmv 9893: </div>
1.91 rillig 9894: <br class="table-break">
1.85 jmmv 9895: </div>
1.148 asau 9896: <div class="sect1">
1.85 jmmv 9897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9898: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9899: <p>When seeing GNOME as a whole, there are two kinds of
9900: updates:</p>
1.148 asau 9901: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9902: <dt><span class="term">Major update</span></dt>
9903: <dd>
9904: <p>Given that there is still a very long way for GNOME 3 (if it
9905: ever appears), we consider a major update one that goes from a
9906: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9907: where <code class="literal">Y</code> is even and greater than
9908: <code class="literal">X</code>. These are hard to achieve because they
9909: introduce lots of changes in the components' code and almost all
9910: GNOME distfiles are updated to newer versions. Some of them can
9911: even break API and ABI compatibility with the previous major
9912: version series. As a result, the update needs to be done all at
9913: once to minimize breakage.</p>
9914: <p>A major update typically consists of around 80 package
9915: updates and the addition of some new ones.</p>
9916: </dd>
9917: <dt><span class="term">Minor update</span></dt>
9918: <dd>
9919: <p>We consider a minor update one that goes from a
9920: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9921: one where <code class="literal">Y</code> is greater than
9922: <code class="literal">X</code>. These are easy to achieve because they do
9923: not update all GNOME components, can be done in an incremental way
9924: and do not break API nor ABI compatibility.</p>
9925: <p>A minor update typically consists of around 50 package
9926: updates, although the numbers here may vary a lot.</p>
9927: </dd>
9928: </dl></div>
9929: <p>In order to update the GNOME components in pkgsrc to a new stable
9930: release (either major or minor), the following steps should be
9931: followed:</p>
1.128 wiz 9932: <div class="orderedlist"><ol class="orderedlist" type="1">
9933: <li class="listitem">
1.85 jmmv 9934: <p>Get a list of all the tarballs that form the new release by
9935: using the following commands. These will leave the full list of the
1.120 snj 9936: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 9937: file:</p>
1.88 wiz 9938: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9939: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9940: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9941: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9942: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9943: awk '{ print $9 }' >>list.txt</code></strong></pre>
9944: </li>
1.128 wiz 9945: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 9946: bump their version to the release you are updating them to. The
9947: three meta packages should be always consistent with versioning.
9948: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9949: in them.</p></li>
1.128 wiz 9950: <li class="listitem">
1.85 jmmv 9951: <p>For each meta package, update all its
9952: <code class="varname">DEPENDS</code> lines to match the latest versions as
9953: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9954: newer version (even if found in the FTP) because the meta packages
9955: are supposed to list the exact versions that form a specific GNOME
9956: release. Exceptions are permitted here if a newer version solves a
9957: serious issue in the overall desktop experience; these typically
9958: come in the form of a revision bump in pkgsrc, not in newer versions
9959: from the developers.</p>
9960: <p>Packages not listed in the <code class="filename">list.txt</code> file
9961: should be updated to the latest version available (if found in
9962: pkgsrc). This is the case, for example, of the dependencies on the
1.188 ! snj 9963: GNU Autotools in the <a href="http://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 9964: </li>
1.128 wiz 9965: <li class="listitem">
1.85 jmmv 9966: <p>Generate a patch from the modified meta packages and extract the
9967: list of "new" lines. This will provide you an outline on what
9968: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9969: <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 9970: </li>
1.128 wiz 9971: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 9972: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 9973: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 9974: of <code class="filename">todo.txt</code> and update the packages listed in
9975: it in order. For major desktop updates none of these should be
1.93 rillig 9976: committed until the entire set is completed because there are chances
1.85 jmmv 9977: of breaking not-yet-updated packages.</p></li>
1.128 wiz 9978: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 9979: the tree one by one with appropriate log messages. At the end,
9980: commit the three meta package updates and all the corresponding
9981: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9982: <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>
9983: </ol></div>
9984: </div>
1.148 asau 9985: <div class="sect1">
1.85 jmmv 9986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9987: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9988: <p>GNOME is a very big component in pkgsrc which approaches 100
9989: packages. Please, it is very important that you always, always,
9990: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 9991: 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 9992: their attention on portability issues and to ensure that future versions
9993: can be built out-of-the box on NetBSD. The less custom patches in
9994: pkgsrc, the easier further updates are. Those developers in charge of
9995: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 9996: <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 9997: Bugzilla</a>. Not all components use these to track bugs, but most
9998: of them do. Do not be short on your reports: always provide detailed
9999: explanations of the current failure, how it can be improved to achieve
10000: maximum portability and, if at all possible, provide a patch against CVS
10001: head. The more verbose you are, the higher chances of your patch being
10002: accepted.</p>
10003: <p>Also, please avoid using preprocessor magic to fix portability
10004: issues. While the FreeBSD GNOME people are doing a great job in porting
10005: GNOME to their operating system, the official GNOME sources are now
10006: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10007: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10008: 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 10009: details.</p>
10010: </div>
10011: </div>
1.75 rillig 10012: </div>
1.148 asau 10013: <div class="part">
1.75 rillig 10014: <div class="titlepage"><div><div><h1 class="title">
10015: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10016: <div class="partintro">
1.75 rillig 10017: <div></div>
10018: <p>This part of the guide deals with everything
10019: from the infrastructure that is behind the interfaces described
10020: in the developer's guide. A casual package maintainer should not
10021: need anything from this part.</p>
10022: <div class="toc">
10023: <p><b>Table of Contents</b></p>
10024: <dl>
1.106 rillig 10025: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10026: <dd><dl>
1.106 rillig 10027: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10028: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10029: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10030: <dd><dl>
1.106 rillig 10031: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10032: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10033: </dl></dd>
1.106 rillig 10034: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10035: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10036: <dd><dl>
1.106 rillig 10037: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10038: <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 10039: </dl></dd>
1.106 rillig 10040: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10041: <dd><dl>
1.128 wiz 10042: <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>
10043: <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 10044: </dl></dd>
10045: </dl></dd>
1.106 rillig 10046: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10047: <dd><dl>
1.106 rillig 10048: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10049: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10050: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10051: <dd><dl>
1.106 rillig 10052: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10053: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10054: </dl></dd>
10055: </dl></dd>
1.106 rillig 10056: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10057: <dd><dl>
1.106 rillig 10058: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10059: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10060: </dl></dd>
10061: </dl>
10062: </div>
10063: </div>
1.148 asau 10064: <div class="chapter">
1.75 rillig 10065: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10066: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10067: <div class="toc">
10068: <p><b>Table of Contents</b></p>
10069: <dl>
1.106 rillig 10070: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10071: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10072: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10073: <dd><dl>
1.106 rillig 10074: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10075: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10076: </dl></dd>
1.106 rillig 10077: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10078: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10079: <dd><dl>
1.106 rillig 10080: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10081: <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 10082: </dl></dd>
1.106 rillig 10083: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10084: <dd><dl>
1.128 wiz 10085: <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>
10086: <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 10087: </dl></dd>
10088: </dl>
10089: </div>
10090: <p>The pkgsrc infrastructure consists of many small Makefile
10091: fragments. Each such fragment needs a properly specified
10092: interface. This chapter explains how such an interface looks
10093: like.</p>
1.148 asau 10094: <div class="sect1">
1.75 rillig 10095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10096: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10097: <p>Whenever a variable is defined in the pkgsrc
10098: infrastructure, the location and the way of definition provide
10099: much information about the intended use of that variable.
10100: Additionally, more documentation may be found in a header
10101: comment or in this pkgsrc guide.</p>
10102: <p>A special file is
10103: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10104: variables that are intended to be user-defined. They are either
10105: defined using the <code class="literal">?=</code> operator or they are
10106: left undefined because defining them to anything would
1.128 wiz 10107: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10108: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10109: file.</p>
10110: <p>Outside this file, the following conventions apply:
10111: Variables that are defined using the <code class="literal">?=</code>
10112: operator may be overridden by a package.</p>
10113: <p>Variables that are defined using the <code class="literal">=</code>
10114: operator may be used read-only at run-time.</p>
10115: <p>Variables whose name starts with an underscore must not be
10116: accessed outside the pkgsrc infrastructure at all. They may
10117: change without further notice.</p>
1.148 asau 10118: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10119: <h3 class="title">Note</h3>
10120: <p>These conventions are currently not applied
10121: consistently to the complete pkgsrc
10122: infrastructure.</p>
10123: </div>
10124: </div>
1.148 asau 10125: <div class="sect1">
1.81 rillig 10126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10127: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10128: <p>All variables that contain lists of things should default
10129: to being empty. Two examples that do not follow this rule are
10130: <code class="varname">USE_LANGUAGES</code> and
10131: <code class="varname">DISTFILES</code>. These variables cannot simply be
10132: modified using the <code class="literal">+=</code> operator in package
10133: <code class="filename">Makefile</code>s (or other files included by
10134: them), since there is no guarantee whether the variable is
10135: already set or not, and what its value is. In the case of
1.128 wiz 10136: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10137: the default value and just define it as in the following
10138: example.</p>
10139: <pre class="programlisting">
1.100 rillig 10140: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10141: </pre>
10142: <p>Because of the selection of this default value, the same
10143: value appears in many package Makefiles. Similarly for
10144: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10145: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10146: doesn't stand out. Nevertheless it is mentioned in many
10147: files.</p>
10148: </div>
1.148 asau 10149: <div class="sect1">
1.81 rillig 10150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10151: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 10152: <div class="sect2">
1.75 rillig 10153: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10154: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10155: <p>Variable evaluation takes place either at load time or at
10156: runtime, depending on the context in which they occur. The
10157: contexts where variables are evaluated at load time are:</p>
1.148 asau 10158: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10159: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10160: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10161: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10162: <code class="literal">.for</code>,</p></li>
1.128 wiz 10163: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10164: </ul></div>
10165: <p>A special exception are references to the iteration
10166: variables of <code class="literal">.for</code> loops, which are expanded
10167: inline, no matter in which context they appear.</p>
10168: <p>As the values of variables may change during load time,
10169: care must be taken not to evaluate them by accident. Typical
10170: examples for variables that should not be evaluated at load time
10171: are <code class="varname">DEPENDS</code> and
10172: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10173: clear, here is an example:</p>
10174: <pre class="programlisting">
1.100 rillig 10175: CONFIGURE_ARGS= # none
10176: CFLAGS= -O
10177: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10178:
1.100 rillig 10179: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10180:
1.100 rillig 10181: CFLAGS+= -Wall
1.75 rillig 10182: </pre>
10183: <p>This code shows how the use of the <code class="literal">:=</code>
10184: operator can quickly lead to unexpected results. The first
10185: paragraph is fairly common code. The second paragraph evaluates
10186: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10187: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10188: <code class="literal">-Wall</code> is appended to the
10189: <code class="varname">CFLAGS</code>, but this addition will not appear in
10190: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10191: paragraphs from above typically occur in completely unrelated
10192: files.</p>
10193: </div>
1.148 asau 10194: <div class="sect2">
1.75 rillig 10195: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10196: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10197: <p>After all the files have been loaded, the values of the
10198: variables cannot be changed anymore. Variables that are used in
10199: the shell commands are expanded at this point.</p>
10200: </div>
10201: </div>
1.148 asau 10202: <div class="sect1">
1.75 rillig 10203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10204: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10205: <p>There are many ways in which the definition and use of a
10206: variable can be restricted in order to detect bugs and
10207: violations of the (mostly unwritten) policies. See the
10208: <code class="literal">pkglint</code> developer's documentation for further
10209: details.</p>
10210: </div>
1.148 asau 10211: <div class="sect1">
1.78 rillig 10212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10213: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10214: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10215: of the following classes. Cases where a file falls into more
10216: than one class should be avoided as it often leads to subtle
10217: bugs.</p>
1.148 asau 10218: <div class="sect2">
1.75 rillig 10219: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10220: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10221: <p>In a traditional imperative programming language some of
1.76 rillig 10222: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10223: procedures. They take some input parameters and—after
10224: inclusion—provide a result in output parameters. Since all
1.76 rillig 10225: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10226: care must be taken not to use parameter names that have already
10227: another meaning. For example, <code class="varname">PKGNAME</code> is a
10228: bad choice for a parameter name.</p>
10229: <p>Procedures are completely evaluated at preprocessing time.
10230: That is, when calling a procedure all input parameters must be
10231: completely resolvable. For example,
10232: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10233: parameter since it is very likely that further text will be
10234: added after calling the procedure, which would effectively apply
10235: the procedure to only a part of the variable. Also, references
10236: to other variables wit will be modified after calling the
10237: procedure.</p>
10238: <p>A procedure can declare its output parameters either as
10239: suitable for use in preprocessing directives or as only
10240: available at runtime. The latter alternative is for variables
10241: that contain references to other runtime variables.</p>
10242: <p>Procedures shall be written such that it is possible to
10243: call the procedure more than once. That is, the file must not
10244: contain multiple-inclusion guards.</p>
10245: <p>Examples for procedures are
1.76 rillig 10246: <code class="filename">mk/bsd.options.mk</code> and
10247: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10248: that the parameters are evaluated at load time, they should be
10249: assigned using the <code class="literal">:=</code> operator, which should
10250: be used only for this purpose.</p>
10251: </div>
1.148 asau 10252: <div class="sect2">
1.75 rillig 10253: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10254: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10255: <p>Action files take some input parameters and may define
10256: runtime variables. They shall not define loadtime variables.
10257: There are action files that are included implicitly by the
10258: pkgsrc infrastructure, while other must be included
10259: explicitly.</p>
10260: <p>An example for action files is
1.76 rillig 10261: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10262: </div>
10263: </div>
1.148 asau 10264: <div class="sect1">
1.81 rillig 10265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10266: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10267: <p>Package <code class="filename">Makefile</code>s usually consist of
10268: a set of variable definitions, and include the file
10269: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10270: Before that, they may also include various other
10271: <code class="filename">*.mk</code> files if they need to query the
10272: availability of certain features like the type of compiler or
10273: the X11 implementation. Due to the heavy use of preprocessor
10274: directives like <code class="literal">.if</code> and
10275: <code class="literal">.for</code>, the order in which the files are loaded
10276: matters.</p>
10277: <p>This section describes at which point the various files
10278: are loaded and gives reasons for that order.</p>
1.148 asau 10279: <div class="sect2">
1.81 rillig 10280: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10281: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10282: </h3></div></div></div>
10283: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10284: is to define some essential variables like
10285: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10286: <code class="varname">MACHINE_ARCH</code>.</p>
10287: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10288: 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 10289: After that, those variables
1.81 rillig 10290: that have not been overridden by the user are loaded from
10291: <code class="filename">mk/defaults/mk.conf</code>.</p>
10292: <p>After the user settings, the system settings and platform
10293: settings are loaded, which may override the user
10294: settings.</p>
10295: <p>Then, the tool definitions are loaded. The tool wrappers
10296: are not yet in effect. This only happens when building a
10297: package, so the proper variables must be used instead of the
10298: direct tool names.</p>
10299: <p>As the last steps, some essential variables from the
10300: wrapper and the package system flavor are loaded, as well as the
10301: variables that have been cached in earlier phases of a package
10302: build.</p>
10303: </div>
1.148 asau 10304: <div class="sect2">
1.81 rillig 10305: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10306: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10307: </h3></div></div></div>
1.81 rillig 10308: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10309: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10310: loaded, which fill default values for those variables that have
1.93 rillig 10311: not been defined by the package. These variables may later
1.81 rillig 10312: be used even in unrelated files.</p>
10313: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10314: provides the target <code class="literal">error-check</code> that is added
10315: as a special dependency to all other targets that use
10316: <code class="varname">DELAYED_ERROR_MSG</code> or
10317: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10318: <p>Then, the package-specific hacks from
10319: <code class="filename">hacks.mk</code> are included.</p>
10320: <p>Then, various other files follow. Most of them don't have
10321: any dependencies on what they need to have included before or
10322: after them, though some do.</p>
10323: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10324: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10325: restricts the use of these variables to all the files that have
10326: been included before. Appearances in later files will be
10327: silently ignored.</p>
10328: <p>Then, the files for the main targets are included, in the
10329: order of later execution, though the actual order should not
10330: matter.</p>
10331: <p>At last, some more files are included that don't set any
10332: interesting variables but rather just define make targets to be
10333: executed.</p>
10334: </div>
10335: </div>
1.75 rillig 10336: </div>
1.148 asau 10337: <div class="chapter">
1.75 rillig 10338: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10339: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10340: <div class="toc">
10341: <p><b>Table of Contents</b></p>
10342: <dl>
1.106 rillig 10343: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10344: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10345: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10346: <dd><dl>
1.106 rillig 10347: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10348: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10349: </dl></dd>
10350: </dl>
10351: </div>
10352: <p>The pkgsrc infrastructure consists of a large codebase,
10353: and there are many corners where every little bit of a file is
10354: well thought out, making pkgsrc likely to fail as soon as
10355: anything is changed near those parts. To prevent most changes
10356: from breaking anything, a suite of regression tests should go
10357: along with every important part of the pkgsrc infrastructure.
10358: This chapter describes how regression tests work in pkgsrc and
10359: how you can add new tests.</p>
1.148 asau 10360: <div class="sect1">
1.75 rillig 10361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10362: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10363: <p></p>
10364: </div>
1.148 asau 10365: <div class="sect1">
1.75 rillig 10366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10367: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.188 ! snj 10368: <p>You first need to install the <a href="http://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 10369: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10370: can simply run that command, which will run all tests in the
1.76 rillig 10371: <code class="filename">regress</code> category.</p>
1.75 rillig 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.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10376: <p>Every directory in the <code class="filename">regress</code>
10377: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10378: is considered a regression test. This file is a shell program
1.110 hubertf 10379: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10380: The following functions can be overridden to suit your
10381: needs.</p>
1.148 asau 10382: <div class="sect2">
1.75 rillig 10383: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10384: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10385: <p>These functions do not take any parameters. They are all
1.128 wiz 10386: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10387: to check the exitcodes of any commands you run in the
10388: test.</p>
1.148 asau 10389: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10390: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10391: <dd><p>This function prepares the environment for the
10392: test. By default it does nothing.</p></dd>
10393: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10394: <dd><p>This function runs the actual test. By default,
10395: it calls <code class="varname">TEST_MAKE</code> with the arguments
10396: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10397: error messages into the file
10398: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10399: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10400: <dd><p>This function is run after the test and is
10401: typically used to compare the actual output from the one that is
10402: expected. It can make use of the various helper functions from
10403: the next section.</p></dd>
10404: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10405: <dd><p>This function cleans everything up after the
10406: test has been run. By default it does nothing.</p></dd>
10407: </dl></div>
10408: </div>
1.148 asau 10409: <div class="sect2">
1.75 rillig 10410: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10411: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 asau 10412: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10413: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10414: <dd><p>This function compares the exitcode of the
1.110 hubertf 10415: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10416: If they differ, the test will fail.</p></dd>
10417: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10418: <dd><p>This function checks for each of its parameters
1.110 hubertf 10419: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10420: extended regular expression. If it does not, the test will
10421: fail.</p></dd>
10422: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10423: <dd><p>This function checks for each of its parameters
1.110 hubertf 10424: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10425: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10426: If any of the regular expressions matches, the test will
10427: fail.</p></dd>
10428: </dl></div>
10429: </div>
10430: </div>
10431: </div>
1.148 asau 10432: <div class="chapter">
1.75 rillig 10433: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10434: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10435: <div class="toc">
10436: <p><b>Table of Contents</b></p>
10437: <dl>
1.106 rillig 10438: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10439: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10440: </dl>
10441: </div>
10442: <p>The pkgsrc system has already been ported to many
10443: operating systems, hardware architectures and compilers. This
10444: chapter explains the necessary steps to make pkgsrc even more
10445: portable.</p>
1.148 asau 10446: <div class="sect1">
1.75 rillig 10447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10448: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10449: <p>To port pkgsrc to a new operating system (called
10450: <code class="literal">MyOS</code> in this example), you need to touch the
10451: following files:</p>
1.148 asau 10452: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10453: <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 10454: <dd><p>This file contains some basic definitions, for
10455: example the name of the C
10456: compiler.</p></dd>
1.76 rillig 10457: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10458: <dd><p>Insert code that defines the variables
10459: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10460: <code class="varname">LOWER_OS_VERSION</code>,
10461: <code class="varname">LOWER_VENDOR</code>,
10462: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10463: <code class="varname">APPEND_ELF</code>, and the other variables that
10464: appear in this file.</p></dd>
1.93 rillig 10465: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10466: <dd><p>This file contains the platform-specific
10467: definitions that are used by pkgsrc. Start by copying one of the
10468: other files and edit it to your
10469: needs.</p></dd>
1.93 rillig 10470: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10471: <dd><p>This file defines the paths to all the tools
10472: that are needed by one or the other package in pkgsrc, as well
10473: as by pkgsrc itself. Find out where these tools are on your
10474: platform and add them.</p></dd>
10475: </dl></div>
10476: <p>Now, you should be able to build some basic packages, like
1.188 ! snj 10477: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75 rillig 10478: </div>
1.148 asau 10479: <div class="sect1">
1.75 rillig 10480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10481: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10482: <p>TODO</p>
10483: </div>
10484: </div>
10485: </div>
1.148 asau 10486: <div class="appendix">
10487: <div class="titlepage"><div><div><h1 class="title">
10488: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10489: <div class="toc">
10490: <p><b>Table of Contents</b></p>
10491: <dl>
10492: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10493: <dd><dl>
10494: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10495: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10496: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10497: <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 10498: </dl></dd>
10499: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10500: </dl>
10501: </div>
10502: <p>We checked to find a piece of software that wasn't in the packages
10503: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10504: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10505: present in the tree is beyond us, but it's useful for the purposes of
10506: this exercise.</p>
1.148 asau 10507: <div class="sect1">
1.75 rillig 10508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10509: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10510: <div class="sect2">
1.75 rillig 10511: <div class="titlepage"><div><div><h3 class="title">
10512: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10513: <pre class="programlisting">
1.100 rillig 10514: # $NetBSD$
10515: #
1.1 grant 10516:
1.100 rillig 10517: DISTNAME= bison-1.25
10518: CATEGORIES= devel
10519: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10520:
1.136 dholland 10521: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10522: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10523: COMMENT= GNU yacc clone
1.1 grant 10524:
1.100 rillig 10525: GNU_CONFIGURE= yes
1.152 wiz 10526: INFO_FILES= yes
1.1 grant 10527:
1.100 rillig 10528: .include "../../mk/bsd.pkg.mk"
1.1 grant 10529: </pre>
1.75 rillig 10530: </div>
1.148 asau 10531: <div class="sect2">
1.75 rillig 10532: <div class="titlepage"><div><div><h3 class="title">
10533: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10534: <pre class="programlisting">
1.100 rillig 10535: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.188 ! snj 10536: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-6.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10537: of the NetBSD source tree is beyond me.
1.1 grant 10538: </pre>
1.75 rillig 10539: </div>
1.148 asau 10540: <div class="sect2">
1.75 rillig 10541: <div class="titlepage"><div><div><h3 class="title">
10542: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10543: <pre class="programlisting">
1.100 rillig 10544: @comment $NetBSD$
10545: bin/bison
10546: man/man1/bison.1.gz
10547: share/bison.simple
10548: share/bison.hairy
1.1 grant 10549: </pre>
1.75 rillig 10550: </div>
1.148 asau 10551: <div class="sect2">
1.75 rillig 10552: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10553: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10554: </h3></div></div></div>
1.75 rillig 10555: <p>The NetBSD package system comes with
1.188 ! snj 10556: <a href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10557: which helps to check the contents of these
10558: files. After installation it is quite easy to use, just change to the
10559: directory of the package you wish to examine and execute
1.110 hubertf 10560: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10561: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10562: looks fine.</pre>
10563: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10564: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10565: -Wall</strong></span> for a very thorough check.</p>
10566: </div>
10567: </div>
1.148 asau 10568: <div class="sect1">
1.75 rillig 10569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10570: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10571: <p>Create the directory where the package lives,
10572: plus any auxiliary directories:</p>
10573: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10574: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10575: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10576: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10577: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10578: <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 10579: then continue with fetching the distfile:</p>
10580: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10581: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10582: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10583: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10584: ftp: Error retrieving file: 500 Internal error
10585:
10586: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10587: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10588: ftp: Error retrieving file: 500 Internal error
10589:
10590: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10591: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10592: Successfully retrieved file.</pre>
10593: <p>Generate the checksum of the distfile into
1.76 rillig 10594: <code class="filename">distinfo</code>:</p>
1.88 wiz 10595: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10596: <p>Now compile:</p>
10597: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10598: >> Checksum OK for bison-1.25.tar.gz.
10599: ===> Extracting for bison-1.25
10600: ===> Patching for bison-1.25
10601: ===> Ignoring empty patch directory
10602: ===> Configuring for bison-1.25
10603: creating cache ./config.cache
10604: checking for gcc... cc
10605: checking whether we are using GNU C... yes
10606: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10607: checking how to run the C preprocessor... cc -E
10608: checking for minix/config.h... no
10609: checking for POSIXized ISC... no
10610: checking whether cross-compiling... no
10611: checking for ANSI C header files... yes
10612: checking for string.h... yes
10613: checking for stdlib.h... yes
10614: checking for memory.h... yes
10615: checking for working const... yes
10616: checking for working alloca.h... no
10617: checking for alloca... yes
10618: checking for strerror... yes
10619: updating cache ./config.cache
10620: creating ./config.status
10621: creating Makefile
10622: ===> Building for bison-1.25
10623: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10624: 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
10625: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10626: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10627: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10628: 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 10629: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10630: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10631: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.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 lex.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 main.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 nullable.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 output.c
10636: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
10637: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.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 reduce.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 symtab.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 warshall.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 version.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 getopt.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 getopt1.c
10644: 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
10645: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10646: rm -f bison.s1
1.75 rillig 10647: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10648: <p>Everything seems OK, so install the files:</p>
10649: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10650: >> Checksum OK for bison-1.25.tar.gz.
10651: ===> Installing for bison-1.25
10652: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10653: rm -f /usr/pkg/bin/bison
10654: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10655: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10656: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10657: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10658: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10659: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10660: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10661: ===> Registering installation for bison-1.25</pre>
10662: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10663: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10664: binary package, do this now:</p>
10665: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10666: >> Checksum OK for bison-1.25.tar.gz.
10667: ===> Building package for bison-1.25
10668: Creating package bison-1.25.tgz
10669: Registering depends:.
1.75 rillig 10670: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10671: <p>Now that you don't need the source and object files
10672: any more, clean up:</p>
10673: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10674: ===> Cleaning for bison-1.25</pre>
10675: </div>
10676: </div>
1.148 asau 10677: <div class="appendix">
10678: <div class="titlepage"><div><div><h1 class="title">
10679: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10680: <div class="toc">
10681: <p><b>Table of Contents</b></p>
10682: <dl>
10683: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10684: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10685: </dl>
10686: </div>
1.148 asau 10687: <div class="sect1">
1.75 rillig 10688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10689: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10690: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10691: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10692: => figlet221.tar.gz doesn't seem to exist on this system.
10693: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10694: => [172219 bytes]
10695: Connected to ftp.plig.net.
10696: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10697: 331 Guest login ok, send your complete e-mail address as password.
10698: 230-You are user #5 of 500 simultaneous users allowed.
10699: 230-
1.68 rillig 10700: 230- ___ _ _ _
10701: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10702: 230- | _| _| . |_| . | | | . |_| . | _| . |
10703: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10704: 230- |_| |_| |___| |___|
10705: 230-
10706: 230-** Welcome to ftp.plig.org **
10707: 230-
10708: 230-Please note that all transfers from this FTP site are logged. If you
10709: 230-do not like this, please disconnect now.
10710: 230-
1.120 snj 10711: 230-This archive is available via
1.1 grant 10712: 230-
10713: 230-HTTP: http://ftp.plig.org/
10714: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10715: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10716: 230-
10717: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10718: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10719: 230-
10720: 230-
10721: 230 Logged in anonymously.
10722: Remote system type is UNIX.
10723: Using binary mode to transfer files.
10724: 200 Type okay.
10725: 250 "/pub" is new cwd.
10726: 250-"/pub/figlet" is new cwd.
10727: 250-
10728: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10729: 250-
1.75 rillig 10730: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10731: 250-
10732: 250-The official FIGlet web page is:
1.75 rillig 10733: 250- http://www.figlet.org/
1.1 grant 10734: 250-
10735: 250-If you have questions, please mailto:info@figlet.org. If you want to
10736: 250-contribute a font or something else, you can email us.
1.68 rillig 10737: 250
1.1 grant 10738: 250 "/pub/figlet/program" is new cwd.
10739: 250 "/pub/figlet/program/unix" is new cwd.
10740: local: figlet221.tar.gz remote: figlet221.tar.gz
10741: 502 Unimplemented command.
10742: 227 Entering Passive Mode (195,40,6,41,246,104)
10743: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10744: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10745: 226 Transfer completed.
10746: 172219 bytes received in 00:02 (75.99 KB/s)
10747: 221 Goodbye.
10748: => Checksum OK for figlet221.tar.gz.
10749: ===> Extracting for figlet-2.2.1nb2
10750: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10751: ===> Patching for figlet-2.2.1nb2
10752: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10753: ===> Overriding tools for figlet-2.2.1nb2
10754: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10755: ===> Configuring for figlet-2.2.1nb2
10756: ===> Building for figlet-2.2.1nb2
10757: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10758: chmod a+x figlet
10759: gcc -O2 -o chkfont chkfont.c
10760: => Unwrapping files-to-be-installed.
1.14 xtraeme 10761: <code class="prompt">#</code>
1.75 rillig 10762: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10763: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10764: ===> Installing for figlet-2.2.1nb2
10765: install -d -o root -g wheel -m 755 /usr/pkg/bin
10766: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10767: mkdir -p /usr/pkg/share/figlet
10768: cp figlet /usr/pkg/bin
10769: cp chkfont /usr/pkg/bin
10770: chmod 555 figlist showfigfonts
10771: cp figlist /usr/pkg/bin
10772: cp showfigfonts /usr/pkg/bin
10773: cp fonts/*.flf /usr/pkg/share/figlet
10774: cp fonts/*.flc /usr/pkg/share/figlet
10775: cp figlet.6 /usr/pkg/man/man6
10776: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10777: <code class="prompt">#</code></pre>
10778: </div>
1.148 asau 10779: <div class="sect1">
1.75 rillig 10780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10781: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10782: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10783: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10784: ===> Packaging figlet-2.2.1nb2
10785: ===> Building binary package for figlet-2.2.1nb2
10786: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10787: Using SrcDir value of /usr/pkg
1.68 rillig 10788: Registering depends:.
1.75 rillig 10789: <code class="prompt">#</code></pre>
10790: </div>
10791: </div>
1.148 asau 10792: <div class="appendix">
10793: <div class="titlepage"><div><div><h1 class="title">
10794: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10795: <div class="toc">
10796: <p><b>Table of Contents</b></p>
10797: <dl>
1.128 wiz 10798: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10799: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10800: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10801: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10802: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10803: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10804: source packages</a></span></dt>
10805: </dl>
10806: </div>
10807: <p>As in other big projects, the directory layout of pkgsrc
10808: is quite complex for newbies. This chapter explains where you
10809: find things on the FTP server. The base directory on
1.110 hubertf 10810: <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 10811: On other servers it may be different, but inside this directory,
10812: everything should look the same, no matter on which server you
10813: are. This directory contains some subdirectories, which are
10814: explained below.</p>
1.148 asau 10815: <div class="sect1">
1.76 rillig 10816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10817: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10818: <p>The directory <code class="filename">distfiles</code> contains lots
10819: of archive files from all pkgsrc packages, which are mirrored
10820: here. The subdirectories are called after their package names
10821: and are used when the distributed files have names that don't
10822: explicitly contain a version number or are otherwise too generic
10823: (for example <code class="filename">release.tar.gz</code>).</p>
10824: </div>
1.148 asau 10825: <div class="sect1">
1.76 rillig 10826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10827: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10828: <p>This directory contains things that individual pkgsrc
10829: developers find worth publishing.</p>
10830: </div>
1.148 asau 10831: <div class="sect1">
1.76 rillig 10832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10833: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10834: <p>This directory contains binary packages for the various
10835: platforms that are supported by pkgsrc.
10836: 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 10837: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10838: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10839: operating system for which the packages have been built. The
1.110 hubertf 10840: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10841: command, so it may differ from the one you are used to
10842: hear.</p></li>
1.128 wiz 10843: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10844: architecture of the platform for which the packages have been
1.110 hubertf 10845: built. It also includes the <code class="varname">ABI</code> (Application
10846: Binary Interface) for platforms that have several of
10847: them.</p></li>
1.128 wiz 10848: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10849: the operating system. For version numbers that change often (for
10850: example NetBSD-current), the often-changing part should be
10851: replaced with an <code class="literal">x</code>, for example
10852: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10853: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10854: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10855: for a stable branch, or <code class="literal">head</code> for packages
10856: built from the HEAD branch. The latter should only be used when
10857: the packages are updated on a regular basis. Otherwise the date
10858: from checking out pkgsrc should be appended, for example
10859: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10860: </ul></div>
10861: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10862: can quickly click through the directories on the
10863: server and find the best binary packages for their machines. Since they
10864: usually know the operating system and the hardware architecture, OPSYS
10865: and ARCH are placed first. After these choices, they can select the
10866: best combination of OSVERSION and TAG together, since it is usually the
10867: case that packages stay compatible between different version of the
10868: operating system.</p>
10869: <p>In each of these directories, there is a
10870: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10871: <code class="filename">All</code> which contains all binary packages.
10872: Besides that, there are various category directories that
10873: contain symbolic links to the real binary packages.</p>
10874: </div>
1.148 asau 10875: <div class="sect1">
1.76 rillig 10876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10877: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10878: <p>Here are the reports from bulk builds, for those who want
10879: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10880: 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 10881: </div>
1.148 asau 10882: <div class="sect1">
1.108 rillig 10883: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10884: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10885: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10886: source packages</h2></div></div></div>
1.128 wiz 10887: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10888: that is the files that define how to create binary packages from
10889: source archives.</p>
10890: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10891: snapshot of the CVS repository, which is updated regularly. The
10892: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10893: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10894: <p>In the directories for the quarterly branches, there is an
10895: additional file called
1.126 jakllsch 10896: <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 10897: which contains the state of pkgsrc when it was branched.</p>
10898: </div>
1.75 rillig 10899: </div>
1.148 asau 10900: <div class="appendix">
10901: <div class="titlepage"><div><div><h1 class="title">
10902: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 10903: <div class="toc">
10904: <p><b>Table of Contents</b></p>
10905: <dl>
1.79 rillig 10906: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10907: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10908: </dl>
10909: </div>
1.79 rillig 10910: <p>This section contains information on editing the pkgsrc
10911: guide itself.</p>
1.148 asau 10912: <div class="sect1">
1.75 rillig 10913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10914: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10915: <p>The pkgsrc guide's source code is stored in
10916: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10917: are created from it:</p>
1.148 asau 10918: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10919: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10920: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10921: <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>
10922: <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 10923: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 10924: <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 10925: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10926: </ul></div>
10927: </div>
1.148 asau 10928: <div class="sect1">
1.75 rillig 10929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10930: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10931: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 10932: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 10933: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 10934: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 10935: documentation) installed. These are automatically installed when
1.188 ! snj 10936: you install the <a href="http://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 10937: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 10938: right directory. All further steps will take place
10939: here.</p></li>
1.148 asau 10940: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 10941: <code class="filename">files/</code>.</p></li>
1.148 asau 10942: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 10943: guide for valid XML and to build the final output files. If you
10944: get any errors at this stage, you can just edit the files, as
10945: there are only symbolic links in the working directory, pointing
10946: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 10947: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 10948: commit)</strong></span></p></li>
1.148 asau 10949: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 10950: regenerate the output files with the proper RCS
10951: Ids.</p></li>
1.148 asau 10952: <li class="step">
1.110 hubertf 10953: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 10954: commit the files in both <code class="filename">pkgsrc/doc</code> and
10955: <code class="filename">htdocs</code>.</p>
1.148 asau 10956: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 10957: <h3 class="title">Note</h3>
10958: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 10959: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10960: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 10961: directory.</p>
10962: </div>
10963: </li>
1.79 rillig 10964: </ol></div>
1.75 rillig 10965: </div>
10966: </div>
10967: </div></body>
1.1 grant 10968: </html>
CVSweb <webmaster@jp.NetBSD.org>