Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.110
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.107 jnemeth 33: <div><p class="copyright">Copyright © 1994-2016 The NetBSD Foundation, Inc</p></div>
1.108 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.30 2016/06/11 18:14:42 rillig Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.100 leot 48: <dl class="toc">
1.1 dsieger 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
1.51 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
81: <dd><dl>
1.45 obache 82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 92: </dl></dd>
93: </dl></dd>
94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
97: <dd><dl>
98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
103: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
105: </dl></dd>
106: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
107: <dd><dl>
108: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
109: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
110: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
111: </dl></dd>
112: </dl></dd>
113: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
114: <dd><dl>
115: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
116: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 117: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 118: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 119: <dd><dl>
1.4 rillig 120: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 121: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
122: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 123: </dl></dd>
1.4 rillig 124: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
125: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 126: </dl></dd>
127: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
128: <dd><dl>
129: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
130: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 131: </dl></dd>
132: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
133: builds)</a></span></dt>
1.1 dsieger 134: <dd><dl>
1.71 wiz 135: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
136: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
137: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
138: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 139: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
140: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 141: </dl></dd>
142: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
143: <dd><dl>
1.23 wiz 144: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
145: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 146: </dl></dd>
147: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
148: <dd><dl>
149: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 150: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
151: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
152: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
153: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
154: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
155: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
156: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
157: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
158: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 159: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 160: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
161: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
162: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
163: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
164: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
165: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
166: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 167: </dl></dd>
168: </dl></dd>
169: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
170: <dd><dl>
1.6 rillig 171: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 172: <dd><dl>
1.6 rillig 173: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 174: <dd><dl>
1.6 rillig 175: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 176: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 177: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 178: </dl></dd>
1.6 rillig 179: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
180: <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>
181: </dl></dd>
182: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
183: <dd><dl>
1.23 wiz 184: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
185: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 186: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 187: <dd><dl>
188: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
189: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
190: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
193: </dl></dd>
194: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
195: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
196: <dd><dl>
197: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
198: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
199: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
200: </dl></dd>
1.23 wiz 201: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
202: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 203: </dl></dd>
1.23 wiz 204: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 205: <dd><dl>
206: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 207: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 208: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
209: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
210: <dd><dl>
211: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 212: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
213: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
214: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 215: </dl></dd>
216: </dl></dd>
217: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
218: <dd><dl>
219: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 220: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
221: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 222: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
223: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 224: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 225: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 226: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
227: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 228: </dl></dd>
229: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
230: <dd><dl>
231: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 232: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 233: <dd><dl>
234: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 235: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
236: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
237: and
238: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
239: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 240: </dl></dd>
1.23 wiz 241: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 242: <dd><dl>
1.23 wiz 243: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 244: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
245: </dl></dd>
246: </dl></dd>
247: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
248: <dd><dl>
249: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
250: <dd><dl>
251: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
252: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
253: </dl></dd>
254: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
255: <dd><dl>
1.23 wiz 256: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 257: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
258: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
259: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
260: </dl></dd>
261: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
262: <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>
263: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
264: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
265: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
266: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
267: <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>
268: </dl></dd>
269: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
270: <dd><dl>
271: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 272: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 273: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 274: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 275: </dl></dd>
276: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
277: <dd><dl>
278: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
279: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
280: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
281: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 282: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 283: <dd><dl>
284: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
285: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
286: </dl></dd>
1.23 wiz 287: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
288: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
289: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 297: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
298: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
299: </dl></dd>
300: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
301: <dd><dl>
302: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
303: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
304: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
305: </dl></dd>
306: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
307: <dd><dl>
308: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
309: <dd><dl>
1.108 rillig 310: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
311: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
312: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
313: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
314: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
315: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
316: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
317: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
318: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
319: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
320: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.6 rillig 321: </dl></dd>
1.108 rillig 322: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 323: <dd><dl>
324: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
325: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.88 tnn 326: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 327: </dl></dd>
1.108 rillig 328: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 329: <dd><dl>
330: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
331: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
332: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
333: </dl></dd>
334: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
335: <dd><dl>
336: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
337: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
338: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 339: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
340: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 341: </dl></dd>
1.108 rillig 342: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 343: <dd><dl>
344: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
345: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 346: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 347: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
348: </dl></dd>
1.108 rillig 349: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 350: <dd><dl>
351: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
352: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
353: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
354: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
355: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
356: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
357: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
358: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 359: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 360: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 361: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
362: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
363: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
364: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
365: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
366: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
367: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
368: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 369: emulation</a></span></dt>
1.6 rillig 370: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
371: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 372: </dl></dd>
1.6 rillig 373: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 374: </dl></dd>
1.6 rillig 375: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
376: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 377: <dd><dl>
1.6 rillig 378: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
379: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
380: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 381: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 382: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 383: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
384: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 385: </dl></dd>
386: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
387: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
388: <dd><dl>
389: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
390: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
391: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
392: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 393: </dl></dd>
394: </dl></dd>
395: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
396: <dd><dl>
1.6 rillig 397: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 398: <dd><dl>
1.6 rillig 399: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
400: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
401: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 402: <dd><dl>
1.6 rillig 403: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
404: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 405: </dl></dd>
1.6 rillig 406: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
407: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 408: <dd><dl>
1.6 rillig 409: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
410: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 411: </dl></dd>
1.6 rillig 412: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 413: <dd><dl>
1.23 wiz 414: <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>
415: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 416: </dl></dd>
417: </dl></dd>
1.6 rillig 418: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 419: <dd><dl>
1.108 rillig 420: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
421: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 422: <dd><dl>
1.108 rillig 423: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
424: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 425: </dl></dd>
426: </dl></dd>
1.6 rillig 427: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 428: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 429: </dl></dd>
430: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
431: <dd><dl>
432: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
433: <dd><dl>
434: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
435: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
436: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 437: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 438: </dl></dd>
439: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
440: </dl></dd>
441: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
442: <dd><dl>
443: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
444: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
445: </dl></dd>
446: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
447: <dd><dl>
1.23 wiz 448: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
449: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
450: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
451: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
452: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
453: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 454: source packages</a></span></dt>
455: </dl></dd>
456: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
457: <dd><dl>
458: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
459: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
460: </dl></dd>
461: </dl>
462: </div>
463: <div class="list-of-tables">
464: <p><b>List of Tables</b></p>
465: <dl>
466: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
467: </dt>
1.6 rillig 468: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 469: </dt>
1.6 rillig 470: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 471: </dt>
472: </dl>
473: </div>
1.41 asau 474: <div class="chapter">
475: <div class="titlepage"><div><div><h1 class="title">
476: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 477: <div class="toc">
478: <p><b>Table of Contents</b></p>
1.100 leot 479: <dl class="toc">
1.1 dsieger 480: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
481: <dd><dl>
482: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
483: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
484: </dl></dd>
485: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
486: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
487: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
488: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
489: </dl>
490: </div>
1.41 asau 491: <div class="sect1">
1.1 dsieger 492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
493: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
494: <p>There is a lot of software freely available for Unix-based
495: systems, which is usually available in form of the source code. Before
496: such software can be used, it needs to be configured to the local
497: system, compiled and installed, and this is exactly what The NetBSD
498: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
499: to handle binary packages, so that not every user has to build the
500: packages for himself, which is a time-costly task.</p>
501: <p>pkgsrc currently contains several thousand packages,
502: including:</p>
1.41 asau 503: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.104 sevan 504: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 505: web server</p></li>
1.79 snj 506: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 507: web browser</p></li>
1.79 snj 508: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 509: Desktop Environment</p></li>
1.102 ryoon 510: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 511: Desktop Environment</p></li>
512: </ul></div>
1.108 rillig 513: <p>… just to name a few.</p>
1.1 dsieger 514: <p>pkgsrc has built-in support for handling varying dependencies,
515: such as pthreads and X11, and extended features such as IPv6 support on
516: a range of platforms.</p>
1.41 asau 517: <div class="sect2">
1.1 dsieger 518: <div class="titlepage"><div><div><h3 class="title">
519: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
520: <p>
521: pkgsrc provides the following key features:
522: </p>
1.41 asau 523: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 524: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 525: and installation of binary packages. The source and latest
526: patches are retrieved from a master or mirror download site, checksum
527: verified, then built on your system. Support for binary-only
528: distributions is available for both native platforms and NetBSD
529: emulated platforms.</p></li>
1.23 wiz 530: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 531: including binaries, libraries, man pages and other
532: documentation.</p></li>
1.104 sevan 533: <li class="listitem"><p>Tracking of package dependencies automatically, including when
534: performing updates, to ensure required packages are installed. The
535: configuration files of various packages are handled automatically during
536: updates, so local changes are preserved.</p></li>
1.23 wiz 537: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 538: consists of highly portable code. This allows the greatest speed of
1.25 spz 539: development when porting to a new platform. This portability also
1.1 dsieger 540: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
541: platforms</em></span>.</p></li>
1.23 wiz 542: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 543: international encryption requirements and build-time options for a
544: large number of packages are all set in a simple, central
545: configuration file.</p></li>
1.23 wiz 546: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 547: freely available under a BSD license, so you may extend and adapt
548: pkgsrc to your needs. Support for local packages and patches is
549: available right out of the box, so you can configure it specifically
550: for your environment.</p></li>
551: </ul></div>
552: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 554: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 555: — That means, if a package contains bugs, it's better to find
1.1 dsieger 556: them and to complain about them rather than to just install the package
557: and hope that it works. There are numerous checks in pkgsrc that try to
1.79 snj 558: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 559: of shell scripts), and post-installation checks (installed files,
560: references to shared libraries, script interpreters).</p></li>
1.23 wiz 561: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 562: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 563: pkgsrc has been ported to many operating systems. Care is taken that
564: packages behave the same on all platforms.</p></li>
565: </ul></div>
566: </div>
1.41 asau 567: <div class="sect2">
1.1 dsieger 568: <div class="titlepage"><div><div><h3 class="title">
569: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
570: <p>pkgsrc consists of both a source distribution and a binary
571: distribution for these operating systems. After retrieving the required
572: source or binaries, you can be up and running with pkgsrc in just
573: minutes!</p>
574: <p>pkgsrc was derived from FreeBSD's ports system, and
575: initially developed for NetBSD only. Since then, pkgsrc has
576: grown a lot, and now supports the following platforms:</p>
577: <div class="table">
578: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 579: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 580: <colgroup>
581: <col>
582: <col>
1.92 sevan 583: <col>
1.1 dsieger 584: </colgroup>
585: <thead><tr>
586: <th>Platform</th>
587: <th>Date Support Added</th>
1.92 sevan 588: <th>Notes</th>
1.1 dsieger 589: </tr></thead>
590: <tbody>
591: <tr>
1.10 hubertf 592: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 593: <td align="center">Aug 1997</td>
1.92 sevan 594: <td class="auto-generated"> </td>
1.1 dsieger 595: </tr>
596: <tr>
1.10 hubertf 597: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 598: <td align="center">Mar 1999</td>
1.93 sevan 599: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 600: </tr>
601: <tr>
1.10 hubertf 602: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 603: <td align="center">Jun 1999</td>
1.93 sevan 604: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 605: </tr>
606: <tr>
607: <td>
1.10 hubertf 608: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
609: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 610: </td>
611: <td align="center">Oct 2001</td>
1.93 sevan 612: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1 dsieger 613: </tr>
614: <tr>
1.10 hubertf 615: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 616: <td align="center">Nov 2002</td>
1.93 sevan 617: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 618: </tr>
619: <tr>
1.10 hubertf 620: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 621: <td align="center">Nov 2002</td>
1.93 sevan 622: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 623: </tr>
624: <tr>
1.10 hubertf 625: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 626: <td align="center">Dec 2002</td>
1.92 sevan 627: <td>
1.93 sevan 628: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
629: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92 sevan 630: </td>
1.1 dsieger 631: </tr>
632: <tr>
633: <td>BSD/OS</td>
634: <td align="center">Dec 2003</td>
1.92 sevan 635: <td class="auto-generated"> </td>
1.1 dsieger 636: </tr>
637: <tr>
1.10 hubertf 638: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 639: <td align="center">Dec 2003</td>
1.93 sevan 640: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 641: </tr>
642: <tr>
643: <td>
1.10 hubertf 644: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 645: (Microsoft Windows Services for Unix)
646: </td>
647: <td align="center">Mar 2004</td>
1.93 sevan 648: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 649: </tr>
650: <tr>
1.10 hubertf 651: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 652: <td align="center">Oct 2004</td>
1.92 sevan 653: <td class="auto-generated"> </td>
1.1 dsieger 654: </tr>
655: <tr>
1.10 hubertf 656: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 657: <td align="center">Nov 2004</td>
1.93 sevan 658: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 659: </tr>
660: <tr>
1.10 hubertf 661: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 662: <td align="center">Apr 2007</td>
1.93 sevan 663: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 664: </tr>
1.23 wiz 665: <tr>
666: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
667: <td align="center">Sep 2010</td>
1.93 sevan 668: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 669: </tr>
1.45 obache 670: <tr>
671: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 672: <td align="center">Jan 2011</td>
1.92 sevan 673: <td class="auto-generated"> </td>
1.45 obache 674: </tr>
675: <tr>
676: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
677: <td align="center">Nov 2011</td>
1.93 sevan 678: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 679: </tr>
680: <tr>
681: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
682: <td align="center">Mar 2013</td>
1.93 sevan 683: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 684: </tr>
1.58 ryoon 685: <tr>
686: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
687: <td align="center">Jul 2013</td>
1.93 sevan 688: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58 ryoon 689: </tr>
1.104 sevan 690: <tr>
691: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
692: <td align="center">Jun 2014</td>
693: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
694: </tr>
1.1 dsieger 695: </tbody>
696: </table></div>
697: </div>
698: <br class="table-break">
699: </div>
700: </div>
1.41 asau 701: <div class="sect1">
1.1 dsieger 702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
703: <a name="overview"></a>1.2. Overview</h2></div></div></div>
704: <p>This document is divided into three parts. The first,
1.10 hubertf 705: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 706: describes how one can use one of the packages in the Package
707: Collection, either by installing a precompiled binary package,
708: or by building one's own copy using the NetBSD package system.
1.10 hubertf 709: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 710: package so it can be easily built by other NetBSD users without
711: knowing about the package's building details. The third part,
1.10 hubertf 712: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 713: is intended for those who want to understand how pkgsrc is
714: implemented.</p>
715: <p>This document is available in various formats:
1.10 hubertf 716: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 717: </div>
1.41 asau 718: <div class="sect1">
1.1 dsieger 719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
720: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 721: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
722: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 723: terminology used within this document.</p>
1.41 asau 724: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 725: <dt><span class="term">Package</span></dt>
726: <dd><p>A set of files and building instructions
727: that describe what's necessary
728: to build a certain piece of software using
729: pkgsrc. Packages are traditionally stored under
730: <code class="filename">/usr/pkgsrc</code>.</p></dd>
731: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 732: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 733: is part of the NetBSD operating system and can be bootstrapped
734: to run on non-NetBSD operating systems as well. It handles
735: building (compiling), installing, and removing of
736: packages.</p></dd>
737: <dt><span class="term">Distfile</span></dt>
738: <dd><p>This term describes the file or files that are
739: provided by the author of the piece of software to
740: distribute his work. All the changes necessary to build on
741: NetBSD are reflected in the corresponding package. Usually
742: the distfile is in the form of a compressed tar-archive,
743: but other types are possible, too. Distfiles are usually
744: stored below
745: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
746: <dt><span class="term">Port</span></dt>
747: <dd><p>This is the term used by FreeBSD and OpenBSD people
748: for what we call a package.
1.23 wiz 749: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 750: architecture.</p></dd>
751: <dt><span class="term">Precompiled/binary package</span></dt>
752: <dd>
753: <p>A set of binaries built with pkgsrc from a distfile
754: and stuffed together in a single <code class="filename">.tgz</code>
755: file so it can be installed on machines of the same
756: machine architecture without the need to
757: recompile. Packages are usually generated in
758: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 759: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 760: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 761: especially in the context of precompiled packages.</p>
762: </dd>
763: <dt><span class="term">Program</span></dt>
764: <dd><p>The piece of software to be installed which will be
765: constructed from all the files in the distfile by the
766: actions defined in the corresponding package.</p></dd>
767: </dl></div>
1.41 asau 768: <div class="sect2">
1.1 dsieger 769: <div class="titlepage"><div><div><h3 class="title">
770: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 771: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 772: <dt><span class="term">pkgsrc users</span></dt>
773: <dd>
774: <p>The
775: pkgsrc users are people who use the packages provided by pkgsrc.
776: Typically they are system administrators. The people using the
1.23 wiz 777: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
778: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 779: <p>There are two kinds of pkgsrc users: Some only want to
780: install pre-built binary packages. Others build the pkgsrc
781: packages from source, either for installing them directly or for
1.10 hubertf 782: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 783: documentation.</p>
784: </dd>
785: <dt><span class="term">package maintainers</span></dt>
786: <dd><p>A
1.10 hubertf 787: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 788: <dt><span class="term">infrastructure developers</span></dt>
789: <dd><p>These people are involved in all those files
790: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 791: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 792: too.</p></dd>
793: </dl></div>
794: </div>
795: </div>
1.41 asau 796: <div class="sect1">
1.1 dsieger 797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
798: <a name="typography"></a>1.4. Typography</h2></div></div></div>
799: <p>When giving examples for commands, shell prompts are used to
800: show if the command should/can be issued as root, or if
1.23 wiz 801: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 802: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
803: shell prompt, assuming they use the C-shell or tcsh.</p>
804: </div>
805: </div>
1.41 asau 806: <div class="part">
1.1 dsieger 807: <div class="titlepage"><div><div><h1 class="title">
808: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
809: <div class="toc">
810: <p><b>Table of Contents</b></p>
1.100 leot 811: <dl class="toc">
1.1 dsieger 812: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
813: <dd><dl>
814: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
815: <dd><dl>
1.51 asau 816: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 817: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 818: </dl></dd>
819: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
820: <dd><dl>
821: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
822: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
823: </dl></dd>
824: </dl></dd>
825: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
826: <dd><dl>
827: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
828: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
829: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
830: <dd><dl>
1.45 obache 831: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
832: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
833: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 834: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
835: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
836: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
837: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
838: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
839: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
840: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 841: </dl></dd>
842: </dl></dd>
843: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
844: <dd><dl>
845: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
846: <dd><dl>
847: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
848: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
849: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
850: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
851: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
852: <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>
853: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
854: </dl></dd>
855: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
856: <dd><dl>
857: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
858: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
859: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
860: </dl></dd>
861: </dl></dd>
862: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
863: <dd><dl>
864: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
865: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 866: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 867: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 868: <dd><dl>
1.4 rillig 869: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 870: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
871: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 872: </dl></dd>
1.4 rillig 873: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
874: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 875: </dl></dd>
876: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
877: <dd><dl>
878: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
879: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 880: </dl></dd>
881: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
882: builds)</a></span></dt>
1.1 dsieger 883: <dd><dl>
1.71 wiz 884: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
885: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
886: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
887: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 888: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
889: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 890: </dl></dd>
891: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
892: <dd><dl>
1.23 wiz 893: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
894: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 895: </dl></dd>
896: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
897: <dd><dl>
898: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 899: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
900: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
901: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
902: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
903: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
904: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
905: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
906: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
907: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 908: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 909: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
910: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
911: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
912: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
913: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
914: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
915: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 916: </dl></dd>
917: </dl>
918: </div>
1.41 asau 919: <div class="chapter">
1.1 dsieger 920: <div class="titlepage"><div><div><h2 class="title">
921: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
922: <div class="toc">
923: <p><b>Table of Contents</b></p>
1.100 leot 924: <dl class="toc">
1.1 dsieger 925: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
926: <dd><dl>
1.51 asau 927: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 928: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 929: </dl></dd>
930: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
931: <dd><dl>
932: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
933: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
934: </dl></dd>
935: </dl>
936: </div>
937: <p>Before you download and extract the files, you need to decide
938: where you want to extract them. When using pkgsrc as root user, pkgsrc
939: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
940: free to install the sources and binary packages wherever you want in
941: your filesystem, provided that the pathname does not contain white-space
942: or other characters that are interpreted specially by the shell and some
943: other programs. A safe bet is to use only letters, digits, underscores
944: and dashes.</p>
1.41 asau 945: <div class="sect1">
1.1 dsieger 946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
947: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
948: <p>Before you download any pkgsrc files, you should decide
949: whether you want the <span class="emphasis"><em>current</em></span> branch or the
950: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
951: quarterly basis from the current branch and only gets modified
952: for security updates. The names of the stable branches are built
953: from the year and the quarter, for example
1.78 snj 954: <code class="literal">2014Q3</code>.</p>
1.1 dsieger 955: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 956: want to download pkgsrc. You can get it as a tar file or via CVS.
957: Both ways are described here.</p>
1.51 asau 958: <p>Note that tar archive contains CVS working copy.
959: Thus you can switch to using CVS at any later time.</p>
1.41 asau 960: <div class="sect2">
1.1 dsieger 961: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 962: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 963: <p>The primary download location for all pkgsrc files is
1.51 asau 964: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
965: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
966: (it points to the same location).
967: There are a number of subdirectories for different purposes,
968: 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>
969: <p>The tar archive for the current branch is in the directory
970: <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.1 dsieger 971: It is autogenerated daily.</p>
1.51 asau 972: <p>To save download time we provide bzip2- and
973: xz-compressed archives which are published at
974: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
975: and
976: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
977: respectively.
978: </p>
979: <p>You can fetch the same files using FTP.</p>
1.78 snj 980: <p>The tar file for the stable branch 2014Q3 is in the
981: directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.12 weinem 982: <p>To download a pkgsrc stable tarball, run:</p>
983: <pre class="screen">
1.59 jnemeth 984: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.22 jakllsch 985: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 986: stable branch to be downloaded, for example,
1.78 snj 987: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
988: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 989: or your web browser.</p>
1.12 weinem 990: <p>Then, extract it with:</p>
1.78 snj 991: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 992: <p>This will create the directory <code class="filename">pkgsrc/</code>
993: in <code class="filename">/usr/</code> and all the package source will be
994: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
995: <p>To download pkgsrc-current, run:</p>
996: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 997: </div>
1.41 asau 998: <div class="sect2">
1.1 dsieger 999: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 1000: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
1001: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 1002: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.23 wiz 1003: </pre>
1004: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.78 snj 1005: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.23 wiz 1006: <p>This will create the directory <code class="filename">pkgsrc/</code>
1007: in your <code class="filename">/usr/</code> directory and all the package source
1008: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1009: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1010: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1011: </pre>
1.78 snj 1012: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 1013: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 1014: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 1015: </pre>
1016: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1017: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1018: or better globally in <code class="filename">/etc/profile</code>:</p>
1019: <pre class="programlisting">
1020: # set CVS remote shell command
1021: CVS_RSH=ssh
1022: export CVS_RSH
1023: </pre>
1024: <p>By default, CVS doesn't do things like most people would expect it to do.
1025: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1026: in your home directory and saving the following lines to it.
1027: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1028: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1029: <pre class="programlisting">
1030: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1031: cvs -q -z2
1.2 rillig 1032: checkout -P
1.4 rillig 1033: update -dP
1034: diff -upN
1.2 rillig 1035: rdiff -u
1.23 wiz 1036: release -d
1.2 rillig 1037: </pre>
1.1 dsieger 1038: </div>
1039: </div>
1.41 asau 1040: <div class="sect1">
1.1 dsieger 1041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1042: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1043: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1044: (which also works if you have first installed it via a tar
1045: file). It saves bandwidth and hard disk activity, compared to
1046: downloading the tar file again.</p>
1.41 asau 1047: <div class="sect2">
1.1 dsieger 1048: <div class="titlepage"><div><div><h3 class="title">
1049: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1050: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1051: <h3 class="title">Warning</h3>
1052: <p>When updating from a tar file, you first need to
1053: completely remove the old pkgsrc directory. Otherwise those
1054: files that have been removed from pkgsrc in the mean time will
1055: not be removed on your local disk, resulting in inconsistencies.
1056: When removing the old files, any changes that you have done to
1057: the pkgsrc files will be lost after updating. Therefore updating
1058: via CVS is strongly recommended.</p>
1059: </div>
1060: <p>Note that by default the distfiles and the binary packages
1061: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1062: before updating. You can also configure pkgsrc to store distfiles
1063: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1064: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1065: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1066: <p>To update pkgsrc from a tar file, download the tar file as
1067: explained above. Then, make sure that you have not made any
1068: changes to the files in the pkgsrc directory. Remove the pkgsrc
1069: directory and extract the new tar file. Done.</p>
1070: </div>
1.41 asau 1071: <div class="sect2">
1.1 dsieger 1072: <div class="titlepage"><div><div><h3 class="title">
1073: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1074: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1075: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1076: </pre>
1077: <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>
1078: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1079: </pre>
1.41 asau 1080: <div class="sect3">
1.1 dsieger 1081: <div class="titlepage"><div><div><h4 class="title">
1082: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1083: <p>When updating pkgsrc, the CVS program keeps track of the
1084: branch you selected. But if you, for whatever reason, want to
1085: switch from the stable branch to the current one, you can do it
1.23 wiz 1086: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1087: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1088: back to the stable branch, add the
1.78 snj 1089: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.1 dsieger 1090: </div>
1.41 asau 1091: <div class="sect3">
1.1 dsieger 1092: <div class="titlepage"><div><div><h4 class="title">
1093: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1094: <p>When you update pkgsrc, the CVS program will only touch
1095: those files that are registered in the CVS repository. That
1096: means that any packages that you created on your own will stay
1097: unmodified. If you change files that are managed by CVS, later
1098: updates will try to merge your changes with those that have been
1099: done by others. See the CVS manual, chapter
1.23 wiz 1100: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1101: </div>
1102: </div>
1103: </div>
1104: </div>
1.41 asau 1105: <div class="chapter">
1.1 dsieger 1106: <div class="titlepage"><div><div><h2 class="title">
1107: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1108: <div class="toc">
1109: <p><b>Table of Contents</b></p>
1.100 leot 1110: <dl class="toc">
1.1 dsieger 1111: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1112: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1113: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1114: <dd><dl>
1.45 obache 1115: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1116: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1117: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 1118: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1119: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1120: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1121: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1122: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1123: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1124: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 1125: </dl></dd>
1126: </dl>
1127: </div>
1.41 asau 1128: <div class="sect1">
1.1 dsieger 1129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1130: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1131: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.1 dsieger 1132: </div>
1.41 asau 1133: <div class="sect1">
1.1 dsieger 1134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1135: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1136: <p>pkgsrc can be bootstrapped for use in two different modes:
1137: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1138: to privileged one all programs are installed under one particular user
1.43 asau 1139: and cannot utilise privileged operations (packages don't create
1140: special users and all special file permissions like setuid are ignored).
1141: </p>
1.1 dsieger 1142: <p>Installing the bootstrap kit from source should be as simple as:</p>
1143: <pre class="screen">
1.60 asau 1144: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1145: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1146: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1147: </pre>
1.43 asau 1148: <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>
1149: <p>By default, in privileged mode pkgsrc uses
1150: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1151: where programs will be installed in,
1.1 dsieger 1152: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1153: directory where pkgsrc will do its internal bookkeeping,
1154: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1155: where packages install their persistent data.
1156: In unprivileged mode pkgsrc uses
1157: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1158: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1159: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1160: </p>
1161: <p>You can change default layout using command-line arguments.
1162: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1163: </p>
1.41 asau 1164: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1165: <h3 class="title">Note</h3>
1.10 hubertf 1166: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1167: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1168: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1169: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1170: </div>
1.43 asau 1171: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1172: <h3 class="title">Note</h3>
1173: <p>It is possible to bootstrap multiple instances of pkgsrc
1174: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1175: corresponding to the installation you're working with to build
1176: and install packages.
1177: </p>
1178: </div>
1.1 dsieger 1179: </div>
1.41 asau 1180: <div class="sect1">
1.1 dsieger 1181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1182: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.41 asau 1183: <div class="sect2">
1.1 dsieger 1184: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1185: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1186: <p>Cygwin 1.7.x and later are supported.</p>
1187: <p>You need to install minimal base packages in `Base' category
1188: plus any of compiler, gcc, gcc4, and/or clang.
1189: For gcc and gcc4, C and C++ compiler will be installed by default,
1190: but you can install Fortran compiler additionally
1191: because it will be required to use libtool.
1192: If it is not installed (or too old), Fortran compiler will be
1193: installed with pkgsrc automatically.</p>
1194: <p>As noted in
1195: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1196: su(1) command has been in Cygwin distribution, but it has never worked.
1197: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1198: </p>
1199: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1200: then pick "Run as administrator".</p></li></ul></div>
1201: </div>
1202: <div class="sect2">
1203: <div class="titlepage"><div><div><h3 class="title">
1204: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.101 sevan 1205: <p>Darwin 8.x and up are supported.</p>
1.41 asau 1206: <p>Before you start, you need to download and install
1207: the Mac OS X Developer Tools from Apple's Developer Connection.
1208: This requires (free) membership. See
1.22 jakllsch 1209: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.41 asau 1210: for details. Also, make sure you install X11 (an optional
1211: package included with the Developer Tools) if you intend
1212: to build packages that use the X11 Window System.
1213: (If you don't want or need the full Xcode GUI,
1214: download and install Command Line Tools for Xcode.)</p>
1.1 dsieger 1215: </div>
1.41 asau 1216: <div class="sect2">
1.1 dsieger 1217: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1218: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.29 dholland 1219: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1 dsieger 1220: other versions may work.</p>
1221: <p>Care should be taken so that the tools that this kit installs do not conflict
1222: with the FreeBSD userland tools. There are several steps:</p>
1.23 wiz 1223: <div class="orderedlist"><ol class="orderedlist" type="1">
1224: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1 dsieger 1225: <code class="filename">/var/db/pkg</code>. It is therefore
1226: recommended that you choose a different location (e.g.
1227: <code class="filename">/usr/pkgdb</code>) by
1228: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1229: <li class="listitem">
1.1 dsieger 1230: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1231: good idea to move them out of the way to avoid confusion, e.g.</p>
1232: <pre class="screen">
1233: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1234: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1235: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1236: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1237: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1238: </pre>
1239: </li>
1.23 wiz 1240: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1241: <code class="filename">/etc/mk.conf.example</code> file
1242: when you use the bootstrap script.</p></li>
1243: </ol></div>
1244: </div>
1.41 asau 1245: <div class="sect2">
1.1 dsieger 1246: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1247: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1248: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1249: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1250: <p> You should install ncurses (libncurses and libncurses-dev)
1251: packages.</p>
1252: </div>
1253: <div class="sect2">
1254: <div class="titlepage"><div><div><h3 class="title">
1255: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.1 dsieger 1256: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1257: providing a Unix-like environment with a tighter kernel integration than
1258: available with Cygwin. It is part of the Windows Services for Unix
1259: package, available for free for any licensed copy of Windows 2000, XP
1.10 hubertf 1260: (not including XP Home), or 2003. SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.1 dsieger 1261: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1262: are not officially supported. (The main difference in 3.0/3.1 is lack
1263: of pthreads, but other parts of libc may also be lacking.)</p>
1.24 wiz 1264: <p>Services for Unix Applications (aka SUA) is an integrated
1265: component of Windows Server 2003 R2 (5.2), Windows Vista and
1266: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1267: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1268: 6.1 (64bit) subsystems have been tested. Other versions may
1269: work as well. The Interix 5.x subsystem has not yet been tested
1270: with pkgsrc.</p>
1.41 asau 1271: <div class="sect3">
1.1 dsieger 1272: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1273: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.1 dsieger 1274: <p>At an absolute minimum, the following packages must be installed from
1275: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.41 asau 1276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1277: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1278: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1279: <li class="listitem"><p>Remote Connectivity</p></li>
1280: <li class="listitem"><p>Interix SDK</p></li>
1.1 dsieger 1281: </ul></div>
1282: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1283: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1284: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1285: pkgsrc (or from a binary package).</p>
1286: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1287: not need to be installed, but Remote Connectivity itself should be
1288: installed in order to have a working inetd.</p>
1289: <p>During installation you may be asked whether to enable setuid
1290: behavior for Interix programs, and whether to make pathnames default to
1291: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1292: enabled. (Without case-sensitivity, a large number of packages including
1293: perl will not build.)</p>
1294: <p>NOTE: Newer Windows service packs change the way binary execution
1295: works (via the Data Execution Prevention feature). In order to use
1296: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1297: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1298: must be installed. Hotfixes are available from Microsoft through a
1.14 jmcneill 1299: support contract; however, Debian Interix Port has made most Interix
1300: hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.1 dsieger 1301: <p>In addition to the hotfix noted above, it may be necessary to
1302: disable Data Execution Prevention entirely to make Interix functional.
1303: This may happen only with certain types of CPUs; the cause is not fully
1304: understood at this time. If gcc or other applications still segfault
1305: repeatedly after installing one of the hotfixes note above, the
1306: following option can be added to the appropriate "boot.ini" line on the
1307: Windows boot drive: /NoExecute=AlwaysOff
1308: (WARNING, this will disable DEP completely, which may be a security
1309: risk if applications are often run as a user in the Administrators
1310: group!)</p>
1311: </div>
1.41 asau 1312: <div class="sect3">
1.1 dsieger 1313: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1314: <a name="platform.interix-sfu-postinstall"></a>3.3.5.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.1 dsieger 1315: <p>If SFU is already installed and you wish to alter these settings to work
1316: with pkgsrc, note the following things.</p>
1.41 asau 1317: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1318: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1 dsieger 1319: Windows Services for UNIX, then click Change. In the installer, choose
1320: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.23 wiz 1321: <li class="listitem">
1.1 dsieger 1322: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1323: change the following registry key:</p>
1324: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1325: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1326: </li>
1.23 wiz 1327: <li class="listitem">
1.1 dsieger 1328: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1329: following registry key:</p>
1330: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1331: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1332: </li>
1333: </ul></div>
1334: </div>
1.41 asau 1335: <div class="sect3">
1.1 dsieger 1336: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1337: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.1 dsieger 1338: <p>The package manager (either the pkgsrc "su" user, or the user
1339: running "pkg_add") must be a member of the local Administrators
1340: group. Such a user must also be used to run the bootstrap. This is
1341: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1342: <p>The package manager should use a umask of 002. "make install" will
1343: automatically complain if this is not the case. This ensures that
1344: directories written in /var/db/pkg are Administrators-group writeable.</p>
1345: <p>The popular Interix binary packages from http://www.interopsystems.com/
1346: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1347: NOT be used in conjunction with pkgsrc. If you choose to use them at
1348: the same time as the pkgsrc packages, ensure that you use the proper
1349: pkg_* tools for each type of binary package.</p>
1350: <p>The TERM setting used for DOS-type console windows (including those
1351: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1352: don't have a termcap/terminfo entry for it, but the following .termcap
1353: entry provides adequate emulation in most cases:</p>
1354: <pre class="programlisting">
1355: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1356: </pre>
1357: </div>
1.41 asau 1358: <div class="sect3">
1.1 dsieger 1359: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1360: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.1 dsieger 1361: <p>Though Interix suffices as a familiar and flexible substitute
1362: for a full Unix-like platform, it has some drawbacks that should
1363: be noted for those desiring to make the most of Interix.</p>
1.41 asau 1364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1365: <li class="listitem">
1.1 dsieger 1366: <p><span class="strong"><strong>X11:</strong></span></p>
1367: <p>Interix comes with the standard set of X11R6 client libraries,
1368: and can run X11 based applications, but it does
1369: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.10 hubertf 1370: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1371: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1 dsieger 1372: (available in a trimmed version for Interix from Interop Systems as the
1.10 hubertf 1373: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1 dsieger 1374: and the free X11 server included with
1.10 hubertf 1375: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1 dsieger 1376: </li>
1.23 wiz 1377: <li class="listitem">
1.1 dsieger 1378: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1379: <p>Because Interix runs in a completely different NT subsystem from
1380: Win32 applications, it does not currently support various X11
1381: protocol extensions for acceleration (such as MIT-SHM or DGA).
1382: Most interactive applications to a local X server will run
1383: reasonably fast, but full motion video and other graphics
1384: intensive applications may require a faster-than-expected CPU.</p>
1385: </li>
1.23 wiz 1386: <li class="listitem">
1.1 dsieger 1387: <p><span class="strong"><strong>Audio:</strong></span></p>
1388: <p>Interix has no native support for audio output. For audio
1.10 hubertf 1389: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1 dsieger 1390: audio system on Interix. Unlike on most platforms, the
1.79 snj 1391: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.10 hubertf 1392: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1 dsieger 1393: server component. To output audio via an Interix host, the
1.79 snj 1394: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.1 dsieger 1395: must also be installed.</p>
1396: </li>
1.23 wiz 1397: <li class="listitem">
1.1 dsieger 1398: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1399: <p>Direct device access is not currently supported in Interix, so it
1400: is not currently possible to access CD/DVD drives, USB devices,
1401: or SCSI devices through non-filesystem means. Among other things,
1402: this makes it impossible to use Interix directly for CD/DVD
1403: burning.</p>
1404: </li>
1.23 wiz 1405: <li class="listitem">
1.1 dsieger 1406: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1407: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1408: drives are also not directly accessible in Interix. However,
1409: support is in work to make tape drive access possible by using
1410: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1411: esound server).</p>
1412: </li>
1413: </ul></div>
1414: </div>
1.41 asau 1415: <div class="sect3">
1.1 dsieger 1416: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1417: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.1 dsieger 1418: <p>It is not necessary, in general, to have a "root" user on the
1419: Windows system; any member of the local Administrators group will
1420: suffice. However, some packages currently assume that the user
1421: named "root" is the privileged user. To accommodate these, you
1422: may create such a user; make sure it is in the local group
1423: Administrators (or your language equivalent).</p>
1.10 hubertf 1424: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1 dsieger 1425: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1426: time being, install packages as the local Administrator (or
1427: your language equivalent), or run the following command after
1428: installing a package to work around the issue:</p>
1429: <pre class="screen">
1430: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1431: </pre>
1432: </div>
1433: </div>
1.41 asau 1434: <div class="sect2">
1.1 dsieger 1435: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1436: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.1 dsieger 1437: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1438: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1439: according to your preference. If you do not have a license for the MIPSpro
1.10 hubertf 1440: compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.1 dsieger 1441: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.79 snj 1442: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.1 dsieger 1443: etc.</p>
1444: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1445: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1446: you start out using "abi=n32", that's what all your packages will be built
1447: with.</p>
1448: <p>Therefore, please make sure that you have no conflicting
1449: <code class="varname">CFLAGS</code> in your environment or the
1.10 hubertf 1450: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1451: try to link n32 object files with lib64 or vice versa. Check your
1452: <code class="filename">/etc/compiler.defaults</code>!</p>
1453: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1454: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1455: as it appears that IRIX linker occasionally runs into issues when trying to
1456: link over a network-mounted file system.</p>
1457: <p>The bootstrapping process should set all the right options for programs such
1458: as imake(1), but you may want to set some options depending on your local
1459: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1460: course, your compiler's man pages for details.</p>
1461: <p>If you are using SGI's MIPSPro compiler, please set
1462:
1463: </p>
1464: <pre class="programlisting">
1465: PKGSRC_COMPILER= mipspro
1466: </pre>
1467: <p>
1468:
1.10 hubertf 1469: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1470: are using gcc and may end up passing invalid flags to the compiler. Note that
1471: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1472: default.</p>
1473: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1474: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1475: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1476: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1477: '--preserve-path' flag.</p>
1478: </div>
1.41 asau 1479: <div class="sect2">
1.1 dsieger 1480: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1481: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.1 dsieger 1482: <p>Some versions of Linux (for example Debian GNU/Linux) need
1483: either libtermcap or libcurses (libncurses). Installing the
1484: distributions libncurses-dev package (or equivalent) should fix
1485: the problem.</p>
1486: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1487: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1488: i386 have been tested.</p>
1489: <p>To bootstrap using icc, assuming the default icc installation
1490: directory:</p>
1491: <pre class="programlisting">
1.31 wiz 1492: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1 dsieger 1493: </pre>
1.41 asau 1494: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1495: <h3 class="title">Note</h3>
1.31 wiz 1496: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1497: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1498: <p>For icc 10.1 neither of these appears to be necessary.</p>
1499: </div>
1500: <p>Use a value for ICCBASE that corresponds to the directory
1501: where icc is installed. After bootstrapping, set
1502: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30 wiz 1503: <pre class="programlisting">
1.31 wiz 1504: ICCBASE= /opt/intel/cc/10.1.008
1.1 dsieger 1505: </pre>
1.31 wiz 1506: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1507: <code class="filename">/opt/intel_cc_80</code>. This is the default
1508: install directory for icc 8.0. If you are using a more recent
1509: version, be sure to set the correct path explicitly.
1510: </p>
1.1 dsieger 1511: <p>pkgsrc uses the static linking method of the runtime libraries
1512: provided by icc, so binaries can be run on other systems which do not
1513: have the shared libraries installed.</p>
1514: <p>Libtool, however, extracts a list of libraries from the
1.79 snj 1515: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.1 dsieger 1516: records it, throwing away the -Bstatic and -Bdynamic options
1517: interspersed between the libraries. This means that
1518: libtool-linked C++ shared libraries will have a runtime
1519: dependency on the icc libraries until this is fixed in
1520: libtool.</p>
1521: </div>
1.41 asau 1522: <div class="sect2">
1.1 dsieger 1523: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1524: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.57 bsiegert 1525: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1526: Older versions might also work. Releases before #10 are not
1527: supported.</p>
1528: <p>The package tools of the (older) native ports tree,
1529: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1530: have the same names as the ones used by pkgsrc. Care should be taken
1531: that the right tools are used. When installing packages from source,
1532: use the <code class="filename">bmake</code> command for pkgsrc and
1533: <code class="filename">mmake</code> for MirPorts.</p>
1534: <p>pkgsrc and MirPorts use the same location for the package
1535: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1536: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1537: tree is self-contained. This is also the default setting used in the
1538: binary package builds.</p>
1539: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1540: server. The bootstrap kit there already contains the
1541: <span class="command"><strong>pkgin</strong></span> package manager. See the
1542: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1543: page for more details.</p>
1544: </div>
1545: <div class="sect2">
1546: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1547: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.29 dholland 1548: <p>OpenBSD 5.1 has been tested and supported,
1549: other versions may work.</p>
1.1 dsieger 1550: <p>Care should be taken so that the tools that this kit installs do not conflict
1551: with the OpenBSD userland tools. There are several steps:</p>
1.23 wiz 1552: <div class="orderedlist"><ol class="orderedlist" type="1">
1553: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1 dsieger 1554: <code class="filename">/var/db/pkg</code>. It is therefore
1555: recommended that you choose a different location (e.g.
1556: <code class="filename">/usr/pkgdb</code>) by
1557: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1558: <li class="listitem">
1.1 dsieger 1559: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1560: good idea to move them out of the way to avoid confusion, e.g.</p>
1561: <pre class="screen">
1562: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1563: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1564: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1565: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1566: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1567: </pre>
1568: </li>
1.23 wiz 1569: <li class="listitem">
1.10 hubertf 1570: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1571: <code class="filename">/etc/mk.conf.example</code> file
1572: when you use the bootstrap script. OpenBSD's make program uses
1.10 hubertf 1573: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1574: as well. You can work around this by enclosing all the pkgsrc-specific parts
1575: of the file with:</p>
1576: <pre class="programlisting">
1577: .ifdef BSD_PKG_MK
1578: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1579: .else
1580: # OpenBSD stuff
1581: .endif
1582: </pre>
1583: </li>
1584: </ol></div>
1585: </div>
1.41 asau 1586: <div class="sect2">
1.1 dsieger 1587: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1588: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.35 wiz 1589: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1590: You will need a working C compiler. Both gcc 4.5.3 and
1.1 dsieger 1591: Sun WorkShop 5 have been tested.</p>
1592: <p>The following packages are required on Solaris 8 for the bootstrap
1593: process and to build packages.</p>
1.41 asau 1594: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1595: <li class="listitem"><p>SUNWsprot</p></li>
1596: <li class="listitem"><p>SUNWarc</p></li>
1597: <li class="listitem"><p>SUNWbtool</p></li>
1598: <li class="listitem"><p>SUNWtoo</p></li>
1599: <li class="listitem"><p>SUNWlibm</p></li>
1.1 dsieger 1600: </ul></div>
1601: <p>Please note that the use of GNU binutils on Solaris is
1602: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1603: <p>Whichever compiler you use, please ensure the compiler tools and
1604: your $prefix are in your <code class="varname">PATH</code>. This includes
1605: <code class="filename">/usr/ccs/{bin,lib}</code>
1606: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.41 asau 1607: <div class="sect3">
1.1 dsieger 1608: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1609: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.1 dsieger 1610: <p>It makes life much simpler if you only use the same gcc consistently
1611: for building all packages.</p>
1612: <p>It is recommended that an external gcc be used only for bootstrapping,
1613: then either build gcc from
1.79 snj 1614: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.1 dsieger 1615: package, then remove gcc used during bootstrapping.</p>
1.10 hubertf 1616: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.1 dsieger 1617: </div>
1.41 asau 1618: <div class="sect3">
1.1 dsieger 1619: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1620: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.1 dsieger 1621: <p>You will need at least the following packages installed (from WorkShop
1622: 5.0)</p>
1.41 asau 1623: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1624: <li class="listitem"><p>SPROcc
1.1 dsieger 1625: - Sun WorkShop Compiler C 5.0</p></li>
1.23 wiz 1626: <li class="listitem"><p>SPROcpl
1.1 dsieger 1627: - Sun WorkShop Compiler C++ 5.0</p></li>
1.23 wiz 1628: <li class="listitem"><p>SPROild
1.1 dsieger 1629: - Sun WorkShop Incremental Linker</p></li>
1.23 wiz 1630: <li class="listitem"><p>SPROlang
1.1 dsieger 1631: - Sun WorkShop Compilers common components</p></li>
1632: </ul></div>
1633: <p>You should set the following variables in your
1.10 hubertf 1634: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1635: <pre class="programlisting">
1636: CC= cc
1637: CXX= CC
1638: CPP= cc -E
1639: CXXCPP= CC -E
1640: </pre>
1.41 asau 1641: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1642: <h3 class="title">Note</h3>
1643: <p>The <code class="varname">CPP</code> setting might break some
1644: packages that use the C preprocessor for processing things other
1645: than C source code.</p>
1646: </div>
1647: </div>
1.41 asau 1648: <div class="sect3">
1.1 dsieger 1649: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1650: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.1 dsieger 1651: <p>To build 64-bit packages, you just need to have the
1.10 hubertf 1652: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1653: <pre class="programlisting">
1654: PKGSRC_COMPILER= sunpro
1655: ABI= 64
1656: </pre>
1.41 asau 1657: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1658: <h3 class="title">Note</h3>
1659: <p>This setting has been tested for the SPARC
1660: architecture. Intel and AMD machines need some more
1661: work.</p>
1662: </div>
1663: </div>
1.41 asau 1664: <div class="sect3">
1.1 dsieger 1665: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1666: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.10 hubertf 1667: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1 dsieger 1668: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1669: The workaround is to use another shell for the configure
1.79 snj 1670: scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.10 hubertf 1671: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1672: <pre class="programlisting">
1673: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1674: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1675: </pre>
1.79 snj 1676: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.1 dsieger 1677: </div>
1678: </div>
1679: </div>
1680: </div>
1.41 asau 1681: <div class="chapter">
1.1 dsieger 1682: <div class="titlepage"><div><div><h2 class="title">
1683: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1684: <div class="toc">
1685: <p><b>Table of Contents</b></p>
1.100 leot 1686: <dl class="toc">
1.1 dsieger 1687: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1688: <dd><dl>
1689: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1690: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1691: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1692: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1693: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1694: <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>
1695: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1696: </dl></dd>
1697: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1698: <dd><dl>
1699: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1700: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1701: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1702: </dl></dd>
1703: </dl>
1704: </div>
1705: <p>Basically, there are two ways of using pkgsrc. The first
1706: is to only install the package tools and to use binary packages
1.23 wiz 1707: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1708: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1709: of pkgsrc, too. Then you are able to build your own packages,
1710: and you can still use binary packages from someone else.</p>
1.41 asau 1711: <div class="sect1">
1.1 dsieger 1712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1713: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1714: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1715: server and its mirrors, there are collections of binary packages,
1716: ready to be installed. These binary packages have been built using the
1717: default settings for the directories, that is:</p>
1.41 asau 1718: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1719: <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>
1720: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1721: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1722: </ul></div>
1723: <p>If you cannot use these directories for whatever reasons (maybe
1724: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1725: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1726: <div class="sect2">
1.1 dsieger 1727: <div class="titlepage"><div><div><h3 class="title">
1728: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1729: <p>To install binary packages, you first need to know from where
1730: to get them. The first place where you should look is on the main
1.10 hubertf 1731: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1732: <p>This directory contains binary packages for multiple
1733: platforms. First, select your operating system. (Ignore the
1734: directories with version numbers attached to it, they just exist for
1735: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1736: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1737: <p>In this directory, you often find a file called
1738: <code class="filename">bootstrap.tar.gz</code> which contains the package
1739: management tools. If the file is missing, it is likely that your
1740: operating system already provides those tools. Download the file and
1741: extract it in the <code class="filename">/</code> directory. It will create
1742: the directories <code class="filename">/usr/pkg</code> (containing the tools
1743: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1744: (the database of installed packages).</p>
1.1 dsieger 1745: </div>
1.41 asau 1746: <div class="sect2">
1.1 dsieger 1747: <div class="titlepage"><div><div><h3 class="title">
1748: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1749: <p>In the directory from the last section, there is a
1.85 wiz 1750: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1751: binary packages that are available for the platform, excluding those
1752: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1753: medium you are using).</p>
1.9 rillig 1754: <p>To install packages directly from an FTP or HTTP server, run
1755: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1756: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1757: <pre class="screen">
1758: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85 wiz 1759: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.9 rillig 1760: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1761: </pre>
1762: <p>Instead of URLs, you can also use local paths, for example if
1763: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1764: repository. If you want to install packages from multiple sources,
1765: you can separate them by a semicolon in
1766: <code class="varname">PKG_PATH</code>.</p>
1767: <p>After these preparations, installing a package is very
1768: easy:</p>
1769: <pre class="screen">
1770: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1771: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1772: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1773: </pre>
1.1 dsieger 1774: <p>Note that any prerequisite packages needed to run the
1775: package in question will be installed, too, assuming they are
1776: present where you install from.</p>
1.23 wiz 1777: <p>Adding packages might install vulnerable packages.
1778: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1779: regularly, especially after installing new packages, and verify
1780: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1781: <p>After you've installed packages, be sure to have
1782: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1783: <code class="varname">PATH</code> so you can actually start the just
1784: installed program.</p>
1785: </div>
1.41 asau 1786: <div class="sect2">
1.1 dsieger 1787: <div class="titlepage"><div><div><h3 class="title">
1788: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1789: <p>To deinstall a package, it does not matter whether it was
1790: installed from source code or from a binary package. The
1.10 hubertf 1791: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1792: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1793: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1794: name can be given with or without version number. Wildcards can
1795: also be used to deinstall a set of packages, for example
1796: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1797: so that the shell does not expand them before
1798: <code class="literal">pkg_delete</code> sees them.</p>
1799: <p>The <code class="option">-r</code> option is very powerful: it
1800: removes all the packages that require the package in question
1801: and then removes the package itself. For example:
1802:
1803: </p>
1804: <pre class="screen">
1805: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1806: </pre>
1807: <p>
1808:
1809: will remove jpeg and all the packages that used it; this allows
1810: upgrading the jpeg package.</p>
1811: </div>
1.41 asau 1812: <div class="sect2">
1.1 dsieger 1813: <div class="titlepage"><div><div><h3 class="title">
1814: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1815: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1816: installed packages or binary package files.</p>
1817: </div>
1.41 asau 1818: <div class="sect2">
1.1 dsieger 1819: <div class="titlepage"><div><div><h3 class="title">
1820: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1821: <p>
1822: The NetBSD Security-Officer and Packages Groups maintain a list of
1823: known security vulnerabilities to packages which are (or have been)
1824: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1825: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1 dsieger 1826: </p>
1827: <p>
1.22 jakllsch 1828: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1829: this list can be downloaded
1830: automatically, and a security audit of all packages installed on a system
1831: can take place.
1832: </p>
1833: <p>
1.22 jakllsch 1834: There are two components to auditing. The first
1835: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1836: is for downloading
1.1 dsieger 1837: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1838: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1839: installed packages are vulnerable. If a package is vulnerable, you
1840: will see output similar to the following:
1841: </p>
1842: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1843: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1844: <p>
1.22 jakllsch 1845: You may wish to have the
1.10 hubertf 1846: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1847: file downloaded daily so that
1848: it remains current. This may be done by adding an appropriate entry
1.79 snj 1849: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1850: </p>
1851: <pre class="screen">
1852: # download vulnerabilities file
1853: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1854: </pre>
1855: <p>
1856: will update the vulnerability list every day at 3AM. You may wish to do
1857: this more often than once a day.
1858:
1859: In addition, you may wish to run the package audit from the daily
1860: security script. This may be accomplished by adding the following
1861: line to <code class="filename">/etc/security.local</code>:
1862: </p>
1863: <pre class="screen">
1864: /usr/sbin/pkg_admin audit
1865: </pre>
1866: <p>
1.1 dsieger 1867: </p>
1868: </div>
1.41 asau 1869: <div class="sect2">
1.1 dsieger 1870: <div class="titlepage"><div><div><h3 class="title">
1871: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1872: <p>
1.79 snj 1873: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1874: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1875: argument to check if your packages are up-to-date, e.g.
1876: </p>
1877: <pre class="screen">
1878: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1879: ...
1880: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1881: </pre>
1.10 hubertf 1882: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1883: package on your system and rebuild any dependencies.
1884: </p>
1885: </div>
1.41 asau 1886: <div class="sect2">
1.1 dsieger 1887: <div class="titlepage"><div><div><h3 class="title">
1888: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1889: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1890: administrative functions on the package system.</p>
1891: </div>
1892: </div>
1.41 asau 1893: <div class="sect1">
1.1 dsieger 1894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1895: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1896: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1897: directory now contains a set of packages, organized into
1898: categories. You can browse the online index of packages, or run
1.10 hubertf 1899: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1900: directory to build local <code class="filename">README.html</code> files for
1.79 snj 1901: all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1902: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1903: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1904: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1905: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1906: different <code class="varname">LOCALBASE</code> definitions on the same
1907: system (inside a chroot is an exception). </p>
1908: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1909: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1910: instructions how to create your own packages.</p>
1.41 asau 1911: <div class="sect2">
1.1 dsieger 1912: <div class="titlepage"><div><div><h3 class="title">
1913: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1914: <p>To build packages from source, you need a working C
1915: compiler. On NetBSD, you need to install the
1.23 wiz 1916: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1917: sets. If you want to build X11-related packages, the
1.23 wiz 1918: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1919: sets are required, too.</p>
1920: </div>
1.41 asau 1921: <div class="sect2">
1.1 dsieger 1922: <div class="titlepage"><div><div><h3 class="title">
1923: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1924: <p>The first step for building a package is downloading the
1925: distfiles (i.e. the unmodified source). If they have not yet been
1926: downloaded, pkgsrc will fetch them automatically.</p>
1927: <p>If you have all files that you need in the
1928: <code class="filename">distfiles</code> directory,
1929: you don't need to connect. If the distfiles are on CD-ROM, you can
1930: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1931: </p>
1932: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1933: <p>
1.10 hubertf 1934: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1935: <p>By default a list of distribution sites will be randomly
1936: intermixed to prevent huge load on servers which holding popular
1937: packages (for example, SourceForge.net mirrors). Thus, every
1938: time when you need to fetch yet another distfile all the mirrors
1939: will be tried in new (random) order. You can turn this feature
1940: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1941: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1942: <p>You can overwrite some of the major distribution sites to
1943: fit to sites that are close to your own. By setting one or two
1944: variables you can modify the order in which the master sites are
1945: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1946: delimited list of domain suffixes.
1947: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1948: contains a whitespace delimited list of regular expressions. It
1949: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1950: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1951: some examples. This may save some of your bandwidth and
1952: time.</p>
1953: <p>You can change these settings either in your shell's environment, or,
1954: if you want to keep the settings, by editing the
1.10 hubertf 1955: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1956: and adding the definitions there.</p>
1957: <p>
1958: If a package depends on many other packages (such as
1.79 snj 1959: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.1 dsieger 1960: alternate between periods of
1961: downloading source, and compiling. To ensure you have all the source
1962: downloaded initially you can run the command:
1963: </p>
1964: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1965: <p>
1966: which will output and run a set of shell commands to fetch the
1967: necessary files into the <code class="filename">distfiles</code> directory. You can
1968: also choose to download the files manually.
1969: </p>
1970: </div>
1.41 asau 1971: <div class="sect2">
1.1 dsieger 1972: <div class="titlepage"><div><div><h3 class="title">
1973: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1974: <p>
1975: Once the software has downloaded, any patches will be applied, then it
1976: will be compiled for you. This may take some time depending on your
1977: computer, and how many other packages the software depends on and their
1978: compile time.
1979: </p>
1.41 asau 1980: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1981: <h3 class="title">Note</h3>
1982: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1983: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1984: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1985: </div>
1986: <p>For example, type</p>
1987: <pre class="screen">
1988: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1989: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1990: </pre>
1991: <p>at the shell prompt to build the various components of the
1992: package.</p>
1993: <p>The next stage is to actually install the newly compiled
1994: program onto your system. Do this by entering:
1995:
1996: </p>
1997: <pre class="screen">
1998: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1999: </pre>
2000: <p>
2001:
2002: while you are still in the directory for whatever package you
2003: are installing.</p>
2004: <p>Installing the package on your system may require you to
2005: be root. However, pkgsrc has a
2006: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2007: to only become root for the actual installation step.</p>
2008: <p>That's it, the software should now be installed and setup for use.
2009: You can now enter:
2010:
2011: </p>
2012: <pre class="screen">
2013: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2014: </pre>
2015: <p>
2016:
2017: to remove the compiled files in the work directory, as you shouldn't need
2018: them any more. If other packages were also added to your system
2019: (dependencies) to allow your program to compile, you can tidy these up
2020: also with the command:</p>
2021: <pre class="screen">
2022: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2023: </pre>
2024: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 2025: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 2026: <p>The program is installed under the default root of the
2027: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2028: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2029: variable in your environment, and it will use that value as the
2030: root of your packages tree. So, to use
2031: <code class="filename">/usr/local</code>, set
2032: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2033: Please note that you should use a directory which is dedicated to
2034: packages and not shared with other programs (i.e., do not try and
2035: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2036: to add any of your own files or directories (such as
2037: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2038: <code class="filename">pkgsrc/</code>) below the
2039: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2040: conflicts between programs and other files installed by the
2041: package system and whatever else may have been installed
2042: there.</p>
1.10 hubertf 2043: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2044: alter some configuration options at build time. Have a look at
2045: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2046: of what will be set there by default. Environment variables such
2047: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 2048: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2049: set them each time you want to use pkgsrc.</p>
1.23 wiz 2050: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2051: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 2052: or being installed. This may be for debugging purposes, or out of
2053: simple curiosity. A number of utility values have been added to
2054: help with this.</p>
1.23 wiz 2055: <div class="orderedlist"><ol class="orderedlist" type="1">
2056: <li class="listitem">
1.79 snj 2057: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 2058: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2059: information will be displayed. For example,</p>
2060: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2061: <p>will show all the commands that are invoked, up to and
1.23 wiz 2062: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 2063: </li>
1.23 wiz 2064: <li class="listitem">
1.79 snj 2065: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2066: definition, then the <code class="varname">VARNAME</code> definition
2067: should be used, in conjunction with the show-var
1.79 snj 2068: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2069: variable <code class="varname">LOCALBASE</code>:</p>
2070: <pre class="screen">
2071: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2072: /usr/pkg
2073: <code class="prompt">%</code>
2074: </pre>
2075: </li>
2076: </ol></div>
2077: <p>If you want to install a binary package that you've either
2078: created yourself (see next section), that you put into
2079: pkgsrc/packages manually or that is located on a remote FTP
2080: server, you can use the "bin-install" target. This target will
1.79 snj 2081: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 2082: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 2083: sites searched is kept in the variable
2084: <code class="varname">BINPKG_SITES</code>, which defaults to
1.79 snj 2085: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 2086: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2087: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2088: details.</p>
2089: <p>A final word of warning: If you set up a system that has a
2090: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2091: set that before any packages are installed, as you cannot use
2092: several directories for the same purpose. Doing so will result in
2093: pkgsrc not being able to properly detect your installed packages,
2094: and fail miserably. Note also that precompiled binary packages are
2095: usually built with the default <code class="varname">LOCALBASE</code> of
2096: <code class="filename">/usr/pkg</code>, and that you should
2097: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2098: <code class="varname">LOCALBASE</code>.</p>
2099: </div>
2100: </div>
2101: </div>
1.41 asau 2102: <div class="chapter">
1.1 dsieger 2103: <div class="titlepage"><div><div><h2 class="title">
2104: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2105: <div class="toc">
2106: <p><b>Table of Contents</b></p>
1.100 leot 2107: <dl class="toc">
1.1 dsieger 2108: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2109: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 2110: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 2111: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2112: <dd><dl>
1.4 rillig 2113: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 2114: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2115: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 2116: </dl></dd>
1.4 rillig 2117: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2118: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2119: </dl>
2120: </div>
1.4 rillig 2121: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2122: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2123: that file depends on the installation. On NetBSD, when you use
1.79 snj 2124: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 2125: <code class="filename">/etc/</code>. In all other cases the default location is
2126: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2127: bootstrap program to install the binary packages.</p>
2128: <p>During the bootstrap, an example configuration file is created. To
2129: use that, you have to create the directory
2130: <code class="filename">${PREFIX}/etc</code> and copy the example file
2131: there.</p>
2132: <p>The format of the configuration file is that of the usual
2133: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2134: is done by setting variables in this file. Note that you can define all
2135: kinds of variables, and no special error checking (for example for
2136: spelling mistakes) takes place, so you have to try it out to see if it
2137: works.</p>
1.41 asau 2138: <div class="sect1">
1.1 dsieger 2139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2140: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2141: <p>In this section, you can find some variables that apply to all
2142: pkgsrc packages. A complete list of the variables that can be
2143: configured by the user is available in
2144: <code class="filename">mk/defaults/mk.conf</code>, together with some
2145: comments that describe each variable's intent.</p>
1.41 asau 2146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2147: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 2148: packages will be installed. The default is
2149: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2150: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 2151: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2152: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 2153: installed. The default is
2154: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 2155: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 2156: X11 is installed on the system. The default is
1.84 wiz 2157: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 2158: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 2159: downloaded copies of the original source distributions used
2160: for building pkgsrc packages. The default is
2161: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 2162: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 2163: database about installed packages is stored. The default is
2164: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 2165: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 2166: If set, override the packages'
2167: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 2168: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 2169: Backup location(s) for distribution files and patch files
2170: if not found locally or in
2171: <code class="filename">${MASTER_SITES}</code> or
2172: <code class="filename">${PATCH_SITES}</code> respectively.
2173: The defaults are
1.25 spz 2174: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 2175: and
2176: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 2177: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 2178: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2179: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 2180: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2181: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2182: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 2183: List of acceptable licenses. License names are case-sensitive.
2184: Whenever you try to build a package whose license is not in this
2185: list, you will get an error message. If the license condition is
2186: simple enough, the error message will include specific
2187: instructions on how to change this variable.</p></li>
1.1 dsieger 2188: </ul></div>
2189: </div>
1.41 asau 2190: <div class="sect1">
1.1 dsieger 2191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2192: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 2193: <p>
1.1 dsieger 2194: </p>
1.41 asau 2195: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2196: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 2197: directory for the binary packages. The default is
2198: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 2199: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 2200: The top level directory where, if defined, the separate
2201: working directories will get created, and symbolically
2202: linked to from <code class="filename">${WRKDIR}</code> (see below).
2203: This is useful for building packages on several
2204: architectures, then <code class="filename">${PKGSRCDIR}</code>
2205: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2206: is local to every architecture. (It should be noted that
2207: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 2208: — it is an internal definition which refers to the
1.1 dsieger 2209: root of the pkgsrc tree. It is possible to have many
2210: pkgsrc tree instances.)</p></li>
1.23 wiz 2211: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 2212: Directory for local patches that aren't part of pkgsrc.
1.108 rillig 2213: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 2214: information.</p></li>
1.23 wiz 2215: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 2216: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2217: BSD-style Makefile. If this is not set,
2218: <code class="varname">MAKECONF</code> is set to
2219: <code class="filename">/dev/null</code> to avoid picking up
2220: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 2221: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 2222: By default, dependencies are only installed, and no binary
2223: package is created for them. You can set this variable to
1.66 asau 2224: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 2225: packages after installing dependencies. Please note that the
1.84 wiz 2226: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 2227: <code class="literal">yes</code> to preserve binary packages when
2228: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 2229: </ul></div>
2230: </div>
1.41 asau 2231: <div class="sect1">
1.1 dsieger 2232: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 2233: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.107 jnemeth 2234: <p>Packages have to support installation into a
1.4 rillig 2235: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2236: to be built, before the actual filesystem is touched. DESTDIR
2237: support exists in two variations:</p>
1.41 asau 2238: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2239: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 2240: installation and packaging is still run as root.</p></li>
2241: <li class="listitem"><p>Full DESTDIR support can run the complete
2242: build, installation and packaging as normal user. Root
2243: privileges are only needed to add packages.</p></li>
2244: </ul></div>
1.4 rillig 2245: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2246: clean</code></strong> needs to be run as root.</p>
1.17 imil 2247: <p>Considering the <code class="filename">foo/bar</code> package,
2248: DESTDIR full support can be tested using the following commands
2249:
2250: </p>
2251: <pre class="programlisting">
2252: <code class="prompt">$</code> id
2253: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2254: <code class="prompt">$</code> mkdir $HOME/packages
2255: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2256: </pre>
2257: <p>
2258:
2259: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2260: should be needed
2261:
2262: </p>
2263: <pre class="programlisting">
1.66 asau 2264: <code class="prompt">$</code> make stage-install
1.17 imil 2265: </pre>
2266: <p>
2267:
2268: Create a package without root privileges
2269:
2270: </p>
2271: <pre class="programlisting">
1.66 asau 2272: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 2273: </pre>
2274: <p>
2275:
2276: For the following command, you must be able to gain root
1.79 snj 2277: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 2278:
2279: </p>
2280: <pre class="programlisting">
1.66 asau 2281: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 2282: </pre>
2283: <p>
2284:
2285: Then, as a simple user
2286:
2287: </p>
2288: <pre class="programlisting">
2289: <code class="prompt">$</code> make clean
2290: </pre>
2291: <p>
2292:
2293: </p>
1.4 rillig 2294: </div>
1.41 asau 2295: <div class="sect1">
1.4 rillig 2296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2297: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 2298: <div class="sect2">
1.1 dsieger 2299: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2300: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2301: <p>By default, pkgsrc will use GCC to build packages. This may be
2302: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 2303: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2304: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2305: <dd>
2306: <p>This is a list of values specifying the chain of
2307: compilers to invoke when building packages. Valid values
2308: are:</p>
1.41 asau 2309: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 2310: <li class="listitem"><p><code class="varname">ccc</code>:
2311: Compaq C Compilers (Tru64)</p></li>
2312: <li class="listitem"><p><code class="varname">ccache</code>:
2313: compiler cache (chainable)</p></li>
2314: <li class="listitem"><p><code class="varname">clang</code>:
2315: Clang C and Objective-C compiler</p></li>
1.23 wiz 2316: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 2317: distributed C/C++ (chainable)</p></li>
1.66 asau 2318: <li class="listitem"><p><code class="varname">f2c</code>:
2319: Fortran 77 to C compiler (chainable)</p></li>
2320: <li class="listitem"><p><code class="varname">icc</code>:
2321: Intel C++ Compiler (Linux)</p></li>
2322: <li class="listitem"><p><code class="varname">ido</code>:
2323: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 2324: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 2325: GNU C/C++ Compiler</p></li>
1.66 asau 2326: <li class="listitem"><p><code class="varname">hp</code>:
2327: HP-UX C/aC++ compilers</p></li>
1.23 wiz 2328: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2329: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 2330: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 2331: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 2332: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 2333: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 2334: <li class="listitem"><p><code class="varname">xlc</code>:
2335: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 2336: </ul></div>
2337: <p>The default is
1.23 wiz 2338: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 2339: <code class="varname">ccache</code> and/or
2340: <code class="varname">distcc</code> with an appropriate
2341: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 2342: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 2343: variable should always be terminated with a value for
2344: a real compiler. Note that only one real compiler
1.23 wiz 2345: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 2346: is not allowed).</p>
2347: </dd>
2348: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2349: <dd><p>This specifies the minimum version of GCC to use
2350: when building packages. If the system GCC doesn't
2351: satisfy this requirement, then pkgsrc will build and
2352: install one of the GCC packages to use instead.</p></dd>
2353: </dl></div>
2354: </div>
1.41 asau 2355: <div class="sect2">
1.1 dsieger 2356: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2357: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2358: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2359: please make sure to use the <code class="literal">+=</code> operator
2360: instead of the <code class="literal">=</code> operator:</p>
2361: <pre class="programlisting">
2362: CFLAGS+= -your -flags
2363: </pre>
2364: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2365: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2366: need to add their own flags. You may want to take a look
1.79 snj 2367: at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 2368: package if you're interested in optimization specifically
2369: for the current CPU. </p>
1.1 dsieger 2370: </div>
1.41 asau 2371: <div class="sect2">
1.1 dsieger 2372: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2373: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2374: <p>If you want to pass flags to the linker, both in the configure
2375: step and the build step, you can do this in two ways. Either set
2376: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2377: between the two is that <code class="varname">LIBS</code> will be appended to
2378: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2379: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2380: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2381: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2382: <code class="varname">CFLAGS</code>, if you do not wish to override these
2383: settings, use the <code class="literal">+=</code> operator:</p>
2384: <pre class="programlisting">
2385: LDFLAGS+= -your -linkerflags
2386: </pre>
2387: </div>
2388: </div>
1.41 asau 2389: <div class="sect1">
1.1 dsieger 2390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2391: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 2392: <p>
1.1 dsieger 2393: </p>
1.41 asau 2394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2395: <li class="listitem">
1.1 dsieger 2396: <p><code class="varname">PKG_DEVELOPER</code>:
2397: Run some sanity checks that package developers want:
2398: </p>
1.41 asau 2399: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2400: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 2401: fuzz</p></li>
1.23 wiz 2402: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 2403: binaries will find their shared libs.</p></li>
2404: </ul></div>
2405: <p>
2406: </p>
2407: </li>
1.23 wiz 2408: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 2409: of debugging output which is displayed whilst making and
2410: installing the package. The default value for this is 0,
2411: which will not display the commands as they are executed
2412: (normal, default, quiet operation); the value 1 will display
2413: all shell commands before their invocation, and the value 2
2414: will display both the shell commands before their invocation,
1.10 hubertf 2415: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 2416: -x</strong></span> will be displayed.</p></li>
2417: </ul></div>
2418: <p>
2419: </p>
2420: </div>
1.41 asau 2421: <div class="sect1">
1.1 dsieger 2422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2423: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2424: <p>Some packages have build time options, usually to select
2425: between different dependencies, enable optional support for big
2426: dependencies or enable experimental features.</p>
2427: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2428: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2429: show-options</strong></span>, for example:</p>
2430: <pre class="programlisting">
2431: The following options are supported by this package:
2432: ssl Enable SSL support.
2433: Exactly one of the following gecko options is required:
2434: firefox Use firefox as gecko rendering engine.
2435: mozilla Use mozilla as gecko rendering engine.
2436: At most one of the following database options may be selected:
2437: mysql Enable support for MySQL database.
2438: pgsql Enable support for PostgreSQL database.
2439:
2440: These options are enabled by default: firefox
2441: These options are currently enabled: mozilla ssl
2442: </pre>
2443: <p>The following variables can be defined in
1.10 hubertf 2444: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2445: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2446: which can be used to select or disable options for all packages
2447: that support them, and
2448: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2449: which can be used to select or disable options specifically for
2450: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2451: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2452: are disabled. A few examples:</p>
2453: <pre class="screen">
1.10 hubertf 2454: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2455: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2456: PKG_OPTIONS.kdebase= debug -sasl
2457: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2458: <p>It is important to note that options that were specifically
1.18 snj 2459: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2460: you do not wish to include the option. If you are unsure you can view
2461: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2462: <p>The following settings are consulted in the order given, and
2463: the last setting that selects or disables an option is
2464: used:</p>
1.23 wiz 2465: <div class="orderedlist"><ol class="orderedlist" type="1">
2466: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2467: maintainer</p></li>
1.23 wiz 2468: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2469: variables (see below)</p></li>
1.23 wiz 2470: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2471: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2472: </ol></div>
2473: <p>For groups of mutually exclusive options, the last option
2474: selected is used, all others are automatically disabled. If an
2475: option of the group is explicitly disabled, the previously
2476: selected option, if any, is used. It is an error if no option
2477: from a required group of options is selected, and building the
2478: package will fail.</p>
2479: <p>Before the options framework was introduced, build options
2480: were selected by setting a variable (often named
2481: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2482: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2483: transition to the options framework for the user, these legacy
2484: variables are converted to the appropriate options setting
2485: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2486: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2487: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2488: directly. Support for the legacy variables will be removed
2489: eventually.</p>
2490: </div>
2491: </div>
1.41 asau 2492: <div class="chapter">
1.1 dsieger 2493: <div class="titlepage"><div><div><h2 class="title">
2494: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2495: <div class="toc">
2496: <p><b>Table of Contents</b></p>
1.100 leot 2497: <dl class="toc">
1.1 dsieger 2498: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2499: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2500: </dl>
2501: </div>
1.41 asau 2502: <div class="sect1">
1.1 dsieger 2503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2504: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2505: <p>Once you have built and installed a package, you can create
2506: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.79 snj 2507: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2508: the same package on a group of hosts and wasting CPU time. It also
2509: provides a simple means for others to install your package, should
2510: you distribute it.</p>
2511: <p>To create a binary package, change into the appropriate
1.10 hubertf 2512: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2513: package</strong></span>:</p>
2514: <pre class="screen">
2515: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2516: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2517: </pre>
2518: <p>This will build and install your package (if not already done),
2519: and then build a binary package from what was installed. You can
1.10 hubertf 2520: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2521: it. Binary packages are created by default in
2522: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2523: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.79 snj 2524: continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.10 hubertf 2525: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2526: such a binary package.</p>
2527: </div>
1.41 asau 2528: <div class="sect1">
1.1 dsieger 2529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2530: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2531: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.6 rillig 2532: </div>
2533: </div>
1.41 asau 2534: <div class="chapter">
1.6 rillig 2535: <div class="titlepage"><div><div><h2 class="title">
2536: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2537: builds)</h2></div></div></div>
2538: <div class="toc">
2539: <p><b>Table of Contents</b></p>
1.100 leot 2540: <dl class="toc">
1.71 wiz 2541: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2542: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2543: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2544: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2545: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2546: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2547: </dl>
2548: </div>
1.71 wiz 2549: <p>For a number of reasons you may want to build binary packages
2550: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2551: For instance, when you have multiple machines that should run the same software,
2552: it is wasted time if they all build their packages themselves from source.
2553: Or you may want to build a list of packages you want and check them before
2554: deploying onto production system.
2555: There is a way of getting a set of binary packages:
1.66 asau 2556: The bulk build system, or pbulk ("p" stands for "parallel).
2557: This chapter describes how to set it up so that the packages
1.6 rillig 2558: are most likely to be usable later.</p>
1.41 asau 2559: <div class="sect1">
1.6 rillig 2560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2561: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2562: <p>First of all, you have to decide whether you build all packages
2563: or a limited set of them. Full bulk builds usually consume a lot more resources,
2564: both space and time, than builds for some practical sets of packages.
2565: There exists a number of particularly heavy packages that are not actually
2566: interesting to a wide audience.
2567:
2568: For a limited bulk builds you need to make a list of packages you want to build.
2569: Note, that all their dependencies will be built, so you don't need to track them manually.
2570: </p>
2571: <p>During bulk builds various packages are installed and deinstalled
2572: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2573: so make sure that you don't need any package during the builds.
2574: Essentially, you should provide fresh system, either a chroot environment
2575: or something even more restrictive, depending on what the operating system provides,
2576: or dedicate the whole physical machine.
2577: As a useful side effect this makes sure that bulk builds cannot
2578: break anything in your system. There have been numerous cases where
1.6 rillig 2579: certain packages tried to install files outside the
2580: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2581: <code class="filename">/etc</code>.
2582: </p>
1.6 rillig 2583: </div>
1.41 asau 2584: <div class="sect1">
1.6 rillig 2585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2586: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2587: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2588: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2589: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2590: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2591: </ul></div>
1.41 asau 2592: <div class="sect2">
1.15 rillig 2593: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2594: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.68 asau 2595: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2596: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2597: Configure network access to fetch distribution files.
2598: Create user with name "pbulk".</p>
2599: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2600: <pre class="screen">
1.72 wiz 2601: <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>
2602: <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>
2603: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68 asau 2604: </pre>
2605: <p>Or any other way that fits (e.g., curl, wget).</p>
2606: <p>Deploy and configure pbulk tools, e.g.:</p>
2607: <pre class="screen">
2608: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2609: <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>
2610: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2611: </pre>
2612: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2613: <h3 class="title">Note</h3>
2614: <p><code class="filename">mk.conf.frag</code> is a fragment of
2615: <code class="filename">mk.conf</code> that contains settings you want to
2616: apply to packages you build. For instance,</p>
2617: <pre class="programlisting">
2618: PKG_DEVELOPER= yes # perform more checks
2619: X11_TYPE= modular # use pkgsrc X11
2620: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2621: </pre>
2622: </div>
2623: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2624: with your list of packages one per line without empty lines or comments. E.g.:</p>
2625: <pre class="programlisting">
2626: www/firefox
2627: mail/thunderbird
2628: misc/libreoffice4
2629: </pre>
1.69 asau 2630: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2631: and make final amendments, if wanted.</p>
1.68 asau 2632: <p>Start it:</p>
2633: <pre class="screen">
2634: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2635: </pre>
2636: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2637: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2638: </p>
2639: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2640: <h3 class="title">Note</h3>
2641: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2642: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2643: The script is kept small enough for better understanding.</p>
2644: </div>
2645: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2646: <h3 class="title">Note</h3>
2647: <p>The <code class="filename">pbulk.sh</code> script supports running
2648: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2649: </div>
1.6 rillig 2650: </div>
2651: </div>
1.41 asau 2652: <div class="sect1">
1.6 rillig 2653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2654: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2655: <p>A complete bulk build requires lots of disk space. Some of the
2656: disk space can be read-only, some other must be writable. Some can be on
2657: remote filesystems (such as NFS) and some should be local. Some can be
2658: temporary filesystems, others must survive a sudden reboot.</p>
2659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2660: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2661: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2662: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2663: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2664: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2665: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2666: </ul></div>
2667: </div>
2668: <div class="sect1">
2669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2670: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2671: <p>After your pkgsrc bulk-build has completed, you may wish to
2672: create a CD-ROM set of the resulting binary packages to assist
2673: in installing packages on other machines. The
1.79 snj 2674: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1 dsieger 2675: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2676: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2677: way that keeps all the dependencies for a given package on the same
2678: CD as that package.</p>
1.41 asau 2679: <div class="sect2">
1.1 dsieger 2680: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2681: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2682: <p>Complete documentation for cdpack is found in the cdpack(1)
2683: man page. The following short example assumes that the binary
2684: packages are left in
2685: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2686: sufficient disk space exists in <code class="filename">/u2</code> to
2687: hold the ISO 9660 images.</p>
2688: <pre class="screen">
2689: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2690: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2691: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2692: </pre>
2693: <p>If you wish to include a common set of files
2694: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2695: etc.) on each CD in the collection, then you need to create a
2696: directory which contains these files. e.g.</p>
2697: <pre class="screen">
2698: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2699: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2700: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2701: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2702: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2703: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2704: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2705: </pre>
2706: <p>Now create the images:</p>
2707: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2708: <p>Each image will contain <code class="filename">README</code>,
2709: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2710: in their root directories.</p>
2711: </div>
2712: </div>
2713: </div>
1.41 asau 2714: <div class="chapter">
1.1 dsieger 2715: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2716: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2717: <div class="toc">
2718: <p><b>Table of Contents</b></p>
1.100 leot 2719: <dl class="toc">
1.23 wiz 2720: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2721: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 2722: </dl>
2723: </div>
2724: <p>The files that are installed by pkgsrc are organized in a way that
2725: is similar to what you find in the <code class="filename">/usr</code> directory
2726: of the base system. But some details are different. This is because
2727: pkgsrc initially came from FreeBSD and had adopted its file system
2728: hierarchy. Later it was largely influenced by NetBSD. But no matter
2729: which operating system you are using pkgsrc with, you can expect the
2730: same layout for pkgsrc.</p>
2731: <p>There are mainly four root directories for pkgsrc, which are all
2732: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2733: When pkgsrc has been installed as root, the default locations
2734: are:</p>
2735: <pre class="programlisting">
2736: LOCALBASE= /usr/pkg
2737: PKG_SYSCONFBASE= /usr/pkg/etc
2738: VARBASE= /var
2739: PKG_DBDIR= /var/db/pkg
2740: </pre>
2741: <p>In unprivileged mode (when pkgsrc has been installed as any other
2742: user), the default locations are:</p>
2743: <pre class="programlisting">
2744: LOCALBASE= ${HOME}/pkg
2745: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2746: VARBASE= ${HOME}/pkg/var
2747: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2748: </pre>
2749: <p>What these four directories are for, and what they look like is
2750: explained below.</p>
1.41 asau 2751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2752: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2753: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2754: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2755: the well-known subdirectories like <code class="filename">bin</code>,
2756: <code class="filename">include</code>, <code class="filename">lib</code>,
2757: <code class="filename">share</code> and
2758: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2759: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2760: <code class="filename">/var</code> in the base system. Some programs (especially
2761: games, network daemons) need write access to it during normal
2762: operation.</p></li>
1.23 wiz 2763: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2764: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2765: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 2766: itself.</p></li>
2767: </ul></div>
1.41 asau 2768: <div class="sect1">
1.1 dsieger 2769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2770: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2771: </h2></div></div></div>
2772: <p>The following directories exist in a typical pkgsrc installation
2773: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2774: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2775: <dt><span class="term"><code class="filename">bin</code></span></dt>
2776: <dd><p>Contains executable programs that are intended to be
2777: directly used by the end user.</p></dd>
2778: <dt><span class="term"><code class="filename">emul</code></span></dt>
2779: <dd><p>Contains files for the emulation layers of various other
2780: operating systems, especially for
2781: NetBSD.</p></dd>
2782: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2783: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2784: <dd><p>Contains
2785: the configuration files.</p></dd>
2786: <dt><span class="term"><code class="filename">include</code></span></dt>
2787: <dd><p>Contains headers for the C and C++ programming
2788: languages.</p></dd>
2789: <dt><span class="term"><code class="filename">info</code></span></dt>
2790: <dd><p>Contains GNU info files of various
2791: packages.</p></dd>
2792: <dt><span class="term"><code class="filename">lib</code></span></dt>
2793: <dd><p>Contains shared and static
2794: libraries.</p></dd>
2795: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2796: <dd><p>Contains data files that don't change after
2797: installation. Other data files belong into
2798: <code class="filename">${VARBASE}</code>.</p></dd>
2799: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2800: <dd><p>Contains programs that are not intended to be used by
2801: end users, such as helper programs or network
2802: daemons.</p></dd>
2803: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2804: <dd><p>Contains programs that are intended to be executed as
2805: CGI scripts by a web server.</p></dd>
2806: <dt><span class="term"><code class="filename">man</code> (the usual value of
2807: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2808: <dd><p>Contains brief
2809: documentation in form of manual pages.</p></dd>
2810: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2811: <dd><p>Contains programs that are intended to be used only by
2812: the super-user.</p></dd>
2813: <dt><span class="term"><code class="filename">share</code></span></dt>
2814: <dd><p>Contains platform-independent data files that don't
2815: change after installation.</p></dd>
2816: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2817: <dd><p>Contains documentation files provided by the
2818: packages.</p></dd>
2819: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2820: <dd><p>Contains example files provided by the packages. Among
2821: others, the original configuration files are saved here and copied to
2822: <code class="filename">${PKG_SYSCONFDIR}</code> during
2823: installation.</p></dd>
2824: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2825: <dd><p>Contains the original files for rc.d
2826: scripts.</p></dd>
2827: <dt><span class="term"><code class="filename">var</code> (the usual location of
2828: <code class="filename">${VARBASE}</code>)</span></dt>
2829: <dd><p>Contains files
2830: that may be modified after
2831: installation.</p></dd>
2832: </dl></div>
2833: </div>
1.41 asau 2834: <div class="sect1">
1.1 dsieger 2835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2836: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2837: </h2></div></div></div>
1.41 asau 2838: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2839: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2840: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2841: <dd><p>Contains
2842: information about the currently installed
2843: packages.</p></dd>
2844: <dt><span class="term"><code class="filename">games</code></span></dt>
2845: <dd><p>Contains highscore
2846: files.</p></dd>
2847: <dt><span class="term"><code class="filename">log</code></span></dt>
2848: <dd><p>Contains log files.</p></dd>
2849: <dt><span class="term"><code class="filename">run</code></span></dt>
2850: <dd><p>Contains informational files about daemons that are
2851: currently running.</p></dd>
2852: </dl></div>
2853: </div>
2854: </div>
1.41 asau 2855: <div class="chapter">
1.1 dsieger 2856: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2857: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2858: <div class="toc">
2859: <p><b>Table of Contents</b></p>
1.100 leot 2860: <dl class="toc">
1.6 rillig 2861: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 2862: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2863: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2864: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2865: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2866: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2867: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2868: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2869: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2870: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2871: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2872: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
2873: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2874: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2875: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2876: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2877: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2878: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 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.41 asau 2884: <div class="sect1">
1.1 dsieger 2885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2886: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2887: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2888: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 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.1 dsieger 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.23 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.1 dsieger 2899: A list where the results of pkgsrc bulk builds are sent and
2900: discussed.</p></li>
1.23 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.1 dsieger 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">
2910: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2911: </pre>
2912: <p>Archives for all these mailing lists are available from
1.10 hubertf 2913: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2914: </div>
1.41 asau 2915: <div class="sect1">
1.1 dsieger 2916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2917: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2918: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2919: a number of useful utilities for both users and developers of pkgsrc. This
2920: section attempts only to make the reader aware of the utilities and when
2921: they might be useful, and not to duplicate the documentation that comes
2922: with each package.</p>
2923: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.79 snj 2924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 2925: Symlinks for use by buildlink.</p></li></ul></div>
2926: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2927: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2928: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.1 dsieger 2929: Calculates various kinds of checksums (including SHA1).</p></li>
1.79 snj 2930: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 2931: Compatibility library for pkgsrc tools.</p></li>
1.79 snj 2932: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 2933: non-BSD systems due to lack of native mtree.</p></li>
1.79 snj 2934: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 2935: Up-to-date replacement for
2936: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2937: systems where pkg_install is not present.</p></li>
2938: </ul></div>
2939: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2941: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2942: Create a binary package from an
1.10 hubertf 2943: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2944: save the old package.</p></li>
1.79 snj 2945: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 2946: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2947: from multiple locations. It currently supports the following
2948: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.79 snj 2949: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 2950: the best compiler flags to optimise code for your current
1.23 wiz 2951: CPU and compiler. </p></li>
1.1 dsieger 2952: </ul></div>
2953: <p>Utilities for keeping track of installed packages, being up to date,
2954: etc:</p>
1.41 asau 2955: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2956: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65 wiz 2957: update tool similar to apt(1). Download, install, and upgrade
2958: binary packages easily.</p></li>
1.79 snj 2959: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 2960: packages whose installed versions do not match the latest pkgsrc
2961: entries.</p></li>
1.79 snj 2962: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 2963: dependency graphs of packages, to aid in choosing a strategy for
2964: updating.</p></li>
1.79 snj 2965: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2966: graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2967: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 2968: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.79 snj 2969: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 2970: does various checks on the complete pkgsrc system.</p></li>
1.79 snj 2971: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 2972: packages you have installed.</p></li>
2973: </ul></div>
2974: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2975: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2976: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 2977: making and maintaining patches for a package (includes pkgdiff,
2978: pkgvi, mkpatches, etc.).</p></li>
1.79 snj 2979: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1 dsieger 2980: converting to pkgsrc.</p></li>
2981: </ul></div>
2982: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2983: utilities)</p>
1.41 asau 2984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2985: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 2986: packages in a chrooted area.</p></li>
1.79 snj 2987: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 2988: kernel version for chrooted cross builds.</p></li>
2989: </ul></div>
2990: </div>
1.41 asau 2991: <div class="sect1">
1.1 dsieger 2992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2993: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2994: <p>To install packages from source as a non-root user, download
2995: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
2996: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2997: --unprivileged</strong></span>.</p>
2998: <p>This will install the binary part of pkgsrc to
2999: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
3000: into <code class="filename">~/pkg/etc</code>.</p>
3001: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 3002: </div>
1.41 asau 3003: <div class="sect1">
1.1 dsieger 3004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3005: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3006: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3007: enable this feature by adding the option
3008: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 3009: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3010: distfile is found, pkgsrc will try to resume it.</p>
3011: <p>You can also
1.61 wiz 3012: use a different program than the platform default program by changing the
1.16 jnemeth 3013: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3014: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3015: by using the value manual. A value of custom disables the system defaults
3016: and dependency tracking for the fetch program. In that case you have to
3017: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3018: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3019: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 3020: <p>For example, if you want to use
1.16 jnemeth 3021: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 3022: like:</p>
3023: <pre class="programlisting">
1.16 jnemeth 3024: FETCH_USING= wget
1.1 dsieger 3025: </pre>
3026: </div>
1.41 asau 3027: <div class="sect1">
1.1 dsieger 3028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3029: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 3030: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3031: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3032: you will have to add the following line into
1.10 hubertf 3033: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3034: <pre class="programlisting">
1.4 rillig 3035: X11_TYPE=modular
1.1 dsieger 3036: </pre>
1.41 asau 3037: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 3038: <h3 class="title">Note</h3>
1.4 rillig 3039: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3040: </p>
1.1 dsieger 3041: </div>
3042: </div>
1.41 asau 3043: <div class="sect1">
1.1 dsieger 3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3045: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3046: <p>If you are sitting behind a firewall which does not allow direct
3047: connections to Internet hosts (i.e. non-NAT), you may specify the
3048: relevant proxy hosts. This is done using an environment variable in the
3049: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 3050: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3051: port 80 as the proxy port number. So the proxy environment variables
3052: are:</p>
3053: <pre class="programlisting">
3054: ftp_proxy=ftp://orpheus.amdahl.com:80/
3055: http_proxy=http://orpheus.amdahl.com:80/
3056: </pre>
3057: </div>
1.41 asau 3058: <div class="sect1">
1.1 dsieger 3059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3060: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 3061: <p>Some fetch tools are not prepared to support HTTPS by default
3062: (for example, the one in NetBSD 6.0), or the one installed by the
3063: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3064: dependency graph).</p>
3065: <p>Usually you won't notice, because distribution files are
3066: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3067: be often enough if you are following pkgsrc-current. In that case, set
3068: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3069: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3070: with HTTPS support by default. Of course, these tools need to be
3071: installed before you can use them this way.</p>
3072: </div>
3073: <div class="sect1">
3074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3075: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 3076: <p>This depends on which utility is used to retrieve distfiles. From
3077: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3078: the first available command from the following list:</p>
1.41 asau 3079: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3080: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3081: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3082: </ul></div>
3083: <p>On a default NetBSD installation, this will be
3084: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3085: connections first, and falls back to active connections if the server
3086: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3088: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3089: <p>Having that option present will prevent
3090: <code class="filename">/usr/bin/ftp</code> from falling back to active
3091: transfers.</p>
3092: </div>
1.41 asau 3093: <div class="sect1">
1.1 dsieger 3094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3095: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3096: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3097: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3098: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 3099: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3100: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3101: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3102: resulting list to your machine at work/school and use it there. If you
1.79 snj 3103: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 3104: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3105: URL:</p>
3106: <p>At home:</p>
3107: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3108: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3109: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3110: <p>At work:</p>
3111: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3112: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3113: home.</p>
3114: <p>If you have a machine running NetBSD, and you want to get
3115: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3116: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3117: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3118: directly by running:</p>
3119: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3120: <p>If you even decide to ignore
3121: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3122: by running:</p>
3123: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3124: </div>
1.41 asau 3125: <div class="sect1">
1.1 dsieger 3126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3127: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 3128: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.79 snj 3129: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1 dsieger 3130: package, you get the error from make that it doesn't know how to make
3131: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3132: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3133: the NetBSD base distribution on your machine. It is recommended to do
3134: that to format man pages.</p>
1.79 snj 3135: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1 dsieger 3136: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3137: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3138: </div>
1.41 asau 3139: <div class="sect1">
1.1 dsieger 3140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3141: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3142: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3143: when you installed your NetBSD machine. Please get and install it, by
3144: extracting it in <code class="filename">/</code>:</p>
3145: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3146: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3147: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3148: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3149: -r</strong></span>).</p>
3150: </div>
1.41 asau 3151: <div class="sect1">
1.1 dsieger 3152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3153: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3154: <p>When installing packages as non-root user and using the just-in-time
1.79 snj 3155: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1 dsieger 3156: password for each required package installed. To avoid this, the sudo
3157: package can be used, which does password caching over a limited time. To
3158: use it, install sudo (either as binary package or from
1.79 snj 3159: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10 hubertf 3160: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3161: <span class="emphasis"><em>after</em></span> the definition of the
3162: <code class="varname">LOCALBASE</code> variable:</p>
3163: <pre class="programlisting">
3164: .if exists(${LOCALBASE}/bin/sudo)
3165: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3166: .endif
3167: </pre>
3168: </div>
1.41 asau 3169: <div class="sect1">
1.1 dsieger 3170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3171: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3172: <p>As the system administrator, you can choose where configuration files
3173: are installed. The default settings make all these files go into
3174: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3175: be suboptimal depending on your expectations (e.g., a read-only,
3176: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3177: configuration of the provided packages).</p>
3178: <p>In order to change the defaults, you can modify the
3179: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3180: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3181: directory; some common examples include <code class="filename">/etc</code> or
3182: <code class="filename">/etc/pkg</code>.</p>
3183: <p>Furthermore, you can change this value on a per-package basis by
3184: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3185: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3186: package you would like to modify, that is, the contents of
3187: <code class="varname">PKGBASE</code>.</p>
3188: <p>Note that after changing these settings, you must rebuild and
3189: reinstall any affected packages.</p>
3190: </div>
1.41 asau 3191: <div class="sect1">
1.1 dsieger 3192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3193: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3194: <p>Please be aware that there can often be bugs in third-party software,
3195: and some of these bugs can leave a machine vulnerable to exploitation by
3196: attackers. In an effort to lessen the exposure, the NetBSD packages team
3197: maintains a database of known-exploits to packages which have at one time
3198: been included in pkgsrc. The database can be downloaded automatically, and
3199: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3200: do this, refer to the following two tools (installed as part of the
1.79 snj 3201: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23 wiz 3202: <div class="orderedlist"><ol class="orderedlist" type="1">
3203: <li class="listitem">
1.20 snj 3204: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3205: download a list of the security vulnerabilities information. This list
1.25 spz 3206: is kept up to date by the pkgsrc security team, and is distributed
3207: from the NetBSD ftp server:</p>
3208: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.1 dsieger 3209: </li>
1.23 wiz 3210: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3211: current machine, checking each known vulnerability. If a
1.1 dsieger 3212: vulnerable package is installed, it will be shown by output to stdout,
3213: including a description of the type of vulnerability, and a URL
3214: containing more information.</p></li>
3215: </ol></div>
1.14 jmcneill 3216: <p>Use of these tools is strongly recommended! After
1.23 wiz 3217: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 3218: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 3219: pkg_install</code></strong>.</p>
1.1 dsieger 3220: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 3221: perform a security check before building any package. See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, “Variables affecting the build process”</a> for ways to control this
1.1 dsieger 3222: check.</p>
3223: </div>
1.41 asau 3224: <div class="sect1">
1.1 dsieger 3225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3226: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3227: <p>When you add your own preferences to the
3228: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3229: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3230: environment variables to the <code class="filename">./configure</code>
1.79 snj 3231: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 3232: <code class="varname">CFLAGS</code> from the environment variable by
3233: overriding them in the <code class="filename">Makefile</code>s of their
3234: package.</p>
3235: <p>Currently there is no solution to this problem. If you
3236: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3237: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3238: directory and then inspect any <code class="filename">Makefile</code> and
3239: <code class="filename">Makefile.in</code> for whether they define
3240: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3241: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3242: programmers write so bad code that it only works for the
3243: specific combination of <code class="varname">CFLAGS</code> they have
3244: chosen.</p>
3245: </div>
1.41 asau 3246: <div class="sect1">
1.1 dsieger 3247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3248: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3249: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3250: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3251: case that occurs often is that people only update pkgsrc in
3252: parts, because of performance reasons. Since pkgsrc is one large
3253: system, not a collection of many small systems, there are
3254: sometimes changes that only work when the whole pkgsrc tree is
3255: updated.</p></li>
1.41 asau 3256: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3257: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3258: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3259: files.</p></li>
1.41 asau 3260: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3261: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3262: verify this.</p></li>
1.108 rillig 3263: <li class="step"><p>If you are a package developer who wants to invest
3264: some work, have a look at <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.41 asau 3265: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3266: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3267: </ol></div>
3268: </div>
1.41 asau 3269: <div class="sect1">
1.1 dsieger 3270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3271: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3272: <p>You have modified a file from pkgsrc, and someone else has
3273: modified that same file afterwards in the CVS repository. Both changes
3274: are in the same region of the file, so when you updated pkgsrc, the
3275: <code class="literal">cvs</code> command marked the conflicting changes in the
3276: file. Because of these markers, the file is no longer a valid
3277: <code class="filename">Makefile</code>.</p>
3278: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3279: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3280: -dP</strong></span> in that directory to download the current version.</p>
3281: </div>
3282: </div>
3283: </div>
1.41 asau 3284: <div class="part">
1.1 dsieger 3285: <div class="titlepage"><div><div><h1 class="title">
3286: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3287: <div class="partintro">
1.1 dsieger 3288: <div></div>
3289: <p>This part of the book deals with creating and
1.23 wiz 3290: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3291: guide on creating a new package. The remaining chapters are more
3292: like a reference manual for pkgsrc.</p>
3293: <div class="toc">
3294: <p><b>Table of Contents</b></p>
1.100 leot 3295: <dl class="toc">
1.6 rillig 3296: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3297: <dd><dl>
1.6 rillig 3298: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3299: <dd><dl>
1.6 rillig 3300: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3301: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3302: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3303: </dl></dd>
1.6 rillig 3304: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3305: <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>
3306: </dl></dd>
3307: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3308: <dd><dl>
1.23 wiz 3309: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3310: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 3311: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3312: <dd><dl>
3313: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3314: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3315: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3316: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3317: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3318: </dl></dd>
3319: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3320: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3321: <dd><dl>
3322: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3323: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3324: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3325: </dl></dd>
1.23 wiz 3326: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3327: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3328: </dl></dd>
1.23 wiz 3329: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3330: <dd><dl>
3331: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 3332: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 3333: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3334: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3335: <dd><dl>
3336: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 3337: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
3338: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
3339: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 3340: </dl></dd>
3341: </dl></dd>
3342: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3343: <dd><dl>
3344: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 3345: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3346: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 3347: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3348: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 3349: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 3350: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 3351: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
3352: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3353: </dl></dd>
3354: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3355: <dd><dl>
3356: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 3357: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3358: <dd><dl>
3359: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 3360: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3361: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3362: and
3363: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3364: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3365: </dl></dd>
1.23 wiz 3366: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 3367: <dd><dl>
1.23 wiz 3368: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 3369: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3370: </dl></dd>
3371: </dl></dd>
3372: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3373: <dd><dl>
3374: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3375: <dd><dl>
3376: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3377: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3378: </dl></dd>
3379: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3380: <dd><dl>
1.23 wiz 3381: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 3382: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3383: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3384: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3385: </dl></dd>
3386: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3387: <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>
3388: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3389: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3390: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3391: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3392: <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>
3393: </dl></dd>
3394: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3395: <dd><dl>
3396: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 3397: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 3398: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3399: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3400: </dl></dd>
3401: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3402: <dd><dl>
3403: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3404: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3405: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3406: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 3407: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3408: <dd><dl>
3409: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3410: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3411: </dl></dd>
1.23 wiz 3412: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3413: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3414: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3415: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3416: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3417: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3418: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3419: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3420: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3421: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 3422: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3423: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3424: </dl></dd>
3425: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3426: <dd><dl>
3427: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3428: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3429: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3430: </dl></dd>
3431: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3432: <dd><dl>
3433: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3434: <dd><dl>
1.108 rillig 3435: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
3436: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
3437: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
3438: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
3439: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
3440: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
3441: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
3442: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
3443: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
3444: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3445: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.6 rillig 3446: </dl></dd>
1.108 rillig 3447: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3448: <dd><dl>
3449: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3450: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.88 tnn 3451: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 3452: </dl></dd>
1.108 rillig 3453: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 3454: <dd><dl>
3455: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3456: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3457: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3458: </dl></dd>
3459: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3460: <dd><dl>
3461: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3462: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3463: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 3464: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3465: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 3466: </dl></dd>
1.108 rillig 3467: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 3468: <dd><dl>
3469: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3470: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 3471: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 3472: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3473: </dl></dd>
1.108 rillig 3474: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 3475: <dd><dl>
3476: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3477: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3478: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3479: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3480: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3481: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3482: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3483: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3484: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 3485: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 3486: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3487: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3488: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3489: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3490: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3491: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3492: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3493: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3494: emulation</a></span></dt>
1.6 rillig 3495: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3496: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3497: </dl></dd>
1.6 rillig 3498: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3499: </dl></dd>
1.6 rillig 3500: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3501: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3502: <dd><dl>
1.6 rillig 3503: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3504: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3505: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 3506: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 3507: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 3508: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3509: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 3510: </dl></dd>
3511: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3512: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3513: <dd><dl>
3514: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3515: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3516: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3517: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3518: </dl></dd>
3519: </dl>
3520: </div>
3521: </div>
1.41 asau 3522: <div class="chapter">
1.1 dsieger 3523: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3524: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3525: <div class="toc">
3526: <p><b>Table of Contents</b></p>
1.100 leot 3527: <dl class="toc">
1.6 rillig 3528: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3529: <dd><dl>
1.6 rillig 3530: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3531: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3532: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3533: </dl></dd>
1.6 rillig 3534: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3535: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1 dsieger 3536: </dl>
3537: </div>
3538: <p>When you find a package that is not yet in pkgsrc, you
3539: most likely have a URL from where you can download the source
3540: code. Starting with this URL, creating a package involves only a
3541: few steps.</p>
1.23 wiz 3542: <div class="procedure"><ol class="procedure" type="1">
1.79 snj 3543: <li class="step"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.41 asau 3544: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3545: category in which you want to place your package. You can also create a
3546: directory of your own (maybe called <code class="filename">local</code>). In that
3547: category directory, create another directory for your package and change
3548: into it.</p></li>
1.41 asau 3549: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3550: you for a URL. Enter the URL of the distribution file (in most cases a
3551: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3552: of your package are created automatically. The distribution file is
3553: extracted automatically to fill in some details in the
3554: <code class="filename">Makefile</code> that would otherwise have to be done
3555: manually.</p></li>
1.41 asau 3556: <li class="step">
1.1 dsieger 3557: <p>Examine the extracted files to determine the dependencies of
3558: your package. Ideally, this is mentioned in some
3559: <code class="filename">README</code> file, but things may differ. For each of
3560: these dependencies, look where it exists in pkgsrc, and if there is a
3561: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3562: line to your package <code class="filename">Makefile</code> which includes that
3563: file just before the last line. If the
1.25 spz 3564: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3565: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3566: <p>If you just need binaries from a package, add a
1.1 dsieger 3567: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3568: version of the dependency and where it can be found in pkgsrc. This line
3569: should be placed in the third paragraph. If the dependency is only
3570: needed for building the package, but not when using it, use
3571: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3572: Your package may then look like this:</p>
3573: <pre class="programlisting">
3574: [...]
3575:
1.66 asau 3576: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3577: DEPENDS+= screen-[0-9]*:../../misc/screen
3578: DEPENDS+= screen>=4.0:../../misc/screen
3579:
3580: [...]
3581:
3582: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3583: .include "../../devel/glib2/buildlink3.mk"
3584: .include "../../mk/bsd.pkg.mk"
3585: </pre>
3586: </li>
1.41 asau 3587: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3588: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.10 hubertf 3589: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3590: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3591: -e</strong></span>, which outputs additional
3592: explanations.</p></li>
1.41 asau 3593: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3594: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, “Common types of packages”</a>. After you have followed the instructions
1.1 dsieger 3595: over there, you can hopefully continue here.</p></li>
1.41 asau 3596: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3597: directory from the extracted files. Besides these files, a lot of cache
3598: files and other system information has been saved in the working
3599: directory, which may become wrong after you edited the
3600: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3601: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3602: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.41 asau 3603: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3604: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3605: everything works.</p></li>
1.41 asau 3606: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3607: contains a list of the files that are installed by the package, is
1.10 hubertf 3608: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3609: >PLIST</strong></span> to generate a probably correct list. Check
3610: the file using your preferred text editor to see if the list of
3611: files looks plausible.</p></li>
1.41 asau 3612: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3613: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3614: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3615: has been registered in the database of installed files, but with an
1.10 hubertf 3616: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3617: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3618: registered with the list of files from
3619: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3620: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3621: package from the set of installed files.</p></li>
3622: </ol></div>
1.41 asau 3623: <div class="sect1">
1.1 dsieger 3624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3625: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3626: <div class="sect2">
1.1 dsieger 3627: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3628: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3629: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3630: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3631: </div>
1.41 asau 3632: <div class="sect2">
1.1 dsieger 3633: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 3634: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3635: <p>KDE3 applications should always include
1.1 dsieger 3636: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 asau 3637: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3638: </div>
1.41 asau 3639: <div class="sect2">
1.17 imil 3640: <div class="titlepage"><div><div><h3 class="title">
3641: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3642: <p>Python modules and programs packages are easily created using a
3643: set of predefined variables.</p>
3644: <p>
1.63 wiz 3645: If some Python versions are not supported by the software, set the
3646: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3647: that are not supported, e.g.
1.17 imil 3648: </p>
3649: <pre class="programlisting">
1.93 sevan 3650: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3651: </pre>
3652: <p>
1.103 wiz 3653: If the packaged software is a Python module, include one of
3654: <code class="filename">../../lang/python/egg.mk</code>,
3655: <code class="filename">../../lang/python/distutils.mk</code>, or
3656: <code class="filename">../../lang/python/extension.mk</code>.</p>
3657: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3658: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3659: if the packaged software is using setuptools, you only need
3660: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3661: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3662: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3663: so pkgsrc will use this framework.
3664: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3665: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3666: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3667: to the name of the script.</p>
3668: <p>Either way, the package directory should be called
1.23 wiz 3669: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3670: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3671: </p>
3672: <pre class="programlisting">
3673: DISTNAME= foopymodule-1.2.10
3674: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3675: </pre>
1.63 wiz 3676: <p>If it is an application, include
3677: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3678: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3679: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3680: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3681: For example:
1.17 imil 3682: </p>
3683: <pre class="programlisting">
1.35 wiz 3684: REPLACE_PYTHON= *.py
1.17 imil 3685: </pre>
1.63 wiz 3686: <p>Some Python modules have separate distributions for Python-2.x
3687: and Python-3.x support. In pkgsrc this is handled by the
3688: <code class="filename">versioned_dependencies.mk</code> file. Set
3689: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3690: packages that should be depended upon and include
3691: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3692: then the pkgsrc infrastructure will depend on the appropriate package
3693: version. For example:
3694: </p>
3695: <pre class="programlisting">
1.110 ! wiz 3696: PYTHON_VERSIONED_DEPENDENCIES=dateutil
1.63 wiz 3697: </pre>
3698: <p>
3699: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3700: of supported packages.</p>
1.17 imil 3701: </div>
1.1 dsieger 3702: </div>
1.41 asau 3703: <div class="sect1">
1.1 dsieger 3704: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3705: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3706: <div class="sect2">
1.1 dsieger 3707: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3708: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3709: <div class="sect3">
1.1 dsieger 3710: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3711: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3712: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3713: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3714: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3715: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3716: <pre class="programlisting">
3717: <code class="prompt">$</code> mkdir www/nvu
3718: <code class="prompt">$</code> cd www/nvu
3719: </pre>
3720: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3721: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3722: <pre class="programlisting">
3723: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3724: </pre>
3725: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3726: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3727: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3728: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3729: <code class="varname">COMMENT</code> fields. Then the package
3730: <code class="filename">Makefile</code> looked like that:</p>
3731: <pre class="programlisting">
3732: # $NetBSD$
3733: #
3734:
3735: DISTNAME= nvu-1.0-sources
3736: PKGNAME= nvu-1.0
3737: CATEGORIES= www
3738: MASTER_SITES= http://cvs.nvu.com/download/
3739: EXTRACT_SUFX= .tar.bz2
3740:
3741: MAINTAINER= rillig@NetBSD.org
3742: HOMEPAGE= http://cvs.nvu.com/
3743: COMMENT= Web Authoring System
3744:
3745: # url2pkg-marker (please do not remove this line.)
3746: .include "../../mk/bsd.pkg.mk"
3747: </pre>
3748: <p>Then, I quit the editor and watched pkgsrc downloading a large
3749: source archive:</p>
3750: <pre class="programlisting">
3751: url2pkg> Running "make makesum" ...
3752: => Required installed package digest>=20010302: digest-20060826 found
3753: => Fetching nvu-1.0-sources.tar.bz2
3754: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3755: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3756: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3757: url2pkg> Running "make extract" ...
3758: => Required installed package digest>=20010302: digest-20060826 found
3759: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3760: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3761: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3762: ===> Installing dependencies for nvu-1.0
3763: ===> Overriding tools for nvu-1.0
3764: ===> Extracting for nvu-1.0
3765: url2pkg> Adjusting the Makefile.
3766:
3767: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3768:
3769: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3770: </pre>
3771: </div>
1.41 asau 3772: <div class="sect3">
1.1 dsieger 3773: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3774: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1 dsieger 3775: <p>Now that the package has been extracted, let's see what's inside
3776: it. The package has a <code class="filename">README.txt</code>, but that only
3777: says something about mozilla, so it's probably useless for seeing what
3778: dependencies this package has. But since there is a GNU configure script
3779: in the package, let's hope that it will complain about everything it
3780: needs.</p>
3781: <pre class="programlisting">
3782: <code class="prompt">$</code> bmake
3783: => Required installed package digest>=20010302: digest-20060826 found
3784: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3785: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3786: ===> Patching for nvu-1.0
3787: ===> Creating toolchain wrappers for nvu-1.0
3788: ===> Configuring for nvu-1.0
3789: [...]
3790: configure: error: Perl 5.004 or higher is required.
3791: [...]
3792: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3793: [...]
3794: </pre>
3795: <p>That worked quite well. So I opened the package Makefile in my
3796: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3797: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3798: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3799: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3800: from scratch.</p>
3801: <pre class="programlisting">
3802: <code class="prompt">$</code> bmake clean
3803: ===> Cleaning for nvu-1.0
3804: <code class="prompt">$</code> bmake
3805: [...]
3806: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3807: GNU Make. You will not be able to build Mozilla without GNU Make.
3808: [...]
3809: </pre>
1.23 wiz 3810: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3811: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3812: <pre class="programlisting">
3813: [...]
3814: checking for GTK - version >= 1.2.0... no
3815: *** Could not run GTK test program, checking why...
3816: [...]
3817: </pre>
3818: <p>Now to the other dependencies. The first question is: Where is the
3819: GTK package hidden in pkgsrc?</p>
3820: <pre class="programlisting">
3821: <code class="prompt">$</code> echo ../../*/gtk*
3822: [many packages ...]
3823: <code class="prompt">$</code> echo ../../*/gtk
3824: ../../x11/gtk
3825: <code class="prompt">$</code> echo ../../*/gtk2
3826: ../../x11/gtk2
3827: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3828: ../../x11/gtk2/buildlink3.mk
3829: </pre>
3830: <p>The first try was definitely too broad. The second one had exactly
3831: one result, which is very good. But there is one pitfall with GNOME
3832: packages. Before GNOME 2 had been released, there were already many
3833: GNOME 1 packages in pkgsrc. To be able to continue to use these
3834: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3835: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3836: whether this was the case here, and indeed it was.</p>
3837: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3838: file, adding the dependency is very easy. I just inserted an
3839: <code class="literal">.include</code> line before the last line of the package
3840: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3841: <pre class="programlisting">
3842: [...]
3843: .include "../../x11/gtk2/buildlink3.mk"
3844: .include "../../mk/bsd.pkg.mk
3845: </pre>
1.10 hubertf 3846: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3847: was:</p>
3848: <pre class="programlisting">
3849: [...]
3850: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3851: checking for GTK - version >= 1.2.0... no
3852: *** Could not run GTK test program, checking why...
3853: *** The test program failed to compile or link. See the file config.log for the
3854: *** exact error that occured. This usually means GTK was incorrectly installed
3855: *** or that you have moved GTK since it was installed. In the latter case, you
3856: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3857: configure: error: Test for GTK failed.
3858: [...]
3859: </pre>
1.23 wiz 3860: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3861: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3862: told me that this package really wanted to have the GNOME 1 version of
3863: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3864: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3865: So I changed the <code class="literal">x11/gtk2</code> to
3866: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3867: and tried again.</p>
3868: <pre class="programlisting">
3869: [...]
1.59 jnemeth 3870: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3871: In file included from xpidl.c:42:
3872: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3873: In file included from xpidl.c:42:
3874: xpidl.h:132: error: parse error before "IDL_ns"
3875: [...]
3876: </pre>
3877: <p>The package still does not find all of its dependencies. Now the
3878: question is: Which package provides the
3879: <code class="filename">libIDL/IDL.h</code> header file?</p>
3880: <pre class="programlisting">
3881: <code class="prompt">$</code> echo ../../*/*idl*
3882: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3883: <code class="prompt">$</code> echo ../../*/*IDL*
3884: ../../net/libIDL
3885: </pre>
3886: <p>Let's take the one from the second try. So I included the
3887: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3888: again. But the error didn't change. After digging through some of the
3889: code, I concluded that the build process of the package was broken and
3890: couldn't have ever worked, but since the Mozilla source tree is quite
3891: large, I didn't want to fix it. So I added the following to the package
3892: <code class="filename">Makefile</code> and tried again:</p>
3893: <pre class="programlisting">
3894: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3895: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3896: </pre>
3897: <p>The latter line is needed because the package expects the library
3898: <code class="filename">libIDL.so</code>, but only
3899: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3900: wrapper to rewrite that on the fly.</p>
3901: <p>The next problem was related to a recent change of the FreeType
1.79 snj 3902: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.1 dsieger 3903: which patch files were relevant for this issue and copied them to the
3904: <code class="filename">patches</code> directory. Then I retried, fixed the
3905: patches so that they applied cleanly and retried again. This time,
3906: everything worked.</p>
3907: </div>
1.41 asau 3908: <div class="sect3">
1.1 dsieger 3909: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3910: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3911: <pre class="programlisting">
3912: <code class="prompt">$</code> bmake CHECK_FILES=no install
3913: [...]
3914: <code class="prompt">$</code> bmake print-PLIST >PLIST
3915: <code class="prompt">$</code> bmake deinstall
3916: <code class="prompt">$</code> bmake install
3917: </pre>
3918: </div>
3919: </div>
3920: </div>
3921: </div>
1.41 asau 3922: <div class="chapter">
1.1 dsieger 3923: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3924: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3925: <div class="toc">
3926: <p><b>Table of Contents</b></p>
1.100 leot 3927: <dl class="toc">
1.23 wiz 3928: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3929: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 3930: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3931: <dd><dl>
3932: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3933: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3934: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3935: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3936: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3937: </dl></dd>
3938: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3939: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3940: <dd><dl>
3941: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3942: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3943: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3944: </dl></dd>
1.23 wiz 3945: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3946: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3947: </dl>
3948: </div>
3949: <p>Whenever you're preparing a package, there are a number of
3950: files involved which are described in the following
3951: sections.</p>
1.41 asau 3952: <div class="sect1">
1.1 dsieger 3953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3954: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3955: </h2></div></div></div>
3956: <p>Building, installation and creation of a binary package are all
3957: controlled by the package's <code class="filename">Makefile</code>.
3958: The <code class="filename">Makefile</code> describes various things about
3959: a package, for example from where to get it, how to configure,
3960: build, and install it.</p>
3961: <p>A package <code class="filename">Makefile</code> contains several
3962: sections that describe the package.</p>
3963: <p>In the first section there are the following variables, which
3964: should appear exactly in the order given here. The order and
3965: grouping of the variables is mostly historical and has no further
3966: meaning.</p>
1.41 asau 3967: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3968: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3969: distribution file to be downloaded from the package's
3970: website.</p></li>
1.23 wiz 3971: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3972: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3973: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3974: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3975: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3976: directory name together with the version number. It must match the
3977: regular expression
3978: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3979: starts with a letter or digit, and contains only letters, digits,
3980: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3981: <li class="listitem">
1.1 dsieger 3982: <p><code class="varname">CATEGORIES</code> is a list of categories
3983: which the package fits in. You can choose any of the top-level
3984: directories of pkgsrc for it.</p>
3985: <p>Currently the following values are available for
3986: <code class="varname">CATEGORIES</code>. If more than
3987: one is used, they need to be separated by spaces:</p>
3988: <pre class="programlisting">
3989: archivers cross geography meta-pkgs security
3990: audio databases graphics misc shells
3991: benchmarks devel ham multimedia sysutils
3992: biology editors inputmethod net textproc
3993: cad emulators lang news time
3994: chat finance mail parallel wm
3995: comms fonts math pkgtools www
3996: converters games mbone print x11
3997: </pre>
3998: </li>
1.23 wiz 3999: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 4000: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4001: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4002: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 4003: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.1 dsieger 4004: </ul></div>
4005: <p>The second section contains information about separately
4006: downloaded patches, if any.
4007: </p>
1.41 asau 4008: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 4009: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 4010: Name(s) of additional files that contain distribution patches.
4011: There is no default. pkgsrc will look for them at
4012: <code class="varname">PATCH_SITES</code>.
4013: They will automatically be uncompressed before patching if
4014: the names end with <code class="filename">.gz</code> or
4015: <code class="filename">.Z</code>.</p></li>
1.23 wiz 4016: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 4017: Primary location(s) for distribution patch files (see
1.80 wiz 4018: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
4019: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
4020: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
4021: help find the correct files to patch. It defaults to
4022: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 4023: </ul></div>
4024: <p>The third section contains the following variables.
4025: </p>
1.41 asau 4026: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4027: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 4028: address of the person who feels responsible for this package,
4029: and who is most likely to look at problems or questions regarding
1.79 snj 4030: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14 jmcneill 4031: Other developers may contact the <code class="varname">MAINTAINER</code>
4032: before making changes to the package, but are not required to
4033: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4034: to yourself. If you really can't maintain the package for future
4035: updates, set it to
1.10 hubertf 4036: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 4037: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 4038: of <code class="varname">MAINTAINER</code> when you do not want other
4039: developers to update or change the package without contacting
4040: you first. A package Makefile should contain one of
4041: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4042: not both. </p></li>
1.23 wiz 4043: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 4044: find more information about the package.</p></li>
1.23 wiz 4045: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 4046: description of the package (should not include the package
4047: name).</p></li>
4048: </ul></div>
4049: <p>Other variables that affect the build:
4050: </p>
1.41 asau 4051: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4052: <p><code class="varname">WRKSRC</code>: The directory where the
4053: interesting distribution files of the package are found. The
4054: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4055: works for most packages.</p>
4056: <p>If a package doesn't create a subdirectory for itself
4057: (most GNU software does, for instance), but extracts itself in
4058: the current directory, you should set
4059: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4060: <p>If a package doesn't create a subdirectory with the
4061: name of <code class="varname">DISTNAME</code> but some different name,
4062: set <code class="varname">WRKSRC</code> to point to the proper name in
4063: <code class="filename">${WRKDIR}</code>, for example
4064: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.79 snj 4065: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.1 dsieger 4066: <p>The name of the working directory created by pkgsrc is
4067: taken from the <code class="varname">WRKDIR_BASENAME</code>
4068: variable. By default, its value is
4069: <code class="filename">work</code>. If you want to use the same
4070: pkgsrc tree for building different kinds of binary packages,
4071: you can change the variable according to your needs. Two
4072: other variables handle common cases of setting
4073: <code class="varname">WRKDIR_BASENAME</code> individually. If
4074: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 4075: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4076: the host's name is attached to the directory name. If
4077: <code class="varname">OBJMACHINE</code> is defined, the platform name
4078: is attached, which might look like
4079: <code class="filename">work.i386</code> or
4080: <code class="filename">work.sparc</code>.</p>
4081: </li></ul></div>
4082: <p>Please pay attention to the following gotchas:</p>
1.41 asau 4083: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4084: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 4085: installed in compressed form by the package. For packages using
4086: BSD-style makefiles which honor MANZ, there is
4087: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 4088: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4089: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 4090: below).</p></li>
1.23 wiz 4091: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.1 dsieger 4092: </ul></div>
4093: </div>
1.41 asau 4094: <div class="sect1">
1.1 dsieger 4095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4096: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4097: </h2></div></div></div>
4098: <p>The <code class="filename">distinfo</code> file contains the message
4099: digest, or checksum, of each distfile needed for the package. This
4100: ensures that the distfiles retrieved from the Internet have not been
4101: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 4102: a security hole. To provide maximum security, all distfiles are
4103: protected using three different message digest algorithms (SHA1,
4104: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 4105: <p>The <code class="filename">distinfo</code> file also contains the
4106: checksums for all the patches found in the
1.108 rillig 4107: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a>).</p>
1.1 dsieger 4108: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 4109: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 4110: <p>Some packages have different sets of distfiles depending on
1.79 snj 4111: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.1 dsieger 4112: <code class="filename">distinfo</code> file and care should be taken when
4113: upgrading such a package to ensure distfile information is not
4114: lost.</p>
4115: </div>
1.41 asau 4116: <div class="sect1">
1.1 dsieger 4117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 4118: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
4119: </h2></div></div></div>
4120: <p>Some packages don't work out-of-the box on the various
4121: platforms that are supported by pkgsrc. These packages need
4122: to be patched to make them work. The patch files can be
1.1 dsieger 4123: found in the <code class="filename">patches/</code> directory.</p>
4124: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4125: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 4126: extracting them, in alphabetic order.</p>
1.41 asau 4127: <div class="sect2">
1.1 dsieger 4128: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4129: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4130: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 4131: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 4132: problems. (To force patches to apply with fuzz you can set
4133: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4134: should contain only changes for a single file, and no file should be
4135: patched by more than one patch file. This helps to keep future
4136: modifications simple.</p>
4137: <p>Each patch file is structured as follows: In the first line,
4138: there is the RCS Id of the patch itself. The second line should be
4139: empty for aesthetic reasons. After that, there should be a comment for
4140: each change that the patch does. There are a number of standard
4141: cases:</p>
1.41 asau 4142: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4143: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 4144: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 4145: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 4146: platform and other environment (for example, the compiler) that the
4147: patch is needed for.</p></li>
4148: </ul></div>
1.108 rillig 4149: <p>The patch should be commented so that any
1.1 dsieger 4150: developer who knows the code of the application can make some use of
4151: the patch. Special care should be taken for the upstream developers,
4152: since we generally want that they accept our patches, so we have less
4153: work in the future.</p>
4154: </div>
1.41 asau 4155: <div class="sect2">
1.1 dsieger 4156: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4157: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4158: <p>One important thing to mention is to pay attention that no RCS
4159: IDs get stored in the patch files, as these will cause problems when
4160: later checked into the NetBSD CVS tree. Use the
1.79 snj 4161: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.1 dsieger 4162: problems.</p>
4163: <p>For even more automation, we recommend using
1.10 hubertf 4164: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4165: whole set of patches. You just have to backup files before you
4166: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4167: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4168: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4169: you upgrade a package this way, you can easily compare the new
4170: set of patches with the previously existing one with
1.24 wiz 4171: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4172: are replaced by new files, so carefully check if you want to take all
4173: the changes.</p>
1.1 dsieger 4174: <p>When you have finished a package, remember to generate
1.10 hubertf 4175: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 4176: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.1 dsieger 4177: <p>When adding a patch that corrects a problem in the
4178: distfile (rather than e.g. enforcing pkgsrc's view of where
4179: man pages should go), send the patch as a bug report to the
4180: maintainer. This benefits non-pkgsrc users of the package,
4181: and usually makes it possible to remove the patch in future
4182: version.</p>
1.2 rillig 4183: <p>The file names of the patch files are usually of the form
1.24 wiz 4184: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4185: Many packages still use the previous convention
4186: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4187: but new patches should be of the form containing the filename.
1.79 snj 4188: <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.24 wiz 4189: automatically.</p>
1.1 dsieger 4190: </div>
1.41 asau 4191: <div class="sect2">
1.1 dsieger 4192: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4193: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4194: <p>If you want to share patches between multiple packages
4195: in pkgsrc, e.g. because they use the same distfiles, set
4196: <code class="varname">PATCHDIR</code> to the path where the patch files
4197: can be found, e.g.:</p>
4198: <pre class="programlisting">
4199: PATCHDIR= ${.CURDIR}/../xemacs/patches
4200: </pre>
4201: <p>Patch files that are distributed by the author or other
4202: maintainers can be listed in
4203: <code class="varname">PATCHFILES</code>.</p>
4204: <p>If it is desired to store any patches that should not be
4205: committed into pkgsrc, they can be kept outside the pkgsrc
4206: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4207: directory tree there is expected to have the same
1.23 wiz 4208: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 4209: patches are expected to be stored inside these dirs (also
4210: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4211: example, if you want to keep a private patch for
4212: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4213: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4214: files in the named directory are expected to be patch files,
4215: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4216: applied</em></span>.</p>
4217: </div>
1.41 asau 4218: <div class="sect2">
1.1 dsieger 4219: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4220: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4221: <p>When fixing a portability issue in the code do not use
4222: preprocessor magic to check for the current operating system nor
4223: platform. Doing so hurts portability to other platforms because
4224: the OS-specific details are not abstracted appropriately.</p>
4225: <p>The general rule to follow is: instead of checking for the
4226: operating system the application is being built on, check for the
4227: specific <span class="emphasis"><em>features</em></span> you need. For example,
4228: instead of assuming that kqueue is available under NetBSD and
4229: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 4230: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4231: yes, this generally involves patching the
1.10 hubertf 4232: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4233: that prevents some OSes from adopting interfaces from other OSes
4234: (e.g. Linux implementing kqueue), something that the above checks
4235: cannot take into account.</p>
4236: <p>Of course, checking for features generally involves more
4237: work on the developer's side, but the resulting changes are
4238: cleaner and there are chances they will work on many other
4239: platforms. Not to mention that there are higher chances of being
4240: later integrated into the mainstream sources. Remember:
4241: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4242: <p>Some typical examples:</p>
4243: <div class="table">
1.6 rillig 4244: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.106 tnn 4245: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 4246: <colgroup>
4247: <col>
4248: <col>
4249: <col>
4250: </colgroup>
4251: <thead><tr>
4252: <th>Where</th>
4253: <th>Incorrect</th>
4254: <th>Correct</th>
4255: </tr></thead>
4256: <tbody>
4257: <tr>
4258: <td>configure script</td>
4259: <td>
4260: <pre class="programlisting">
4261: case ${target_os} in
4262: netbsd*) have_kvm=yes ;;
4263: *) have_kvm=no ;;
4264: esac
4265: </pre>
4266: </td>
4267: <td>
4268: <pre class="programlisting">
4269: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4270: </pre>
4271: </td>
4272: </tr>
4273: <tr>
4274: <td>C source file</td>
4275: <td>
4276: <pre class="programlisting">
4277: #if defined(__NetBSD__)
4278: # include <sys/event.h>
4279: #endif
4280: </pre>
4281: </td>
4282: <td>
4283: <pre class="programlisting">
4284: #if defined(HAVE_SYS_EVENT_H)
4285: # include <sys/event.h>
4286: #endif
4287: </pre>
4288: </td>
4289: </tr>
4290: <tr>
4291: <td>C source file</td>
4292: <td>
4293: <pre class="programlisting">
4294: int
4295: monitor_file(...)
4296: {
4297: #if defined(__NetBSD__)
4298: int fd = kqueue();
4299: ...
4300: #else
4301: ...
4302: #endif
4303: }
4304: </pre>
4305: </td>
4306: <td>
4307: <pre class="programlisting">
4308: int
4309: monitor_file(...)
4310: {
4311: #if defined(HAVE_KQUEUE)
4312: int fd = kqueue();
4313: ...
4314: #else
4315: ...
4316: #endif
4317: }
4318: </pre>
4319: </td>
4320: </tr>
4321: </tbody>
4322: </table></div>
4323: </div>
4324: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 4325: 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
4326: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 4327: 2</a>). It summarizes multiple details on how to make
4328: software easier to package; all the suggestions in it were
4329: collected from our experience in pkgsrc work, so they are possibly
4330: helpful when creating patches too.</p>
4331: </div>
1.41 asau 4332: <div class="sect2">
1.1 dsieger 4333: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4334: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4335: <p>Always, always, <span class="strong"><strong>always</strong></span>
4336: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4337: improvements you do to a package to the mainstream developers.
4338: This is the only way to get their attention on portability issues
4339: and to ensure that future versions can be built out-of-the box on
4340: NetBSD. Furthermore, any user that gets newer distfiles will get
4341: the fixes straight from the packaged code.</p>
4342: <p>This generally involves cleaning up the patches
4343: (because sometimes the patches that are
1.40 wiz 4344: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 4345: appropriate trackers for the projects and working with the
4346: mainstream authors to accept your changes. It is
4347: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4348: the packages in pkgsrc are kept simple and thus further changes
4349: can be done without much hassle.</p>
1.24 wiz 4350: <p>When you have done this, please add a URL to the upstream
4351: bug report to the patch comment.</p>
1.1 dsieger 4352: <p>Support the idea of free software!</p>
4353: </div>
4354: </div>
1.41 asau 4355: <div class="sect1">
1.1 dsieger 4356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4357: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 4358: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4359: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4360: <dd><p>A multi-line description of the piece of software. This should include
4361: any credits where they are due. Please bear in mind that others do not
4362: share your sense of humour (or spelling idiosyncrasies), and that others
4363: will read everything that you write here.</p></dd>
4364: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4365: <dd><p>This file governs the files that are installed on your
4366: system: all the binaries, manual pages, etc. There are other
4367: directives which may be entered in this file, to control the
4368: creation and deletion of directories, and the location of
1.10 hubertf 4369: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 4370: information.</p></dd>
4371: </dl></div>
4372: </div>
1.41 asau 4373: <div class="sect1">
1.1 dsieger 4374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4375: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 4376: <div class="sect2">
1.1 dsieger 4377: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4378: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4379: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4380: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4381: <dd>
1.79 snj 4382: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 4383: First time after package extraction and before files are
4384: moved in place, the second time after the files to install
4385: are moved in place. This can be used to do any custom
4386: procedures not possible with @exec commands in
1.79 snj 4387: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4388: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.
1.28 wiz 4389: Please note that you can modify variables in it easily by using
4390: <code class="varname">FILES_SUBST</code> in the package's
4391: <code class="filename">Makefile</code>:</p>
4392: <pre class="programlisting">
4393: FILES_SUBST+= SOMEVAR="somevalue"
4394: </pre>
4395: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4396: <code class="filename">INSTALL</code>. By default, substitution is
4397: performed for <code class="varname">PREFIX</code>,
4398: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4399: <code class="varname">VARBASE</code>, and a few others, type
4400: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4401: complete list.</p>
4402: </dd>
1.1 dsieger 4403: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4404: <dd><p>This script is executed before and after any files are removed. It is
4405: this script's responsibility to clean up any additional messy details
4406: around the package's installation, since all pkg_delete knows is how to
4407: delete the files created in the original distribution.
1.79 snj 4408: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4409: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28 wiz 4410: The same methods to replace variables can be used as for
4411: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4412: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4413: <dd>
4414: <p>This file is displayed after installation of the package.
4415: Useful for things like legal notices on almost-free
4416: software and hints for updating config files after
4417: installing modules for apache, PHP etc.
4418: Please note that you can modify variables in it easily by using
4419: <code class="varname">MESSAGE_SUBST</code> in the package's
4420: <code class="filename">Makefile</code>:</p>
4421: <pre class="programlisting">
4422: MESSAGE_SUBST+= SOMEVAR="somevalue"
4423: </pre>
1.23 wiz 4424: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4425: <code class="filename">MESSAGE</code>. By default, substitution is
4426: performed for <code class="varname">PKGNAME</code>,
4427: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 4428: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 4429: <code class="varname">PKG_SYSCONFDIR</code>,
4430: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4431: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4432: <p>You can display a different or additional files by
4433: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4434: default is <code class="filename">MESSAGE</code>, if the file
4435: exists.</p>
4436: </dd>
4437: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 4438: <dd>
4439: <p>This file is used by the alternatives framework.
4440: It creates, configures, and destroys generic wrappers used to
4441: run programs with similar interfaces.
4442: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4443: for more information.</p>
4444: <p>Each line of the file contains two filenames, first
4445: the wrapper and then the alternative provided by the package.
4446: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4447: </dd>
1.1 dsieger 4448: </dl></div>
4449: </div>
1.41 asau 4450: <div class="sect2">
1.1 dsieger 4451: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4452: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4453: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4454: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4455: <dd><p>This file contains arbitrary things that could
4456: also go into a <code class="filename">Makefile</code>, but its purpose is
4457: to be used by more than one package. This file should only be
4458: used when the packages that will use the file are known in
4459: advance. For other purposes it is often better to write a
4460: <code class="filename">*.mk</code> file and give it a good name that
4461: describes what it does.</p></dd>
4462: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4463: <dd><p>This file contains the dependency information
1.10 hubertf 4464: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1 dsieger 4465: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4466: <dd><p>This file contains workarounds for compiler bugs
4467: and similar things. It is included automatically by the pkgsrc
4468: infrastructure, so you don't need an extra
4469: <code class="literal">.include</code> line for
4470: it.</p></dd>
4471: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4472: <dd><p>This file contains the code for the
1.10 hubertf 4473: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1 dsieger 4474: selected by the user. If a package has only one or two options,
4475: it is equally acceptable to put the code directly into the
4476: <code class="filename">Makefile</code>.</p></dd>
4477: </dl></div>
4478: </div>
1.41 asau 4479: <div class="sect2">
1.1 dsieger 4480: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4481: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4482: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4483: <dt><span class="term"><code class="filename">README*</code></span></dt>
4484: <dd><p>These files do not take place in the creation of
4485: a package and thus are purely informative to the package
4486: developer.</p></dd>
4487: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4488: <dd><p>This file contains things that need to be done
4489: to make the package even
4490: better.</p></dd>
4491: </dl></div>
4492: </div>
4493: </div>
1.41 asau 4494: <div class="sect1">
1.1 dsieger 4495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4496: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4497: </h2></div></div></div>
1.10 hubertf 4498: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4499: unpacked into the directory denoted by
4500: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4501: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4502: directory is also used to keep various timestamp files.
4503: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4504: The default is <code class="filename">${.CURDIR}/work</code>
4505: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4506: if <code class="varname">OBJMACHINE</code> is set.</p>
4507: </div>
1.41 asau 4508: <div class="sect1">
1.1 dsieger 4509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4510: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4511: </h2></div></div></div>
4512: <p>If you have any files that you wish to be placed in the package prior
4513: to configuration or building, you could place these files here and use
1.10 hubertf 4514: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4515: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4516: this. Alternatively, you could simply diff the file against
4517: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4518: the creation of this file.</p>
4519: <p>If you want to share files in this way with other
4520: packages, set the <code class="varname">FILESDIR</code> variable to point
4521: to the other package's <code class="filename">files</code> directory,
4522: e.g.:</p>
4523: <pre class="programlisting">
4524: FILESDIR=${.CURDIR}/../xemacs/files
4525: </pre>
4526: </div>
4527: </div>
1.41 asau 4528: <div class="chapter">
1.1 dsieger 4529: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4530: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4531: <div class="toc">
4532: <p><b>Table of Contents</b></p>
1.100 leot 4533: <dl class="toc">
1.6 rillig 4534: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4535: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4536: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4537: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4538: <dd><dl>
4539: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 4540: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
4541: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
4542: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4543: </dl></dd>
4544: </dl>
4545: </div>
4546: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4547: each of which forms a well-defined part of the pkgsrc system. Using
1.79 snj 4548: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1 dsieger 4549: like pkgsrc requires some discipline to keep the code correct and
4550: understandable.</p>
4551: <p>The basic ingredients for <code class="filename">Makefile</code>
4552: programming are variables (which are actually macros) and shell
4553: commands. Among these shell commands may even be more complex ones
1.79 snj 4554: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1 dsieger 4555: as intended it is necessary to quote all variables correctly when they
4556: are used.</p>
4557: <p>This chapter describes some patterns, that appear quite often in
4558: <code class="filename">Makefile</code>s, including the pitfalls that come along
4559: with them.</p>
1.41 asau 4560: <div class="sect1">
1.1 dsieger 4561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4562: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4564: <p>When you are creating a file as a
4565: target of a rule, always write the data to a temporary file first
4566: and finally rename that file. Otherwise there might occur an error
4567: in the middle of generating the file, and when the user runs
1.79 snj 4568: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1 dsieger 4569: regenerated properly. Example:</p>
4570: <pre class="programlisting">
4571: wrong:
4572: @echo "line 1" > ${.TARGET}
4573: @echo "line 2" >> ${.TARGET}
4574: @false
4575:
4576: correct:
4577: @echo "line 1" > ${.TARGET}.tmp
4578: @echo "line 2" >> ${.TARGET}.tmp
4579: @false
4580: @mv ${.TARGET}.tmp ${.TARGET}
4581: </pre>
1.10 hubertf 4582: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4583: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4584: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4585: correct</strong></span> gives an error message twice, as expected.</p>
1.79 snj 4586: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1 dsieger 4587: <code class="literal">${.TARGET}</code> in case of error, but this only
4588: happens when it is interrupted, for example by pressing
4589: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.79 snj 4590: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1 dsieger 4591: </li></ul></div>
4592: </div>
1.41 asau 4593: <div class="sect1">
1.1 dsieger 4594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4595: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4596: <p><code class="filename">Makefile</code> variables contain strings that
4597: can be processed using the five operators ``='', ``+='', ``?='',
1.79 snj 4598: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1 dsieger 4599: page.</p>
4600: <p>When a variable's value is parsed from a
4601: <code class="filename">Makefile</code>, the hash character ``#'' and the
4602: backslash character ``\'' are handled specially. If a backslash is
4603: followed by a newline, any whitespace immediately in front of the
4604: backslash, the backslash, the newline, and any whitespace
4605: immediately behind the newline are replaced with a single space. A
4606: backslash character and an immediately following hash character are
4607: replaced with a single hash character. Otherwise, the backslash is
4608: passed as is. In a variable assignment, any hash character that is
4609: not preceded by a backslash starts a comment that continues upto the
4610: end of the logical line.</p>
1.108 rillig 4611: <p>The evaluation of variables either happens immediately or lazy.
4612: It happens immediately when the variable occurs
4613: on the right-hand side of the ``:='' or the ``!='' operator, in a
4614: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4615: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4616: <p>Some of the modifiers split the string into words and then
4617: operate on the words, others operate on the string as a whole. When
1.108 rillig 4618: a string is split into words, it is split like in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.1 dsieger 4619: <p>There are several types of variables that should be handled
4620: differently. Strings and two types of lists.</p>
1.41 asau 4621: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4622: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4623: characters. Nevertheless, you should restrict yourself to only
4624: using printable characters. Examples are
4625: <code class="varname">PREFIX</code> and
4626: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4627: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4628: are never exported to any shell command. Their elements are
4629: separated by whitespace. Therefore, the elements themselves cannot
4630: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4631: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4632: Examples are <code class="varname">DEPENDS</code> and
4633: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4634: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4635: may be exported to a shell command. Their elements can contain any
4636: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4637: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4638: <code class="varname">DISTFILES</code> and
4639: <code class="varname">MASTER_SITES</code>.</p></li>
4640: </ul></div>
1.41 asau 4641: <div class="sect2">
1.1 dsieger 4642: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4643: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4644: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4645: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4646: are reserved for use by the pkgsrc infrastructure. They shall
4647: not be used by package
4648: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4649: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4650: lowercase variable names for the iteration
4651: variables.</p></li>
1.23 wiz 4652: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4653: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4654: <code class="varname">DISTFILES</code>.</p></li>
4655: </ul></div>
4656: </div>
4657: </div>
1.41 asau 4658: <div class="sect1">
1.1 dsieger 4659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4660: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.41 asau 4661: <div class="sect2">
1.1 dsieger 4662: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4663: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4664: <p>When adding a string that possibly contains whitespace or quotes to
4665: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4666: modifier.</p>
4667: <p>When adding another list to a list (example 2), it must not be
4668: quoted, since its elements are already quoted.</p>
1.1 dsieger 4669: <pre class="programlisting">
1.108 rillig 4670: STRING= foo * bar `date`
4671: LIST= # empty
4672: ANOTHER_LIST= a=b c=d
4673:
4674: LIST+= ${STRING:Q} # 1
4675: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4676: </pre>
4677: </div>
1.41 asau 4678: <div class="sect2">
1.1 dsieger 4679: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4680: <a name="echo-literal"></a>12.3.2. Echoing a string exacty as-is</h3></div></div></div>
4681: <p>Echoing a string containing special characters needs special
4682: work.</p>
1.1 dsieger 4683: <pre class="programlisting">
4684: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4685: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4686:
4687: all:
4688: echo ${STRING} # 1
1.108 rillig 4689: echo ${STRING:Q} # 2
4690: printf '%s\n' ${STRING:Q}'' # 3
4691: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4692: </pre>
4693: <p>Example 1 leads to a syntax error in the shell, as the characters
4694: are just copied.</p>
4695: <p>Example 2 quotes the string so that the shell interprets it
4696: correctly. But the echo command may additionally interpret strings with a
4697: leading dash or those containing backslashes.</p>
4698: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
4699: interprets the format string, but not the next argument.</p>
4700: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4701: need to be quoted because the quoting has already been done
4702: when adding elements to the list.</p>
1.1 dsieger 4703: </div>
1.41 asau 4704: <div class="sect2">
1.1 dsieger 4705: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4706: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4707: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4708: GNU-style configure script (especially those that call other configure
4709: scripts), it must not have leading or trailing whitespace, since
4710: otherwise the configure script gets confused. To trim leading and
4711: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4712: following example:</p>
1.1 dsieger 4713: <pre class="programlisting">
4714: CPPFLAGS= # empty
1.108 rillig 4715: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4716: CPPFLAGS+= ${MY_CPPFLAGS}
4717:
4718: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4719:
4720: all:
4721: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4722: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4723: </pre>
1.108 rillig 4724: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4725: trailing whitespace because the <code class="code">+=</code> operator always adds a
4726: space.</p>
4727: </div>
4728: <div class="sect2">
4729: <div class="titlepage"><div><div><h3 class="title">
4730: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4731: <p>When a possibly empty variable is used in a shell program, it may
4732: lead to a syntax error.</p>
4733: <pre class="programlisting">
4734: EGFILES= # empty
4735:
4736: install-examples: # produces a syntax error in the shell
4737: for egfile in ${EGFILES}; do \
4738: echo "Installing $$egfile"; \
4739: done
4740: </pre>
4741: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
4742: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
4743: To fix this syntax error, use one of the snippets below.</p>
4744: <pre class="programlisting">
4745: EMPTY= # empty
4746:
4747: install-examples:
4748: for egfile in ${EGFILES} ""; do \
4749: [ -n "$$egfile" ] || continue; \
4750: echo "Installing $$egfile"; \
1.1 dsieger 4751: done
1.108 rillig 4752: </pre>
4753: <p>In this case, an empty string is appended to the iteration list (to
4754: prevent the syntax error) and filtered out later.</p>
4755: <pre class="programlisting">
4756: EGFILES= # empty
1.1 dsieger 4757:
1.108 rillig 4758: install-examples:
4759: .for egfile in ${EGFILES}
4760: echo "Installing ${egfile}"
1.1 dsieger 4761: .endfor
4762: </pre>
1.108 rillig 4763: <p>This variant only works when <code class="varname">EGFILES</code> does not
4764: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4765: simple whitespace.</p>
4766: <p>To have a shell command test whether a make variable is empty, use
4767: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4768: </div>
4769: </div>
4770: </div>
1.41 asau 4771: <div class="chapter">
1.1 dsieger 4772: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4773: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4774: <div class="toc">
4775: <p><b>Table of Contents</b></p>
1.100 leot 4776: <dl class="toc">
1.6 rillig 4777: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4778: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4779: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 4780: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4781: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4782: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 4783: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4784: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4785: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4786: </dl>
4787: </div>
4788: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4789: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4790: the package (relative to the <code class="filename">${PREFIX}</code>
4791: directory it's been installed in) plus some additional statements
1.79 snj 4792: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 4793: This chapter addresses some issues that need attention when
4794: dealing with the <code class="filename">PLIST</code> file (or files, see
4795: below!).</p>
1.41 asau 4796: <div class="sect1">
1.1 dsieger 4797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4798: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4799: <p>Be sure to add a RCS ID line as the first thing in any
4800: <code class="filename">PLIST</code> file you write:</p>
4801: <pre class="programlisting">
4802: @comment $NetBSD$
4803: </pre>
4804: </div>
1.41 asau 4805: <div class="sect1">
1.1 dsieger 4806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4807: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4808: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4809: to output a PLIST that matches any new files since the package
1.10 hubertf 4810: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.1 dsieger 4811: more information on this target.</p>
4812: </div>
1.41 asau 4813: <div class="sect1">
1.1 dsieger 4814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4815: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4816: </h2></div></div></div>
4817: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4818: of AWK patterns and actions that are used to filter the output of
4819: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4820: scripting you like to it, but be careful with quoting.</p>
4821: <p>For example, to get all files inside the
4822: <code class="filename">libdata/foo</code> directory removed from the
4823: resulting PLIST:</p>
4824: <pre class="programlisting">
4825: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
4826: </pre>
4827: </div>
1.41 asau 4828: <div class="sect1">
1.1 dsieger 4829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4830: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4831: <p>A number of variables are substituted automatically in
4832: PLISTs when a package is installed on a system. This includes the
4833: following variables:</p>
1.41 asau 4834: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4835: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4836: <dd>
4837: <p>Some packages like emacs and perl embed information
4838: about which architecture they were built on into the
4839: pathnames where they install their files. To handle this
4840: case, PLIST will be preprocessed before actually used, and
4841: the symbol
1.23 wiz 4842: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4843: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4844: same is done if the string
4845: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4846: PLIST somewhere - use this on packages that have GNU
4847: autoconf-created configure scripts.</p>
1.41 asau 4848: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4849: <h3 class="title">Legacy note</h3>
4850: <p>There used to be a symbol
1.23 wiz 4851: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4852: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4853: -m</strong></span>, but that's no longer supported and has
4854: been removed.</p>
4855: </div>
4856: </dd>
4857: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4858: <dd>
4859: <p>Some packages want to embed the OS name and version
4860: into some paths. To do this, use these variables in the
4861: <code class="filename">PLIST</code>:
4862: </p>
1.41 asau 4863: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4864: <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>
4865: <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>
4866: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.1 dsieger 4867: </ul></div>
4868: </dd>
4869: </dl></div>
1.88 tnn 4870: <p>For a list of values which are replaced by
4871: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4872: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4873: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4874: <p>If you want to change other variables not listed above, you
4875: can add variables and their expansions to this variable in the
1.10 hubertf 4876: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.1 dsieger 4877: <pre class="programlisting">
4878: PLIST_SUBST+= SOMEVAR="somevalue"
4879: </pre>
1.23 wiz 4880: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4881: in the <code class="filename">PLIST</code> with
1.23 wiz 4882: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4883: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4884: the common case of conditionally including some
4885: <code class="filename">PLIST</code> entries. It can be done by adding
4886: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4887: setting the corresponding <code class="varname">PLIST.foo</code> variable
4888: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4889: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4890: in the <code class="filename">PLIST</code> with either
1.23 wiz 4891: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4892: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4893: For example, in <code class="filename">Makefile</code>:</p>
4894: <pre class="programlisting">
4895: PLIST_VARS+= foo
4896: .if <em class="replaceable"><code>condition</code></em>
4897: PLIST.foo= yes
4898: .else
4899: </pre>
4900: <p>And then in <code class="filename">PLIST</code>:</p>
4901: <pre class="programlisting">
4902: @comment $NetBSD$
4903: bin/bar
4904: man/man1/bar.1
4905: ${PLIST.foo}bin/foo
4906: ${PLIST.foo}man/man1/foo.1
4907: ${PLIST.foo}share/bar/foo.data
4908: </pre>
1.1 dsieger 4909: </div>
1.41 asau 4910: <div class="sect1">
1.1 dsieger 4911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4912: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 4913: <p>Man pages should be installed in compressed form if
4914: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4915: and uncompressed otherwise. To handle this in the
1.23 wiz 4916: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4917: appended/removed automatically for man pages according to
4918: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4919: or not, see above for details. This modification of the
4920: <code class="filename">PLIST</code> file is done on a copy of it, not
4921: <code class="filename">PLIST</code> itself.</p>
4922: </div>
1.41 asau 4923: <div class="sect1">
1.1 dsieger 4924: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4925: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4926: </h2></div></div></div>
4927: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4928: in generating the binary package, set the variable
4929: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.79 snj 4930: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1 dsieger 4931: important. The default for <code class="varname">PLIST_SRC</code> is
4932: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4933: </div>
1.41 asau 4934: <div class="sect1">
1.1 dsieger 4935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4936: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4937: <p>Some packages decide to install a different set of files based on
4938: the operating system being used. These differences can be
4939: automatically handled by using the following files:</p>
1.41 asau 4940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4941: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4942: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4943: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4944: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4945: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4946: </ul></div>
4947: </div>
1.41 asau 4948: <div class="sect1">
1.1 dsieger 4949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 4950: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4951: <p>Some packages decide to generate hard-to-guess file names
4952: during installation that are hard to wire down.</p>
4953: <p>In such cases, you can set the
4954: <code class="varname">GENERATE_PLIST</code> variable to shell code
4955: terminated (with a semicolon) that will output PLIST entries which
4956: will be appended to the PLIST</p>
4957: <p>You can find one example in editors/xemacs:</p>
4958: <pre class="programlisting">
4959: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4960: </pre>
4961: <p>which will append something like
4962: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4963: <code class="filename">PLIST</code>.
4964: </p>
4965: </div>
4966: <div class="sect1">
4967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4968: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4969: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4970: multiple (and unrelated) packages install files. These
1.22 jakllsch 4971: directories were problematic because you had to add special
4972: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4973: centralized package handle them.</p>
1.22 jakllsch 4974: <p>In pkgsrc, it is now easy: Each package should create
4975: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4976: will remove any directories left empty after uninstalling a
4977: package.</p>
4978: <p>If a package needs an empty directory to work, create
4979: the directory during installation as usual, and also add an
4980: entry to the PLIST:
4981: </p>
1.1 dsieger 4982: <pre class="programlisting">
1.22 jakllsch 4983: @pkgdir path/to/empty/directory
1.1 dsieger 4984: </pre>
1.22 jakllsch 4985: <p>
1.86 wiz 4986: or take a look at <code class="varname">MAKE_DIRS</code> and
4987: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4988: </p>
1.1 dsieger 4989: </div>
4990: </div>
1.41 asau 4991: <div class="chapter">
1.1 dsieger 4992: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4993: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4994: <div class="toc">
4995: <p><b>Table of Contents</b></p>
1.100 leot 4996: <dl class="toc">
1.6 rillig 4997: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 4998: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4999: <dd><dl>
1.6 rillig 5000: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 5001: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5002: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5003: and
5004: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5005: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5006: </dl></dd>
1.23 wiz 5007: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1 dsieger 5008: <dd><dl>
1.23 wiz 5009: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 5010: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1 dsieger 5011: </dl></dd>
5012: </dl>
5013: </div>
5014: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5015: are seen by a package's configure and build processes. This is implemented
5016: in a two step process:</p>
1.23 wiz 5017: <div class="orderedlist"><ol class="orderedlist" type="1">
5018: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 5019: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5020: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 5021: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 5022: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5023: <code class="option">-L${LOCALBASE}/lib</code> into references to
5024: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5025: native compiler on some operating systems look like GCC, so that
5026: packages that expect GCC won't require modifications to build with
5027: those native compilers.</p></li>
5028: </ol></div>
5029: <p>This normalizes the environment in which a package is built so that the
5030: package may be built consistently despite what other software may be
5031: installed. Please note that the normal system header and library paths,
5032: e.g. <code class="filename">/usr/include</code>,
5033: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5034: designed to insulate the package build from non-system-supplied
5035: software.</p>
1.41 asau 5036: <div class="sect1">
1.1 dsieger 5037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5038: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5039: <p>The process of converting packages to use the buildlink3
1.23 wiz 5040: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 5041: The things to keep in mind are:</p>
1.23 wiz 5042: <div class="orderedlist"><ol class="orderedlist" type="1">
5043: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 5044: instead of the actual toolchain. Some packages are tricky,
5045: and the only way to know for sure is the check
5046: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5047: wrappers are being invoked.</p></li>
1.23 wiz 5048: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 5049: the package Makefile, e.g. Java VMs, standalone shells,
5050: etc., because the code to symlink files into
5051: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 5052: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 5053: </p></li>
1.23 wiz 5054: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 5055: <code class="filename">buildlink3.mk</code> files that you list in a
5056: package's Makefile are added as dependencies for that package.
5057: </p></li>
5058: </ol></div>
5059: <p>If a dependency on a particular package is required for its libraries and
5060: headers, then we replace:</p>
5061: <pre class="programlisting">
5062: DEPENDS+= foo>=1.1.0:../../category/foo
5063: </pre>
5064: <p>with</p>
5065: <pre class="programlisting">
5066: .include "../../category/foo/buildlink3.mk"
5067: </pre>
5068: <p>The buildlink3.mk files usually define the required dependencies.
5069: If you need a newer version of the dependency when using buildlink3.mk
5070: files, then you can define it in your Makefile; for example:</p>
5071: <pre class="programlisting">
5072: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5073: .include "../../category/foo/buildlink3.mk"
5074: </pre>
5075: <p>There are several <code class="filename">buildlink3.mk</code>
5076: files in <code class="filename">pkgsrc/mk</code>
5077: that handle special package issues:</p>
1.41 asau 5078: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5079: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 5080: the native or a pkgsrc Berkeley DB implementation based on
5081: the values of <code class="varname">BDB_ACCEPTED</code> and
5082: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 5083: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 5084: comes with neither Curses nor NCurses, this will take care
1.79 snj 5085: to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.23 wiz 5086: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 5087: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5088: adding a dependency on Heimdal or MIT-krb5 for packages that
5089: require a Kerberos 5 implementation.</p></li>
1.23 wiz 5090: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 5091: system-provided Motif installation or adds a dependency on
1.79 snj 5092: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>. The user can set
1.23 wiz 5093: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 5094: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5095: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 5096: which Motif version will be used.</p></li>
1.55 ryoon 5097: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 5098: system-provided GNU readline or editline (libedit) installation,
1.79 snj 5099: or adds a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
5100: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.55 ryoon 5101: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5102: If your package really needs GNU readline library, its Makefile
5103: should include <code class="filename">devel/readline/buildlink3.mk</code>
5104: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 5105: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 5106: variables that may be used by packages that use the
5107: Open Sound System (OSS) API.</p></li>
1.23 wiz 5108: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 5109: any of the Postgres versions in the variable
5110: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5111: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 5112: the file for more information.</p></li>
1.23 wiz 5113: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 5114: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.79 snj 5115: a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.23 wiz 5116: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 5117: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5118: library.</p></li>
5119: </ul></div>
5120: <p>The comments in those <code class="filename">buildlink3.mk</code>
5121: files provide a more complete
5122: description of how to use them properly.</p>
5123: </div>
1.41 asau 5124: <div class="sect1">
1.1 dsieger 5125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5126: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5127: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5128: included by Makefiles to indicate the need to compile and link
5129: against header files and libraries provided by the package. A
5130: <code class="filename">buildlink3.mk</code> file should always provide
5131: enough information to add the correct type of dependency
5132: relationship and include any other
5133: <code class="filename">buildlink3.mk</code> files that it needs to find
5134: headers and libraries that it needs in turn.</p>
5135: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.79 snj 5136: file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.1 dsieger 5137: package is highly recommended. For most packages, the following
5138: command will generate a good starting point for
5139: <code class="filename">buildlink3.mk</code> files:</p>
5140: <pre class="screen">
5141: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5142: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5143: </pre>
1.41 asau 5144: <div class="sect2">
1.1 dsieger 5145: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5146: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5147: <p>The following real-life example
5148: <code class="filename">buildlink3.mk</code> is taken
5149: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5150: <pre class="programlisting">
1.18 snj 5151: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5152:
1.18 snj 5153: BUILDLINK_TREE+= tiff
1.1 dsieger 5154:
1.18 snj 5155: .if !defined(TIFF_BUILDLINK3_MK)
5156: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5157:
1.18 snj 5158: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5159: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5160: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5161:
5162: .include "../../devel/zlib/buildlink3.mk"
5163: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 5164: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5165:
1.18 snj 5166: BUILDLINK_TREE+= -tiff
1.1 dsieger 5167: </pre>
5168: <p>The header and footer manipulate
1.18 snj 5169: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 5170: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 5171: the dependency tree.</p>
5172: <p>The main section is protected from multiple inclusion
1.1 dsieger 5173: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5174: added. Several important variables are set in the section:</p>
1.41 asau 5175: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5176: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5177: is the actual dependency recorded in the installed
5178: package; this should always be set using
1.10 hubertf 5179: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5180: we're appending to any pre-existing list of values. This
5181: variable should be set to the first version of the
1.26 wiz 5182: package that had an backwards-incompatible API change.
1.1 dsieger 5183: </p></li>
1.23 wiz 5184: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5185: is the location of the <em class="replaceable"><code>pkg</code></em>
5186: pkgsrc directory.</p></li>
1.23 wiz 5187: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5188: (not shown above) controls whether we use
5189: <code class="varname">BUILD_DEPENDS</code> or
5190: <code class="varname">DEPENDS</code> to add the dependency on
5191: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5192: selected by setting
5193: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5194: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 5195: used.</p></li>
1.23 wiz 5196: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5197: and
5198: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5199: (not shown above) are lists of subdirectories of
5200: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5201: to add to the header and library search paths. These
1.23 wiz 5202: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 5203: respectively.</p></li>
1.23 wiz 5204: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5205: (not shown above) is the list of preprocessor flags to add
5206: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 5207: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 5208: should be avoided and instead be handled using
5209: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5210: above.</p></li>
5211: </ul></div>
5212: <p>The following variables are all optionally defined within
5213: this second section (protected against multiple inclusion) and
5214: control which package files are symlinked into
5215: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5216: transformed during the symlinking:</p>
1.41 asau 5217: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5218: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5219: (not shown above) is a shell glob pattern relative to
5220: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5221: to be symlinked into
5222: <code class="filename">${BUILDLINK_DIR}</code>,
5223: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 5224: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5225: (not shown above) is a shell pipeline that
5226: outputs to stdout a list of files relative to
5227: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5228: The resulting files are to be symlinked
5229: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5230: this takes the <code class="filename">+CONTENTS</code> of a
5231: <em class="replaceable"><code>pkg</code></em> and filters it through
5232: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 5233: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5234: (not shown above) is a filter command that filters
5235: <code class="filename">+CONTENTS</code> input into a list of files
5236: relative to
5237: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 5238: on stdout. By default,
1.1 dsieger 5239: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5240: outputs the contents of the <code class="filename">include</code>
5241: and <code class="filename">lib</code> directories in the package
1.84 wiz 5242: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 5243: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5244: (not shown above) is a list of sed arguments used to
5245: transform the name of the source filename into a
1.10 hubertf 5246: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5247: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5248: </ul></div>
1.18 snj 5249: <p>This section can additionally include any
1.1 dsieger 5250: <code class="filename">buildlink3.mk</code> needed for
5251: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5252: Including these <code class="filename">buildlink3.mk</code> files
5253: means that the headers and libraries for these
5254: dependencies are also symlinked into
5255: <code class="filename">${BUILDLINK_DIR}</code>
5256: whenever the <em class="replaceable"><code>pkg</code></em>
5257: <code class="filename">buildlink3.mk</code>
1.18 snj 5258: file is included. Dependencies are only added for directly
5259: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 5260: <p>When providing a <code class="filename">buildlink3.mk</code> and
5261: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 5262: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 5263: header files are automatically exposed when the package is
5264: use.</p>
5265: <p>In particular, if only an executable
5266: (<code class="filename">bin/foo</code>) is linked against a library, that
5267: library does not need to be propagated in the
5268: <code class="filename">buildlink3.mk</code> file.</p>
5269: <p>The following steps should help you decide if a
5270: <code class="filename">buildlink3.mk</code> file needs to be included:
5271: </p>
5272: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5273: <li class="listitem"><p>Look at the installed header files: What
5274: headers do they include? The packages providing these files
5275: must be buildlinked.</p></li>
1.49 wiz 5276: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5277: libraries and look against what other libraries they link.
5278: Some of the packages providing these probably need to be
5279: buildlinked; however, it's not automatic, since e.g. GTK on
5280: some systems pulls in the X libraries, so they will show up in
5281: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 5282: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 5283: used as a hint.</p></li>
1.47 wiz 5284: </ul></div>
5285: <p>
5286: </p>
1.1 dsieger 5287: </div>
1.41 asau 5288: <div class="sect2">
1.1 dsieger 5289: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 5290: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 5291: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5292: and
5293: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5294: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5295: <p>These two variables differ in that one describes source
5296: compatibility (API) and the other binary compatibility (ABI).
5297: The difference is that a change in the API breaks compilation of
5298: programs while changes in the ABI stop compiled programs from
5299: running.</p>
5300: <p>Changes to the
1.27 wiz 5301: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5302: variable in a <code class="filename">buildlink3.mk</code> file happen
5303: very rarely. One possible reason is that all packages depending
5304: on this already need a newer version. In case it is bumped see
5305: the description below.</p>
5306: <p>The most common example of an ABI change is that the major
5307: version of a shared library is increased. In this case,
5308: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5309: should be adjusted to require at least the new package version.
5310: Then the packages that depend on this package need their
5311: <code class="varname">PKGREVISION</code>s increased and, if they have
5312: <code class="filename">buildlink3.mk</code> files, their
5313: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5314: adjusted, too. This is needed so pkgsrc will require the correct
5315: package dependency and not settle for an older one when building
5316: the source.</p>
1.108 rillig 5317: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.26 wiz 5318: more information about dependencies on other packages,
5319: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 5320: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5321: <p>Please take careful consideration before adjusting
5322: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5323: or
5324: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5325: as we don't want to cause unneeded package deletions and
5326: rebuilds. In many cases, new versions of packages work just
5327: fine with older dependencies.</p>
5328: <p>Also it is not needed to set
1.26 wiz 5329: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5330: when it is identical to
1.1 dsieger 5331: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5332: </div>
5333: </div>
1.41 asau 5334: <div class="sect1">
1.1 dsieger 5335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5336: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5337: <p>Some packages in pkgsrc install headers and libraries that
5338: coincide with headers and libraries present in the base system.
5339: Aside from a <code class="filename">buildlink3.mk</code> file, these
5340: packages should also include a <code class="filename">builtin.mk</code>
5341: file that includes the necessary checks to decide whether using
5342: the built-in software or the pkgsrc software is
5343: appropriate.</p>
5344: <p>The only requirements of a builtin.mk file for
5345: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 5346: <div class="orderedlist"><ol class="orderedlist" type="1">
5347: <li class="listitem"><p>It should set
1.1 dsieger 5348: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5349: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 5350: after it is included.</p></li>
1.23 wiz 5351: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 5352: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5353: which is already set before the
5354: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 5355: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 5356: is <span class="emphasis"><em>very</em></span> important and takes careful
5357: attention to <code class="filename">Makefile</code> coding.</p></li>
5358: </ol></div>
1.41 asau 5359: <div class="sect2">
1.1 dsieger 5360: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5361: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1 dsieger 5362: <p>The following is the recommended template for builtin.mk
5363: files:</p>
5364: <pre class="programlisting">
5365: .if !defined(IS_BUILTIN.foo)
5366: #
5367: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5368: # genuinely exists in the system or not.
5369: #
5370: IS_BUILTIN.foo?= no
5371:
5372: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5373: # version can be determined.
5374: #
5375: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5376: BUILTIN_PKG.foo?= foo-1.0
5377: . endif
5378: .endif # IS_BUILTIN.foo
5379:
5380: .if !defined(USE_BUILTIN.foo)
5381: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5382: . if defined(BUILTIN_PKG.foo)
5383: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5384: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5385: USE_BUILTIN.foo!= \
5386: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5387: && ${ECHO} "yes" || ${ECHO} "no"
5388: . endif
5389: . endfor
5390: . endif
5391: .endif # USE_BUILTIN.foo
5392:
5393: CHECK_BUILTIN.foo?= no
5394: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5395: #
5396: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5397: # "yes" or "no".
5398: #
5399: .endif # CHECK_BUILTIN.foo
5400: </pre>
5401: <p>The first section sets
5402: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5403: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5404: in the base system. This should not be a base system software
5405: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5406: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5407: included as part of the base system. This variable is only
5408: used internally within the <code class="filename">builtin.mk</code>
5409: file.</p>
5410: <p>The second section sets
5411: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5412: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5413: system if it exists (if
5414: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5415: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5416: within the <code class="filename">builtin.mk</code> file.</p>
5417: <p>The third section sets
5418: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5419: and is <span class="emphasis"><em>required</em></span> in all
5420: <code class="filename">builtin.mk</code> files. The code in this
5421: section must make the determination whether the built-in
5422: software is adequate to satisfy the dependencies listed in
5423: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5424: This is typically done by comparing
5425: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5426: against each of the dependencies in
5427: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5428: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5429: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5430: end of the <code class="filename">builtin.mk</code> file. Note that
5431: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5432: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5433: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5434: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5435: that the built-in version of the software is similar enough to
5436: be used as a replacement.</p>
5437: <p>The last section is guarded by
5438: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5439: and includes code that uses the value of
5440: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5441: set in the previous section. This typically includes, e.g.,
5442: adding additional dependency restrictions and listing additional
5443: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5444: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5445: </div>
1.41 asau 5446: <div class="sect2">
1.1 dsieger 5447: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5448: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5449: <p>When building packages, it's possible to choose whether to set
5450: a global preference for using either the built-in (native)
5451: version or the pkgsrc version of software to satisfy a
5452: dependency. This is controlled by setting
5453: <code class="varname">PREFER_PKGSRC</code> and
5454: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5455: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.1 dsieger 5456: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5457: use the pkgsrc versions of software, while
5458: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5459: built-in versions. Preferences are determined by the most
5460: specific instance of the package in either
5461: <code class="varname">PREFER_PKGSRC</code> or
5462: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5463: in neither or in both variables, then
5464: <code class="varname">PREFER_PKGSRC</code> has precedence over
5465: <code class="varname">PREFER_NATIVE</code>. For example, to require
5466: using pkgsrc versions of software for all but the most basic
5467: bits on a NetBSD system, you can set:</p>
5468: <pre class="programlisting">
5469: PREFER_PKGSRC= yes
5470: PREFER_NATIVE= getopt skey tcp_wrappers
5471: </pre>
5472: <p>A package <span class="emphasis"><em>must</em></span> have a
5473: <code class="filename">builtin.mk</code>
5474: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5475: otherwise it is simply ignored in that list.</p>
5476: </div>
5477: </div>
5478: </div>
1.41 asau 5479: <div class="chapter">
1.1 dsieger 5480: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5481: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5482: <div class="toc">
5483: <p><b>Table of Contents</b></p>
1.100 leot 5484: <dl class="toc">
1.6 rillig 5485: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1 dsieger 5486: <dd><dl>
1.6 rillig 5487: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5488: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5489: </dl></dd>
1.6 rillig 5490: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5491: <dd><dl>
1.23 wiz 5492: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 5493: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5494: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5495: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5496: </dl></dd>
5497: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5498: <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>
5499: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5500: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5501: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5502: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5503: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1 dsieger 5504: </dl>
5505: </div>
5506: <p>This chapter describes the framework known as
5507: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5508: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5509: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5510: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5511: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5512: provided that packages are correctly designed.</p></li>
1.23 wiz 5513: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5514: <li class="listitem"><p>Registration of system users and groups.</p></li>
5515: <li class="listitem"><p>Registration of system shells.</p></li>
5516: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5517: </ul></div>
5518: <p>The following sections inspect each of the above points in detail.</p>
5519: <p>You may be thinking that many of the things described here could be
5520: easily done with simple code in the package's post-installation target
5521: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5522: as the code in them is only executed when building from source. Machines
5523: using binary packages could not benefit from it at all (as the code itself
5524: could be unavailable). Therefore, the only way to achieve any of the items
5525: described above is by means of the installation scripts, which are
5526: automatically generated by pkginstall.</p>
1.41 asau 5527: <div class="sect1">
1.1 dsieger 5528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5529: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5530: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5531: of files and directories that belong to a package. The names used in it
5532: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5533: which means that it cannot register files outside this directory (absolute
5534: path names are not allowed). Despite this restriction, some packages need
5535: to install files outside this location; e.g., under
5536: <code class="filename">${VARBASE}</code> or
5537: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5538: is to create such files during installation time by using
5539: installation scripts.</p>
5540: <p>The generic installation scripts are shell scripts that can
5541: contain arbitrary code. The list of scripts to execute is taken from
5542: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5543: <code class="filename">INSTALL</code>. A similar variable exists for package
5544: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5545: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5546: commands, so they have the potential to create and manage files
5547: anywhere in the file system.</p>
5548: <p>Using these general installation files is not recommended, but
5549: may be needed in some special cases. One reason for avoiding them is
5550: that the user has to trust the packager that there is no unwanted or
5551: simply erroneous code included in the installation script. Also,
5552: previously there were many similar scripts for the same functionality,
5553: and fixing a common error involved finding and changing all of
5554: them.</p>
5555: <p>The pkginstall framework offers another, standardized way. It
5556: provides generic scripts to abstract the manipulation of such files
5557: and directories based on variables set in the package's
5558: <code class="filename">Makefile</code>. The rest of this section describes
5559: these variables.</p>
1.41 asau 5560: <div class="sect2">
1.1 dsieger 5561: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5562: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5563: <p>The following variables can be set to request the creation of
5564: directories anywhere in the file system:</p>
1.41 asau 5565: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5566: <li class="listitem">
5567: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5568: contain a list of directories that should be created and should attempt
5569: to be destroyed by the installation scripts. The difference between
5570: the two is that the latter prompts the administrator to remove any
5571: directories that may be left after deinstallation (because they were
1.108 rillig 5572: not empty), while the former does not. Example:</p>
5573: <pre class="programlisting">
5574: MAKE_DIRS+= ${VARBASE}/foo/private
5575: </pre>
5576: </li>
1.23 wiz 5577: <li class="listitem">
1.1 dsieger 5578: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5579: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5580: which directories should be created and should attempt to be destroyed
5581: by the installation scripts. Each tuple holds the following values,
5582: separated by spaces: the directory name, its owner, its group and its
5583: numerical mode. For example:</p>
5584: <pre class="programlisting">
1.108 rillig 5585: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5586: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5587: </pre>
5588: <p>The difference between the two is exactly the same as their
5589: non-<code class="varname">PERMS</code> counterparts.</p>
5590: </li>
5591: </ul></div>
5592: </div>
1.41 asau 5593: <div class="sect2">
1.1 dsieger 5594: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5595: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5596: <p>Creating non-empty files outside the installation prefix is tricky
5597: because the <code class="filename">PLIST</code> forces all files to be inside it.
5598: To overcome this problem, the only solution is to extract the file in the
5599: known place (i.e., inside the installation prefix) and copy it to the
5600: appropriate location during installation (done by the installation scripts
5601: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5602: file</em></span> in the following paragraphs, which describe the variables
5603: that can be used to automatically and consistently handle files outside the
5604: installation prefix:</p>
1.41 asau 5605: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5606: <li class="listitem">
1.1 dsieger 5607: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5608: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5609: During installation time, the master file is copied to the target one
5610: if and only if the latter does not exist. Upon deinstallation, the
5611: target file is removed provided that it was not modified by the
5612: installation.</p>
5613: <p>The difference between the two is that the latter prompts the
5614: administrator to remove any files that may be left after
5615: deinstallation (because they were not empty), while the former does
5616: not.</p>
5617: </li>
1.23 wiz 5618: <li class="listitem">
1.1 dsieger 5619: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5620: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5621: files as well as their target locations. For each of them, it also
5622: specifies their owner, their group and their numeric permissions, in
5623: this order. For example:</p>
5624: <pre class="programlisting">
1.108 rillig 5625: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5626: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5627: </pre>
5628: <p>The difference between the two is exactly the same as their
5629: non-<code class="varname">PERMS</code> counterparts.</p>
5630: </li>
5631: </ul></div>
5632: </div>
5633: </div>
1.41 asau 5634: <div class="sect1">
1.1 dsieger 5635: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5636: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5637: <p>Configuration files are special in the sense that they are installed
5638: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5639: need special treatment during installation (most of which is automated by
5640: pkginstall). The main concept you must bear in mind is that files marked
5641: as configuration files are automatically copied to the right place (somewhere
5642: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5643: and only if</em></span> they didn't exist before. Similarly, they will not
5644: be removed if they have local modifications. This ensures that
5645: administrators never lose any custom changes they may have made.</p>
1.41 asau 5646: <div class="sect2">
1.1 dsieger 5647: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5648: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1 dsieger 5649: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5650: specifies where configuration files shall be installed. Its contents are
5651: set based upon the following variables:</p>
1.41 asau 5652: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5653: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5654: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5655: be overridden by the user to point to his preferred location (e.g.,
5656: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5657: Packages must not use it directly.</p></li>
1.23 wiz 5658: <li class="listitem">
1.1 dsieger 5659: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5660: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5661: for the package being built shall be installed. The definition of this
5662: variable only makes sense in the package's
5663: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5664: <p>As an example, consider the Apache package,
1.79 snj 5665: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.1 dsieger 5666: configuration files under the
5667: <code class="filename">httpd/</code> subdirectory of
5668: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5669: Makefile.</p>
5670: </li>
1.23 wiz 5671: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5672: variable that holds this package's configuration directory (if
5673: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5674: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5675: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5676: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5677: directory where the configuration files for the package identified by
5678: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5679: </ul></div>
5680: <p>Based on the above variables, pkginstall determines the value of
5681: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5682: variable that can be used within a package to refer to its configuration
5683: directory. The algorithm used to set its value is basically the
5684: following:</p>
1.23 wiz 5685: <div class="orderedlist"><ol class="orderedlist" type="1">
5686: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5687: its value is used.</p></li>
1.23 wiz 5688: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5689: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5690: <code class="filename">Makefile</code>, the resulting value is
5691: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5692: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5693: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5694: </ol></div>
5695: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5696: 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
5697: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5698: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5699: </div>
1.41 asau 5700: <div class="sect2">
1.1 dsieger 5701: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5702: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5703: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5704: known place, you need to teach each package where it shall install its
5705: files. In some cases you will have to patch the package Makefiles to
5706: achieve it. If you are lucky, though, it may be as easy as passing an
5707: extra flag to the configuration script; this is the case of GNU Autoconf-
5708: generated files:</p>
5709: <pre class="programlisting">
5710: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5711: </pre>
5712: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5713: for</em></span> its configuration files, not where they will be originally
5714: installed (although the difference is never explicit,
5715: unfortunately).</p>
5716: </div>
1.41 asau 5717: <div class="sect2">
1.1 dsieger 5718: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5719: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5720: <p>As said before, pkginstall automatically handles configuration files.
5721: This means that <span class="strong"><strong>the packages themselves must not
5722: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5723: directly</strong></span>. Bad news is that many software installation scripts
5724: will, out of the box, mess with the contents of that directory. So what is
5725: the correct procedure to fix this issue?</p>
5726: <p>You must teach the package (usually by manually patching it) to
5727: install any configuration files under the examples hierarchy,
5728: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5729: <code class="filename">PLIST</code> registers them and the administrator always
5730: has the original copies available.</p>
5731: <p>Once the required configuration files are in place (i.e., under the
5732: examples hierarchy), the pkginstall framework can use them as master copies
5733: during the package installation to update what is in
5734: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5735: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5736: used. Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.1 dsieger 5737: about their syntax and their purpose. Here is an example, taken from the
1.79 snj 5738: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.1 dsieger 5739: <pre class="programlisting">
5740: EGDIR= ${PREFIX}/share/doc/mutt/samples
5741: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5742: </pre>
5743: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5744: package and has no meaning outside it.</p>
5745: </div>
1.41 asau 5746: <div class="sect2">
1.1 dsieger 5747: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5748: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5749: <p>The automatic copying of config files can be toggled by setting the
5750: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5751: installation.</p>
5752: </div>
5753: </div>
1.41 asau 5754: <div class="sect1">
1.1 dsieger 5755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5756: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5757: <p>System startup scripts are special files because they must be
5758: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5759: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.1 dsieger 5760: can be used. However, pkginstall provides a special mechanism to handle
5761: these files.</p>
5762: <p>In order to provide system startup scripts, the package has
5763: to:</p>
1.23 wiz 5764: <div class="orderedlist"><ol class="orderedlist" type="1">
5765: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5766: the <code class="literal">.sh</code> suffix appended. Considering the
1.79 snj 5767: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.1 dsieger 5768: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5769: <li class="listitem">
1.1 dsieger 5770: <p>Tell pkginstall to handle it, appending the name of the script,
5771: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5772: Continuing the previous example:</p>
5773: <pre class="programlisting">
5774: RCD_SCRIPTS+= cupsd
5775: </pre>
5776: </li>
5777: </ol></div>
5778: <p>Once this is done, pkginstall will do the following steps for each
5779: script in an automated fashion:</p>
1.23 wiz 5780: <div class="orderedlist"><ol class="orderedlist" type="1">
5781: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5782: substitutions described in the <code class="filename">FILES_SUBST</code>
5783: variable.</p></li>
1.23 wiz 5784: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5785: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5786: that this master file must be explicitly registered in the
5787: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5788: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5789: from the examples hierarchy into the system-wide startup scripts
5790: directory.</p></li>
5791: </ol></div>
1.41 asau 5792: <div class="sect2">
1.1 dsieger 5793: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5794: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5795: <p>The automatic copying of config files can be toggled by setting the
5796: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5797: installation. Note that the scripts will be always copied inside the
5798: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5799: matter what the value of this variable is.</p>
5800: </div>
5801: </div>
1.41 asau 5802: <div class="sect1">
1.1 dsieger 5803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5804: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5805: <p>If a package needs to create special users and/or groups during
5806: installation, it can do so by using the pkginstall framework.</p>
5807: <p>Users can be created by adding entries to the
5808: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5809: syntax:</p>
5810: <pre class="programlisting">
5811: user:group
5812: </pre>
5813: <p>Further specification of user details may be done by setting
5814: per-user variables.
5815: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5816: numeric UID for the user.
5817: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5818: user's description or comment.
5819: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5820: user's home directory, and defaults to
5821: <code class="filename">/nonexistent</code> if not specified.
5822: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5823: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5824: not specified.</p>
5825: <p>Similarly, groups can be created by adding entries to the
5826: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5827: <pre class="programlisting">
5828: group
5829: </pre>
5830: <p>The numeric GID of the group may be set by defining
5831: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5832: <p>If a package needs to create the users and groups at an earlier
5833: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5834: either <code class="literal">configure</code> or <code class="literal">build</code> to
5835: indicate the phase before which the users and groups are created. In
5836: this case, the numeric UIDs and GIDs of the created users and groups
5837: are automatically hardcoded into the final installation scripts.</p>
5838: </div>
1.41 asau 5839: <div class="sect1">
1.1 dsieger 5840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5841: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5842: <p>Packages that install system shells should register them in the shell
5843: database, <code class="filename">/etc/shells</code>, to make things easier to the
5844: administrator. This must be done from the installation scripts to keep
5845: binary packages working on any system. pkginstall provides an easy way to
5846: accomplish this task.</p>
5847: <p>When a package provides a shell interpreter, it has to set the
5848: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5849: add some hooks to the installation scripts to handle it. Consider the
1.79 snj 5850: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.1 dsieger 5851: <pre class="programlisting">
5852: PKG_SHELL= ${PREFIX}/bin/zsh
5853: </pre>
1.41 asau 5854: <div class="sect2">
1.1 dsieger 5855: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5856: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5857: <p>The automatic registration of shell interpreters can be disabled by
5858: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5859: environment variable to <code class="literal">NO</code>.</p>
5860: </div>
5861: </div>
1.41 asau 5862: <div class="sect1">
1.1 dsieger 5863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5864: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5865: <p>Packages that install X11 fonts should update the database files
5866: that index the fonts within each fonts directory. This can easily be
5867: accomplished within the pkginstall framework.</p>
5868: <p>When a package installs X11 fonts, it must list the directories in
5869: which fonts are installed in the
5870: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5871: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5872: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.1 dsieger 5873: installation scripts to run the appropriate commands to update the fonts
5874: database files within each of those directories. For convenience, if the
5875: directory path is relative, it is taken to be relative to the package's
1.79 snj 5876: installation prefix. Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1 dsieger 5877: <pre class="programlisting">
1.67 wiz 5878: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5879: </pre>
1.41 asau 5880: <div class="sect2">
1.1 dsieger 5881: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5882: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5883: <p>The automatic update of fonts databases can be disabled by
5884: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5885: environment variable to <code class="literal">NO</code>.</p>
5886: </div>
5887: </div>
5888: </div>
1.41 asau 5889: <div class="chapter">
1.1 dsieger 5890: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5891: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5892: <div class="toc">
5893: <p><b>Table of Contents</b></p>
1.100 leot 5894: <dl class="toc">
1.6 rillig 5895: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5896: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 5897: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5898: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5899: </dl>
5900: </div>
5901: <p>Many packages have the ability to be built to support different
5902: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5903: in pkgsrc that provides generic handling of those options that
5904: determine different ways in which the packages can be built. It's
5905: possible for the user to specify exactly which sets of options will be
5906: built into a package or to allow a set of global default options
5907: apply.</p>
1.7 rillig 5908: <p>There are two broad classes of behaviors that one might want to
5909: control via options. One is whether some particular feature is
5910: enabled in a program that will be built anyway, often by including or
5911: not including a dependency on some other package. The other is
5912: whether or not an additional program will be built as part of the
5913: package. Generally, it is better to make a split package for such
5914: additional programs instead of using options, because it enables
5915: binary packages to be built which can then be added separately. For
5916: example, the foo package might have minimal dependencies (those
5917: packages without which foo doesn't make sense), and then the foo-gfoo
5918: package might include the GTK frontend program gfoo. This is better
5919: than including a gtk option to foo that adds gfoo, because either that
5920: option is default, in which case binary users can't get foo without
5921: gfoo, or not default, in which case they can't get gfoo. With split
5922: packages, they can install foo without having GTK, and later decide to
5923: install gfoo (pulling in GTK at that time). This is an advantage to
5924: source users too, avoiding the need for rebuilds.</p>
5925: <p>Plugins with widely varying dependencies should usually be split
5926: instead of options.</p>
5927: <p>It is often more work to maintain split packages, especially if
5928: the upstream package does not support this. The decision of split
5929: vs. option should be made based on the likelihood that users will want
5930: or object to the various pieces, the size of the dependencies that are
5931: included, and the amount of work.</p>
5932: <p>A further consideration is licensing. Non-free parts, or parts
5933: that depend on non-free dependencies (especially plugins) should
5934: almost always be split if feasible.</p>
1.41 asau 5935: <div class="sect1">
1.1 dsieger 5936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5937: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 5938: <p>Global default options are listed in
5939: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5940: that should be built into every package if that option is supported.
1.10 hubertf 5941: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5942: </div>
1.41 asau 5943: <div class="sect1">
1.1 dsieger 5944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5945: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5946: </h2></div></div></div>
5947: <p>The following example shows how
5948: <code class="filename">bsd.options.mk</code> should be used
5949: by the hypothetical ``wibble'' package, either in the package
5950: <code class="filename">Makefile</code>, or in a file,
5951: e.g. <code class="filename">options.mk</code>, that is included by the
5952: main package <code class="filename">Makefile</code>.</p>
5953: <pre class="programlisting">
5954: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5955: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5956: PKG_OPTIONS_OPTIONAL_GROUPS= database
5957: PKG_OPTIONS_GROUP.database= mysql pgsql
5958: PKG_SUGGESTED_OPTIONS= wibble-foo
5959: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5960: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5961:
5962: .include "../../mk/bsd.prefs.mk"
5963:
5964: # this package was previously named wibble2
5965: .if defined(PKG_OPTIONS.wibble2)
5966: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5967: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5968: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5969: .endif
5970:
5971: .include "../../mk/bsd.options.mk"
5972:
5973: # Package-specific option-handling
5974:
5975: ###
5976: ### FOO support
5977: ###
5978: .if !empty(PKG_OPTIONS:Mwibble-foo)
5979: CONFIGURE_ARGS+= --enable-foo
5980: .endif
5981:
5982: ###
5983: ### LDAP support
5984: ###
5985: .if !empty(PKG_OPTIONS:Mldap)
5986: . include "../../databases/openldap-client/buildlink3.mk"
5987: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5988: .endif
5989:
5990: ###
5991: ### database support
5992: ###
5993: .if !empty(PKG_OPTIONS:Mmysql)
5994: . include "../../mk/mysql.buildlink3.mk"
5995: .endif
5996: .if !empty(PKG_OPTIONS:Mpgsql)
5997: . include "../../mk/pgsql.buildlink3.mk"
5998: .endif
5999: </pre>
6000: <p>The first section contains the information about which build
6001: options are supported by the package, and any default options settings
6002: if needed.</p>
1.23 wiz 6003: <div class="orderedlist"><ol class="orderedlist" type="1">
6004: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.79 snj 6005: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1 dsieger 6006: options. It should be set to
6007: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6008: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6009: at the point where the options are processed.</p></li>
1.23 wiz 6010: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 6011: build options supported by the package.</p></li>
1.23 wiz 6012: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 6013: list of names of groups of mutually exclusive options. The options in
6014: each group are listed in
6015: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6016: The most specific setting of any option from the group takes
6017: precedence over all other options in the group. Options from the
6018: groups will be automatically added to
6019: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 6020: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 6021: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6022: packages will fail if no option from the group is
6023: selected.</p></li>
1.23 wiz 6024: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 6025: of names of sets of options. At least one option from each set must
6026: be selected. The options in each set are listed in
6027: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6028: Options from the sets will be automatically added to
6029: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6030: fail if no option from the set is selected.</p></li>
1.23 wiz 6031: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 6032: build options which are enabled by default.</p></li>
1.23 wiz 6033: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 6034: of
1.23 wiz 6035: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.10 hubertf 6036: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6037: their option counterparts. Pairs should be added with
1.23 wiz 6038: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 6039: warning will be issued if the user uses a legacy
6040: variable.</p></li>
1.23 wiz 6041: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 6042: of
1.23 wiz 6043: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.1 dsieger 6044: pairs that map options that have been renamed to their new
1.23 wiz 6045: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 6046: the listing of global legacy options. A warning will be issued if
6047: the user uses a legacy option.</p></li>
1.23 wiz 6048: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 6049: options implied by deprecated variables used. This can be used for
6050: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6051: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6052: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 6053: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 6054: a list of warnings about deprecated variables or options used, and
6055: what to use instead.</p></li>
6056: </ol></div>
6057: <p>A package should never modify
6058: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6059: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6060: To suggest a default set of options, use
6061: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6062: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6063: including <code class="filename">bsd.options.mk</code>. If none of
6064: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6065: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6066: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6067: happen with platform-specific options if none of them is supported on
6068: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6069: empty list and the package is otherwise treated as not using the
6070: options framework.</p>
6071: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6072: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6073: build options, properly filtered to remove unsupported and duplicate
6074: options.</p>
6075: <p>The remaining sections contain the logic that is specific to
6076: each option. The correct way to check for an option is to check
6077: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6078: <pre class="programlisting">
6079: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6080: </pre>
6081: </div>
1.41 asau 6082: <div class="sect1">
1.1 dsieger 6083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6084: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6085: <p>Options that enable similar features in different packages (like
6086: optional support for a library) should use a common name in all
6087: packages that support it (like the name of the library). If another
6088: package already has an option with the same meaning, use the same
6089: name.</p>
6090: <p>Options that enable features specific to one package, where it's
6091: unlikely that another (unrelated) package has the same (or a similar)
6092: optional feature, should use a name prefixed with
6093: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6094: <p>If a group of related packages share an optional feature
6095: specific to that group, prefix it with the name of the
1.23 wiz 6096: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 6097: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6098: <p>For new options, add a line to
6099: <code class="filename">mk/defaults/options.description</code>. Lines have two
6100: fields, separated by tab. The first field is the option name, the
6101: second its description. The description should be a whole sentence
6102: (starting with an uppercase letter and ending with a period) that
1.23 wiz 6103: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6104: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 6105: </div>
1.41 asau 6106: <div class="sect1">
1.7 rillig 6107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6108: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 6109: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7 rillig 6110: different dependencies based on the options with which the package was
6111: built. For querying these options, the file
6112: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6113: typical example looks like this:</p>
6114: <pre class="programlisting">
6115: pkgbase := libpurple
6116: .include "../../mk/pkg-build-options.mk"
6117:
6118: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6119: ...
6120: .endif
6121: </pre>
6122: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6123: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6124: options of the libpurple package, which can then be queried like
6125: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6126: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6127: details.</p>
6128: </div>
1.1 dsieger 6129: </div>
1.41 asau 6130: <div class="chapter">
1.1 dsieger 6131: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6132: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6133: <div class="toc">
6134: <p><b>Table of Contents</b></p>
1.100 leot 6135: <dl class="toc">
1.6 rillig 6136: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6137: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6138: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6139: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 6140: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 6141: <dd><dl>
6142: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6143: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6144: </dl></dd>
1.23 wiz 6145: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6146: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6147: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6148: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6149: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6150: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6151: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6152: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6153: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6154: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 6155: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6156: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6157: </dl>
6158: </div>
1.41 asau 6159: <div class="sect1">
1.1 dsieger 6160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6161: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6162: <p>This chapter gives a detailed description on how a package is
6163: built. Building a package is separated into different
6164: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6165: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 6166: described in the following sections. Each phase is split into
1.1 dsieger 6167: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6168: containing phase, prefixed by one of <code class="varname">pre-</code>,
6169: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6170: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6171: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6172: <p>Never override the regular targets (like
6173: <code class="varname">fetch</code>), if you have to, override the
6174: <code class="varname">do-*</code> ones instead.</p>
6175: <p>The basic steps for building a program are always the same. First
6176: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6177: the local system and then extracted. After any pkgsrc-specific patches
6178: to compile properly are applied, the software can be configured, then
6179: built (usually by compiling), and finally the generated binaries, etc.
6180: can be put into place on the system.</p>
6181: <p>To get more details about what is happening at each step,
6182: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6183: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6184: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6185: </div>
1.41 asau 6186: <div class="sect1">
1.1 dsieger 6187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6188: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6189: <p>Before outlining the process performed by the NetBSD package system in
6190: the next section, here's a brief discussion on where programs are
6191: installed, and which variables influence this.</p>
6192: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6193: where all files of the final program shall be installed. It is
6194: usually set to <code class="varname">LOCALBASE</code>
6195: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6196: for pkgs in the <code class="filename">cross</code> category. The value of
6197: <code class="varname">PREFIX</code> needs to be put
6198: into the various places in the program's source where paths to
1.108 rillig 6199: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.1 dsieger 6200: <p>When choosing which of these variables to use,
6201: follow the following rules:</p>
1.41 asau 6202: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6203: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 6204: where the current pkg will be installed. When referring to a
6205: pkg's own installation path, use
1.23 wiz 6206: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6207: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 6208: are installed. If you need to construct a -I or -L argument
6209: to the compiler to find includes and libraries installed by
1.23 wiz 6210: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 6211: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6212: installed all packages in <code class="filename">/usr/local</code>. As
6213: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6214: administrator, this variable is a misnomer.</p></li>
1.23 wiz 6215: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 6216: distribution (from xsrc, etc.) is installed. When looking for
6217: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 6218: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 6219: <li class="listitem"><p>X11-based packages using imake must set
6220: <code class="varname">USE_IMAKE</code> to be installed correctly under
6221: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 6222: <li class="listitem">
1.99 sevan 6223: <p>To determine the prefix of an
1.1 dsieger 6224: installed package, the <code class="varname">EVAL_PREFIX</code>
6225: definition can be used. It takes pairs in the format
1.79 snj 6226: <span class="quote">“<span class="quote">DIRNAME=<package></span>”</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 6227: variable <code class="varname">DIRNAME</code> will be set to the prefix
6228: of the installed package <package>, or
1.99 sevan 6229: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> if the package is not
1.1 dsieger 6230: installed.</p>
6231: <p>This is best illustrated by example.</p>
6232: <p>The following lines are taken from
6233: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6234: <pre class="programlisting">
6235: EVAL_PREFIX+= GTKDIR=gtk+
6236: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6237: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6238: CONFIGURE_ARGS+= --enable-multibyte
6239: </pre>
6240: <p>Specific defaults can be defined for the packages
6241: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6242: definition of the form:</p>
6243: <pre class="programlisting">
6244: GTKDIR_DEFAULT= ${LOCALBASE}
6245: </pre>
6246: <p>where <code class="varname">GTKDIR</code> corresponds
6247: to the first definition in
6248: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6249: </li>
1.23 wiz 6250: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.79 snj 6251: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1 dsieger 6252: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6253: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6254: </ul></div>
6255: </div>
1.41 asau 6256: <div class="sect1">
1.1 dsieger 6257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6258: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 6259: <p>When building a package, various directories are used to store
1.1 dsieger 6260: source files, temporary files, pkgsrc-internal files, and so on. These
6261: directories are explained here.</p>
6262: <p>Some of the directory variables contain relative pathnames. There
6263: are two common base directories for these relative directories:
6264: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6265: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6266: inside the package itself.</p>
1.41 asau 6267: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6268: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6269: <dd><p>This is an absolute pathname that points to the pkgsrc
6270: root directory. Generally, you don't need
6271: it.</p></dd>
6272: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6273: <dd><p>This is an absolute pathname that points to the
6274: current package.</p></dd>
6275: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6276: <dd><p>This is a pathname relative to
6277: <code class="varname">PKGSRCDIR</code> that points to the current
6278: package.</p></dd>
6279: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6280: <dd><p>This is an absolute pathname pointing to the directory
6281: where all work takes place. The distfiles are extracted to this
6282: directory. It also contains temporary directories and log files used by
6283: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6284: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6285: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6286: <dd><p>This is an absolute pathname pointing to the directory
6287: where the distfiles are extracted. It is usually a direct subdirectory
6288: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6289: that isn't hidden. This variable may be changed by a package
6290: <code class="filename">Makefile</code>.</p></dd>
6291: </dl></div>
1.14 jmcneill 6292: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6293: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 6294: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 6295: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6296: If users would like to have their pkgsrc trees behave in a
6297: read-only manner, then the value of
6298: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6299: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 6300: </div>
1.41 asau 6301: <div class="sect1">
1.1 dsieger 6302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6303: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 6304: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6305: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6306: phase. This will automatically run all phases that are required for this
6307: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6308: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6309: the package will be built, but not installed.</p>
6310: </div>
1.41 asau 6311: <div class="sect1">
1.1 dsieger 6312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6313: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6314: <p>The first step in building a package is to fetch the
6315: distribution files (distfiles) from the sites that are providing
6316: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6317: phase.</p>
1.41 asau 6318: <div class="sect2">
1.1 dsieger 6319: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6320: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 6321: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6322: defines all URLs from where the distfile, whose name is
6323: derived from the <code class="varname">DISTNAME</code> variable, is
6324: fetched. The more complicated cases are described
6325: below.</p>
6326: <p>The variable <code class="varname">DISTFILES</code> specifies
6327: the list of distfiles that have to be fetched. Its value
1.66 asau 6328: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6329: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 6330: so that most packages don't need to define it at all.
6331: <code class="varname">EXTRACT_SUFX</code> is
6332: <code class="literal">.tar.gz</code> by default, but can be changed
6333: freely. Note that if your package requires additional
6334: distfiles to the default one, you cannot just append the
6335: additional filenames using the <code class="literal">+=</code>
6336: operator, but you have write for example:</p>
6337: <pre class="programlisting">
1.66 asau 6338: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 6339: </pre>
6340: <p>Each distfile is fetched from a list of sites, usually
6341: <code class="varname">MASTER_SITES</code>. If the package has multiple
6342: <code class="varname">DISTFILES</code> or multiple
6343: <code class="varname">PATCHFILES</code> from different sites, you can
6344: set
6345: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6346: to the list of URLs where the file
6347: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6348: (including the suffix) can be found.</p>
6349: <pre class="programlisting">
6350: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6351: DISTFILES+= foo-file.tar.gz
6352: SITES.foo-file.tar.gz= \
6353: http://www.somewhere.com/somehow/ \
6354: http://www.somewhereelse.com/mirror/somehow/
6355: </pre>
6356: <p>When actually fetching the distfiles, each item from
6357: <code class="varname">MASTER_SITES</code> or
6358: <code class="varname">SITES.*</code> gets the name of each distfile
6359: appended to it, without an intermediate slash. Therefore,
6360: all site values have to end with a slash or other separator
6361: character. This allows for example to set
6362: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6363: that gets the name of the distfile as a parameter. In this
6364: case, the definition would look like:</p>
6365: <pre class="programlisting">
6366: MASTER_SITES= http://www.example.com/download.cgi?file=
6367: </pre>
1.22 jakllsch 6368: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 6369: In that case the URL is taken as is, fetched and the result
6370: stored under the name of the distfile. You can use this style
6371: for the case when the download URL style does not match the
6372: above common case. For example, if permanent download URL is a
6373: redirector to the real download URL, or the download file name
6374: is offered by an HTTP Content-Disposition header. In the
6375: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6376: created instead of the default
6377: <code class="filename">v1.0.0.tar.gz</code>.</p>
6378: <pre class="programlisting">
6379: DISTNAME= foo-1.0.0
6380: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6381: </pre>
1.1 dsieger 6382: <p>There are some predefined values for
6383: <code class="varname">MASTER_SITES</code>, which can be used in
6384: packages. The names of the variables should speak for
6385: themselves.</p>
6386: <pre class="programlisting">
6387: ${MASTER_SITE_APACHE}
6388: ${MASTER_SITE_BACKUP}
6389: ${MASTER_SITE_CYGWIN}
6390: ${MASTER_SITE_DEBIAN}
6391: ${MASTER_SITE_FREEBSD}
6392: ${MASTER_SITE_FREEBSD_LOCAL}
6393: ${MASTER_SITE_GENTOO}
6394: ${MASTER_SITE_GNOME}
6395: ${MASTER_SITE_GNU}
6396: ${MASTER_SITE_GNUSTEP}
1.66 asau 6397: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 6398: ${MASTER_SITE_IFARCHIVE}
6399: ${MASTER_SITE_KDE}
6400: ${MASTER_SITE_MOZILLA}
1.66 asau 6401: ${MASTER_SITE_MOZILLA_ALL}
6402: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 6403: ${MASTER_SITE_MYSQL}
1.66 asau 6404: ${MASTER_SITE_NETLIB}
1.1 dsieger 6405: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 6406: ${MASTER_SITE_OSDN}
1.1 dsieger 6407: ${MASTER_SITE_PERL_CPAN}
6408: ${MASTER_SITE_PGSQL}
1.66 asau 6409: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 6410: ${MASTER_SITE_R_CRAN}
6411: ${MASTER_SITE_SOURCEFORGE}
6412: ${MASTER_SITE_SUNSITE}
6413: ${MASTER_SITE_SUSE}
6414: ${MASTER_SITE_TEX_CTAN}
6415: ${MASTER_SITE_XCONTRIB}
6416: ${MASTER_SITE_XEMACS}
1.66 asau 6417: ${MASTER_SITE_XORG}
1.1 dsieger 6418: </pre>
6419: <p>Some explanations for the less self-explaining ones:
6420: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6421: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.25 spz 6422: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.1 dsieger 6423: <p>If you choose one of these predefined sites, you may
6424: want to specify a subdirectory of that site. Since these
6425: macros may expand to more than one actual site, you
6426: <span class="emphasis"><em>must</em></span> use the following construct to
6427: specify a subdirectory:</p>
6428: <pre class="programlisting">
6429: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6430: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6431: </pre>
6432: <p>Note the trailing slash after the subdirectory
6433: name.</p>
6434: </div>
1.41 asau 6435: <div class="sect2">
1.1 dsieger 6436: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6437: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6438: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6439: all the distfiles exist in a local directory
6440: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6441: user). If the files do not exist, they are fetched using
6442: commands of the form</p>
6443: <pre class="programlisting">
6444: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6445: </pre>
6446: <p>where <code class="literal">${site}</code> varies through
6447: several possibilities in turn: first,
6448: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6449: sites specified in either <code class="varname">SITES.file</code> if
6450: defined, else <code class="varname">MASTER_SITES</code> or
6451: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6452: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6453: all except the first and the last can be optionally sorted
6454: by the user, via setting either
6455: <code class="varname">MASTER_SORT_RANDOM</code>, and
6456: <code class="varname">MASTER_SORT_AWK</code> or
6457: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6458: <p> The specific command and arguments used depend on the
6459: <code class="varname">FETCH_USING</code> parameter. The example above is
6460: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6461: <p>The distfiles mirror run by the NetBSD Foundation uses the
6462: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6463: distfiles, if they are freely distributable. Packages setting
6464: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6465: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6466: mirrored.</p>
6467: </div>
6468: </div>
1.41 asau 6469: <div class="sect1">
1.1 dsieger 6470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6471: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6472: <p>After the distfile(s) are fetched, their checksum is
6473: generated and compared with the checksums stored in the
6474: distinfo file. If the checksums don't match, the build is
6475: aborted. This is to ensure the same distfile is used for
6476: building, and that the distfile wasn't changed, e.g. by some
6477: malign force, deliberately changed distfiles on the master
6478: distribution site or network lossage.</p>
6479: </div>
1.41 asau 6480: <div class="sect1">
1.1 dsieger 6481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6482: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6483: <p>When the distfiles are present on the local system, they
6484: need to be extracted, as they usually come in the form of some
6485: compressed archive format.</p>
6486: <p>By default, all <code class="varname">DISTFILES</code> are
6487: extracted. If you only need some of them, you can set the
6488: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6489: files.</p>
6490: <p>Extracting the files is usually done by a little
6491: program, <code class="filename">mk/extract/extract</code>, which
6492: already knows how to extract various archive formats, so most
6493: likely you will not need to change anything here. But if you
6494: need, the following variables may help you:</p>
1.41 asau 6495: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6496: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6497: <dd><p>Use these variables to override the default
6498: options for an extract command, which are defined in
6499: <code class="filename">mk/extract/extract</code>.</p></dd>
6500: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6501: <dd><p>This variable can be set to
1.14 jmcneill 6502: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6503: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6504: absolute pathname pointing to the command with which tar
1.14 jmcneill 6505: archives should be extracted. It is preferred to choose bsdtar over gtar
6506: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6507: </dl></div>
6508: <p>If the <code class="filename">extract</code> program doesn't
6509: serve your needs, you can also override the
6510: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6511: command used for extracting the files. This command is
6512: executed in the <code class="filename">${WRKSRC}</code>
6513: directory. During execution of this command, the shell
6514: variable <code class="varname">extract_file</code> holds the absolute
6515: pathname of the file that is going to be extracted.</p>
6516: <p>And if that still does not suffice, you can override the
6517: <code class="varname">do-extract</code> target in the package
6518: Makefile.</p>
6519: </div>
1.41 asau 6520: <div class="sect1">
1.1 dsieger 6521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6522: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6523: <p>After extraction, all the patches named by the
6524: <code class="varname">PATCHFILES</code>, those present in the patches
6525: subdirectory of the package as well as in
6526: $LOCALPATCHES/$PKGPATH (e.g.
6527: <code class="filename">/usr/local/patches/graphics/png</code>) are
6528: applied. Patchfiles ending in <code class="filename">.Z</code> or
6529: <code class="filename">.gz</code> are uncompressed before they are
6530: applied, files ending in <code class="filename">.orig</code> or
6531: <code class="filename">.rej</code> are ignored. Any special options to
1.79 snj 6532: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.108 rillig 6533: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> for more details.</p>
1.79 snj 6534: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1 dsieger 6535: it fail if the patches apply with some lines of fuzz. Please
6536: fix (regen) the patches so that they apply cleanly. The
6537: rationale behind this is that patches that don't apply cleanly
6538: may end up being applied in the wrong place, and cause severe
6539: harm there.</p>
6540: </div>
1.41 asau 6541: <div class="sect1">
1.1 dsieger 6542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6543: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6544: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.1 dsieger 6545: </p>
6546: </div>
1.41 asau 6547: <div class="sect1">
1.1 dsieger 6548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6549: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6550: <p>This phase creates wrapper programs for the compilers and
6551: linkers. The following variables can be used to tweak the
6552: wrappers.</p>
1.41 asau 6553: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6554: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6555: <dd><p>The command used to print progress
6556: messages. Does nothing by default. Set to
6557: <code class="literal">${ECHO}</code> to see the progress
6558: messages.</p></dd>
6559: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6560: <dd><p>This variable can be set to
6561: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6562: depending on whether you want additional information in the
6563: wrapper log file.</p></dd>
6564: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6565: <dd><p>This variable can be set to
6566: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6567: on whether the wrapper should use its cache, which will
6568: improve the speed. The default value is
6569: <code class="literal">yes</code>, but is forced to
6570: <code class="literal">no</code> if the platform does not support
6571: it.</p></dd>
6572: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6573: <dd><p>A list of reordering commands. A reordering
6574: command has the form
6575: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6576: It ensures that that
6577: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6578: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6579: </p></dd>
6580: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6581: <dd><p>A list of transformation commands. [TODO:
6582: investigate further]</p></dd>
6583: </dl></div>
6584: </div>
1.41 asau 6585: <div class="sect1">
1.1 dsieger 6586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6587: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6588: <p>Most pieces of software need information on the header
6589: files, system calls, and library routines which are available
6590: on the platform they run on. The process of determining this
6591: information is known as configuration, and is usually
6592: automated. In most cases, a script is supplied with the
6593: distfiles, and its invocation results in generation of header
6594: files, Makefiles, etc.</p>
6595: <p>If the package contains a configure script, this can be
6596: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6597: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6598: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6599: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6600: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6601: <pre class="programlisting">
6602: .for d in ${CONFIGURE_DIRS}
6603: cd ${WRKSRC} \
6604: && cd ${d} \
6605: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6606: .endfor
6607: </pre>
6608: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6609: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6610: <code class="varname">WRKSRC</code>. In each of these directories, the
6611: configure script is run with the environment
6612: <code class="varname">CONFIGURE_ENV</code> and arguments
6613: <code class="varname">CONFIGURE_ARGS</code>. The variables
6614: <code class="varname">CONFIGURE_ENV</code>,
6615: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6616: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6617: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6618: package.</p>
1.37 wiz 6619: <p>If the program uses the Perl way of configuration (mainly Perl
6620: modules, but not only), i.e. a file called
6621: <code class="filename">Makefile.PL</code>, it should include
6622: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6623: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6624: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6625: <p>If the program uses an <code class="filename">Imakefile</code>
6626: for configuration, the appropriate steps can be invoked by
6627: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6628: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6629: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6630: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6631: <p>If the program uses <code class="filename">cmake</code>
6632: for configuration, the appropriate steps can be invoked by
1.23 wiz 6633: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6634: You can add variables to cmake's environment by adding them to the
6635: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6636: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6637: The top directory argument is given by the
6638: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6639: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6640: <p>If there is no configure step at all, set
1.23 wiz 6641: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6642: </div>
1.41 asau 6643: <div class="sect1">
1.1 dsieger 6644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6645: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6646: <p>For building a package, a rough equivalent of the
6647: following code is executed.</p>
6648: <pre class="programlisting">
6649: .for d in ${BUILD_DIRS}
6650: cd ${WRKSRC} \
6651: && cd ${d} \
6652: && env ${MAKE_ENV} \
6653: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6654: -f ${MAKE_FILE} \
6655: ${BUILD_TARGET}
6656: .endfor
6657: </pre>
6658: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6659: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6660: <code class="varname">WRKSRC</code>. In each of these directories,
6661: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6662: <code class="varname">MAKE_ENV</code> and arguments
6663: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6664: <code class="varname">MAKE_ENV</code>,
6665: <code class="varname">BUILD_MAKE_FLAGS</code>,
6666: <code class="varname">MAKE_FILE</code> and
6667: <code class="varname">BUILD_TARGET</code> may all be changed by the
6668: package.</p>
6669: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6670: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6671: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6672: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6673: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6674: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6675: <p>If there is no build step at all, set
1.23 wiz 6676: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6677: </div>
1.41 asau 6678: <div class="sect1">
1.1 dsieger 6679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6680: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6681: <p>[TODO]</p>
6682: </div>
1.41 asau 6683: <div class="sect1">
1.1 dsieger 6684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6685: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6686: <p>Once the build stage has completed, the final step is to
6687: install the software in public directories, so users can
6688: access the programs and files.</p>
6689: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6690: equivalent of the following code is executed. Additionally,
6691: before and after this code, much magic is performed to do
6692: consistency checks, registering the package, and so on.</p>
6693: <pre class="programlisting">
6694: .for d in ${INSTALL_DIRS}
6695: cd ${WRKSRC} \
6696: && cd ${d} \
6697: && env ${MAKE_ENV} \
6698: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6699: -f ${MAKE_FILE} \
6700: ${INSTALL_TARGET}
6701: .endfor
6702: </pre>
6703: <p>The variable's meanings are analogous to the ones in the
6704: <span class="emphasis"><em>build</em></span> phase.
6705: <code class="varname">INSTALL_DIRS</code> defaults to
6706: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6707: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6708: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6709: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6710: defined.</p>
6711: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6712: variables are useful. They are all variations of the
1.79 snj 6713: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1 dsieger 6714: permissions preset. <code class="varname">INSTALL</code> is the plain
6715: install command. The specialized variants, together with their
6716: intended use, are:</p>
1.41 asau 6717: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6718: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6719: <dd><p>directories that contain
6720: binaries</p></dd>
6721: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6722: <dd><p>directories that contain
6723: scripts</p></dd>
6724: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6725: <dd><p>directories that contain shared and static
6726: libraries</p></dd>
6727: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6728: <dd><p>directories that contain data
6729: files</p></dd>
6730: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6731: <dd><p>directories that contain man
6732: pages</p></dd>
1.100 leot 6733: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6734: <dd><p>directories that contain data files for games
6735: </p></dd>
1.1 dsieger 6736: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6737: <dd><p>binaries that can be stripped from debugging
6738: symbols</p></dd>
6739: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6740: <dd><p>binaries that cannot be
6741: stripped</p></dd>
6742: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6743: <dd><p>game
6744: binaries</p></dd>
6745: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6746: <dd><p>shared and static
6747: libraries</p></dd>
6748: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6749: <dd><p>data files</p></dd>
6750: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6751: <dd><p>data files for
6752: games</p></dd>
6753: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6754: <dd><p>man pages</p></dd>
6755: </dl></div>
6756: <p>Some other variables are:</p>
1.41 asau 6757: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6758: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
6759: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?strip+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
6760: when installing binaries. Any debugging sections and symbols present in
6761: binaries will be preserved.
6762: </p></dd>
1.1 dsieger 6763: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6764: <dd><p>A list of directories relative to
6765: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6766: beginning of the <span class="emphasis"><em>install</em></span> phase.
6767: The package is supposed to create all needed directories itself
6768: before installing files to it and list all other directories here.
6769: </p></dd>
6770: </dl></div>
6771: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6772: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6773: mostly relevant for packages in the <code class="filename">regress</code>
6774: category.</p>
6775: </div>
1.41 asau 6776: <div class="sect1">
1.1 dsieger 6777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6778: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6779: <p>Once the install stage has completed, a binary package of
6780: the installed files can be built. These binary packages can be
6781: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6782: the <span class="command"><strong>make bin-install</strong></span> or by using
6783: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6784: <p>By default, the binary packages are created in
6785: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6786: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6787: one for each category in the <code class="varname">CATEGORIES</code>
6788: variable. <code class="varname">PACKAGES</code> defaults to
6789: <code class="filename">pkgsrc/packages</code>.</p>
6790: </div>
1.41 asau 6791: <div class="sect1">
1.1 dsieger 6792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6793: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6794: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6795: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6796: to clean the work directories of all dependencies too, use
1.10 hubertf 6797: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6798: </div>
1.41 asau 6799: <div class="sect1">
1.1 dsieger 6800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6801: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6802: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6803: <dt><span class="term">pre/post-*</span></dt>
6804: <dd><p>For any of the main targets described in the
6805: previous section, two auxiliary targets exist with
1.23 wiz 6806: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.1 dsieger 6807: prefix for the main target's name. These targets are
6808: invoked before and after the main target is called,
6809: allowing extra configuration or installation steps be
6810: performed from a package's Makefile, for example, which
6811: a program's configure script or install target
6812: omitted.</p></dd>
6813: <dt><span class="term">do-*</span></dt>
6814: <dd><p>Should one of the main targets do the wrong thing,
6815: and should there be no variable to fix this, you can
6816: redefine it with the do-* target. (Note that redefining
6817: the target itself instead of the do-* target is a bad
6818: idea, as the pre-* and post-* targets won't be called
6819: anymore, etc.) You will not usually need to do
6820: this.</p></dd>
6821: <dt><span class="term">reinstall</span></dt>
6822: <dd>
1.10 hubertf 6823: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6824: you noticed some file was not installed properly, you
6825: can repeat the installation with this target, which will
1.23 wiz 6826: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6827: <p>This is the default value of
6828: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6829: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6830: package</strong></span>, where the defaults are
1.23 wiz 6831: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6832: respectively.</p>
6833: </dd>
6834: <dt><span class="term">deinstall</span></dt>
6835: <dd>
1.79 snj 6836: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1 dsieger 6837: current directory, effectively de-installing the
6838: package. The following variables can be used to tune the
6839: behaviour:</p>
1.41 asau 6840: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6841: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.79 snj 6842: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1 dsieger 6843: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6844: <dd><p>Remove all packages that require (depend on)
6845: the given package. This can be used to remove any
6846: packages that may have been pulled in by a given
1.10 hubertf 6847: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6848: DEINSTALLDEPENDS=1</strong></span> is done in
6849: <code class="filename">pkgsrc/x11/kde</code>, this is
6850: likely to remove whole KDE. Works by adding
1.79 snj 6851: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1 dsieger 6852: command line.</p></dd>
6853: </dl></div>
6854: </dd>
6855: <dt><span class="term">bin-install</span></dt>
6856: <dd><p>Install a binary package from local disk and via FTP
6857: from a list of sites (see the
6858: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6859: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6860: available anywhere. The arguments given to
1.10 hubertf 6861: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6862: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6863: operation, etc.</p></dd>
1.95 wiz 6864: <dt><span class="term">install-clean</span></dt>
6865: <dd><p>This target removes the state files for the "install" and later
6866: phases so that the "install" target may be re-invoked. This can be
6867: used after editing the PLIST to install the package without
6868: rebuilding it.</p></dd>
6869: <dt><span class="term">build-clean</span></dt>
6870: <dd><p>This target removes the state files for the "build" and later
6871: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6872: <dt><span class="term">update</span></dt>
6873: <dd>
6874: <p>This target causes the current package to be
6875: updated to the latest version. The package and all
6876: depending packages first get de-installed, then current
6877: versions of the corresponding packages get compiled and
6878: installed. This is similar to manually noting which
6879: packages are currently installed, then performing a
1.10 hubertf 6880: series of <span class="command"><strong>make deinstall</strong></span> and
6881: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6882: <code class="varname">UPDATE_TARGET</code> is set to) for these
6883: packages.</p>
1.23 wiz 6884: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6885: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6886: update</strong></span> was interrupted for some reason.
6887: However, in this case, make sure you don't call
1.10 hubertf 6888: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6889: list of dependent packages in <code class="varname">WRKDIR</code>.
6890: Otherwise, you lose the ability to automatically update
6891: the current package along with the dependent packages
6892: you have installed.</p>
1.10 hubertf 6893: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6894: update</strong></span> will only work as long as the package
6895: tree remains unchanged. If the source code for one of
6896: the packages to be updated has been changed, resuming
1.10 hubertf 6897: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6898: fail!</p>
6899: <p>The following variables can be used either on the
1.10 hubertf 6900: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6901: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6902: update</strong></span>:</p>
1.41 asau 6903: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6904: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6905: <dd><p>Install target to recursively use for the
6906: updated package and the dependent packages.
6907: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6908: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6909: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6910: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6911: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6912: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6913: endless loop!</p></dd>
6914: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6915: <dd><p>Don't clean up after updating. Useful if
6916: you want to leave the work sources of the updated
6917: packages around for inspection or other purposes.
6918: Be sure you eventually clean up the source tree
1.23 wiz 6919: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6920: or you may run into troubles with old source code
6921: still lying around on your next
1.10 hubertf 6922: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6923: update</strong></span>.</p></dd>
6924: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6925: <dd><p>Deinstall each package before installing
6926: (making <code class="varname">DEPENDS_TARGET</code>). This
6927: may be necessary if the
1.23 wiz 6928: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6929: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6930: update</strong></span>.</p></dd>
6931: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6932: <dd><p>Allows you to disable recursion and hardcode
6933: the target for packages. The default is
1.23 wiz 6934: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6935: facilitating a recursive update of prerequisite
6936: packages. Only set
6937: <code class="varname">DEPENDS_TARGET</code> if you want to
6938: disable recursive updates. Use
6939: <code class="varname">UPDATE_TARGET</code> instead to just
6940: set a specific target for each package to be
1.10 hubertf 6941: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6942: (see above).</p></dd>
6943: </dl></div>
6944: </dd>
6945: <dt><span class="term">clean-update</span></dt>
6946: <dd>
6947: <p>Clean the source tree for all packages that would
1.10 hubertf 6948: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6949: from the current directory. This target should not be
6950: used if the current package (or any of its depending
6951: packages) have already been de-installed (e.g., after
1.10 hubertf 6952: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6953: some packages you intended to update. As a rule of
6954: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6955: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6956: and only if you have a dirty package tree (e.g., if you
6957: used <code class="varname">NOCLEAN</code>).</p>
6958: <p>If you are unsure about whether your tree is
1.10 hubertf 6959: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6960: clean</strong></span> at the top of the tree, or use the
6961: following sequence of commands from the directory of the
6962: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6963: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6964: time, otherwise you lose all the packages you wanted to
6965: update!):</p>
6966: <pre class="screen">
6967: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6968: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6969: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6970: </pre>
6971: <p>The following variables can be used either on the
1.10 hubertf 6972: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6973: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6974: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6975: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6976: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6977: reconstruct the list of directories to update for
1.10 hubertf 6978: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6979: update</strong></span> successfully installed all
6980: packages you wanted to update. Normally, this is
1.10 hubertf 6981: done automatically on <span class="command"><strong>make
1.1 dsieger 6982: update</strong></span>, but may have been suppressed by
6983: the <code class="varname">NOCLEAN</code> variable (see
6984: above).</p></dd>
6985: </dl></div>
6986: </dd>
6987: <dt><span class="term">replace</span></dt>
6988: <dd>
6989: <p>Update the installation of the current package. This
6990: differs from update in that it does not replace dependent
1.79 snj 6991: packages. You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.1 dsieger 6992: target to work.</p>
6993: <p><span class="emphasis"><em>Be careful when using this
6994: target!</em></span> There are no guarantees that dependent
6995: packages will still work, in particular they will most
1.10 hubertf 6996: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6997: library package whose shared library major version changed
6998: between your installed version and the new one. For this
6999: reason, this target is not officially supported and only
7000: recommended for advanced users.</p>
7001: </dd>
7002: <dt><span class="term">info</span></dt>
1.79 snj 7003: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1 dsieger 7004: package. You can use this to check which version of a
7005: package is installed.</p></dd>
7006: <dt><span class="term">index</span></dt>
7007: <dd>
7008: <p>This is a top-level command, i.e. it should be used in
7009: the <code class="filename">pkgsrc</code> directory. It creates a
7010: database of all packages in the local pkgsrc tree, including
7011: dependencies, comment, maintainer, and some other useful
7012: information. Individual entries are created by running
1.10 hubertf 7013: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 7014: directories. This index file is saved as
7015: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 7016: verbose format by running <span class="command"><strong>make
1.1 dsieger 7017: print-index</strong></span>. You can search in it with
1.10 hubertf 7018: <span class="command"><strong>make search
1.1 dsieger 7019: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7020: extract a list of all packages that depend on a particular
1.10 hubertf 7021: one by running <span class="command"><strong>make show-deps
1.1 dsieger 7022: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7023: <p>Running this command takes a very long time, some
7024: hours even on fast machines!</p>
7025: </dd>
7026: <dt><span class="term">readme</span></dt>
7027: <dd>
7028: <p>This target generates a
7029: <code class="filename">README.html</code> file, which can be
1.79 snj 7030: viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.1 dsieger 7031: contain references to any packages which are in the
7032: <code class="varname">PACKAGES</code> directory on the local
7033: host. The generated files can be made to refer to URLs
7034: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7035: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7036: wanted to generate <code class="filename">README.html</code>
7037: files which pointed to binary packages on the local
7038: machine, in the directory
7039: <code class="filename">/usr/packages</code>, set
7040: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7041: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7042: <code class="varname">${PACKAGES}</code> directory and its
7043: subdirectories will be searched for all the binary
7044: packages.</p>
7045: <p>The target can be run at the toplevel or in category
7046: directories, in which case it descends recursively.</p>
7047: </dd>
7048: <dt><span class="term">readme-all</span></dt>
7049: <dd><p>This is a top-level command, run it in
7050: <code class="filename">pkgsrc</code>. Use this target to create a
7051: file <code class="filename">README-all.html</code> which contains a
7052: list of all packages currently available in the NetBSD
7053: Packages Collection, together with the category they belong
7054: to and a short description. This file is compiled from the
7055: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 7056: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 7057: readme</strong></span>.</p></dd>
7058: <dt><span class="term">cdrom-readme</span></dt>
7059: <dd><p>This is very much the same as the
1.23 wiz 7060: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 7061: used when generating a pkgsrc tree to be written to a
7062: CD-ROM. This target also produces
7063: <code class="filename">README.html</code> files, and can be made
7064: to refer to URLs based on
7065: <code class="varname">CDROM_PKG_URL_HOST</code> and
7066: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7067: <dt><span class="term">show-distfiles</span></dt>
7068: <dd><p>This target shows which distfiles and patchfiles
7069: are needed to build the package
7070: (<code class="varname">ALLFILES</code>, which contains all
7071: <code class="varname">DISTFILES</code> and
7072: <code class="varname">PATCHFILES</code>, but not
7073: <code class="filename">patches/*</code>).</p></dd>
7074: <dt><span class="term">show-downlevel</span></dt>
7075: <dd><p>This target shows nothing if the package is not
7076: installed. If a version of this package is installed,
7077: but is not the version provided in this version of
7078: pkgsrc, then a warning message is displayed. This target
7079: can be used to show which of your installed packages are
7080: downlevel, and so the old versions can be deleted, and
7081: the current ones added.</p></dd>
7082: <dt><span class="term">show-pkgsrc-dir</span></dt>
7083: <dd><p>This target shows the directory in the pkgsrc
7084: hierarchy from which the package can be built and
7085: installed. This may not be the same directory as the one
7086: from which the package was installed. This target is
7087: intended to be used by people who may wish to upgrade
7088: many packages on a single host, and can be invoked from
7089: the top-level pkgsrc Makefile by using the
1.23 wiz 7090: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 7091: <dt><span class="term">show-installed-depends</span></dt>
7092: <dd><p>This target shows which installed packages match
7093: the current package's <code class="varname">DEPENDS</code>. Useful
7094: if out of date dependencies are causing build
7095: problems.</p></dd>
1.95 wiz 7096: <dt><span class="term">print-build-depends-list</span></dt>
7097: <dd><p>This target shows the list of packages that the current package
7098: depends on for building.</p></dd>
7099: <dt><span class="term">print-run-depends-list</span></dt>
7100: <dd><p>This target shows the list of packages that the current package
7101: depends on for running.</p></dd>
1.1 dsieger 7102: <dt><span class="term">check-shlibs</span></dt>
7103: <dd><p>After a package is installed, check all its
7104: binaries and (on ELF platforms) shared libraries to see
7105: if they find the shared libs they need. Run by default
1.10 hubertf 7106: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1 dsieger 7107: <dt><span class="term">print-PLIST</span></dt>
7108: <dd>
1.23 wiz 7109: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 7110: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 7111: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 7112: -newer work/.extract_done</strong></span>. An attempt is made
7113: to care for shared libs etc., but it is
7114: <span class="emphasis"><em>strongly</em></span> recommended to review the
7115: result before putting it into
7116: <code class="filename">PLIST</code>. On upgrades, it's useful to
7117: diff the output of this command against an already
7118: existing <code class="filename">PLIST</code> file.</p>
1.79 snj 7119: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 7120: other methods that don't update file access times, be
7121: sure to add these files manually to your
1.23 wiz 7122: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7123: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 7124: them!</p>
1.23 wiz 7125: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.1 dsieger 7126: information on this target.</p>
7127: </dd>
7128: <dt><span class="term">bulk-package</span></dt>
7129: <dd>
7130: <p>Used to do bulk builds. If an appropriate binary
7131: package already exists, no action is taken. If not, this
7132: target will compile, install and package it (and its
7133: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 7134: 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
7135: builds)</i></a>).
1.1 dsieger 7136: After creating the binary package, the sources, the
7137: just-installed package and its required packages are
7138: removed, preserving free disk space.</p>
7139: <p><span class="emphasis"><em>Beware that this target may deinstall
7140: all packages installed on a system!</em></span></p>
7141: </dd>
7142: <dt><span class="term">bulk-install</span></dt>
7143: <dd>
7144: <p>Used during bulk-installs to install required
7145: packages. If an up-to-date binary package is available,
1.79 snj 7146: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10 hubertf 7147: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 7148: but the installed binary won't be removed.</p>
7149: <p>A binary package is considered
1.23 wiz 7150: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.79 snj 7151: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41 asau 7152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7153: <li class="listitem"><p>None of the package's files
1.1 dsieger 7154: (<code class="filename">Makefile</code>, ...) were modified
7155: since it was built.</p></li>
1.23 wiz 7156: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 7157: packages were modified since it was built.</p></li>
7158: </ul></div>
7159: <p><span class="emphasis"><em>Beware that this target may deinstall
7160: all packages installed on a system!</em></span></p>
7161: </dd>
7162: </dl></div>
7163: </div>
7164: </div>
1.41 asau 7165: <div class="chapter">
1.1 dsieger 7166: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7167: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7168: <div class="toc">
7169: <p><b>Table of Contents</b></p>
1.100 leot 7170: <dl class="toc">
1.6 rillig 7171: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7172: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7173: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 7174: </dl>
7175: </div>
7176: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7177: by pkgsrc and also for individual packages to define what commands
7178: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7179: or for later run-time of an installed packaged (such as
7180: <code class="varname">DEPENDS</code>).
7181: If the native system provides an adequate tool, then in many cases, a pkgsrc
7182: package will not be used.</p>
7183: <p>When building a package, the replacement tools are
7184: made available in a directory (as symlinks or wrapper scripts)
7185: that is early in the executable search path. Just like the buildlink
7186: system, this helps with consistent builds.</p>
7187: <p>A tool may be needed to help build a specific package. For example,
7188: perl, GNU make (gmake) or yacc may be needed.</p>
7189: <p>Also a tool may be needed, for example, because the native system's supplied
7190: tool may be inefficient for building a package with pkgsrc.
7191: For example, a package may need GNU awk, bison (instead of
7192: yacc) or a better sed.</p>
7193: <p>The tools used by a package can be listed by running
1.10 hubertf 7194: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 7195: <div class="sect1">
1.1 dsieger 7196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7197: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7198: <p>The default set of tools used by pkgsrc is defined in
7199: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7200: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7201: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7202: These can be seen by running:
1.10 hubertf 7203: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7204: <p>If a package needs a specific program to build
7205: then the <code class="varname">USE_TOOLS</code> variable can be used
7206: to define the tools needed.</p>
7207: </div>
1.41 asau 7208: <div class="sect1">
1.1 dsieger 7209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7210: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 7211: <p>In the following examples, the :run means that it is needed at
7212: run-time (and becomes a DEPENDS).
1.1 dsieger 7213: The default is a build dependency which can be set with
7214: :build. (So in this example, it is the same as gmake:build
7215: and pkg-config:build.)</p>
7216: <pre class="programlisting">
7217: USE_TOOLS+= gmake perl:run pkg-config
7218: </pre>
7219: <p>When using the tools framework, a
7220: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7221: which contains the full path to the appropriate tool. For example,
1.23 wiz 7222: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 7223: on Linux systems.</p>
7224: <p>If you always need a pkgsrc version of the
7225: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7226: </p>
7227: </div>
1.41 asau 7228: <div class="sect1">
1.1 dsieger 7229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7230: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7231: <p>When improving or porting pkgsrc to a new platform, have a look
7232: at (or create) the corresponding platform specific make file fragment under
7233: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7234: the name of the common tools. For example:</p>
7235: <pre class="programlisting">
7236: .if exists(/usr/bin/bzcat)
7237: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7238: .elif exists(/usr/bin/bzip2)
7239: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7240: .endif
7241:
7242: TOOLS_PLATFORM.true?= true # shell builtin
7243: </pre>
7244: </div>
7245: </div>
1.41 asau 7246: <div class="chapter">
1.1 dsieger 7247: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7248: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7249: <div class="toc">
7250: <p><b>Table of Contents</b></p>
1.100 leot 7251: <dl class="toc">
1.6 rillig 7252: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7253: <dd><dl>
1.108 rillig 7254: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
7255: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
7256: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
7257: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
7258: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
7259: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
7260: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
7261: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
7262: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
7263: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7264: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.6 rillig 7265: </dl></dd>
1.108 rillig 7266: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 7267: <dd><dl>
7268: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7269: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.88 tnn 7270: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 7271: </dl></dd>
1.108 rillig 7272: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 7273: <dd><dl>
7274: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7275: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7276: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7277: </dl></dd>
7278: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7279: <dd><dl>
7280: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7281: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7282: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 7283: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7284: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 7285: </dl></dd>
1.108 rillig 7286: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 7287: <dd><dl>
7288: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7289: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 7290: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 7291: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7292: </dl></dd>
1.108 rillig 7293: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 7294: <dd><dl>
7295: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7296: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7297: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7298: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7299: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7300: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7301: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7302: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7303: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 7304: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 7305: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7306: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7307: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7308: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7309: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7310: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7311: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7312: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7313: emulation</a></span></dt>
1.6 rillig 7314: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7315: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7316: </dl></dd>
1.6 rillig 7317: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7318: </dl>
7319: </div>
1.41 asau 7320: <div class="sect1">
1.1 dsieger 7321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7322: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 7323: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7324: different platforms. As a result, it is important to ensure,
7325: where possible, that packages in pkgsrc are portable. This
7326: chapter mentions some particular details you should pay
7327: attention to while working on pkgsrc.</p>
1.41 asau 7328: <div class="sect2">
1.1 dsieger 7329: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7330: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 7331: </h3></div></div></div>
7332: <p>The pkgsrc user can configure pkgsrc by overriding several
7333: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7334: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7335: want to use those variables in the preprocessor directives of
1.79 snj 7336: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7337: <code class="literal">.for</code>), you need to include the file
7338: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7339: loads the user preferences.</p>
7340: <p>But note that some variables may not be completely defined
7341: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7342: included, as they may contain references to variables that are
1.108 rillig 7343: not yet defined. In shell commands (the lines in
7344: <code class="filename">Makefile</code> that are indented with a tab) this
7345: is no problem, since variables are only expanded when they are
7346: used. But in the preprocessor directives mentioned above and in
7347: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7348: dependencies</code>) the variables are expanded at load
7349: time.</p>
1.41 asau 7350: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7351: <h3 class="title">Note</h3>
1.108 rillig 7352: <p>To check whether a variable can be used at load time,
7353: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7354: </div>
7355: </div>
1.41 asau 7356: <div class="sect2">
1.1 dsieger 7357: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7358: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7359: <p>Occasionally, packages require interaction from the user,
7360: and this can be in a number of ways:</p>
1.41 asau 7361: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7362: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7363: interaction such as entering username/password or accepting a
7364: license on a web page.</p></li>
1.23 wiz 7365: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7366: passwords.</p></li>
1.23 wiz 7367: <li class="listitem"><p>help to configure the package before it is built</p></li>
7368: <li class="listitem"><p>help during the build process</p></li>
7369: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7370: </ul></div>
1.108 rillig 7371: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7372: variable to define which stages need interaction. This should be
7373: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7374: <pre class="programlisting">
7375: INTERACTIVE_STAGE= configure install
7376: </pre>
7377: <p>The user can then decide to skip this package by setting the
1.108 rillig 7378: <code class="varname">BATCH</code> variable. Packages that require interaction
7379: are also excluded from bulk builds.</p>
1.1 dsieger 7380: </div>
1.41 asau 7381: <div class="sect2">
1.1 dsieger 7382: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7383: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.1 dsieger 7384: <p>Authors of software can choose the licence under which
7385: software can be copied. This is due to copyright law, and reasons
7386: for license choices are outside the scope of pkgsrc. The pkgsrc
7387: system recognizes that there are a number of licenses which some
7388: users may find objectionable or difficult or impossible to comply
7389: with. The Free Software Foundation has declared some licenses
7390: "Free", and the Open Source Initiative has a definition of "Open
7391: Source". The pkgsrc system, as a policy choice, does not label
7392: packages which have licenses that are Free or Open Source.
7393: However, packages without a license meeting either of those tests
7394: are labeled with a license tag denoting the license. Note that a
7395: package with no license to copy trivially does not meet either the
7396: Free or Open Source test.</p>
7397: <p>For packages which are not Free or Open Source, pkgsrc will
7398: not build the package unless the user has indicated to pkgsrc that
7399: packages with that particular license may be built. Note that
7400: this documentation avoids the term "accepted the license". The
7401: pkgsrc system is merely providing a mechanism to avoid
7402: accidentally building a package with a non-free license;
7403: judgement and responsibility remain with the user. (Installation
7404: of binary packages are not currently subject to this mechanism;
7405: this is a bug.)</p>
7406: <p>One might want to only install packages with a BSD license,
1.108 rillig 7407: or the GPL, and not the other. The free licenses are added to the
1.19 jnemeth 7408: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7409: user can override the default by setting the
7410: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7411: of "+=". The licenses accepted by default are:
7412: </p>
7413: <pre class="programlisting">
1.48 rodent 7414: apache-1.1 apache-2.0
7415: arphic-public
7416: artistic artistic-2.0
7417: boost-license
7418: cc-by-sa-v3.0
1.55 ryoon 7419: cc0-1.0-universal
1.48 rodent 7420: cddl-1.0
7421: cpl-1.0
7422: epl-v1.0
7423: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7424: gnu-gpl-v1
7425: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7426: gnu-gpl-v3 gnu-lgpl-v3
7427: ibm-public-license-1.0
7428: ipafont
7429: isc
7430: lppl-1.3c
7431: lucent
7432: miros
7433: mit
7434: mpl-1.0 mpl-1.1 mpl-2.0
7435: mplusfont
7436: ofl-v1.0 ofl-v1.1
7437: original-bsd modified-bsd 2-clause-bsd
7438: php
7439: png-license
7440: postgresql-license
7441: public-domain
7442: python-software-foundation
7443: qpl-v1.0
1.52 rodent 7444: sgi-free-software-b-v2.0
1.48 rodent 7445: sleepycat-public
7446: unlicense
7447: x11
7448: zlib
7449: zpl
1.19 jnemeth 7450: </pre>
7451: <p>
7452: </p>
1.1 dsieger 7453: <p>The license tag mechanism is intended to address
7454: copyright-related issues surrounding building, installing and
7455: using a package, and not to address redistribution issues (see
7456: <code class="varname">RESTRICTED</code> and
1.19 jnemeth 7457: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7458: Packages with redistribution restrictions should set these
7459: tags.</p>
1.1 dsieger 7460: <p>Denoting that a package may be copied according to a
7461: particular license is done by placing the license in
7462: <code class="filename">pkgsrc/licenses</code> and setting the
7463: <code class="varname">LICENSE</code> variable to a string identifying the
1.79 snj 7464: license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1 dsieger 7465: <pre class="programlisting">
7466: LICENSE= xv-license
7467: </pre>
7468: <p>When trying to build, the user will get a notice that the
7469: package is covered by a license which has not been placed in the
7470: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7471: <pre class="programlisting">
7472: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7473: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7474: ===> To view the license, enter "/usr/bin/make show-license".
7475: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7476: ===> ACCEPTABLE_LICENSES+=xv-license
7477: *** Error code 1
7478: </pre>
1.10 hubertf 7479: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7480: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7481: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7482: convey to pkgsrc that it should not in the future fail because of
7483: that license:</p>
7484: <pre class="programlisting">
7485: ACCEPTABLE_LICENSES+=xv-license
7486: </pre>
1.48 rodent 7487: <p>When adding a package with a new license, the following steps
7488: are required:</p>
7489: <div class="orderedlist"><ol class="orderedlist" type="1">
7490: <li class="listitem">
7491: <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>
7492: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7493: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7494: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.52 rodent 7495: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.48 rodent 7496: </ul></div>
7497: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7498: </li>
7499: <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>
7500: </ol></div>
1.1 dsieger 7501: <p>When the license changes (in a way other than formatting),
7502: please make sure that the new license has a different name (e.g.,
7503: append the version number if it exists, or the date). Just
7504: because a user told pkgsrc to build programs under a previous
7505: version of a license does not mean that pkgsrc should build
7506: programs under the new licenses. The higher-level point is that
7507: pkgsrc does not evaluate licenses for reasonableness; the only
7508: test is a mechanistic test of whether a particular text has been
7509: approved by either of two bodies.</p>
7510: <p>The use of <code class="varname">LICENSE=shareware</code>,
7511: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7512: is deprecated because it does not crisply refer to a particular
7513: license text. Another problem with such usage is that it does not
7514: enable a user to tell pkgsrc to proceed for a single package
7515: without also telling pkgsrc to proceed for all packages with that
7516: tag.</p>
7517: </div>
1.41 asau 7518: <div class="sect2">
1.1 dsieger 7519: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7520: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7521: <p>Some licenses restrict how software may be re-distributed.
7522: Because a license tag is required unless the package is Free or
7523: Open Source, all packages with restrictions should have license
7524: tags. By declaring the restrictions, package tools can
7525: automatically refrain from e.g. placing binary packages on FTP
7526: sites.</p>
7527: <p>There are four restrictions that may be encoded, which are
7528: the cross product of sources (distfiles) and binaries not being
7529: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7530: language in any license, and because non-Free licenses tend to be
7531: different from each other, pkgsrc adopts a definition of FTP and
7532: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7533: should not be made available over the Internet at no charge.
7534: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7535: made available on some kind of media, together with other source
7536: and binary packages, and which is sold for a distribution charge.
7537: </p>
7538: <p>In order to encode these restrictions, the package system
7539: defines five make variables that can be set to note these
7540: restrictions:</p>
1.41 asau 7541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7542: <li class="listitem">
1.1 dsieger 7543: <p><code class="varname">RESTRICTED</code></p>
7544: <p>This variable should be set whenever a restriction
7545: exists (regardless of its kind). Set this variable to a
7546: string containing the reason for the restriction. It should
7547: be understood that those wanting to understand the restriction
7548: will have to read the license, and perhaps seek advice of
7549: counsel.</p>
7550: </li>
1.23 wiz 7551: <li class="listitem">
1.1 dsieger 7552: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7553: <p>Binaries may not be placed on CD-ROM containing other
7554: binary packages, for which a distribution charge may be made.
7555: In this case, set this variable to
7556: <code class="varname">${RESTRICTED}</code>.</p>
7557: </li>
1.23 wiz 7558: <li class="listitem">
1.1 dsieger 7559: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7560: <p>Binaries may not made available on the Internet without
7561: charge. In this case, set this variable to
7562: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7563: binary packages will not be included on ftp.NetBSD.org.</p>
7564: </li>
1.23 wiz 7565: <li class="listitem">
1.1 dsieger 7566: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7567: <p>Distfiles may not be placed on CD-ROM, together with
7568: other distfiles, for which a fee may be charged. In this
7569: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7570: </p>
7571: </li>
1.23 wiz 7572: <li class="listitem">
1.1 dsieger 7573: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7574: <p>Distfiles may not made available via FTP at no charge.
7575: In this case, set this variable to
7576: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7577: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7578: </li>
7579: </ul></div>
1.32 wiz 7580: <p>Please note that packages will to be removed from pkgsrc
7581: when the distfiles are not distributable and cannot be obtained
7582: for a period of one full quarter branch. Packages with manual /
7583: interactive fetch must have a maintainer and it is his/her
7584: responsibility to ensure this.</p>
1.1 dsieger 7585: </div>
1.41 asau 7586: <div class="sect2">
1.1 dsieger 7587: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7588: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7589: <p>Your package may depend on some other package being present
7590: - and there are various ways of expressing this dependency.
7591: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7592: <code class="varname">DEPENDS</code> definitions, the
7593: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7594: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7595: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7596: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 7597: <p>The basic difference between the two variables is as
7598: follows: The <code class="varname">DEPENDS</code> definition registers
7599: that pre-requisite in the binary package so it will be pulled in
7600: when the binary package is later installed, whilst the
7601: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7602: dependency that is only needed for building the package.</p>
7603: <p>This means that if you only need a package present whilst
7604: you are building, it should be noted as a
7605: <code class="varname">BUILD_DEPENDS</code>.</p>
7606: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7607: <code class="varname">DEPENDS</code> definition is:</p>
7608: <pre class="programlisting">
7609: <pre-req-package-name>:../../<category>/<pre-req-package>
7610: </pre>
1.23 wiz 7611: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7612: may include any of the wildcard version numbers recognized by
1.79 snj 7613: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7614: <div class="orderedlist"><ol class="orderedlist" type="1">
7615: <li class="listitem">
1.1 dsieger 7616: <p>If your package needs another package's binaries or
1.54 wiz 7617: libraries to build and run, and if that package has a
1.1 dsieger 7618: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7619: <pre class="programlisting">
7620: .include "../../graphics/jpeg/buildlink3.mk"
7621: </pre>
7622: </li>
1.23 wiz 7623: <li class="listitem">
1.54 wiz 7624: <p>If your package needs another package's binaries or
7625: libraries only for building, and if that package has a
7626: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7627: <pre class="programlisting">
7628: .include "../../graphics/jpeg/buildlink3.mk"
7629: </pre>
7630: <p>but set
7631: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7632: to make it a build dependency only. This case is rather
7633: rare.</p>
7634: </li>
7635: <li class="listitem">
1.25 spz 7636: <p>If your package needs binaries from another package to build,
7637: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7638: <pre class="programlisting">
1.25 spz 7639: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1 dsieger 7640: </pre>
7641: </li>
1.25 spz 7642: <li class="listitem"><p>If your package needs a library with which to link and
7643: there is no <code class="filename">buildlink3.mk</code> file
7644: available, create one. Using
7645: <code class="varname">DEPENDS</code> won't be sufficient because the
7646: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7647: <li class="listitem">
1.25 spz 7648: <p>If your package needs some executable to be able to run
7649: correctly and if there's no
7650: <code class="filename">buildlink3.mk</code> file, this is specified
7651: using the <code class="varname">DEPENDS</code> variable. The
1.79 snj 7652: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.25 spz 7653: be able to execute the latex binary from the teTeX package
7654: when it runs, and that is specified:</p>
1.1 dsieger 7655: <pre class="programlisting">
1.25 spz 7656: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.1 dsieger 7657: </pre>
1.25 spz 7658: </li>
7659: <li class="listitem">
7660: <p>You can use wildcards in package dependencies. Note that
7661: such wildcard dependencies are retained when creating binary
7662: packages. The dependency is checked when installing the binary
7663: package and any package which matches the pattern will be
7664: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7665: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7666: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7667: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7668: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7669: <p>Wildcards can also be used to specify that a package
7670: will only build against a certain minimum version of a
7671: pre-requisite:</p>
7672: <pre class="programlisting">
1.25 spz 7673: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 7674: </pre>
1.25 spz 7675: <p>This means that the package will build using version 6.0
7676: of ImageMagick or newer. Such a dependency may be warranted
7677: if, for example, the command line options of an executable
7678: have changed.</p>
7679: <p>If you need to depend on minimum versions of libraries,
7680: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7681: <p>For security fixes, please update the package
1.108 rillig 7682: vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.9. Handling packages with security problems">Section 19.1.9, “Handling packages with security problems”</a> for more
1.1 dsieger 7683: information.</p>
7684: </li>
7685: </ol></div>
7686: <p>If your package needs files from another package to build,
7687: add the relevant distribution files to
7688: <code class="varname">DISTFILES</code>, so they will be extracted
1.79 snj 7689: automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1 dsieger 7690: (It relies on the jpeg sources being present in source form
7691: during the build.)</p>
7692: </div>
1.41 asau 7693: <div class="sect2">
1.1 dsieger 7694: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7695: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7696: <p>Your package may conflict with other packages a user might
7697: already have installed on his system, e.g. if your package
7698: installs the same set of files as another package in the pkgsrc
1.80 wiz 7699: tree or has the same <code class="varname">PKGNAME</code>.</p>
7700: <p>These cases are handled automatically by the packaging tools
7701: at package installation time and do not need to be handled
7702: manually.</p>
7703: <p>In case the conflicts can not be recognized automatically
7704: (e.g., packages using the same config file location but no other
7705: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7706: space-separated list of packages (including version string) your
7707: package conflicts with.</p>
1.80 wiz 7708: <p>For example, if both <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
7709: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7710: use the same config file, you would set in
7711: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7712: <pre class="programlisting">
1.80 wiz 7713: CONFLICTS= baz-[0-9]*
1.1 dsieger 7714: </pre>
1.80 wiz 7715: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7716: <pre class="programlisting">
1.80 wiz 7717: CONFLICTS= bar-[0-9]*
1.1 dsieger 7718: </pre>
7719: </div>
1.41 asau 7720: <div class="sect2">
1.1 dsieger 7721: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7722: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7723: <p>There are several reasons why a package might be
7724: instructed to not build under certain circumstances. If the
7725: package builds and runs on most platforms, the exceptions
1.83 dholland 7726: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7727: the package builds and runs on a small handful of platforms,
7728: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7729: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7730: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7731: (OS-version-platform) that can use glob-style
7732: wildcards.</p>
7733: <p>If a package is not appropriate for some platforms (as
7734: oopposed to merely broken), a different set of variables should be
7735: used as this affects failure reporting and statistics.
7736: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7737: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7738: the package is appropriate for only a small handful of platforms
7739: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7740: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7741: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7742: (OS-version-platform) that can use glob-style
7743: wildcards.</p>
7744: <p>Some packages are tightly bound to a specific version of an
1.79 snj 7745: operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.1 dsieger 7746: backwards compatible with other versions of the OS, and should be
7747: uploaded to a version specific directory on the FTP server. Mark
7748: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7749: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7750: the package system internals, but may be used in the
7751: future.</p>
7752: <p>If the package should be skipped (for example, because it
7753: provides functionality already provided by the system), set
7754: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7755: the package should fail because some preconditions are not met,
7756: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7757: message.</p>
7758: </div>
1.41 asau 7759: <div class="sect2">
1.1 dsieger 7760: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7761: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7762: <p>To ensure that a package may not be deleted, once it has been
7763: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7764: be set in the package Makefile. This will be carried into any
7765: binary package that is made from this pkgsrc entry. A
1.23 wiz 7766: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.79 snj 7767: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7768: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7769: </div>
1.41 asau 7770: <div class="sect2">
1.1 dsieger 7771: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7772: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7773: <p>When a vulnerability is found, this should be noted in
7774: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7775: and after committing that file, ask pkgsrc-security@NetBSD.org to
7776: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7777: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7778: <code class="varname">PKGREVISION</code> should be increased (this is of
7779: course not necessary if the problem is fixed by using a newer
7780: release of the software), and the pattern in the
7781: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7782: <p>Also, if the fix should be applied to the stable pkgsrc
7783: branch, be sure to submit a pullup request!</p>
7784: <p>Binary packages already on ftp.NetBSD.org will be handled
7785: semi-automatically by a weekly cron job.</p>
7786: </div>
1.41 asau 7787: <div class="sect2">
1.1 dsieger 7788: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7789: <a name="bumping-pkgrevision"></a>19.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 7790: <p>When making fixes to an existing package it can be useful
7791: to change the version number in <code class="varname">PKGNAME</code>. To
7792: avoid conflicting with future versions by the original author, a
1.23 wiz 7793: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 7794: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7795: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7796: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7797: <pre class="programlisting">
7798: DISTNAME= foo-17.42
7799: PKGREVISION= 9
7800: </pre>
7801: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7802: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7803: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7804: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7805: <code class="varname">PKGNAME_NOREV</code>.</p>
7806: <p>When a new release of the package is released, the
7807: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7808: minor release of the above package, things should be like:</p>
7809: <pre class="programlisting">
7810: DISTNAME= foo-17.43
7811: </pre>
7812: <p><code class="varname">PKGREVISION</code> should be incremented for any
7813: non-trivial change in the resulting binary package. Without a
7814: <code class="varname">PKGREVISION</code> bump, someone with the previous
7815: version installed has no way of knowing that their package is out
7816: of date. Thus, changes without increasing
7817: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7818: trivial that no reasonable person would want to upgrade", and this
7819: is the rough test for when increasing
7820: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7821: changes that do not merit increasing
7822: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7823: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7824: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7825: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7826: or comments in Makefile.</p></li>
1.23 wiz 7827: <li class="listitem"><p>
1.1 dsieger 7828: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7829: <li class="listitem"><p>
1.1 dsieger 7830: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7831: <li class="listitem"><p>
1.1 dsieger 7832: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7833: </ul></div>
7834: <p>Examples of changes that do merit an increase to
7835: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7836: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7837: <li class="listitem"><p>
1.1 dsieger 7838: Security fixes</p></li>
1.23 wiz 7839: <li class="listitem"><p>
1.1 dsieger 7840: Changes or additions to a patch file</p></li>
1.23 wiz 7841: <li class="listitem"><p>
1.1 dsieger 7842: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 7843: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 7844: </ul></div>
7845: <p>PKGREVISION must also be incremented when dependencies have ABI
7846: changes.</p>
7847: </div>
1.41 asau 7848: <div class="sect2">
1.1 dsieger 7849: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7850: <a name="fixes.subst"></a>19.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1 dsieger 7851: <p>When you want to replace the same text in multiple files
7852: or when the replacement text varies, patches alone cannot help.
7853: This is where the SUBST framework comes in. It provides an
7854: easy-to-use interface for replacing text in files.
7855: Example:</p>
7856: <pre class="programlisting">
7857: SUBST_CLASSES+= fix-paths
7858: SUBST_STAGE.fix-paths= pre-configure
7859: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7860: SUBST_FILES.fix-paths= src/*.c
7861: SUBST_FILES.fix-paths+= scripts/*.sh
7862: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7863: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7864: </pre>
7865: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7866: that are used to identify the different SUBST blocks that are
7867: defined. The SUBST framework is heavily used by pkgsrc, so it is
7868: important to always use the <code class="literal">+=</code> operator with
7869: this variable. Otherwise some substitutions may be
7870: skipped.</p>
7871: <p>The remaining variables of each SUBST block are
7872: parameterized with the identifier from the first line
7873: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7874: parameters to a function call.</p>
7875: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7876: which the replacement will take place. All combinations of
7877: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7878: <code class="literal">post-</code> together with a phase name are
7879: possible, though only few are actually used. Most commonly used
7880: are <code class="literal">post-patch</code> and
7881: <code class="literal">pre-configure</code>. Of these two,
7882: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7883: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7884: have the state after applying the patches but before making any
7885: other changes. This is especially useful when you are debugging
7886: a package in order to create new patches for it. Similarly,
7887: <code class="literal">post-build</code> is preferred over
7888: <code class="literal">pre-install</code>, because the install phase should
7889: generally be kept as simple as possible. When you use
7890: <code class="literal">post-build</code>, you have the same files in the
7891: working directory that will be installed later, so you can check
7892: if the substitution has succeeded.</p>
7893: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7894: that is printed just before the substitution is done.</p>
7895: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7896: globbing patterns that specifies the files in which the
7897: substitution will take place. The patterns are interpreted
7898: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7899: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.79 snj 7900: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1 dsieger 7901: command should be prefixed with <code class="literal">-e</code>, so that
7902: all SUBST blocks look uniform.</p>
7903: <p>There are some more variables, but they are so seldomly
7904: used that they are only documented in the
7905: <code class="filename">mk/subst.mk</code> file.</p>
7906: </div>
7907: </div>
1.41 asau 7908: <div class="sect1">
1.1 dsieger 7909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7910: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7911: <div class="sect2">
1.1 dsieger 7912: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7913: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 7914: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7915: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7916: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7917: with the name of each file to download as an argument, expecting
7918: it to output the URL of the directory from which to download
1.79 snj 7919: it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1 dsieger 7920: example of this usage.</p>
7921: <p>If the download can't be automated, because the user must
7922: submit personal information to apply for a password, or must pay
7923: for the source, or whatever, you can set
7924: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7925: displayed to the user before aborting the build. Example:</p>
7926: <pre class="programlisting">
7927: FETCH_MESSAGE= "Please download the files"
7928: FETCH_MESSAGE+= " "${DISTFILES:Q}
7929: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
7930: </pre>
7931: </div>
1.41 asau 7932: <div class="sect2">
1.1 dsieger 7933: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7934: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 7935: <p>Sometimes authors of a software package make some
7936: modifications after the software was released, and they put up a
7937: new distfile without changing the package's version number. If a
7938: package is already in pkgsrc at that time, the checksum will
7939: no longer match. The contents of the new distfile should be
7940: compared against the old one before changing anything, to make
7941: sure the distfile was really updated on purpose, and that
7942: no trojan horse or so crept in.
7943: Please mention that the distfiles were compared and what was found
1.53 rodent 7944: in your commit message.</p>
1.109 wiz 7945: <p>Then, the correct way to work around this is to set
7946: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7947: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7948: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7949: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7950: <code class="varname">PATCHFILES</code> for this package will be put in that
1.109 wiz 7951: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="19.1.10. How to handle incrementing versions when fixing an existing package">Section 19.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.1 dsieger 7952: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7953: including the <code class="filename">nbX</code> suffix) or a date stamp can
7954: be appended, like
7955: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53 rodent 7956: <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>
7957: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7958: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7959: path in the filenames.
1.53 rodent 7960: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7961: Furthermore, a mail to the package's authors seems appropriate
7962: telling them that changing distfiles after releases without
7963: changing the file names is not good practice.</p>
7964: </div>
1.88 tnn 7965: <div class="sect2">
7966: <div class="titlepage"><div><div><h3 class="title">
7967: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 7968: <p>Helper methods exist for packages hosted on github.com which will often have distfile names that clash with other packages, for example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes from below:
7969: </p>
1.88 tnn 7970: <div class="sect3">
7971: <div class="titlepage"><div><div><h4 class="title">
7972: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
7973: <p>
7974: If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/archive/v1.0.zip</code>, then you are packaging a tagged release.
7975: </p>
7976: <pre class="programlisting">
7977: DISTNAME= exampleproject-1.0
1.90 tnn 7978: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7979: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7980: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7981: EXTRACT_SUFX= .zip
7982: </pre>
7983: </div>
7984: <div class="sect3">
7985: <div class="titlepage"><div><div><h4 class="title">
7986: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
7987: <p>
7988: If your distfile URL looks similar to <code class="literal">http://github.com/example/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>, then you are packaging a specific commit not tied to a release.
7989: </p>
7990: <pre class="programlisting">
7991: DISTNAME= example-1.0
1.107 jnemeth 7992: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7993: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7994: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 7995: </pre>
7996: </div>
7997: <div class="sect3">
7998: <div class="titlepage"><div><div><h4 class="title">
7999: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
8000: <p>
8001: If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/releases/download/rel-1.6/offensive-1.6.zip</code>, then you are packaging a release.
8002: </p>
8003: <pre class="programlisting">
8004: DISTNAME= offensive-1.6
1.90 tnn 8005: PKGNAME= ${DISTNAME:S/offensive/proper/}
8006: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8007: GITHUB_PROJECT= exampleproject
8008: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8009: EXTRACT_SUFX= .zip
1.88 tnn 8010: </pre>
8011: </div>
8012: </div>
1.1 dsieger 8013: </div>
1.41 asau 8014: <div class="sect1">
1.1 dsieger 8015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 8016: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8017: <div class="sect2">
1.1 dsieger 8018: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8019: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8020: <p>pkgsrc supports many different machines, with different
8021: object formats like a.out and ELF, and varying abilities to do
8022: shared library and dynamic loading at all. To accompany this,
8023: varying commands and options have to be passed to the
8024: compiler, linker, etc. to get the Right Thing, which can be
8025: pretty annoying especially if you don't have all the machines
8026: at your hand to test things. The
1.79 snj 8027: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 8028: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8029: both static and dynamic libraries from a set of source files,
8030: thus being platform-independent.</p>
8031: <p>Here's how to use libtool in a package in seven simple
8032: steps:</p>
1.23 wiz 8033: <div class="orderedlist"><ol class="orderedlist" type="1">
8034: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8035: Makefile.</p></li>
1.23 wiz 8036: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8037: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8038: add it to the definition of <code class="varname">CC</code>, if only
8039: libraries are being built in a given Makefile. This one command
8040: will build both PIC and non-PIC library objects, so you need not
8041: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8042: <li class="listitem">
1.1 dsieger 8043: <p>For the linking of the library, remove any
1.23 wiz 8044: <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
8045: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8046: <pre class="programlisting">
8047: ${LIBTOOL} --mode=link \
8048: ${CC} -o ${.TARGET:.a=.la} \
8049: ${OBJS:.o=.lo} \
8050: -rpath ${PREFIX}/lib \
8051: -version-info major:minor
8052: </pre>
8053: <p>Note that the library is changed to have a
8054: <code class="filename">.la</code> extension, and the objects are
8055: changed to have a <code class="filename">.lo</code>
8056: extension. Change <code class="varname">OBJS</code> as
8057: necessary. This automatically creates all of the
8058: <code class="filename">.a</code>,
8059: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8060: necessary) in the build directory. Be sure to include
1.23 wiz 8061: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8062: minor are zero, as libtool will otherwise strip off the
8063: shared library version.</p>
8064: <p>From the libtool manual:</p>
8065: <pre class="programlisting">
8066: So, libtool library versions are described by three integers:
8067:
8068: CURRENT
8069: The most recent interface number that this library implements.
8070:
8071: REVISION
8072: The implementation number of the CURRENT interface.
8073:
8074: AGE
8075: The difference between the newest and oldest interfaces that
8076: this library implements. In other words, the library implements
8077: all the interface numbers in the range from number `CURRENT -
8078: AGE' to `CURRENT'.
8079:
8080: If two libraries have identical CURRENT and AGE numbers, then the
8081: dynamic linker chooses the library with the greater REVISION number.
8082: </pre>
1.23 wiz 8083: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8084: different results for a.out and ELF (excluding symlinks)
8085: in only one case. An ELF library of the form
1.23 wiz 8086: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8087: will have a symlink of
1.23 wiz 8088: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8089: on an a.out platform. This is handled
8090: automatically.</p>
1.23 wiz 8091: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8092: directory of the library being built.</p>
8093: <p>In the <code class="filename">PLIST</code>, include only the
8094: <code class="filename">.la</code> file, the other files will be
8095: added automatically.</p>
8096: </li>
1.23 wiz 8097: <li class="listitem">
1.1 dsieger 8098: <p>When linking shared object (<code class="filename">.so</code>)
1.79 snj 8099: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 8100: shared libraries, use <span class="quote">“<span class="quote">-module
8101: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8102: tacked on.</p>
8103: <p>The <code class="filename">PLIST</code> file gets the
8104: <code class="filename">foo.so</code> entry.</p>
8105: </li>
1.23 wiz 8106: <li class="listitem">
1.1 dsieger 8107: <p>When linking programs that depend on these libraries
8108: <span class="emphasis"><em>before</em></span> they are installed, preface
1.79 snj 8109: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8110: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8111: libraries (static or shared), but please be aware that
8112: libtool will not allow you to specify a relative path in
1.23 wiz 8113: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8114: expects you to change that argument to be the
8115: <code class="filename">.la</code> file. e.g.</p>
8116: <pre class="programlisting">
8117: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8118: </pre>
8119: <p>should be changed to:</p>
8120: <pre class="programlisting">
8121: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8122: </pre>
8123: <p>and it will do the right thing with the libraries.</p>
8124: </li>
1.23 wiz 8125: <li class="listitem">
1.79 snj 8126: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8127: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8128: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8129: <code class="filename">.la</code>. e.g.</p>
8130: <pre class="programlisting">
1.22 jakllsch 8131: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 8132: </pre>
8133: <p>This will install the static <code class="filename">.a</code>,
8134: shared library, any needed symlinks, and run
1.79 snj 8135: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8136: </li>
1.23 wiz 8137: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8138: the <code class="filename">.la</code>
8139: file (this is a change from previous behaviour).</p></li>
8140: </ol></div>
8141: </div>
1.41 asau 8142: <div class="sect2">
1.1 dsieger 8143: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8144: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8145: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8146: package Makefile. This will override the package's own libtool
8147: in most cases. For older libtool using packages, libtool is
8148: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8149: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8150: configure; find work*/ -name libtool</strong></span>.</p>
8151: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8152: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8153: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8154: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8155: package's libtool script(s), set it as appropriate.</p>
8156: <p>If you do not need <code class="filename">*.a</code> static
8157: libraries built and installed, then use
8158: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8159: <p>If your package makes use of the platform-independent library
8160: for loading dynamic shared objects, that comes with libtool
8161: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8162: <p>Some packages use libtool incorrectly so that the package
8163: may not work or build in some circumstances. Some of the more
8164: common errors are:</p>
1.41 asau 8165: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8166: <li class="listitem">
1.1 dsieger 8167: <p>The inclusion of a shared object (-module) as a dependent library in an
8168: executable or library. This in itself isn't a problem if one of two things
8169: has been done:</p>
1.23 wiz 8170: <div class="orderedlist"><ol class="orderedlist" type="1">
8171: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8172: <code class="filename">libfoo.la</code>, not
8173: <code class="filename">foo.la</code></p></li>
1.23 wiz 8174: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8175: </ol></div>
8176: </li>
1.23 wiz 8177: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8178: The function lt_dlinit() should be called and the macro
8179: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8180: executables.</p></li>
8181: </ul></div>
8182: </div>
1.41 asau 8183: <div class="sect2">
1.1 dsieger 8184: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8185: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8186: <p>If a package needs GNU autoconf or automake to be executed
8187: to regenerate the configure script and Makefile.in makefile
8188: templates, then they should be executed in a pre-configure
8189: target.</p>
8190: <p>For packages that need only autoconf:</p>
8191: <pre class="programlisting">
8192: AUTOCONF_REQD= 2.50 # if default version is not good enough
8193: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8194: ...
8195:
8196: pre-configure:
8197: cd ${WRKSRC} && autoconf
8198:
8199: ...
8200: </pre>
8201: <p>and for packages that need automake and autoconf:</p>
8202: <pre class="programlisting">
8203: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8204: USE_TOOLS+= automake # use "automake14" for automake-1.4
8205: ...
8206:
8207: pre-configure:
8208: set -e; cd ${WRKSRC}; \
8209: aclocal; autoheader; automake -a --foreign -i; autoconf
8210:
8211: ...
8212: </pre>
8213: <p>Packages which use GNU Automake will almost certainly
8214: require GNU Make.</p>
8215: <p>There are times when the configure process makes
8216: additional changes to the generated files, which then causes
8217: the build process to try to re-execute the automake sequence.
8218: This is prevented by touching various files in the configure
8219: stage. If this causes problems with your package you can set
8220: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8221: Makefile.</p>
8222: </div>
8223: </div>
1.41 asau 8224: <div class="sect1">
1.1 dsieger 8225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8226: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 8227: <div class="sect2">
1.1 dsieger 8228: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8229: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8230: <p>Compilers for the C, C++, and Fortran languages comes with
8231: the NetBSD base system. By default, pkgsrc assumes that a package
8232: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 8233: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8234: <p>To declare which language's compiler a package needs, set
8235: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8236: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8237: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8238: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8239: written in C++, usually need a C compiler for the configure
8240: phase.</p>
8241: </div>
1.41 asau 8242: <div class="sect2">
1.1 dsieger 8243: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8244: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8245: <p>If a program is written in Java, use the Java framework in
8246: pkgsrc. The package must include
8247: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8248: provides the following variables:</p>
1.41 asau 8249: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8250: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8251: dependency on the JDK is added. If
1.23 wiz 8252: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8253: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8254: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8255: JDK.</p></li>
1.23 wiz 8256: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8257: a package needs a Java2 implementation. The supported values
1.23 wiz 8258: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8259: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8260: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8261: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8262: above. This variable is not set by default.</p></li>
1.24 wiz 8263: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8264: automatically set to the runtime location of the used Java
8265: implementation dependency. It may be used to set
8266: <code class="varname">JAVA_HOME</code> to a good value if the program
8267: needs this variable to be defined.
8268: </p></li>
1.1 dsieger 8269: </ul></div>
8270: </div>
1.41 asau 8271: <div class="sect2">
1.1 dsieger 8272: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8273: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8274: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8275: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8276: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8277: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8278: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8279: that you want adjusted. Every occurrence of
8280: <code class="filename">*/bin/perl</code> in a she-bang line will be
8281: replaced with the full path to the perl executable.</p>
1.1 dsieger 8282: <p>If a particular version of perl is needed, set the
8283: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8284: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 8285: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.1 dsieger 8286: about handling perl modules.</p>
8287: </div>
1.41 asau 8288: <div class="sect2">
1.1 dsieger 8289: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 8290: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8291: <p><code class="varname">REPLACE_SH</code>,
8292: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8293: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8294: hash bangs in files. Please use the appropriate one, prefering
8295: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 8296: Each should contain a list of scripts, relative to
8297: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8298: occurrence of the matching shell in a she-bang line will be
8299: replaced with the full path to the shell executable.
1.40 wiz 8300: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8301: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8302: </div>
1.41 asau 8303: <div class="sect2">
1.40 wiz 8304: <div class="titlepage"><div><div><h3 class="title">
8305: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8306: <p>Currently, there is no special handling for other languages
8307: in pkgsrc. If a compiler package provides a
8308: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8309: just add a (build) dependency on the appropriate compiler
8310: package.</p>
8311: </div>
8312: </div>
1.41 asau 8313: <div class="sect1">
1.1 dsieger 8314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 8315: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8316: <p>The most common failures when building a package are that
8317: some platforms do not provide certain header files, functions or
8318: libraries, or they provide the functions in a library that the
8319: original package author didn't know. To work around this, you
8320: can rewrite the source code in most cases so that it does not
8321: use the missing functions or provides a replacement function.</p>
1.41 asau 8322: <div class="sect2">
1.1 dsieger 8323: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8324: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8325: <p>If a package already comes with a GNU configure script, the
8326: preferred way to fix the build failure is to change the
8327: configure script, not the code. In the other cases, you can
8328: utilize the C preprocessor, which defines certain macros
8329: depending on the operating system and hardware architecture it
8330: compiles for. These macros can be queried using for example
8331: <code class="varname">#if defined(__i386)</code>. Almost every operating
8332: system, hardware architecture and compiler has its own macro.
8333: For example, if the macros <code class="varname">__GNUC__</code>,
8334: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8335: are all defined, you know that you are using NetBSD on an i386
8336: compatible CPU, and your compiler is GCC.</p>
8337: <p>The list of the following macros for hardware and
8338: operating system depends on the compiler that is used. For
8339: example, if you want to conditionally compile code on Solaris,
8340: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8341: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8342: <div class="sect3">
1.1 dsieger 8343: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8344: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 8345: <p>To distinguish between 4.4 BSD-derived systems and the
8346: rest of the world, you should use the following code.</p>
8347: <pre class="programlisting">
8348: #include <sys/param.h>
8349: #if (defined(BSD) && BSD >= 199306)
8350: /* BSD-specific code goes here */
8351: #else
8352: /* non-BSD-specific code goes here */
8353: #endif
8354: </pre>
8355: <p>If this distinction is not fine enough, you can also test
8356: for the following macros.</p>
8357: <pre class="programlisting">
1.45 obache 8358: Cygwin __CYGWIN__
8359: DragonFly __DragonFly__
1.1 dsieger 8360: FreeBSD __FreeBSD__
1.45 obache 8361: Haiku __HAIKU__
1.1 dsieger 8362: Interix __INTERIX
8363: IRIX __sgi (TODO: get a definite source for this)
8364: Linux linux, __linux, __linux__
1.83 dholland 8365: Mac OS X __APPLE__
1.45 obache 8366: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8367: Minix3 __minix
1.1 dsieger 8368: NetBSD __NetBSD__
8369: OpenBSD __OpenBSD__
8370: Solaris sun, __sun
8371: </pre>
8372: </div>
1.41 asau 8373: <div class="sect3">
1.1 dsieger 8374: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8375: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8376: <pre class="programlisting">
8377: i386 i386, __i386, __i386__
8378: MIPS __mips
8379: SPARC sparc, __sparc
8380: </pre>
8381: </div>
1.41 asau 8382: <div class="sect3">
1.1 dsieger 8383: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8384: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8385: <pre class="programlisting">
8386: GCC __GNUC__ (major version), __GNUC_MINOR__
8387: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8388: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8389: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8390: </pre>
8391: </div>
8392: </div>
1.41 asau 8393: <div class="sect2">
1.1 dsieger 8394: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8395: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8396: <p>Some source files trigger bugs in the compiler, based on
8397: combinations of compiler version and architecture and almost
8398: always relation to optimisation being enabled. Common symptoms
8399: are gcc internal errors or never finishing compiling a
8400: file.</p>
8401: <p>Typically, a workaround involves testing the
8402: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8403: optimisation for that combination of file,
1.87 tnn 8404: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8405: <p>This used to be a big problem in the past, but is rarely
8406: needed now as compiler technology has matured. If you still need
8407: to add a compiler specific workaround, please do so in the file
8408: <code class="filename">hacks.mk</code> and describe the symptom and
8409: compiler version as detailed as possible.</p>
1.1 dsieger 8410: </div>
1.41 asau 8411: <div class="sect2">
1.1 dsieger 8412: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 8413: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8414: </h3></div></div></div>
1.1 dsieger 8415: <p>This error message often means that a package did not
8416: link to a shared library it needs. The following functions are
8417: known to cause this error message over and over.</p>
8418: <div class="informaltable">
1.106 tnn 8419: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 8420: <colgroup>
8421: <col>
8422: <col>
8423: <col>
8424: </colgroup>
8425: <thead><tr>
8426: <th>Function</th>
8427: <th>Library</th>
8428: <th>Affected platforms</th>
8429: </tr></thead>
8430: <tbody>
8431: <tr>
8432: <td>accept, bind, connect</td>
8433: <td>-lsocket</td>
8434: <td>Solaris</td>
8435: </tr>
8436: <tr>
8437: <td>crypt</td>
8438: <td>-lcrypt</td>
8439: <td>DragonFly, NetBSD</td>
8440: </tr>
8441: <tr>
8442: <td>dlopen, dlsym</td>
8443: <td>-ldl</td>
8444: <td>Linux</td>
8445: </tr>
8446: <tr>
8447: <td>gethost*</td>
8448: <td>-lnsl</td>
8449: <td>Solaris</td>
8450: </tr>
8451: <tr>
8452: <td>inet_aton</td>
8453: <td>-lresolv</td>
8454: <td>Solaris</td>
8455: </tr>
8456: <tr>
8457: <td>nanosleep, sem_*, timer_*</td>
8458: <td>-lrt</td>
8459: <td>Solaris</td>
8460: </tr>
8461: <tr>
8462: <td>openpty</td>
8463: <td>-lutil</td>
8464: <td>Linux</td>
8465: </tr>
8466: </tbody>
8467: </table>
8468: </div>
8469: <p>To fix these linker errors, it is often sufficient to say
8470: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8471: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8472: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8473: bmake</strong></span>.</p>
1.41 asau 8474: <div class="sect3">
1.1 dsieger 8475: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8476: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8477: <p>When you are using the SunPro compiler, there is another
8478: possibility. That compiler cannot handle the following code:</p>
8479: <pre class="programlisting">
8480: extern int extern_func(int);
8481:
8482: static inline int
8483: inline_func(int x)
8484: {
8485: return extern_func(x);
8486: }
8487:
8488: int main(void)
8489: {
8490: return 0;
8491: }
8492: </pre>
8493: <p>It generates the code for <code class="function">inline_func</code> even if
8494: that function is never used. This code then refers to
8495: <code class="function">extern_func</code>, which can usually not be resolved. To
8496: solve this problem you can try to tell the package to disable inlining
8497: of functions.</p>
8498: </div>
8499: </div>
1.41 asau 8500: <div class="sect2">
1.1 dsieger 8501: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8502: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8503: <p>Sometimes packages fail to build because the compiler runs
8504: into an operating system specific soft limit. With the
8505: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8506: to unlimit the resources. Currently, the allowed values are any combination of
8507: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8508: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8509: Setting this variable is similar to running the shell builtin
1.10 hubertf 8510: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8511: segment size or maximum stack size of a process, respectively, to
8512: their hard limits.</p>
8513: </div>
8514: </div>
1.41 asau 8515: <div class="sect1">
1.1 dsieger 8516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 8517: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8518: <div class="sect2">
1.1 dsieger 8519: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8520: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8521: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8522: with some operating systems cannot create more than one
8523: directory at a time. As such, you should call
8524: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8525: <pre class="programlisting">
8526: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8527: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8528: </pre>
1.23 wiz 8529: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8530: dir2</code></span>”</span> to the
1.1 dsieger 8531: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8532: automatically do the right thing.</p>
8533: </div>
1.41 asau 8534: <div class="sect2">
1.1 dsieger 8535: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8536: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8537: <p>In general, documentation should be installed into
8538: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8539: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8540: includes the version number of the package).</p>
8541: <p>Many modern packages using GNU autoconf allow to set the
8542: directory where HTML documentation is installed with the
1.23 wiz 8543: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8544: is needed because otherwise the documentation ends up in
8545: <code class="filename">${PREFIX}/share/doc/html</code> or other
8546: places.</p>
8547: <p>An exception to the above is that library API documentation
1.79 snj 8548: generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.1 dsieger 8549: browsers (devhelp) should be left at their default location, which
8550: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8551: documentation can be recognized from files ending in
8552: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8553: (It is also acceptable to install such files in
8554: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8555: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8556: <code class="filename">.devhelp*</code> file must be directly in that
8557: directory then, no additional subdirectory level is allowed in
8558: this case. This is usually achieved by using
1.23 wiz 8559: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8560: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8561: though.)</p>
8562: </div>
1.41 asau 8563: <div class="sect2">
1.1 dsieger 8564: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8565: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8566: <p>Certain packages, most of them in the games category, install
8567: a score file that allows all users on the system to record their
8568: highscores. In order for this to work, the binaries need to be
8569: installed setgid and the score files owned by the appropriate
1.35 wiz 8570: group and/or owner (traditionally the "games" user/group). Set
8571: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8572: following variables, documented in more detail in
8573: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8574: behaviour: <code class="varname">GAMEDATAMODE</code>,
8575: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8576: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8577: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8578: <code class="varname">GAMEDATA_PERMS</code> and
8579: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8580: <p>An example that illustrates some of the variables described above is
8581: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8582: used to properly set directory permissions of the directory where the
8583: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8584: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8585: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8586: binary:</p>
8587: <pre class="programlisting">
8588: USE_GAMESGROUP= yes
8589:
8590: BUILD_DEFS+= VARBASE
8591:
8592: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8593: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8594: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
8595: </pre>
8596: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8597: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8598: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8599: needed to be accessed by setgid games and
8600: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8601: <p>A package should therefore never hard code file ownership or
1.100 leot 8602: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8603: or alternatively on <code class="varname">INSTALL_GAME</code>,
8604: <code class="varname">INSTALL_GAME_DATA</code> and
8605: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8606: </div>
1.41 asau 8607: <div class="sect2">
1.1 dsieger 8608: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8609: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8610: <p><code class="varname">DESTDIR</code> support means that a package
8611: installs into a staging directory, not the final location of the
8612: files. Then a binary package is created which can be used for
8613: installation as usual. There are two ways: Either the package must
1.23 wiz 8614: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8615: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8616: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8617: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 8618: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8619: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8620: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8621: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8622: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8623: the inclusion.</p></li>
1.23 wiz 8624: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8625: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8626: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8627: automatically. Many manual rules and pre/post-install often are
8628: incorrect; fix them.</p></li>
1.23 wiz 8629: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8630: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8631: <li class="listitem"><p>In general, packages should support
1.4 rillig 8632: <code class="varname">UNPRIVILEGED</code> to be able to use
8633: DESTDIR.</p></li>
8634: </ul></div>
8635: </div>
1.41 asau 8636: <div class="sect2">
1.4 rillig 8637: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8638: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8639: <p>Your package may also contain scripts with hardcoded paths to
8640: other interpreters besides (or as well as) perl. To correct the
8641: full pathname to the script interpreter, you need to set the
8642: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8643: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8644: <pre class="programlisting">
8645: REPLACE_INTERPRETER+= tcl
8646: REPLACE.tcl.old= .*/bin/tclsh
8647: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8648: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8649: # relative to ${WRKSRC}, just as in REPLACE_PERL
8650: </pre>
1.41 asau 8651: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8652: <h3 class="title">Note</h3>
8653: <p>Before March 2006, these variables were called
8654: <code class="varname">_REPLACE.*</code> and
8655: <code class="varname">_REPLACE_FILES.*</code>.</p>
8656: </div>
8657: </div>
1.41 asau 8658: <div class="sect2">
1.1 dsieger 8659: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8660: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8661: <p>Makefiles of packages providing perl5 modules should include
8662: the Makefile fragment
8663: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8664: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8665: configuration for such modules as well as various hooks to tune
8666: this configuration. See comments in this file for
8667: details.</p>
8668: <p>Perl5 modules will install into different places depending
8669: on the version of perl used during the build process. To
8670: address this, pkgsrc will append lines to the
8671: <code class="filename">PLIST</code> corresponding to the files listed in
8672: the installed <code class="filename">.packlist</code> file generated by
8673: most perl5 modules. This is invoked by defining
8674: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8675: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8676: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8677: e.g.:</p>
1.1 dsieger 8678: <pre class="programlisting">
1.47 wiz 8679: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 8680: </pre>
1.47 wiz 8681: <p>The perl5 config variables
8682: <code class="varname">installarchlib</code>,
8683: <code class="varname">installscript</code>,
8684: <code class="varname">installvendorbin</code>,
8685: <code class="varname">installvendorscript</code>,
8686: <code class="varname">installvendorarch</code>,
8687: <code class="varname">installvendorlib</code>,
8688: <code class="varname">installvendorman1dir</code>, and
8689: <code class="varname">installvendorman3dir</code> represent those
8690: locations in which components of perl5 modules may be installed,
8691: provided as variable with uppercase and prefixed with
8692: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8693: and may be used by perl5 packages that don't have a packlist.
8694: These variables are also substituted for in the
8695: <code class="filename">PLIST</code> as uppercase prefixed with
8696: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8697: </div>
1.41 asau 8698: <div class="sect2">
1.1 dsieger 8699: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8700: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8701: <p>Some packages install info files or use the
1.23 wiz 8702: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8703: commands. <code class="varname">INFO_FILES</code> should be defined in
8704: the package Makefile so that <code class="filename">INSTALL</code> and
8705: <code class="filename">DEINSTALL</code> scripts will be generated to
8706: handle registration of the info files in the Info directory
1.23 wiz 8707: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8708: files registration is either provided by the system, or by a
8709: special purpose package automatically added as dependency if
8710: needed.</p>
8711: <p><code class="varname">PKGINFODIR</code> is the directory under
8712: <code class="filename">${PREFIX}</code> where info files are primarily
8713: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8714: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8715: <p>The info files for the package should be listed in the
8716: package <code class="filename">PLIST</code>; however any split info files
8717: need not be listed.</p>
1.23 wiz 8718: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8719: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8720: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8721: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8722: should be noted with the <code class="varname">TEXINFO_REQD</code>
8723: variable in the package <code class="filename">Makefile</code>. By
8724: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8725: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8726: does not match the required minimum, a build dependency on the
1.79 snj 8727: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1 dsieger 8728: be added automatically.</p>
8729: <p>The build and installation process of the software provided
8730: by the package should not use the
1.10 hubertf 8731: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8732: info files is the task of the package
8733: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8734: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8735: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8736: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8737: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8738: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8739: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8740: no effect except the logging of a message. The script overriding
1.10 hubertf 8741: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8742: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8743: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8744: </div>
1.41 asau 8745: <div class="sect2">
1.1 dsieger 8746: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8747: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8748: <p>All packages that install manual pages should install them
8749: into the same directory, so that there is one common place to look
8750: for them. In pkgsrc, this place is
8751: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8752: should be used in packages. The default for
8753: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8754: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8755: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8756: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8757: <h3 class="title">Note</h3>
8758: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8759: is far from complete.</p>
8760: </div>
8761: <p>The <code class="filename">PLIST</code> files can just use
8762: <code class="filename">man/</code> as the top level directory for the man
8763: page file entries, and the pkgsrc framework will convert as
8764: needed. In all other places, the correct
8765: <code class="varname">PKGMANDIR</code> must be used.</p>
8766: <p>Packages that are
8767: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8768: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8769: <code class="filename">./configure</code>
8770: --mandir switch to set where the man pages should be installed.
8771: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8772: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8773: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8774: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8775: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8776: Or if the <code class="filename">./configure</code> script uses
8777: a non-standard use of --mandir, you can set
8778: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8779: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.1 dsieger 8780: information on installation of compressed manual pages.</p>
8781: </div>
1.41 asau 8782: <div class="sect2">
1.1 dsieger 8783: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8784: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8785: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8786: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8787: you need to take some extra steps to make sure they get registered
8788: in the database:</p>
1.23 wiz 8789: <div class="orderedlist"><ol class="orderedlist" type="1">
8790: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8791: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8792: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8793: deinstallation time, and tells the package where to install
1.7 rillig 8794: GConf data files using some standard configure arguments. It
1.1 dsieger 8795: also disallows any access to the database directly from the
8796: package.</p></li>
1.23 wiz 8797: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8798: <code class="filename">.schemas</code> files under
8799: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8800: installed under <code class="filename">${PREFIX}/etc</code>, you will
8801: need to manually patch the package.</p></li>
1.23 wiz 8802: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8803: directory, as they will be handled automatically. See
1.84 wiz 8804: <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.23 wiz 8805: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8806: your <code class="filename">Makefile</code> with a list of all
8807: <code class="filename">.schemas</code> files installed by the package, if
8808: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8809: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8810: your <code class="filename">Makefile</code> with a
8811: list of all <code class="filename">.entries</code> files installed by the
8812: package, if any. Names must not contain any directories in
8813: them.</p></li>
8814: </ol></div>
8815: </div>
1.41 asau 8816: <div class="sect2">
1.1 dsieger 8817: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8818: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8819: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8820: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8821: get registered in the database:</p>
1.23 wiz 8822: <div class="orderedlist"><ol class="orderedlist" type="1">
8823: <li class="listitem"><p>Include
1.18 snj 8824: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8825: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8826: takes care of rebuilding the scrollkeeper database at
8827: installation and deinstallation time, and disallows any access
8828: to it directly from the package.</p></li>
1.23 wiz 8829: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8830: <code class="filename">libdata/scrollkeeper</code> directory, as they
8831: will be handled automatically.</p></li>
1.23 wiz 8832: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8833: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8834: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8835: </ol></div>
8836: </div>
1.41 asau 8837: <div class="sect2">
1.1 dsieger 8838: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8839: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8840: <p>If a package installs font files, you will need to rebuild
8841: the fonts database in the directory where they get installed at
8842: installation and deinstallation time. This can be automatically
8843: done by using the pkginstall framework.</p>
8844: <p>You can list the directories where fonts are installed in the
8845: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8846: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8847: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.1 dsieger 8848: Also make sure that the database file
8849: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8850: <p>Note that you should not create new directories for fonts;
8851: instead use the standard ones to avoid that the user needs to
8852: manually configure his X server to find them.</p>
8853: </div>
1.41 asau 8854: <div class="sect2">
1.1 dsieger 8855: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8856: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8857: <p>If a package installs GTK2 immodules or loaders, you need to
8858: take some extra steps to get them registered in the GTK2 database
8859: properly:</p>
1.23 wiz 8860: <div class="orderedlist"><ol class="orderedlist" type="1">
8861: <li class="listitem"><p>Include
1.1 dsieger 8862: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8863: <code class="filename">buildlink3.mk</code> file. This takes care of
8864: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8865: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8866: your package installs GTK2 immodules.</p></li>
1.23 wiz 8867: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8868: GTK2 loaders.</p></li>
1.23 wiz 8869: <li class="listitem">
1.1 dsieger 8870: <p>Patch the package to not touch any of the GTK2
8871: databases directly. These are:</p>
1.41 asau 8872: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8873: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8874: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8875: </ul></div>
8876: </li>
1.23 wiz 8877: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8878: any entries under the <code class="filename">libdata/gtk-2.0</code>
8879: directory, as they will be handled automatically.</p></li>
8880: </ol></div>
8881: </div>
1.41 asau 8882: <div class="sect2">
1.1 dsieger 8883: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8884: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8885: <p>If a package installs SGML or XML data files that need to be
8886: registered in system-wide catalogs (like DTDs, sub-catalogs,
8887: etc.), you need to take some extra steps:</p>
1.23 wiz 8888: <div class="orderedlist"><ol class="orderedlist" type="1">
8889: <li class="listitem"><p>Include
1.1 dsieger 8890: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8891: your <code class="filename">Makefile</code>, which takes care of
8892: registering those files in system-wide catalogs at
8893: installation and deinstallation time.</p></li>
1.23 wiz 8894: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8895: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8896: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8897: any XML catalogs installed by the package.</p></li>
1.23 wiz 8898: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8899: to be added to the SGML catalog. These come in groups of
8900: three strings; see xmlcatmgr(1) for more information
8901: (specifically, arguments recognized by the 'add' action).
8902: Note that you will normally not use this variable.</p></li>
1.23 wiz 8903: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8904: to be added to the XML catalog. These come in groups of three
8905: strings; see xmlcatmgr(1) for more information (specifically,
8906: arguments recognized by the 'add' action). Note that you will
8907: normally not use this variable.</p></li>
8908: </ol></div>
8909: </div>
1.41 asau 8910: <div class="sect2">
1.1 dsieger 8911: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8912: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8913: <p>If a package provides extensions to the MIME database by
8914: installing <code class="filename">.xml</code> files inside
8915: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8916: need to take some extra steps to ensure that the database is kept
8917: consistent with respect to these new files:</p>
1.23 wiz 8918: <div class="orderedlist"><ol class="orderedlist" type="1">
8919: <li class="listitem"><p>Include
1.1 dsieger 8920: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8921: (avoid using the <code class="filename">buildlink3.mk</code> file from
8922: this same directory, which is reserved for inclusion from
8923: other <code class="filename">buildlink3.mk</code> files). It takes
8924: care of rebuilding the MIME database at installation and
8925: deinstallation time, and disallows any access to it directly
8926: from the package.</p></li>
1.23 wiz 8927: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8928: <code class="filename">share/mime</code> directory,
8929: <span class="emphasis"><em>except</em></span> for files saved under
8930: <code class="filename">share/mime/packages</code>. The former are
8931: handled automatically by
8932: the update-mime-database program, but the latter are
8933: package-dependent and must be removed by the package that
8934: installed them in the first place.</p></li>
1.23 wiz 8935: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8936: from the PLIST. They will be handled by the shared-mime-info
8937: package.</p></li>
8938: </ol></div>
8939: </div>
1.41 asau 8940: <div class="sect2">
1.1 dsieger 8941: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8942: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8943: <p>If a package uses intltool during its build, add
8944: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8945: which forces it to use the intltool package provided by pkgsrc,
8946: instead of the one bundled with the distribution file.</p>
8947: <p>This tracks intltool's build-time dependencies and uses the
8948: latest available version; this way, the package benefits of any
8949: bug fixes that may have appeared since it was released.</p>
8950: </div>
1.41 asau 8951: <div class="sect2">
1.1 dsieger 8952: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8953: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8954: <p>If a package contains a rc.d script, it won't be copied into
8955: the startup directory by default, but you can enable it, by adding
8956: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8957: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8958: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8959: it will automatically remove the scripts when the package is
8960: deinstalled.</p>
8961: </div>
1.41 asau 8962: <div class="sect2">
1.1 dsieger 8963: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8964: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8965: <p>If a package installs TeX packages into the texmf tree,
8966: the <code class="filename">ls-R</code> database of the tree needs to be
8967: updated.</p>
1.41 asau 8968: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8969: <h3 class="title">Note</h3>
1.22 jakllsch 8970: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8971: packages should install files
1.22 jakllsch 8972: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8973: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8974: </div>
1.23 wiz 8975: <div class="orderedlist"><ol class="orderedlist" type="1">
8976: <li class="listitem"><p>Include
1.22 jakllsch 8977: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8978: takes care of rebuilding the <code class="filename">ls-R</code>
8979: database at installation and deinstallation time.</p></li>
1.23 wiz 8980: <li class="listitem">
1.1 dsieger 8981: <p>If your package installs files into a texmf
8982: tree other than the one
1.22 jakllsch 8983: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8984: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8985: trees that need database update.</p>
8986: <p>If your package also installs font map files that need
1.10 hubertf 8987: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8988: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8989: set <code class="varname">TEX_MAP_FILES</code> and/or
8990: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8991: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8992: be run automatically at installation/deinstallation to
8993: enable/disable font map files for TeX output
8994: drivers.</p>
8995: </li>
1.23 wiz 8996: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8997: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8998: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8999: </ol></div>
9000: </div>
1.41 asau 9001: <div class="sect2">
1.1 dsieger 9002: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9003: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9004: emulation</h3></div></div></div>
9005: <p>There are some packages that provide libraries and
9006: executables for running binaries from a one operating system
9007: on a different one (if the latter supports it). One example
9008: is running Linux binaries on NetBSD.</p>
1.79 snj 9009: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1 dsieger 9010: helps in extracting and packaging Linux rpm packages.</p>
9011: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9012: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9013: if all libraries for each installed executable can be found by
9014: the dynamic linker. Since the standard dynamic linker is run,
9015: this fails for emulation packages, because the libraries used
9016: by the emulation are not in the standard directories.</p>
9017: </div>
1.41 asau 9018: <div class="sect2">
1.1 dsieger 9019: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9020: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9021: <p>If a package installs images under the
9022: <code class="filename">share/icons/hicolor</code> and/or updates the
9023: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9024: database, you need to take some extra steps to make sure that the
9025: shared theme directory is handled appropriately and that the cache
9026: database is rebuilt:</p>
1.23 wiz 9027: <div class="orderedlist"><ol class="orderedlist" type="1">
9028: <li class="listitem"><p>Include
1.1 dsieger 9029: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 9030: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 9031: entry that refers to the theme cache.</p></li>
1.23 wiz 9032: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 9033: directories from the <code class="filename">share/icons/hicolor</code>
9034: hierarchy because they will be handled automatically.</p></li>
9035: </ol></div>
9036: <p>The best way to verify that the PLIST is correct with
9037: respect to the last two points is to regenerate it using
1.10 hubertf 9038: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9039: </div>
1.41 asau 9040: <div class="sect2">
1.1 dsieger 9041: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9042: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9043: <p>If a package installs <code class="filename">.desktop</code> files
9044: under <code class="filename">share/applications</code> and these include
1.53 rodent 9045: MIME information (MimeType key), you need to take extra steps to
9046: ensure that they are registered into the MIME database:</p>
1.23 wiz 9047: <div class="orderedlist"><ol class="orderedlist" type="1">
9048: <li class="listitem"><p>Include
1.1 dsieger 9049: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 9050: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 9051: <code class="filename">share/applications/mimeinfo.cache</code> file.
9052: It will be handled automatically.</p></li>
9053: </ol></div>
9054: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9055: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9056: print-PLIST</strong></span>.</p>
9057: </div>
9058: </div>
1.41 asau 9059: <div class="sect1">
1.1 dsieger 9060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9061: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9062: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 9063: immediately. In this case, one can plainly mark a package as broken. For
9064: this, one just sets the variable <code class="varname">BROKEN</code> to the
9065: reason why the package is broken (similar to the
9066: <code class="varname">RESTRICTED</code> variable). A user trying to build
9067: the package will immediately be shown this message, and the build
9068: will not be even tried.</p>
9069: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 9070: intervals.</p>
9071: </div>
9072: </div>
1.41 asau 9073: <div class="chapter">
1.1 dsieger 9074: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9075: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9076: <p>To check out all the gotchas when building a package, here are
9077: the steps that I do in order to get a package working. Please note
9078: this is basically the same as what was explained in the previous
9079: sections, only with some debugging aids.</p>
1.41 asau 9080: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9081: <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>
9082: <li class="listitem">
1.79 snj 9083: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.1 dsieger 9084: create a directory for a new package, change into it, then run
1.10 hubertf 9085: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9086: <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>
9087: <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>
9088: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9089: </li>
1.23 wiz 9090: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9091: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9092: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9093: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 9094: configure step to the package's
9095: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 9096: <li class="listitem">
1.1 dsieger 9097: <p>Make the package compile, doing multiple rounds of</p>
9098: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9099: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9100: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9101: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9102: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9103: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9104: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9105: <p>Doing this step as non-root user will ensure that no files
9106: are modified that shouldn't be, especially during the build
1.10 hubertf 9107: phase. <span class="command"><strong>mkpatches</strong></span>,
9108: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.79 snj 9109: from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.1 dsieger 9110: package.</p>
9111: </li>
1.23 wiz 9112: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9113: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9114: <li class="listitem">
1.1 dsieger 9115: <p>Generate a <code class="filename">PLIST</code>:</p>
9116: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9117: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9118: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9119: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9120: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9121: <p>You usually need to be <code class="username">root</code> to do
9122: this. Look if there are any files left:</p>
9123: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9124: <p>If this reveals any files that are missing in
9125: <code class="filename">PLIST</code>, add them.</p>
9126: </li>
1.23 wiz 9127: <li class="listitem">
1.1 dsieger 9128: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9129: package again and make a binary package:</p>
9130: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9131: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9132: </li>
1.23 wiz 9133: <li class="listitem">
1.1 dsieger 9134: <p>Delete the installed package:</p>
9135: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9136: </li>
1.23 wiz 9137: <li class="listitem">
1.10 hubertf 9138: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9139: command, which shouldn't find anything now:</p>
9140: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9141: </li>
1.23 wiz 9142: <li class="listitem">
1.1 dsieger 9143: <p>Reinstall the binary package:</p>
9144: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9145: </li>
1.23 wiz 9146: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9147: <li class="listitem">
1.79 snj 9148: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.1 dsieger 9149: reports:</p>
9150: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9151: </li>
1.23 wiz 9152: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.1 dsieger 9153: </ul></div>
9154: </div>
1.41 asau 9155: <div class="chapter">
1.1 dsieger 9156: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9157: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9158: <div class="toc">
9159: <p><b>Table of Contents</b></p>
1.100 leot 9160: <dl class="toc">
1.6 rillig 9161: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9162: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9163: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 9164: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 9165: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 9166: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9167: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9168: </dl>
9169: </div>
1.41 asau 9170: <div class="sect1">
1.1 dsieger 9171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9172: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9173: <p>Our policy is that we accept binaries only from pkgsrc
9174: developers to guarantee that the packages don't contain any
9175: trojan horses etc. This is not to annoy anyone but rather to
9176: protect our users! You're still free to put up your home-made
9177: binary packages and tell the world where to get them. NetBSD
9178: developers doing bulk builds and wanting to upload them please
1.66 asau 9179: 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
9180: builds)</i></a>.</p>
1.1 dsieger 9181: </div>
1.41 asau 9182: <div class="sect1">
1.1 dsieger 9183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9184: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9185: <p>First, check that your package is complete, compiles and
1.10 hubertf 9186: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.79 snj 9187: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 9188: archive that contains all files that make up the package.
9189: Finally, send this package to the pkgsrc bug tracking system,
1.79 snj 9190: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 9191: that, go to the web page
1.10 hubertf 9192: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 9193: which contains some instructions and a link to a form where you
9194: can submit packages. The
1.79 snj 9195: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.21 snj 9196: also available as a substitute for either of the above two tools.
9197: </p>
1.1 dsieger 9198: <p>In the form of the problem report, the category should be
1.23 wiz 9199: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9200: and version number, and the description field should contain a
9201: short description of your package (contents of the COMMENT
9202: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9203: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9204: <p>If you want to submit several packages, please send a
9205: separate PR for each one, it's easier for us to track things
9206: that way.</p>
9207: <p>Alternatively, you can also import new packages into
1.23 wiz 9208: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 9209: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 9210: for details.</p>
9211: </div>
1.41 asau 9212: <div class="sect1">
1.1 dsieger 9213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9214: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9215: <p>Please note all package additions, updates, moves, and
9216: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9217: important to keep this file up to date and conforming to the
9218: existing format, because it will be used by scripts to
1.10 hubertf 9219: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9220: sites. Additionally, check the
9221: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9222: for the package you updated or removed, in case it was mentioned
9223: there.</p>
9224: <p>When the <code class="varname">PKGREVISION</code> of a package is
9225: bumped, the change should appear in
9226: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9227: related or otherwise relevant. Mass bumps that result from a
9228: dependency being updated should not be mentioned. In all other
9229: cases it's the developer's decision.</p>
9230: <p>There is a make target that helps in creating proper
1.10 hubertf 9231: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9232: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9233: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9234: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9235: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9236: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9237: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9238: For new packages, or package moves or removals, set the
9239: <code class="varname">CTYPE</code> variable on the command line to "Added",
9240: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9241: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9242: not the same as your NetBSD login name. The target also automatically
9243: removes possibly existing entries for the package in the
9244: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9245: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9246: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9247: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9248: makes the cvs commands use the main repository.
9249: </p>
1.1 dsieger 9250: </div>
1.41 asau 9251: <div class="sect1">
1.1 dsieger 9252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 9253: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9254: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9255: access to the pkgsrc repository.</p>
9256: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9257: Start by adding the directory and then files in the directory. Don't
9258: forget to add the new package to the category's
9259: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9260: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9261: <pre class="programlisting">
9262: <code class="prompt">$</code> cd .../pkgsrc/category
9263: <code class="prompt">$</code> cvs add pkgname
9264: <code class="prompt">$</code> cd pkgname
9265: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9266: <code class="prompt">$</code> cvs add patches/p*
9267: <code class="prompt">$</code> cvs status | less
1.34 wiz 9268: <code class="prompt">$</code> cvs commit
1.33 wiz 9269: <code class="prompt">$</code> cd ..
9270: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9271: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9272: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9273: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9274: </pre>
1.1 dsieger 9275: <p>The commit message of the initial import should include part of the
9276: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9277: what the package is/does.</p>
1.33 wiz 9278: <p>Also mention the new package in
9279: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9280: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9281: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9282: </div>
1.41 asau 9283: <div class="sect1">
1.1 dsieger 9284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9285: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9286: <p>Please always put a concise, appropriate and relevant summary of the
9287: changes between old and new versions into the commit log when updating
9288: a package. There are various reasons for this:</p>
1.41 asau 9289: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9290: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9291: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9292: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9293: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9294: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9295: repository is very useful for people who read the pkgsrc-changes mailing
9296: list, so that they can make tactical decisions about when to upgrade
9297: the package.</p></li>
9298: </ul></div>
9299: <p>Please also recognize that, just because a new version of a package
9300: has been released, it should not automatically be upgraded in the CVS
9301: repository. We prefer to be conservative in the packages that are
9302: included in pkgsrc - development or beta packages are not really the
9303: best thing for most places in which pkgsrc is used. Please use your
9304: judgement about what should go into pkgsrc, and bear in mind that
9305: stability is to be preferred above new and possibly untested features.</p>
9306: </div>
1.41 asau 9307: <div class="sect1">
1.1 dsieger 9308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 9309: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9310: <p>Renaming packages is not recommended.</p>
9311: <p>When renaming packages, be sure to fix any references to old name
9312: in other Makefiles, options, buildlink files, etc.</p>
9313: <p>Also When renaming a package, please define
9314: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9315: pattern(s) of the previous package name.
9316: This may be repeated for multiple renames.
9317: The new package would be an exact replacement.
9318: </p>
1.23 wiz 9319: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9320: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9321: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9322: not be an exact replacement but is a suggestion for the replaced
9323: functionality.</p>
9324: </div>
1.41 asau 9325: <div class="sect1">
1.20 snj 9326: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9327: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9328: <p>It is preferred that packages are not renamed or moved, but if needed
9329: please follow these steps.
9330: </p>
1.23 wiz 9331: <div class="orderedlist"><ol class="orderedlist" type="1">
9332: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9333: <li class="listitem">
1.1 dsieger 9334: <p>Remove all CVS dirs.</p>
9335: <p>Alternatively to the first two steps you can also do:</p>
9336: <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>
9337: <p>and use that for further work.</p>
9338: </li>
1.23 wiz 9339: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9340: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9341: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9342: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9343: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9344: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9345: for doing an update using pkgsrc building; for example, it can
1.79 snj 9346: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 9347: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9348: new <code class="varname">PKGPATH</code> for that moved package. Note that
9349: it may have multiple matches, so the tool should also check on the
9350: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9351: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9352: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9353: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9354: place.</p></li>
1.23 wiz 9355: <li class="listitem">
1.1 dsieger 9356: <p>Check if any package depends on it:
9357: </p>
9358: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9359: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9360: </li>
1.23 wiz 9361: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9362: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9363: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9364: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9365: <li class="listitem">
1.1 dsieger 9366: <p>Commit the changed and removed files:</p>
9367: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9368: <p>(and any packages from step 5, of course).</p>
9369: </li>
9370: </ol></div>
9371: </div>
9372: </div>
1.41 asau 9373: <div class="chapter">
1.1 dsieger 9374: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9375: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9376: <p>This section contains the answers to questions that may
9377: arise when you are writing a package. If you don't find your
9378: question answered here, first have a look in the other chapters,
9379: and if you still don't have the answer, ask on the
9380: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9381: <div class="qandaset">
1.110 ! wiz 9382: <a name="idm79349520"></a><dl>
1.6 rillig 9383: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9384: MAKEFLAGS, .MAKEFLAGS and
9385: MAKE_FLAGS?</a>
9386: </dt>
1.6 rillig 9387: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9388: MAKE, GMAKE and
9389: MAKE_PROGRAM?</a>
9390: </dt>
1.6 rillig 9391: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9392: CC, PKG_CC and
9393: PKGSRC_COMPILER?</a>
9394: </dt>
1.6 rillig 9395: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9396: BUILDLINK_LDFLAGS,
9397: BUILDLINK_LDADD and
9398: BUILDLINK_LIBS?</a>
9399: </dt>
1.6 rillig 9400: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9401: VARNAME=BUILDLINK_PREFIX.foo
9402: say it's empty?</a>
9403: </dt>
1.6 rillig 9404: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9405: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9406: don't understand the := inside
9407: it.</a>
9408: </dt>
1.6 rillig 9409: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9410: developers?</a>
9411: </dt>
1.6 rillig 9412: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9413: documentation?</a>
9414: </dt>
1.6 rillig 9415: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9416: do?</a>
9417: </dt>
9418: </dl>
1.41 asau 9419: <table border="0" style="width: 100%;">
9420: <colgroup>
1.1 dsieger 9421: <col align="left" width="1%">
1.23 wiz 9422: <col>
1.41 asau 9423: </colgroup>
1.1 dsieger 9424: <tbody>
1.41 asau 9425: <tr class="question">
1.1 dsieger 9426: <td align="left" valign="top">
1.110 ! wiz 9427: <a name="devfaq.makeflags"></a><a name="idm79349008"></a><p><b>22.1.</b></p>
1.1 dsieger 9428: </td>
9429: <td align="left" valign="top"><p>What is the difference between
9430: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9431: <code class="varname">MAKE_FLAGS</code>?</p></td>
9432: </tr>
9433: <tr class="answer">
9434: <td align="left" valign="top"></td>
9435: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.79 snj 9436: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 9437: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9438: the <code class="varname">MAKE_PROGRAM</code> when building the
9439: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9440: </tr>
1.41 asau 9441: <tr class="question">
1.1 dsieger 9442: <td align="left" valign="top">
1.110 ! wiz 9443: <a name="devfaq.make"></a><a name="idm79345040"></a><p><b>22.2.</b></p>
1.1 dsieger 9444: </td>
9445: <td align="left" valign="top"><p>What is the difference between
9446: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9447: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9448: </tr>
9449: <tr class="answer">
9450: <td align="left" valign="top"></td>
9451: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.79 snj 9452: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 9453: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9454: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9455: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9456: Make program that is used for building the
9457: package.</p></td>
9458: </tr>
1.41 asau 9459: <tr class="question">
1.1 dsieger 9460: <td align="left" valign="top">
1.110 ! wiz 9461: <a name="devfaq.cc"></a><a name="idm79340560"></a><p><b>22.3.</b></p>
1.1 dsieger 9462: </td>
9463: <td align="left" valign="top"><p>What is the difference between
9464: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9465: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9466: </tr>
9467: <tr class="answer">
9468: <td align="left" valign="top"></td>
9469: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9470: compiler, which can be configured by the pkgsrc user.
9471: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9472: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9473: path to a compiler, but the type of compiler that should be
9474: used. See <code class="filename">mk/compiler.mk</code> for more
9475: information about the latter variable.</p></td>
9476: </tr>
1.41 asau 9477: <tr class="question">
1.1 dsieger 9478: <td align="left" valign="top">
1.110 ! wiz 9479: <a name="devfaq.bl3flags"></a><a name="idm79336464"></a><p><b>22.4.</b></p>
1.1 dsieger 9480: </td>
9481: <td align="left" valign="top"><p>What is the difference between
9482: <code class="varname">BUILDLINK_LDFLAGS</code>,
9483: <code class="varname">BUILDLINK_LDADD</code> and
9484: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9485: </tr>
9486: <tr class="answer">
9487: <td align="left" valign="top"></td>
9488: <td align="left" valign="top"><p>[FIXME]</p></td>
9489: </tr>
1.41 asau 9490: <tr class="question">
1.1 dsieger 9491: <td align="left" valign="top">
1.110 ! wiz 9492: <a name="devfaq.bl3prefix"></a><a name="idm79334288"></a><p><b>22.5.</b></p>
1.1 dsieger 9493: </td>
1.10 hubertf 9494: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9495: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9496: say it's empty?</p></td>
9497: </tr>
9498: <tr class="answer">
9499: <td align="left" valign="top"></td>
9500: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9501: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9502: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9503: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9504: command.</p></td>
9505: </tr>
1.41 asau 9506: <tr class="question">
1.1 dsieger 9507: <td align="left" valign="top">
1.110 ! wiz 9508: <a name="devfaq.master_sites"></a><a name="idm79331088"></a><p><b>22.6.</b></p>
1.1 dsieger 9509: </td>
9510: <td align="left" valign="top"><p>What does
1.108 rillig 9511: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9512: don't understand the <code class="code">:=</code> inside
1.1 dsieger 9513: it.</p></td>
9514: </tr>
9515: <tr class="answer">
9516: <td align="left" valign="top"></td>
1.108 rillig 9517: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
9518: assignment operator, although it looks like it.
1.1 dsieger 9519: Instead, it is a degenerate form of
1.108 rillig 9520: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9521: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
9522: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 9523: case of <code class="varname">MASTER_SITE_*</code>,
9524: <em class="replaceable"><code>old_string</code></em> is the empty string and
9525: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 9526: <code class="code">package/</code>. That's where the
9527: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 9528: together.</p></td>
9529: </tr>
1.41 asau 9530: <tr class="question">
1.1 dsieger 9531: <td align="left" valign="top">
1.110 ! wiz 9532: <a name="devfaq.mailinglists"></a><a name="idm79324176"></a><p><b>22.7.</b></p>
1.1 dsieger 9533: </td>
9534: <td align="left" valign="top"><p>Which mailing lists are there for package
9535: developers?</p></td>
9536: </tr>
9537: <tr class="answer">
9538: <td align="left" valign="top"></td>
1.41 asau 9539: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9540: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 9541: <dd><p>This is a list for technical discussions related
9542: to pkgsrc development, e.g. soliciting feedback for changes to
9543: pkgsrc infrastructure, proposed new features, questions related
9544: to porting pkgsrc to a new platform, advice for maintaining a
9545: package, patches that affect many packages, help requests moved
9546: from pkgsrc-users when an infrastructure bug is found,
9547: etc.</p></dd>
1.10 hubertf 9548: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 9549: <dd><p>All bug reports in category "pkg" sent with
1.79 snj 9550: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 9551: directly; use one of the other mailing
9552: lists.</p></dd>
9553: </dl></div></td>
9554: </tr>
1.41 asau 9555: <tr class="question">
1.1 dsieger 9556: <td align="left" valign="top">
1.110 ! wiz 9557: <a name="devfaq.documentation"></a><a name="idm79320464"></a><p><b>22.8.</b></p>
1.1 dsieger 9558: </td>
9559: <td align="left" valign="top"><p>Where is the pkgsrc
9560: documentation?</p></td>
9561: </tr>
9562: <tr class="answer">
9563: <td align="left" valign="top"></td>
9564: <td align="left" valign="top">
9565: <p>There are many places where you can find
9566: documentation about pkgsrc:</p>
1.41 asau 9567: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9568: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9569: of chapters that explain large parts of pkgsrc, but some
9570: chapters tend to be outdated. Which ones they are is hard to
9571: say.</p></li>
1.23 wiz 9572: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 9573: about certain features, announcements of new parts of the pkgsrc
9574: infrastructure and sometimes even announcements that a certain
9575: feature has been marked as obsolete. The benefit here is that
9576: each message has a date appended to it.</p></li>
1.23 wiz 9577: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9578: <code class="filename">mk/</code> directory start with a comment that
9579: describes the purpose of the file and how it can be used by the
9580: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9581: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9582: help</strong></span>.</p></li>
1.23 wiz 9583: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9584: information, but they tend to be highly abbreviated, especially
9585: for actions that occur often. Some contain a detailed
9586: description of what has changed, but they are geared towards the
9587: other pkgsrc developers, not towards an average pkgsrc user.
9588: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9589: don't know what has been before, these messages may not be worth
9590: too much to you.</p></li>
1.23 wiz 9591: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9592: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9593: mind of the developer who wrote the code. To get this
1.10 hubertf 9594: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9595: to see who has written it and ask on the
9596: <code class="literal">tech-pkg</code> mailing list, so that others can
9597: find your questions later (see above). To be sure that the
9598: developer in charge reads the mail, you may CC him or
9599: her.</p></li>
9600: </ul></div>
9601: </td>
9602: </tr>
1.41 asau 9603: <tr class="question">
1.1 dsieger 9604: <td align="left" valign="top">
1.110 ! wiz 9605: <a name="devfaq.too-much-time"></a><a name="idm79313936"></a><p><b>22.9.</b></p>
1.1 dsieger 9606: </td>
9607: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9608: do?</p></td>
9609: </tr>
9610: <tr class="answer">
9611: <td align="left" valign="top"></td>
9612: <td align="left" valign="top">
9613: <p>This is not really an FAQ yet, but here's the answer
9614: anyway.</p>
1.41 asau 9615: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9616: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.79 snj 9617: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.1 dsieger 9618: will tell you about newer versions of installed packages that are
9619: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9620: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9621: — it contains a list of suggested new packages and a list of
1.1 dsieger 9622: cleanups and enhancements for pkgsrc that would be nice to
9623: have.</p></li>
1.23 wiz 9624: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9625: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9626: mailing list.</p></li>
9627: </ul></div>
9628: </td>
9629: </tr>
9630: </tbody>
9631: </table>
9632: </div>
9633: </div>
1.41 asau 9634: <div class="chapter">
1.1 dsieger 9635: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9636: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9637: <div class="toc">
9638: <p><b>Table of Contents</b></p>
1.100 leot 9639: <dl class="toc">
1.6 rillig 9640: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9641: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9642: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9643: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9644: </dl>
9645: </div>
1.10 hubertf 9646: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9647: site</a>:</p>
9648: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9649: environment, an intuitive and attractive desktop for users, and the
9650: GNOME development platform, an extensive framework for building
9651: applications that integrate into the rest of the desktop.</p></blockquote></div>
9652: <p>pkgsrc provides a seamless way to automatically build and install
9653: a complete GNOME environment <span class="emphasis"><em>under many different
9654: platforms</em></span>. We can say with confidence that pkgsrc is one of
9655: the most advanced build and packaging systems for GNOME due to its
9656: included technologies buildlink3, the wrappers and tools framework and
9657: automatic configuration file management. Lots of efforts are put into
9658: achieving a completely clean deinstallation of installed software
9659: components.</p>
1.10 hubertf 9660: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9661: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9662: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9663: pkgsrc as its preferred packaging system, contributing lots of
9664: portability fixes to make GNOME build and install under it.</p>
9665: <p>This chapter is aimed at pkgsrc developers and other people
9666: interested in helping our GNOME porting and packaging efforts. It
9667: provides instructions on how to manage the existing packages and some
9668: important information regarding their internals.</p>
1.41 asau 9669: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9670: <h3 class="title">We need your help!</h3>
9671: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9672: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9673: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9674: work</a> list! There is still a long way to go to get a
9675: fully-functional GNOME desktop under NetBSD and we need your help to
9676: achieve it!</p>
9677: </div>
1.41 asau 9678: <div class="sect1">
1.1 dsieger 9679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9680: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9681: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9682: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 9683: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.1 dsieger 9684: the core GNOME desktop environment. It only includes the necessary
9685: bits to get it to boot correctly, although it may lack important
9686: functionality for daily operation. The idea behind this package is
9687: to let end users build their own configurations on top of this one,
9688: first installing this meta package to achieve a functional setup and
9689: then adding individual applications.</p></li>
1.79 snj 9690: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.1 dsieger 9691: complete installation of the GNOME platform and desktop as defined
9692: by the GNOME project; this is based on the components distributed in
9693: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9694: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9695: official FTP server. Developer-only tools found in those
9696: directories are not installed unless required by some other
9697: component to work properly. Similarly, packages from the bindings
9698: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9699: in unless required as a dependency for an end-user component. This
1.79 snj 9700: package "extends" <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
9701: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.1 dsieger 9702: Installs all the tools required to build a GNOME component when
9703: fetched from the CVS repository. These are required to let the
1.10 hubertf 9704: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9705: </ul></div>
9706: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9707: sorted in a way that eases updates: a package may depend on other
9708: packages listed before it but not on any listed after it. It is very
9709: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9710: change it to alphabetical sorting!</em></span></p>
9711: </div>
1.41 asau 9712: <div class="sect1">
1.1 dsieger 9713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9714: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9715: <p>Almost all GNOME applications are written in C and use a common
9716: set of tools as their build system. Things get different with the new
9717: bindings to other languages (such as Python), but the following will
9718: give you a general idea on the minimum required tools:</p>
1.41 asau 9719: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9720: <li class="listitem">
1.1 dsieger 9721: <p>Almost all GNOME applications use the GNU Autotools as their
9722: build system. As a general rule you will need to tell this to your
9723: package:</p>
9724: <pre class="programlisting">
9725: GNU_CONFIGURE=yes
9726: USE_LIBTOOL=yes
9727: USE_TOOLS+=gmake
9728: </pre>
9729: </li>
1.23 wiz 9730: <li class="listitem">
1.1 dsieger 9731: <p>If the package uses pkg-config to detect dependencies, add this
9732: tool to the list of required utilities:</p>
9733: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.79 snj 9734: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.1 dsieger 9735: the end of the build process to ensure that you did not miss to
9736: specify any dependency in your package and that the version
9737: requirements are all correct.</p>
9738: </li>
1.23 wiz 9739: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9740: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9741: to handle dependencies and to force the package to use the latest
9742: available version.</p></li>
1.23 wiz 9743: <li class="listitem">
1.1 dsieger 9744: <p>If the package uses gtk-doc (a documentation generation
9745: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9746: tool is rather big and the distfile should come with pregenerated
9747: documentation anyway; if it does not, it is a bug that you ought to
9748: report. For such packages you should disable gtk-doc (unless it is
9749: the default):</p>
9750: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9751: <p>The default location of installed HTML files
9752: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9753: and should not be changed unless the package insists on installing
9754: them somewhere else. Otherwise programs as
1.10 hubertf 9755: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9756: do that with an entry similar to:</p>
9757: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9758: </li>
9759: </ul></div>
9760: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9761: files under the installation prefix to maintain databases. In this
9762: context, shared means that those exact same directories and files are
9763: used among several different packages, leading to conflicts in the
9764: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9765: handle the most common cases, so you have to forget about using
9766: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9767: omitting shared files from them. If you find yourself doing those,
9768: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9769: <p>The following table lists the common situations that result in
9770: using shared directories or files. For each of them, the appropriate
9771: solution is given. After applying the solution be sure to
9772: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9773: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9774: <div class="table">
1.6 rillig 9775: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9776: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9777: <colgroup>
9778: <col>
9779: <col>
9780: </colgroup>
9781: <thead><tr>
9782: <th>If the package...</th>
9783: <th>Then...</th>
9784: </tr></thead>
9785: <tbody>
9786: <tr>
9787: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9788: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.1 dsieger 9789: </tr>
9790: <tr>
9791: <td>Installs icons under the
9792: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9793: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9794: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.1 dsieger 9795: </tr>
9796: <tr>
9797: <td>Installs files under
9798: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9799: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.1 dsieger 9800: </tr>
9801: <tr>
9802: <td>Installs <code class="filename">.desktop</code> files under
9803: <code class="filename">share/applications</code> and these include MIME
9804: information.</td>
1.10 hubertf 9805: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.1 dsieger 9806: </tr>
9807: </tbody>
9808: </table></div>
9809: </div>
9810: <br class="table-break">
9811: </div>
1.41 asau 9812: <div class="sect1">
1.1 dsieger 9813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9814: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9815: <p>When seeing GNOME as a whole, there are two kinds of
9816: updates:</p>
1.41 asau 9817: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9818: <dt><span class="term">Major update</span></dt>
9819: <dd>
9820: <p>Given that there is still a very long way for GNOME 3 (if it
9821: ever appears), we consider a major update one that goes from a
9822: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9823: where <code class="literal">Y</code> is even and greater than
9824: <code class="literal">X</code>. These are hard to achieve because they
9825: introduce lots of changes in the components' code and almost all
9826: GNOME distfiles are updated to newer versions. Some of them can
9827: even break API and ABI compatibility with the previous major
9828: version series. As a result, the update needs to be done all at
9829: once to minimize breakage.</p>
9830: <p>A major update typically consists of around 80 package
9831: updates and the addition of some new ones.</p>
9832: </dd>
9833: <dt><span class="term">Minor update</span></dt>
9834: <dd>
9835: <p>We consider a minor update one that goes from a
9836: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9837: one where <code class="literal">Y</code> is greater than
9838: <code class="literal">X</code>. These are easy to achieve because they do
9839: not update all GNOME components, can be done in an incremental way
9840: and do not break API nor ABI compatibility.</p>
9841: <p>A minor update typically consists of around 50 package
9842: updates, although the numbers here may vary a lot.</p>
9843: </dd>
9844: </dl></div>
9845: <p>In order to update the GNOME components in pkgsrc to a new stable
9846: release (either major or minor), the following steps should be
9847: followed:</p>
1.23 wiz 9848: <div class="orderedlist"><ol class="orderedlist" type="1">
9849: <li class="listitem">
1.1 dsieger 9850: <p>Get a list of all the tarballs that form the new release by
9851: using the following commands. These will leave the full list of the
1.18 snj 9852: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9853: file:</p>
9854: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9855: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9856: awk '{ print $9 }' >list.txt</code></strong>
9857: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9858: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9859: awk '{ print $9 }' >>list.txt</code></strong></pre>
9860: </li>
1.23 wiz 9861: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9862: bump their version to the release you are updating them to. The
9863: three meta packages should be always consistent with versioning.
9864: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9865: in them.</p></li>
1.23 wiz 9866: <li class="listitem">
1.1 dsieger 9867: <p>For each meta package, update all its
9868: <code class="varname">DEPENDS</code> lines to match the latest versions as
9869: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9870: newer version (even if found in the FTP) because the meta packages
9871: are supposed to list the exact versions that form a specific GNOME
9872: release. Exceptions are permitted here if a newer version solves a
9873: serious issue in the overall desktop experience; these typically
9874: come in the form of a revision bump in pkgsrc, not in newer versions
9875: from the developers.</p>
9876: <p>Packages not listed in the <code class="filename">list.txt</code> file
9877: should be updated to the latest version available (if found in
9878: pkgsrc). This is the case, for example, of the dependencies on the
1.79 snj 9879: GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.1 dsieger 9880: </li>
1.23 wiz 9881: <li class="listitem">
1.1 dsieger 9882: <p>Generate a patch from the modified meta packages and extract the
9883: list of "new" lines. This will provide you an outline on what
9884: packages need to be updated in pkgsrc and in what order:</p>
9885: <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>
9886: </li>
1.23 wiz 9887: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9888: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9889: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9890: of <code class="filename">todo.txt</code> and update the packages listed in
9891: it in order. For major desktop updates none of these should be
9892: committed until the entire set is completed because there are chances
9893: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9894: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9895: the tree one by one with appropriate log messages. At the end,
9896: commit the three meta package updates and all the corresponding
9897: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9898: <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>
9899: </ol></div>
9900: </div>
1.41 asau 9901: <div class="sect1">
1.1 dsieger 9902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9903: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9904: <p>GNOME is a very big component in pkgsrc which approaches 100
9905: packages. Please, it is very important that you always, always,
9906: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9907: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.1 dsieger 9908: their attention on portability issues and to ensure that future versions
9909: can be built out-of-the box on NetBSD. The less custom patches in
9910: pkgsrc, the easier further updates are. Those developers in charge of
9911: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9912: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1 dsieger 9913: Bugzilla</a>. Not all components use these to track bugs, but most
9914: of them do. Do not be short on your reports: always provide detailed
9915: explanations of the current failure, how it can be improved to achieve
9916: maximum portability and, if at all possible, provide a patch against CVS
9917: head. The more verbose you are, the higher chances of your patch being
9918: accepted.</p>
9919: <p>Also, please avoid using preprocessor magic to fix portability
9920: issues. While the FreeBSD GNOME people are doing a great job in porting
9921: GNOME to their operating system, the official GNOME sources are now
9922: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9923: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 9924: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 9925: details.</p>
9926: </div>
9927: </div>
9928: </div>
1.41 asau 9929: <div class="part">
1.1 dsieger 9930: <div class="titlepage"><div><div><h1 class="title">
9931: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9932: <div class="partintro">
1.1 dsieger 9933: <div></div>
9934: <p>This part of the guide deals with everything
9935: from the infrastructure that is behind the interfaces described
9936: in the developer's guide. A casual package maintainer should not
9937: need anything from this part.</p>
9938: <div class="toc">
9939: <p><b>Table of Contents</b></p>
1.100 leot 9940: <dl class="toc">
1.6 rillig 9941: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9942: <dd><dl>
1.6 rillig 9943: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9944: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9945: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9946: <dd><dl>
1.6 rillig 9947: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9948: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9949: </dl></dd>
1.6 rillig 9950: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9951: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9952: <dd><dl>
1.6 rillig 9953: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9954: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 9955: </dl></dd>
1.6 rillig 9956: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9957: <dd><dl>
1.23 wiz 9958: <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>
9959: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 9960: </dl></dd>
9961: </dl></dd>
1.6 rillig 9962: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 9963: <dd><dl>
1.108 rillig 9964: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9965: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9966: <dd><dl>
1.108 rillig 9967: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9968: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9969: </dl></dd>
9970: </dl></dd>
1.6 rillig 9971: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 9972: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 9973: </dl>
9974: </div>
9975: </div>
1.41 asau 9976: <div class="chapter">
1.1 dsieger 9977: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9978: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9979: <div class="toc">
9980: <p><b>Table of Contents</b></p>
1.100 leot 9981: <dl class="toc">
1.6 rillig 9982: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9983: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9984: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9985: <dd><dl>
1.6 rillig 9986: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9987: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9988: </dl></dd>
1.6 rillig 9989: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9990: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9991: <dd><dl>
1.6 rillig 9992: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9993: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 9994: </dl></dd>
1.6 rillig 9995: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9996: <dd><dl>
1.23 wiz 9997: <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>
9998: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 9999: </dl></dd>
10000: </dl>
10001: </div>
10002: <p>The pkgsrc infrastructure consists of many small Makefile
10003: fragments. Each such fragment needs a properly specified
10004: interface. This chapter explains how such an interface looks
10005: like.</p>
1.41 asau 10006: <div class="sect1">
1.1 dsieger 10007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10008: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10009: <p>Whenever a variable is defined in the pkgsrc
10010: infrastructure, the location and the way of definition provide
10011: much information about the intended use of that variable.
10012: Additionally, more documentation may be found in a header
10013: comment or in this pkgsrc guide.</p>
10014: <p>A special file is
10015: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10016: variables that are intended to be user-defined. They are either
10017: defined using the <code class="literal">?=</code> operator or they are
10018: left undefined because defining them to anything would
1.23 wiz 10019: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10020: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10021: file.</p>
10022: <p>Outside this file, the following conventions apply:
10023: Variables that are defined using the <code class="literal">?=</code>
10024: operator may be overridden by a package.</p>
10025: <p>Variables that are defined using the <code class="literal">=</code>
10026: operator may be used read-only at run-time.</p>
10027: <p>Variables whose name starts with an underscore must not be
10028: accessed outside the pkgsrc infrastructure at all. They may
10029: change without further notice.</p>
1.41 asau 10030: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10031: <h3 class="title">Note</h3>
10032: <p>These conventions are currently not applied
10033: consistently to the complete pkgsrc
10034: infrastructure.</p>
10035: </div>
10036: </div>
1.41 asau 10037: <div class="sect1">
1.1 dsieger 10038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10039: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10040: <p>All variables that contain lists of things should default
10041: to being empty. Two examples that do not follow this rule are
10042: <code class="varname">USE_LANGUAGES</code> and
10043: <code class="varname">DISTFILES</code>. These variables cannot simply be
10044: modified using the <code class="literal">+=</code> operator in package
10045: <code class="filename">Makefile</code>s (or other files included by
10046: them), since there is no guarantee whether the variable is
10047: already set or not, and what its value is. In the case of
1.23 wiz 10048: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10049: the default value and just define it as in the following
10050: example.</p>
10051: <pre class="programlisting">
10052: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10053: </pre>
10054: <p>Because of the selection of this default value, the same
10055: value appears in many package Makefiles. Similarly for
10056: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10057: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10058: doesn't stand out. Nevertheless it is mentioned in many
10059: files.</p>
10060: </div>
1.41 asau 10061: <div class="sect1">
1.1 dsieger 10062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10063: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 10064: <div class="sect2">
1.1 dsieger 10065: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10066: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10067: <p>Variable evaluation takes place either at load time or at
10068: runtime, depending on the context in which they occur. The
10069: contexts where variables are evaluated at load time are:</p>
1.41 asau 10070: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10071: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10072: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10073: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10074: <code class="literal">.for</code>,</p></li>
1.23 wiz 10075: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10076: </ul></div>
10077: <p>A special exception are references to the iteration
10078: variables of <code class="literal">.for</code> loops, which are expanded
10079: inline, no matter in which context they appear.</p>
10080: <p>As the values of variables may change during load time,
10081: care must be taken not to evaluate them by accident. Typical
10082: examples for variables that should not be evaluated at load time
10083: are <code class="varname">DEPENDS</code> and
10084: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10085: clear, here is an example:</p>
10086: <pre class="programlisting">
10087: CONFIGURE_ARGS= # none
10088: CFLAGS= -O
10089: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10090:
10091: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10092:
10093: CFLAGS+= -Wall
10094: </pre>
10095: <p>This code shows how the use of the <code class="literal">:=</code>
10096: operator can quickly lead to unexpected results. The first
10097: paragraph is fairly common code. The second paragraph evaluates
10098: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10099: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10100: <code class="literal">-Wall</code> is appended to the
10101: <code class="varname">CFLAGS</code>, but this addition will not appear in
10102: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10103: paragraphs from above typically occur in completely unrelated
10104: files.</p>
10105: </div>
1.41 asau 10106: <div class="sect2">
1.1 dsieger 10107: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10108: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10109: <p>After all the files have been loaded, the values of the
10110: variables cannot be changed anymore. Variables that are used in
10111: the shell commands are expanded at this point.</p>
10112: </div>
10113: </div>
1.41 asau 10114: <div class="sect1">
1.1 dsieger 10115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10116: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10117: <p>There are many ways in which the definition and use of a
1.108 rillig 10118: variable can be restricted in order to detect bugs and violations
10119: of the (mostly unwritten) policies. A package can be checked with
10120: <code class="literal">pkglint -Wall</code> to see whether it meets these
10121: rules.</p>
1.1 dsieger 10122: </div>
1.41 asau 10123: <div class="sect1">
1.1 dsieger 10124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10125: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10126: <p>Most of the <code class="filename">.mk</code> files fall into one
10127: of the following classes. Cases where a file falls into more
10128: than one class should be avoided as it often leads to subtle
10129: bugs.</p>
1.41 asau 10130: <div class="sect2">
1.1 dsieger 10131: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10132: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10133: <p>In a traditional imperative programming language some of
10134: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10135: procedures. They take some input parameters and—after
10136: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10137: variables in <code class="filename">Makefile</code>s have global scope
10138: care must be taken not to use parameter names that have already
10139: another meaning. For example, <code class="varname">PKGNAME</code> is a
10140: bad choice for a parameter name.</p>
10141: <p>Procedures are completely evaluated at preprocessing time.
10142: That is, when calling a procedure all input parameters must be
10143: completely resolvable. For example,
10144: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10145: parameter since it is very likely that further text will be
10146: added after calling the procedure, which would effectively apply
10147: the procedure to only a part of the variable. Also, references
1.108 rillig 10148: to other variables will be modified after calling the
1.1 dsieger 10149: procedure.</p>
10150: <p>A procedure can declare its output parameters either as
10151: suitable for use in preprocessing directives or as only
10152: available at runtime. The latter alternative is for variables
10153: that contain references to other runtime variables.</p>
10154: <p>Procedures shall be written such that it is possible to
10155: call the procedure more than once. That is, the file must not
10156: contain multiple-inclusion guards.</p>
10157: <p>Examples for procedures are
10158: <code class="filename">mk/bsd.options.mk</code> and
10159: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10160: that the parameters are evaluated at load time, they should be
10161: assigned using the <code class="literal">:=</code> operator, which should
10162: be used only for this purpose.</p>
10163: </div>
1.41 asau 10164: <div class="sect2">
1.1 dsieger 10165: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10166: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10167: <p>Action files take some input parameters and may define
10168: runtime variables. They shall not define loadtime variables.
10169: There are action files that are included implicitly by the
10170: pkgsrc infrastructure, while other must be included
10171: explicitly.</p>
10172: <p>An example for action files is
10173: <code class="filename">mk/subst.mk</code>.</p>
10174: </div>
10175: </div>
1.41 asau 10176: <div class="sect1">
1.1 dsieger 10177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10178: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10179: <p>Package <code class="filename">Makefile</code>s usually consist of
10180: a set of variable definitions, and include the file
10181: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10182: Before that, they may also include various other
10183: <code class="filename">*.mk</code> files if they need to query the
10184: availability of certain features like the type of compiler or
10185: the X11 implementation. Due to the heavy use of preprocessor
10186: directives like <code class="literal">.if</code> and
10187: <code class="literal">.for</code>, the order in which the files are loaded
10188: matters.</p>
10189: <p>This section describes at which point the various files
10190: are loaded and gives reasons for that order.</p>
1.41 asau 10191: <div class="sect2">
1.1 dsieger 10192: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10193: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10194: </h3></div></div></div>
10195: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10196: is to define some essential variables like
10197: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10198: <code class="varname">MACHINE_ARCH</code>.</p>
10199: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10200: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 10201: After that, those variables
1.1 dsieger 10202: that have not been overridden by the user are loaded from
10203: <code class="filename">mk/defaults/mk.conf</code>.</p>
10204: <p>After the user settings, the system settings and platform
10205: settings are loaded, which may override the user
10206: settings.</p>
10207: <p>Then, the tool definitions are loaded. The tool wrappers
10208: are not yet in effect. This only happens when building a
10209: package, so the proper variables must be used instead of the
10210: direct tool names.</p>
10211: <p>As the last steps, some essential variables from the
10212: wrapper and the package system flavor are loaded, as well as the
10213: variables that have been cached in earlier phases of a package
10214: build.</p>
10215: </div>
1.41 asau 10216: <div class="sect2">
1.1 dsieger 10217: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10218: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10219: </h3></div></div></div>
10220: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10221: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10222: loaded, which fill default values for those variables that have
10223: not been defined by the package. These variables may later
10224: be used even in unrelated files.</p>
10225: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10226: provides the target <code class="literal">error-check</code> that is added
10227: as a special dependency to all other targets that use
10228: <code class="varname">DELAYED_ERROR_MSG</code> or
10229: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10230: <p>Then, the package-specific hacks from
10231: <code class="filename">hacks.mk</code> are included.</p>
10232: <p>Then, various other files follow. Most of them don't have
10233: any dependencies on what they need to have included before or
10234: after them, though some do.</p>
10235: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10236: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10237: restricts the use of these variables to all the files that have
10238: been included before. Appearances in later files will be
10239: silently ignored.</p>
10240: <p>Then, the files for the main targets are included, in the
10241: order of later execution, though the actual order should not
10242: matter.</p>
10243: <p>At last, some more files are included that don't set any
10244: interesting variables but rather just define make targets to be
10245: executed.</p>
10246: </div>
10247: </div>
10248: </div>
1.41 asau 10249: <div class="chapter">
1.1 dsieger 10250: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10251: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10252: <div class="toc">
10253: <p><b>Table of Contents</b></p>
1.100 leot 10254: <dl class="toc">
1.108 rillig 10255: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
10256: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10257: <dd><dl>
1.108 rillig 10258: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
10259: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 10260: </dl></dd>
10261: </dl>
10262: </div>
10263: <p>The pkgsrc infrastructure consists of a large codebase,
10264: and there are many corners where every little bit of a file is
10265: well thought out, making pkgsrc likely to fail as soon as
10266: anything is changed near those parts. To prevent most changes
10267: from breaking anything, a suite of regression tests should go
10268: along with every important part of the pkgsrc infrastructure.
10269: This chapter describes how regression tests work in pkgsrc and
10270: how you can add new tests.</p>
1.41 asau 10271: <div class="sect1">
1.1 dsieger 10272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 10273: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.79 snj 10274: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10 hubertf 10275: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10276: can simply run that command, which will run all tests in the
10277: <code class="filename">regress</code> category.</p>
10278: </div>
1.41 asau 10279: <div class="sect1">
1.1 dsieger 10280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 10281: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10282: <p>Every directory in the <code class="filename">regress</code>
10283: category that contains a file called <code class="filename">spec</code>
10284: is considered a regression test. This file is a shell program
1.10 hubertf 10285: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10286: The following functions can be overridden to suit your
10287: needs.</p>
1.41 asau 10288: <div class="sect2">
1.1 dsieger 10289: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 10290: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
10291: <p>These functions do not take any parameters. Although they
10292: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
10293: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
10294: question</a> for details.</p>
1.41 asau 10295: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10296: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10297: <dd><p>This function prepares the environment for the
10298: test. By default it does nothing.</p></dd>
1.108 rillig 10299: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10300: <dd>
10301: <p>This function runs the actual test. By default,
1.1 dsieger 10302: it calls <code class="varname">TEST_MAKE</code> with the arguments
10303: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10304: error messages into the file
1.108 rillig 10305: <code class="varname">TEST_OUTFILE</code>.</p>
10306: <p>When defining this function, make sure that all output that
10307: needs to be checked is written to the correct output file.
10308: Example:</p>
10309: <pre class="programlisting">
10310: do_test() {
10311: echo "Example output"
10312: } 1>$TEST_OUTFILE 2>&1
10313: </pre>
10314: </dd>
10315: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10316: <dd>
10317: <p>This function is run after the test and is
1.1 dsieger 10318: typically used to compare the actual output from the one that is
10319: expected. It can make use of the various helper functions from
1.108 rillig 10320: the next section. Example:</p>
10321: <pre class="programlisting">
10322: check_result() {
10323: exit_status 0
10324: output_require "Example"
10325: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10326: output_prohibit "no such file or directory"
10327: }
10328: </pre>
10329: </dd>
10330: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10331: <dd><p>This function cleans everything up after the
10332: test has been run. By default it does nothing.</p></dd>
10333: </dl></div>
10334: </div>
1.41 asau 10335: <div class="sect2">
1.1 dsieger 10336: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 10337: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.41 asau 10338: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10339: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10340: <dd><p>This function compares the exitcode of the
1.108 rillig 10341: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10342: If they differ, the test will fail.</p></dd>
1.108 rillig 10343: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10344: <dd>
10345: <p>This function checks for each of its parameters
10346: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10347: extended regular expression. If it does not, the test will
1.108 rillig 10348: fail. Example:</p>
10349: <pre class="programlisting">
10350: output_require "looks fine"
10351: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10352: </pre>
10353: </dd>
1.1 dsieger 10354: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10355: <dd><p>This function checks for each of its parameters
1.10 hubertf 10356: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10357: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10358: If any of the regular expressions matches, the test will
10359: fail.</p></dd>
10360: </dl></div>
10361: </div>
10362: </div>
10363: </div>
1.41 asau 10364: <div class="chapter">
1.1 dsieger 10365: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10366: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10367: <div class="toc">
10368: <p><b>Table of Contents</b></p>
1.108 rillig 10369: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.1 dsieger 10370: </div>
10371: <p>The pkgsrc system has already been ported to many
10372: operating systems, hardware architectures and compilers. This
10373: chapter explains the necessary steps to make pkgsrc even more
10374: portable.</p>
1.41 asau 10375: <div class="sect1">
1.1 dsieger 10376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10377: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10378: <p>To port pkgsrc to a new operating system (called
10379: <code class="literal">MyOS</code> in this example), you need to touch the
10380: following files:</p>
1.41 asau 10381: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10382: <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>
10383: <dd><p>This file contains some basic definitions, for
10384: example the name of the C
10385: compiler.</p></dd>
10386: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10387: <dd><p>Insert code that defines the variables
10388: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10389: <code class="varname">LOWER_OS_VERSION</code>,
10390: <code class="varname">LOWER_VENDOR</code>,
10391: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10392: <code class="varname">APPEND_ELF</code>, and the other variables that
10393: appear in this file.</p></dd>
10394: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10395: <dd><p>This file contains the platform-specific
10396: definitions that are used by pkgsrc. Start by copying one of the
10397: other files and edit it to your
10398: needs.</p></dd>
10399: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10400: <dd><p>This file defines the paths to all the tools
10401: that are needed by one or the other package in pkgsrc, as well
10402: as by pkgsrc itself. Find out where these tools are on your
10403: platform and add them.</p></dd>
10404: </dl></div>
10405: <p>Now, you should be able to build some basic packages, like
1.79 snj 10406: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1 dsieger 10407: </div>
10408: </div>
10409: </div>
1.41 asau 10410: <div class="appendix">
10411: <div class="titlepage"><div><div><h1 class="title">
10412: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10413: <div class="toc">
10414: <p><b>Table of Contents</b></p>
1.100 leot 10415: <dl class="toc">
1.1 dsieger 10416: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10417: <dd><dl>
10418: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10419: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10420: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10421: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 10422: </dl></dd>
10423: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10424: </dl>
10425: </div>
10426: <p>We checked to find a piece of software that wasn't in the packages
10427: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10428: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10429: present in the tree is beyond us, but it's useful for the purposes of
10430: this exercise.</p>
1.41 asau 10431: <div class="sect1">
1.1 dsieger 10432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10433: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10434: <div class="sect2">
1.1 dsieger 10435: <div class="titlepage"><div><div><h3 class="title">
10436: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10437: <pre class="programlisting">
10438: # $NetBSD$
10439: #
10440:
10441: DISTNAME= bison-1.25
10442: CATEGORIES= devel
10443: MASTER_SITES= ${MASTER_SITE_GNU}
10444:
1.29 dholland 10445: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10446: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10447: COMMENT= GNU yacc clone
10448:
10449: GNU_CONFIGURE= yes
1.46 wiz 10450: INFO_FILES= yes
1.1 dsieger 10451:
10452: .include "../../mk/bsd.pkg.mk"
10453: </pre>
10454: </div>
1.41 asau 10455: <div class="sect2">
1.1 dsieger 10456: <div class="titlepage"><div><div><h3 class="title">
10457: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10458: <pre class="programlisting">
10459: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.79 snj 10460: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10461: of the NetBSD source tree is beyond me.
10462: </pre>
10463: </div>
1.41 asau 10464: <div class="sect2">
1.1 dsieger 10465: <div class="titlepage"><div><div><h3 class="title">
10466: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10467: <pre class="programlisting">
10468: @comment $NetBSD$
10469: bin/bison
10470: man/man1/bison.1.gz
10471: share/bison.simple
10472: share/bison.hairy
10473: </pre>
10474: </div>
1.41 asau 10475: <div class="sect2">
1.1 dsieger 10476: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10477: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10478: </h3></div></div></div>
10479: <p>The NetBSD package system comes with
1.79 snj 10480: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 10481: which helps to check the contents of these
10482: files. After installation it is quite easy to use, just change to the
10483: directory of the package you wish to examine and execute
1.10 hubertf 10484: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10485: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10486: looks fine.</pre>
10487: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10488: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10489: -Wall</strong></span> for a very thorough check.</p>
10490: </div>
10491: </div>
1.41 asau 10492: <div class="sect1">
1.1 dsieger 10493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10494: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10495: <p>Create the directory where the package lives,
10496: plus any auxiliary directories:</p>
10497: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10498: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10499: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10500: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10501: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 10502: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 10503: then continue with fetching the distfile:</p>
10504: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10505: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10506: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10507: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10508: ftp: Error retrieving file: 500 Internal error
10509:
10510: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10511: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10512: ftp: Error retrieving file: 500 Internal error
10513:
10514: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10515: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10516: Successfully retrieved file.</pre>
10517: <p>Generate the checksum of the distfile into
10518: <code class="filename">distinfo</code>:</p>
10519: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10520: <p>Now compile:</p>
10521: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10522: >> Checksum OK for bison-1.25.tar.gz.
10523: ===> Extracting for bison-1.25
10524: ===> Patching for bison-1.25
10525: ===> Ignoring empty patch directory
10526: ===> Configuring for bison-1.25
10527: creating cache ./config.cache
10528: checking for gcc... cc
10529: checking whether we are using GNU C... yes
10530: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10531: checking how to run the C preprocessor... cc -E
10532: checking for minix/config.h... no
10533: checking for POSIXized ISC... no
10534: checking whether cross-compiling... no
10535: checking for ANSI C header files... yes
10536: checking for string.h... yes
10537: checking for stdlib.h... yes
10538: checking for memory.h... yes
10539: checking for working const... yes
10540: checking for working alloca.h... no
10541: checking for alloca... yes
10542: checking for strerror... yes
10543: updating cache ./config.cache
10544: creating ./config.status
10545: creating Makefile
10546: ===> Building for bison-1.25
10547: 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
10548: 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
10549: 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
10550: 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
10551: 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
10552: 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
10553: 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
10554: 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
10555: 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
10556: 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
10557: 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
10558: 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
10559: 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
10560: 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
10561: 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
10562: 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
10563: 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
10564: 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
10565: 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
10566: 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
10567: 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
10568: 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
10569: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10570: rm -f bison.s1
10571: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10572: <p>Everything seems OK, so install the files:</p>
10573: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10574: >> Checksum OK for bison-1.25.tar.gz.
10575: ===> Installing for bison-1.25
10576: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10577: rm -f /usr/pkg/bin/bison
10578: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10579: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10580: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10581: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10582: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10583: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10584: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10585: ===> Registering installation for bison-1.25</pre>
10586: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10587: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10588: binary package, do this now:</p>
10589: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10590: >> Checksum OK for bison-1.25.tar.gz.
10591: ===> Building package for bison-1.25
10592: Creating package bison-1.25.tgz
10593: Registering depends:.
10594: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10595: <p>Now that you don't need the source and object files
10596: any more, clean up:</p>
10597: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10598: ===> Cleaning for bison-1.25</pre>
10599: </div>
10600: </div>
1.41 asau 10601: <div class="appendix">
10602: <div class="titlepage"><div><div><h1 class="title">
10603: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10604: <div class="toc">
10605: <p><b>Table of Contents</b></p>
1.100 leot 10606: <dl class="toc">
1.1 dsieger 10607: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10608: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10609: </dl>
10610: </div>
1.41 asau 10611: <div class="sect1">
1.1 dsieger 10612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10613: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10614: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10615: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10616: => figlet221.tar.gz doesn't seem to exist on this system.
10617: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10618: => [172219 bytes]
10619: Connected to ftp.plig.net.
10620: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10621: 331 Guest login ok, send your complete e-mail address as password.
10622: 230-You are user #5 of 500 simultaneous users allowed.
10623: 230-
10624: 230- ___ _ _ _
10625: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10626: 230- | _| _| . |_| . | | | . |_| . | _| . |
10627: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10628: 230- |_| |_| |___| |___|
10629: 230-
10630: 230-** Welcome to ftp.plig.org **
10631: 230-
10632: 230-Please note that all transfers from this FTP site are logged. If you
10633: 230-do not like this, please disconnect now.
10634: 230-
1.18 snj 10635: 230-This archive is available via
1.1 dsieger 10636: 230-
10637: 230-HTTP: http://ftp.plig.org/
10638: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10639: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10640: 230-
10641: 230-Please email comments, bug reports and requests for packages to be
10642: 230-mirrored to ftp-admin@plig.org.
10643: 230-
10644: 230-
10645: 230 Logged in anonymously.
10646: Remote system type is UNIX.
10647: Using binary mode to transfer files.
10648: 200 Type okay.
10649: 250 "/pub" is new cwd.
10650: 250-"/pub/figlet" is new cwd.
10651: 250-
10652: 250-Welcome to the figlet archive at ftp.figlet.org
10653: 250-
10654: 250- ftp://ftp.figlet.org/pub/figlet/
10655: 250-
10656: 250-The official FIGlet web page is:
10657: 250- http://www.figlet.org/
10658: 250-
10659: 250-If you have questions, please mailto:info@figlet.org. If you want to
10660: 250-contribute a font or something else, you can email us.
10661: 250
10662: 250 "/pub/figlet/program" is new cwd.
10663: 250 "/pub/figlet/program/unix" is new cwd.
10664: local: figlet221.tar.gz remote: figlet221.tar.gz
10665: 502 Unimplemented command.
10666: 227 Entering Passive Mode (195,40,6,41,246,104)
10667: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10668: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10669: 226 Transfer completed.
10670: 172219 bytes received in 00:02 (75.99 KB/s)
10671: 221 Goodbye.
10672: => Checksum OK for figlet221.tar.gz.
10673: ===> Extracting for figlet-2.2.1nb2
10674: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10675: ===> Patching for figlet-2.2.1nb2
10676: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10677: ===> Overriding tools for figlet-2.2.1nb2
10678: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10679: ===> Configuring for figlet-2.2.1nb2
10680: ===> Building for figlet-2.2.1nb2
10681: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10682: chmod a+x figlet
10683: gcc -O2 -o chkfont chkfont.c
10684: => Unwrapping files-to-be-installed.
10685: <code class="prompt">#</code>
10686: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10687: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10688: ===> Installing for figlet-2.2.1nb2
10689: install -d -o root -g wheel -m 755 /usr/pkg/bin
10690: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10691: mkdir -p /usr/pkg/share/figlet
10692: cp figlet /usr/pkg/bin
10693: cp chkfont /usr/pkg/bin
10694: chmod 555 figlist showfigfonts
10695: cp figlist /usr/pkg/bin
10696: cp showfigfonts /usr/pkg/bin
10697: cp fonts/*.flf /usr/pkg/share/figlet
10698: cp fonts/*.flc /usr/pkg/share/figlet
10699: cp figlet.6 /usr/pkg/man/man6
10700: ===> Registering installation for figlet-2.2.1nb2
10701: <code class="prompt">#</code></pre>
10702: </div>
1.41 asau 10703: <div class="sect1">
1.1 dsieger 10704: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10705: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10706: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10707: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10708: ===> Packaging figlet-2.2.1nb2
10709: ===> Building binary package for figlet-2.2.1nb2
10710: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10711: Using SrcDir value of /usr/pkg
10712: Registering depends:.
10713: <code class="prompt">#</code></pre>
10714: </div>
10715: </div>
1.41 asau 10716: <div class="appendix">
10717: <div class="titlepage"><div><div><h1 class="title">
10718: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10719: <div class="toc">
10720: <p><b>Table of Contents</b></p>
1.100 leot 10721: <dl class="toc">
1.23 wiz 10722: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10723: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10724: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10725: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10726: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10727: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10728: source packages</a></span></dt>
10729: </dl>
10730: </div>
10731: <p>As in other big projects, the directory layout of pkgsrc
10732: is quite complex for newbies. This chapter explains where you
10733: find things on the FTP server. The base directory on
1.10 hubertf 10734: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1 dsieger 10735: On other servers it may be different, but inside this directory,
10736: everything should look the same, no matter on which server you
10737: are. This directory contains some subdirectories, which are
10738: explained below.</p>
1.41 asau 10739: <div class="sect1">
1.1 dsieger 10740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10741: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10742: <p>The directory <code class="filename">distfiles</code> contains lots
10743: of archive files from all pkgsrc packages, which are mirrored
10744: here. The subdirectories are called after their package names
10745: and are used when the distributed files have names that don't
10746: explicitly contain a version number or are otherwise too generic
10747: (for example <code class="filename">release.tar.gz</code>).</p>
10748: </div>
1.41 asau 10749: <div class="sect1">
1.1 dsieger 10750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10751: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10752: <p>This directory contains things that individual pkgsrc
10753: developers find worth publishing.</p>
10754: </div>
1.41 asau 10755: <div class="sect1">
1.1 dsieger 10756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10757: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10758: <p>This directory contains binary packages for the various
10759: platforms that are supported by pkgsrc.
10760: Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.41 asau 10761: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10762: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10763: operating system for which the packages have been built. The
1.10 hubertf 10764: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10765: command, so it may differ from the one you are used to
10766: hear.</p></li>
1.23 wiz 10767: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10768: architecture of the platform for which the packages have been
1.10 hubertf 10769: built. It also includes the <code class="varname">ABI</code> (Application
10770: Binary Interface) for platforms that have several of
10771: them.</p></li>
1.23 wiz 10772: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10773: the operating system. For version numbers that change often (for
10774: example NetBSD-current), the often-changing part should be
10775: replaced with an <code class="literal">x</code>, for example
10776: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10777: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10778: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10779: for a stable branch, or <code class="literal">head</code> for packages
10780: built from the HEAD branch. The latter should only be used when
10781: the packages are updated on a regular basis. Otherwise the date
10782: from checking out pkgsrc should be appended, for example
10783: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10784: </ul></div>
10785: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10786: can quickly click through the directories on the
10787: server and find the best binary packages for their machines. Since they
10788: usually know the operating system and the hardware architecture, OPSYS
10789: and ARCH are placed first. After these choices, they can select the
10790: best combination of OSVERSION and TAG together, since it is usually the
10791: case that packages stay compatible between different version of the
10792: operating system.</p>
10793: <p>In each of these directories, there is a
10794: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10795: <code class="filename">All</code> which contains all binary packages.
10796: Besides that, there are various category directories that
10797: contain symbolic links to the real binary packages.</p>
10798: </div>
1.41 asau 10799: <div class="sect1">
1.1 dsieger 10800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10801: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10802: <p>Here are the reports from bulk builds, for those who want
10803: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10804: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 10805: </div>
1.41 asau 10806: <div class="sect1">
1.8 rillig 10807: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10808: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10809: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10810: source packages</h2></div></div></div>
1.23 wiz 10811: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10812: that is the files that define how to create binary packages from
10813: source archives.</p>
10814: <p>The directory <code class="filename">pkgsrc</code> contains a
10815: snapshot of the CVS repository, which is updated regularly. The
10816: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10817: directory, ready to be downloaded as a whole.</p>
10818: <p>In the directories for the quarterly branches, there is an
10819: additional file called
1.22 jakllsch 10820: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.1 dsieger 10821: which contains the state of pkgsrc when it was branched.</p>
10822: </div>
10823: </div>
1.41 asau 10824: <div class="appendix">
10825: <div class="titlepage"><div><div><h1 class="title">
10826: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10827: <div class="toc">
10828: <p><b>Table of Contents</b></p>
1.100 leot 10829: <dl class="toc">
1.1 dsieger 10830: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10831: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10832: </dl>
10833: </div>
10834: <p>This section contains information on editing the pkgsrc
10835: guide itself.</p>
1.41 asau 10836: <div class="sect1">
1.1 dsieger 10837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10838: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10839: <p>The pkgsrc guide's source code is stored in
10840: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10841: are created from it:</p>
1.41 asau 10842: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10843: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10844: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10845: <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>
10846: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 10847: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10848: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 10849: PostScript version of the pkgsrc guide.</p></li>
10850: </ul></div>
10851: </div>
1.41 asau 10852: <div class="sect1">
1.1 dsieger 10853: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10854: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10855: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10856: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10857: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10858: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10859: documentation) installed. These are automatically installed when
1.79 snj 10860: you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41 asau 10861: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10862: right directory. All further steps will take place
10863: here.</p></li>
1.41 asau 10864: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10865: <code class="filename">files/</code>.</p></li>
1.41 asau 10866: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10867: guide for valid XML and to build the final output files. If you
10868: get any errors at this stage, you can just edit the files, as
10869: there are only symbolic links in the working directory, pointing
10870: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10871: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10872: commit)</strong></span></p></li>
1.41 asau 10873: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10874: regenerate the output files with the proper RCS
10875: Ids.</p></li>
1.41 asau 10876: <li class="step">
1.10 hubertf 10877: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10878: commit the files in both <code class="filename">pkgsrc/doc</code> and
10879: <code class="filename">htdocs</code>.</p>
1.41 asau 10880: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10881: <h3 class="title">Note</h3>
10882: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10883: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10884: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10885: directory.</p>
10886: </div>
10887: </li>
10888: </ol></div>
10889: </div>
10890: </div>
10891: </div></body>
10892: </html>
CVSweb <webmaster@jp.NetBSD.org>