Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.112
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: </dl></dd>
82: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
83: <dd><dl>
84: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
85: <dd><dl>
86: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
88: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
90: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
91: <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>
92: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
93: </dl></dd>
94: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
97: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
98: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
99: </dl></dd>
100: </dl></dd>
101: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
102: <dd><dl>
103: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
104: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 105: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 106: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 107: <dd><dl>
1.4 rillig 108: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 109: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
110: <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 111: </dl></dd>
1.4 rillig 112: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
113: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 114: </dl></dd>
115: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
116: <dd><dl>
117: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
118: <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 119: </dl></dd>
120: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
121: builds)</a></span></dt>
1.1 dsieger 122: <dd><dl>
1.71 wiz 123: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
124: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
125: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
126: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 127: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
128: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 129: </dl></dd>
130: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
131: <dd><dl>
1.23 wiz 132: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
133: <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 134: </dl></dd>
135: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
136: <dd><dl>
137: <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 138: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
139: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
140: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
141: <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>
142: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
143: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
144: <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>
145: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
146: <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 147: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 148: <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>
149: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
150: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
151: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
152: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
153: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
154: <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 155: </dl></dd>
156: </dl></dd>
157: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
158: <dd><dl>
1.6 rillig 159: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 160: <dd><dl>
1.6 rillig 161: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 162: <dd><dl>
1.6 rillig 163: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 164: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 165: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 166: </dl></dd>
1.6 rillig 167: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
168: <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>
169: </dl></dd>
170: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
171: <dd><dl>
1.23 wiz 172: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
173: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 174: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 175: <dd><dl>
176: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
177: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
178: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
179: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
180: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
181: </dl></dd>
182: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
183: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
184: <dd><dl>
185: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
186: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
187: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
188: </dl></dd>
1.23 wiz 189: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
190: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 191: </dl></dd>
1.23 wiz 192: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 193: <dd><dl>
194: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 195: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 196: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
197: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
198: <dd><dl>
199: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 200: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
201: <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>
202: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 203: </dl></dd>
204: </dl></dd>
205: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
206: <dd><dl>
207: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 208: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
209: <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 210: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
211: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 212: <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 213: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 214: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
215: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 216: </dl></dd>
217: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
218: <dd><dl>
219: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 220: <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 221: <dd><dl>
222: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 223: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
224: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
225: and
226: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
227: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 228: </dl></dd>
1.23 wiz 229: <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 230: <dd><dl>
1.23 wiz 231: <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 232: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
233: </dl></dd>
234: </dl></dd>
235: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
236: <dd><dl>
237: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
238: <dd><dl>
239: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
240: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
241: </dl></dd>
242: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
243: <dd><dl>
1.23 wiz 244: <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 245: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
246: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
247: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
248: </dl></dd>
249: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
250: <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>
251: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
252: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
253: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
254: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
255: <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>
256: </dl></dd>
257: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
258: <dd><dl>
259: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 260: <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 261: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 262: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 263: </dl></dd>
264: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
265: <dd><dl>
266: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
267: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
268: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
269: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 270: <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 271: <dd><dl>
272: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
273: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
274: </dl></dd>
1.23 wiz 275: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
276: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
277: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
279: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
280: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
281: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
282: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
283: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
284: <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 285: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
286: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
287: </dl></dd>
288: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
291: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
292: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
293: </dl></dd>
294: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
295: <dd><dl>
296: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
297: <dd><dl>
1.108 rillig 298: <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>
299: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
300: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
301: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
302: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
303: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
304: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
305: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
306: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
307: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
308: <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 309: </dl></dd>
1.108 rillig 310: <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 311: <dd><dl>
312: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
313: <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 314: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 315: </dl></dd>
1.108 rillig 316: <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 317: <dd><dl>
318: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
319: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
320: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
321: </dl></dd>
322: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
323: <dd><dl>
324: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
325: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
326: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 327: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
328: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 329: </dl></dd>
1.108 rillig 330: <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 331: <dd><dl>
332: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
333: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 334: <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 335: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
336: </dl></dd>
1.108 rillig 337: <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 338: <dd><dl>
339: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
340: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
341: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
342: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
343: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
344: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
345: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
346: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 347: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 348: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 349: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
350: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
351: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
352: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
353: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
354: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
355: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
356: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 357: emulation</a></span></dt>
1.6 rillig 358: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
359: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 360: </dl></dd>
1.6 rillig 361: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 362: </dl></dd>
1.6 rillig 363: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
364: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 365: <dd><dl>
1.6 rillig 366: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
367: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
368: <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 369: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 370: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 371: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
372: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 373: </dl></dd>
374: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
375: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
376: <dd><dl>
377: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
378: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
379: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
380: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 381: </dl></dd>
382: </dl></dd>
383: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
384: <dd><dl>
1.6 rillig 385: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 386: <dd><dl>
1.6 rillig 387: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
388: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
389: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 390: <dd><dl>
1.6 rillig 391: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
392: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 393: </dl></dd>
1.6 rillig 394: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
395: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 396: <dd><dl>
1.6 rillig 397: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
398: <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 399: </dl></dd>
1.6 rillig 400: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 401: <dd><dl>
1.23 wiz 402: <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>
403: <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 404: </dl></dd>
405: </dl></dd>
1.6 rillig 406: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 407: <dd><dl>
1.108 rillig 408: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
409: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 410: <dd><dl>
1.108 rillig 411: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
412: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 413: </dl></dd>
414: </dl></dd>
1.6 rillig 415: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 416: <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 417: </dl></dd>
418: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
419: <dd><dl>
420: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
421: <dd><dl>
422: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
423: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
424: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 425: <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 426: </dl></dd>
427: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
428: </dl></dd>
429: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
430: <dd><dl>
431: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
432: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
433: </dl></dd>
434: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
435: <dd><dl>
1.23 wiz 436: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
437: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
438: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
439: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
440: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
441: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 442: source packages</a></span></dt>
443: </dl></dd>
444: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
445: <dd><dl>
446: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
447: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
448: </dl></dd>
449: </dl>
450: </div>
451: <div class="list-of-tables">
452: <p><b>List of Tables</b></p>
453: <dl>
454: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
455: </dt>
1.6 rillig 456: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 457: </dt>
1.6 rillig 458: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 459: </dt>
460: </dl>
461: </div>
1.41 asau 462: <div class="chapter">
463: <div class="titlepage"><div><div><h1 class="title">
464: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 465: <div class="toc">
466: <p><b>Table of Contents</b></p>
1.100 leot 467: <dl class="toc">
1.1 dsieger 468: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
469: <dd><dl>
470: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
471: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
472: </dl></dd>
473: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
474: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
475: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
476: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
477: </dl>
478: </div>
1.41 asau 479: <div class="sect1">
1.1 dsieger 480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
481: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
482: <p>There is a lot of software freely available for Unix-based
483: systems, which is usually available in form of the source code. Before
484: such software can be used, it needs to be configured to the local
485: system, compiled and installed, and this is exactly what The NetBSD
486: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
487: to handle binary packages, so that not every user has to build the
488: packages for himself, which is a time-costly task.</p>
489: <p>pkgsrc currently contains several thousand packages,
490: including:</p>
1.41 asau 491: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.104 sevan 492: <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 493: web server</p></li>
1.79 snj 494: <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 495: web browser</p></li>
1.79 snj 496: <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 497: Desktop Environment</p></li>
1.102 ryoon 498: <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 499: Desktop Environment</p></li>
500: </ul></div>
1.108 rillig 501: <p>… just to name a few.</p>
1.1 dsieger 502: <p>pkgsrc has built-in support for handling varying dependencies,
503: such as pthreads and X11, and extended features such as IPv6 support on
504: a range of platforms.</p>
1.41 asau 505: <div class="sect2">
1.1 dsieger 506: <div class="titlepage"><div><div><h3 class="title">
507: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
508: <p>
509: pkgsrc provides the following key features:
510: </p>
1.41 asau 511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 512: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 513: and installation of binary packages. The source and latest
514: patches are retrieved from a master or mirror download site, checksum
515: verified, then built on your system. Support for binary-only
516: distributions is available for both native platforms and NetBSD
517: emulated platforms.</p></li>
1.23 wiz 518: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 519: including binaries, libraries, man pages and other
520: documentation.</p></li>
1.104 sevan 521: <li class="listitem"><p>Tracking of package dependencies automatically, including when
522: performing updates, to ensure required packages are installed. The
523: configuration files of various packages are handled automatically during
524: updates, so local changes are preserved.</p></li>
1.23 wiz 525: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 526: consists of highly portable code. This allows the greatest speed of
1.25 spz 527: development when porting to a new platform. This portability also
1.1 dsieger 528: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
529: platforms</em></span>.</p></li>
1.23 wiz 530: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 531: international encryption requirements and build-time options for a
532: large number of packages are all set in a simple, central
533: configuration file.</p></li>
1.23 wiz 534: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 535: freely available under a BSD license, so you may extend and adapt
536: pkgsrc to your needs. Support for local packages and patches is
537: available right out of the box, so you can configure it specifically
538: for your environment.</p></li>
539: </ul></div>
540: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 542: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 543: — That means, if a package contains bugs, it's better to find
1.1 dsieger 544: them and to complain about them rather than to just install the package
545: and hope that it works. There are numerous checks in pkgsrc that try to
1.79 snj 546: 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 547: of shell scripts), and post-installation checks (installed files,
548: references to shared libraries, script interpreters).</p></li>
1.23 wiz 549: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 550: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 551: pkgsrc has been ported to many operating systems. Care is taken that
552: packages behave the same on all platforms.</p></li>
553: </ul></div>
554: </div>
1.41 asau 555: <div class="sect2">
1.1 dsieger 556: <div class="titlepage"><div><div><h3 class="title">
557: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
558: <p>pkgsrc consists of both a source distribution and a binary
559: distribution for these operating systems. After retrieving the required
560: source or binaries, you can be up and running with pkgsrc in just
561: minutes!</p>
562: <p>pkgsrc was derived from FreeBSD's ports system, and
563: initially developed for NetBSD only. Since then, pkgsrc has
564: grown a lot, and now supports the following platforms:</p>
565: <div class="table">
566: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 567: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 568: <colgroup>
569: <col>
570: <col>
1.92 sevan 571: <col>
1.1 dsieger 572: </colgroup>
573: <thead><tr>
574: <th>Platform</th>
575: <th>Date Support Added</th>
1.92 sevan 576: <th>Notes</th>
1.1 dsieger 577: </tr></thead>
578: <tbody>
579: <tr>
1.10 hubertf 580: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 581: <td align="center">Aug 1997</td>
1.92 sevan 582: <td class="auto-generated"> </td>
1.1 dsieger 583: </tr>
584: <tr>
1.10 hubertf 585: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 586: <td align="center">Mar 1999</td>
1.93 sevan 587: <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 588: </tr>
589: <tr>
1.10 hubertf 590: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 591: <td align="center">Jun 1999</td>
1.93 sevan 592: <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 593: </tr>
594: <tr>
595: <td>
1.10 hubertf 596: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
597: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 598: </td>
599: <td align="center">Oct 2001</td>
1.93 sevan 600: <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 601: </tr>
602: <tr>
1.10 hubertf 603: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 604: <td align="center">Nov 2002</td>
1.93 sevan 605: <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 606: </tr>
607: <tr>
1.10 hubertf 608: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 609: <td align="center">Nov 2002</td>
1.93 sevan 610: <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 611: </tr>
612: <tr>
1.10 hubertf 613: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 614: <td align="center">Dec 2002</td>
1.92 sevan 615: <td>
1.93 sevan 616: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
617: <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 618: </td>
1.1 dsieger 619: </tr>
620: <tr>
621: <td>BSD/OS</td>
622: <td align="center">Dec 2003</td>
1.92 sevan 623: <td class="auto-generated"> </td>
1.1 dsieger 624: </tr>
625: <tr>
1.10 hubertf 626: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 627: <td align="center">Dec 2003</td>
1.93 sevan 628: <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 629: </tr>
630: <tr>
631: <td>
1.10 hubertf 632: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 633: (Microsoft Windows Services for Unix)
634: </td>
635: <td align="center">Mar 2004</td>
1.93 sevan 636: <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 637: </tr>
638: <tr>
1.10 hubertf 639: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 640: <td align="center">Oct 2004</td>
1.92 sevan 641: <td class="auto-generated"> </td>
1.1 dsieger 642: </tr>
643: <tr>
1.10 hubertf 644: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 645: <td align="center">Nov 2004</td>
1.93 sevan 646: <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 647: </tr>
648: <tr>
1.10 hubertf 649: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 650: <td align="center">Apr 2007</td>
1.93 sevan 651: <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 652: </tr>
1.23 wiz 653: <tr>
654: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
655: <td align="center">Sep 2010</td>
1.93 sevan 656: <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 657: </tr>
1.45 obache 658: <tr>
659: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 660: <td align="center">Jan 2011</td>
1.92 sevan 661: <td class="auto-generated"> </td>
1.45 obache 662: </tr>
663: <tr>
664: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
665: <td align="center">Nov 2011</td>
1.93 sevan 666: <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 667: </tr>
668: <tr>
669: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
670: <td align="center">Mar 2013</td>
1.93 sevan 671: <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 672: </tr>
1.58 ryoon 673: <tr>
674: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
675: <td align="center">Jul 2013</td>
1.93 sevan 676: <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 677: </tr>
1.104 sevan 678: <tr>
679: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
680: <td align="center">Jun 2014</td>
681: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
682: </tr>
1.1 dsieger 683: </tbody>
684: </table></div>
685: </div>
686: <br class="table-break">
687: </div>
688: </div>
1.41 asau 689: <div class="sect1">
1.1 dsieger 690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
691: <a name="overview"></a>1.2. Overview</h2></div></div></div>
692: <p>This document is divided into three parts. The first,
1.10 hubertf 693: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 694: describes how one can use one of the packages in the Package
695: Collection, either by installing a precompiled binary package,
696: or by building one's own copy using the NetBSD package system.
1.10 hubertf 697: 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 698: package so it can be easily built by other NetBSD users without
699: knowing about the package's building details. The third part,
1.10 hubertf 700: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 701: is intended for those who want to understand how pkgsrc is
702: implemented.</p>
703: <p>This document is available in various formats:
1.10 hubertf 704: <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 705: </div>
1.41 asau 706: <div class="sect1">
1.1 dsieger 707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
708: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 709: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
710: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 711: terminology used within this document.</p>
1.41 asau 712: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 713: <dt><span class="term">Package</span></dt>
714: <dd><p>A set of files and building instructions
715: that describe what's necessary
716: to build a certain piece of software using
717: pkgsrc. Packages are traditionally stored under
718: <code class="filename">/usr/pkgsrc</code>.</p></dd>
719: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 720: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 721: is part of the NetBSD operating system and can be bootstrapped
722: to run on non-NetBSD operating systems as well. It handles
723: building (compiling), installing, and removing of
724: packages.</p></dd>
725: <dt><span class="term">Distfile</span></dt>
726: <dd><p>This term describes the file or files that are
727: provided by the author of the piece of software to
728: distribute his work. All the changes necessary to build on
729: NetBSD are reflected in the corresponding package. Usually
730: the distfile is in the form of a compressed tar-archive,
731: but other types are possible, too. Distfiles are usually
732: stored below
733: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
734: <dt><span class="term">Port</span></dt>
735: <dd><p>This is the term used by FreeBSD and OpenBSD people
736: for what we call a package.
1.23 wiz 737: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 738: architecture.</p></dd>
739: <dt><span class="term">Precompiled/binary package</span></dt>
740: <dd>
741: <p>A set of binaries built with pkgsrc from a distfile
742: and stuffed together in a single <code class="filename">.tgz</code>
743: file so it can be installed on machines of the same
744: machine architecture without the need to
745: recompile. Packages are usually generated in
746: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 747: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 748: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 749: especially in the context of precompiled packages.</p>
750: </dd>
751: <dt><span class="term">Program</span></dt>
752: <dd><p>The piece of software to be installed which will be
753: constructed from all the files in the distfile by the
754: actions defined in the corresponding package.</p></dd>
755: </dl></div>
1.41 asau 756: <div class="sect2">
1.1 dsieger 757: <div class="titlepage"><div><div><h3 class="title">
758: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 759: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 760: <dt><span class="term">pkgsrc users</span></dt>
761: <dd>
762: <p>The
763: pkgsrc users are people who use the packages provided by pkgsrc.
764: Typically they are system administrators. The people using the
1.23 wiz 765: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
766: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 767: <p>There are two kinds of pkgsrc users: Some only want to
768: install pre-built binary packages. Others build the pkgsrc
769: packages from source, either for installing them directly or for
1.10 hubertf 770: 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 771: documentation.</p>
772: </dd>
773: <dt><span class="term">package maintainers</span></dt>
774: <dd><p>A
1.10 hubertf 775: 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 776: <dt><span class="term">infrastructure developers</span></dt>
777: <dd><p>These people are involved in all those files
778: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 779: 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 780: too.</p></dd>
781: </dl></div>
782: </div>
783: </div>
1.41 asau 784: <div class="sect1">
1.1 dsieger 785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
786: <a name="typography"></a>1.4. Typography</h2></div></div></div>
787: <p>When giving examples for commands, shell prompts are used to
788: show if the command should/can be issued as root, or if
1.23 wiz 789: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 790: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
791: shell prompt, assuming they use the C-shell or tcsh.</p>
792: </div>
793: </div>
1.41 asau 794: <div class="part">
1.1 dsieger 795: <div class="titlepage"><div><div><h1 class="title">
796: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
797: <div class="toc">
798: <p><b>Table of Contents</b></p>
1.100 leot 799: <dl class="toc">
1.1 dsieger 800: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
801: <dd><dl>
802: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
803: <dd><dl>
1.51 asau 804: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 805: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 806: </dl></dd>
807: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
808: <dd><dl>
809: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
810: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
811: </dl></dd>
812: </dl></dd>
813: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
814: <dd><dl>
815: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
816: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
817: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
818: </dl></dd>
819: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
820: <dd><dl>
821: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
824: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
825: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
826: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
827: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
828: <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>
829: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
830: </dl></dd>
831: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
832: <dd><dl>
833: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
834: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
835: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
836: </dl></dd>
837: </dl></dd>
838: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
839: <dd><dl>
840: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
841: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 842: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 843: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 844: <dd><dl>
1.4 rillig 845: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 846: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
847: <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 848: </dl></dd>
1.4 rillig 849: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
850: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 851: </dl></dd>
852: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
853: <dd><dl>
854: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
855: <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 856: </dl></dd>
857: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
858: builds)</a></span></dt>
1.1 dsieger 859: <dd><dl>
1.71 wiz 860: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
861: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
862: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
863: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 864: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
865: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 866: </dl></dd>
867: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
868: <dd><dl>
1.23 wiz 869: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
870: <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 871: </dl></dd>
872: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
873: <dd><dl>
874: <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 875: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
876: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
877: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
878: <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>
879: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
880: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
881: <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>
882: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
883: <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 884: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 885: <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>
886: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
887: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
888: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
889: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
890: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
891: <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 892: </dl></dd>
893: </dl>
894: </div>
1.41 asau 895: <div class="chapter">
1.1 dsieger 896: <div class="titlepage"><div><div><h2 class="title">
897: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
898: <div class="toc">
899: <p><b>Table of Contents</b></p>
1.100 leot 900: <dl class="toc">
1.1 dsieger 901: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
902: <dd><dl>
1.51 asau 903: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 904: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 905: </dl></dd>
906: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
907: <dd><dl>
908: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
909: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
910: </dl></dd>
911: </dl>
912: </div>
913: <p>Before you download and extract the files, you need to decide
914: where you want to extract them. When using pkgsrc as root user, pkgsrc
915: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
916: free to install the sources and binary packages wherever you want in
917: your filesystem, provided that the pathname does not contain white-space
918: or other characters that are interpreted specially by the shell and some
919: other programs. A safe bet is to use only letters, digits, underscores
920: and dashes.</p>
1.41 asau 921: <div class="sect1">
1.1 dsieger 922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
923: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
924: <p>Before you download any pkgsrc files, you should decide
925: whether you want the <span class="emphasis"><em>current</em></span> branch or the
926: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
927: quarterly basis from the current branch and only gets modified
928: for security updates. The names of the stable branches are built
929: from the year and the quarter, for example
1.78 snj 930: <code class="literal">2014Q3</code>.</p>
1.1 dsieger 931: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 932: want to download pkgsrc. You can get it as a tar file or via CVS.
933: Both ways are described here.</p>
1.51 asau 934: <p>Note that tar archive contains CVS working copy.
935: Thus you can switch to using CVS at any later time.</p>
1.41 asau 936: <div class="sect2">
1.1 dsieger 937: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 938: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 939: <p>The primary download location for all pkgsrc files is
1.51 asau 940: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
941: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
942: (it points to the same location).
943: There are a number of subdirectories for different purposes,
944: 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>
945: <p>The tar archive for the current branch is in the directory
946: <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 947: It is autogenerated daily.</p>
1.51 asau 948: <p>To save download time we provide bzip2- and
949: xz-compressed archives which are published at
950: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
951: and
952: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
953: respectively.
954: </p>
955: <p>You can fetch the same files using FTP.</p>
1.78 snj 956: <p>The tar file for the stable branch 2014Q3 is in the
957: 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 958: <p>To download a pkgsrc stable tarball, run:</p>
959: <pre class="screen">
1.59 jnemeth 960: <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 961: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 962: stable branch to be downloaded, for example,
1.78 snj 963: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
964: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 965: or your web browser.</p>
1.12 weinem 966: <p>Then, extract it with:</p>
1.78 snj 967: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 968: <p>This will create the directory <code class="filename">pkgsrc/</code>
969: in <code class="filename">/usr/</code> and all the package source will be
970: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
971: <p>To download pkgsrc-current, run:</p>
972: <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 973: </div>
1.41 asau 974: <div class="sect2">
1.1 dsieger 975: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 976: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
977: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 978: <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 979: </pre>
980: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.78 snj 981: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.23 wiz 982: <p>This will create the directory <code class="filename">pkgsrc/</code>
983: in your <code class="filename">/usr/</code> directory and all the package source
984: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
985: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 986: <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 987: </pre>
1.78 snj 988: <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 989: <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 990: <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 991: </pre>
992: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
993: For Bourne shells, you can set it in your <code class="filename">.profile</code>
994: or better globally in <code class="filename">/etc/profile</code>:</p>
995: <pre class="programlisting">
996: # set CVS remote shell command
997: CVS_RSH=ssh
998: export CVS_RSH
999: </pre>
1000: <p>By default, CVS doesn't do things like most people would expect it to do.
1001: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1002: in your home directory and saving the following lines to it.
1003: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1004: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1005: <pre class="programlisting">
1006: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1007: cvs -q -z2
1.2 rillig 1008: checkout -P
1.4 rillig 1009: update -dP
1010: diff -upN
1.2 rillig 1011: rdiff -u
1.23 wiz 1012: release -d
1.2 rillig 1013: </pre>
1.1 dsieger 1014: </div>
1015: </div>
1.41 asau 1016: <div class="sect1">
1.1 dsieger 1017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1018: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1019: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1020: (which also works if you have first installed it via a tar
1021: file). It saves bandwidth and hard disk activity, compared to
1022: downloading the tar file again.</p>
1.41 asau 1023: <div class="sect2">
1.1 dsieger 1024: <div class="titlepage"><div><div><h3 class="title">
1025: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1026: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1027: <h3 class="title">Warning</h3>
1028: <p>When updating from a tar file, you first need to
1029: completely remove the old pkgsrc directory. Otherwise those
1030: files that have been removed from pkgsrc in the mean time will
1031: not be removed on your local disk, resulting in inconsistencies.
1032: When removing the old files, any changes that you have done to
1033: the pkgsrc files will be lost after updating. Therefore updating
1034: via CVS is strongly recommended.</p>
1035: </div>
1036: <p>Note that by default the distfiles and the binary packages
1037: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1038: before updating. You can also configure pkgsrc to store distfiles
1039: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1040: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1041: 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 1042: <p>To update pkgsrc from a tar file, download the tar file as
1043: explained above. Then, make sure that you have not made any
1044: changes to the files in the pkgsrc directory. Remove the pkgsrc
1045: directory and extract the new tar file. Done.</p>
1046: </div>
1.41 asau 1047: <div class="sect2">
1.1 dsieger 1048: <div class="titlepage"><div><div><h3 class="title">
1049: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1050: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1051: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1052: </pre>
1053: <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>
1054: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1055: </pre>
1.41 asau 1056: <div class="sect3">
1.1 dsieger 1057: <div class="titlepage"><div><div><h4 class="title">
1058: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1059: <p>When updating pkgsrc, the CVS program keeps track of the
1060: branch you selected. But if you, for whatever reason, want to
1061: switch from the stable branch to the current one, you can do it
1.23 wiz 1062: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1063: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1064: back to the stable branch, add the
1.78 snj 1065: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.1 dsieger 1066: </div>
1.41 asau 1067: <div class="sect3">
1.1 dsieger 1068: <div class="titlepage"><div><div><h4 class="title">
1069: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1070: <p>When you update pkgsrc, the CVS program will only touch
1071: those files that are registered in the CVS repository. That
1072: means that any packages that you created on your own will stay
1073: unmodified. If you change files that are managed by CVS, later
1074: updates will try to merge your changes with those that have been
1075: done by others. See the CVS manual, chapter
1.23 wiz 1076: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1077: </div>
1078: </div>
1079: </div>
1080: </div>
1.41 asau 1081: <div class="chapter">
1.1 dsieger 1082: <div class="titlepage"><div><div><h2 class="title">
1083: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1084: <div class="toc">
1085: <p><b>Table of Contents</b></p>
1.100 leot 1086: <dl class="toc">
1.1 dsieger 1087: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1088: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1089: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1090: </dl>
1091: </div>
1.41 asau 1092: <div class="sect1">
1.1 dsieger 1093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1094: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1095: <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 1096: </div>
1.41 asau 1097: <div class="sect1">
1.1 dsieger 1098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1099: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1100: <p>pkgsrc can be bootstrapped for use in two different modes:
1101: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1102: to privileged one all programs are installed under one particular user
1.43 asau 1103: and cannot utilise privileged operations (packages don't create
1104: special users and all special file permissions like setuid are ignored).
1105: </p>
1.1 dsieger 1106: <p>Installing the bootstrap kit from source should be as simple as:</p>
1107: <pre class="screen">
1.60 asau 1108: <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 1109: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1110: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1111: </pre>
1.43 asau 1112: <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>
1113: <p>By default, in privileged mode pkgsrc uses
1114: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1115: where programs will be installed in,
1.1 dsieger 1116: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1117: directory where pkgsrc will do its internal bookkeeping,
1118: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1119: where packages install their persistent data.
1120: In unprivileged mode pkgsrc uses
1121: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1122: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1123: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1124: </p>
1125: <p>You can change default layout using command-line arguments.
1126: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1127: </p>
1.41 asau 1128: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1129: <h3 class="title">Note</h3>
1.10 hubertf 1130: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1131: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1132: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1133: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1134: </div>
1.43 asau 1135: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1136: <h3 class="title">Note</h3>
1137: <p>It is possible to bootstrap multiple instances of pkgsrc
1138: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1139: corresponding to the installation you're working with to build
1140: and install packages.
1141: </p>
1142: </div>
1.1 dsieger 1143: </div>
1.41 asau 1144: <div class="sect1">
1.1 dsieger 1145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1146: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.111 sevan 1147: <p>For platform-specific notes consult the <code class="filename">README</code>
1148: files found in the notes column of <a class="xref" href="#supported-platforms" title="Table 1.1. Platforms supported by pkgsrc">Table 1.1, “Platforms supported by pkgsrc”</a></p>
1.1 dsieger 1149: </div>
1150: </div>
1.41 asau 1151: <div class="chapter">
1.1 dsieger 1152: <div class="titlepage"><div><div><h2 class="title">
1153: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1154: <div class="toc">
1155: <p><b>Table of Contents</b></p>
1.100 leot 1156: <dl class="toc">
1.1 dsieger 1157: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1158: <dd><dl>
1159: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1160: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1161: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1162: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1163: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1164: <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>
1165: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1166: </dl></dd>
1167: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1168: <dd><dl>
1169: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1170: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1171: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1172: </dl></dd>
1173: </dl>
1174: </div>
1175: <p>Basically, there are two ways of using pkgsrc. The first
1176: is to only install the package tools and to use binary packages
1.23 wiz 1177: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1178: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1179: of pkgsrc, too. Then you are able to build your own packages,
1180: and you can still use binary packages from someone else.</p>
1.41 asau 1181: <div class="sect1">
1.1 dsieger 1182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1183: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1184: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1185: server and its mirrors, there are collections of binary packages,
1186: ready to be installed. These binary packages have been built using the
1187: default settings for the directories, that is:</p>
1.41 asau 1188: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1189: <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>
1190: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1191: <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 1192: </ul></div>
1193: <p>If you cannot use these directories for whatever reasons (maybe
1194: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1195: 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 1196: <div class="sect2">
1.1 dsieger 1197: <div class="titlepage"><div><div><h3 class="title">
1198: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1199: <p>To install binary packages, you first need to know from where
1200: to get them. The first place where you should look is on the main
1.10 hubertf 1201: 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 1202: <p>This directory contains binary packages for multiple
1203: platforms. First, select your operating system. (Ignore the
1204: directories with version numbers attached to it, they just exist for
1205: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1206: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1207: <p>In this directory, you often find a file called
1208: <code class="filename">bootstrap.tar.gz</code> which contains the package
1209: management tools. If the file is missing, it is likely that your
1210: operating system already provides those tools. Download the file and
1211: extract it in the <code class="filename">/</code> directory. It will create
1212: the directories <code class="filename">/usr/pkg</code> (containing the tools
1213: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1214: (the database of installed packages).</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">
1218: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1219: <p>In the directory from the last section, there is a
1.85 wiz 1220: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1221: binary packages that are available for the platform, excluding those
1222: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1223: medium you are using).</p>
1.9 rillig 1224: <p>To install packages directly from an FTP or HTTP server, run
1225: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1226: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1227: <pre class="screen">
1228: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85 wiz 1229: <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 1230: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1231: </pre>
1232: <p>Instead of URLs, you can also use local paths, for example if
1233: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1234: repository. If you want to install packages from multiple sources,
1235: you can separate them by a semicolon in
1236: <code class="varname">PKG_PATH</code>.</p>
1237: <p>After these preparations, installing a package is very
1238: easy:</p>
1239: <pre class="screen">
1240: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1241: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1242: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1243: </pre>
1.1 dsieger 1244: <p>Note that any prerequisite packages needed to run the
1245: package in question will be installed, too, assuming they are
1246: present where you install from.</p>
1.23 wiz 1247: <p>Adding packages might install vulnerable packages.
1248: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1249: regularly, especially after installing new packages, and verify
1250: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1251: <p>After you've installed packages, be sure to have
1252: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1253: <code class="varname">PATH</code> so you can actually start the just
1254: installed program.</p>
1255: </div>
1.41 asau 1256: <div class="sect2">
1.1 dsieger 1257: <div class="titlepage"><div><div><h3 class="title">
1258: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1259: <p>To deinstall a package, it does not matter whether it was
1260: installed from source code or from a binary package. The
1.10 hubertf 1261: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1262: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1263: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1264: name can be given with or without version number. Wildcards can
1265: also be used to deinstall a set of packages, for example
1266: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1267: so that the shell does not expand them before
1268: <code class="literal">pkg_delete</code> sees them.</p>
1269: <p>The <code class="option">-r</code> option is very powerful: it
1270: removes all the packages that require the package in question
1271: and then removes the package itself. For example:
1272:
1273: </p>
1274: <pre class="screen">
1275: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1276: </pre>
1277: <p>
1278:
1279: will remove jpeg and all the packages that used it; this allows
1280: upgrading the jpeg package.</p>
1281: </div>
1.41 asau 1282: <div class="sect2">
1.1 dsieger 1283: <div class="titlepage"><div><div><h3 class="title">
1284: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1285: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1286: installed packages or binary package files.</p>
1287: </div>
1.41 asau 1288: <div class="sect2">
1.1 dsieger 1289: <div class="titlepage"><div><div><h3 class="title">
1290: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1291: <p>
1292: The NetBSD Security-Officer and Packages Groups maintain a list of
1293: known security vulnerabilities to packages which are (or have been)
1294: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1295: 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 1296: </p>
1297: <p>
1.22 jakllsch 1298: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1299: this list can be downloaded
1300: automatically, and a security audit of all packages installed on a system
1301: can take place.
1302: </p>
1303: <p>
1.22 jakllsch 1304: There are two components to auditing. The first
1305: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1306: is for downloading
1.1 dsieger 1307: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1308: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1309: installed packages are vulnerable. If a package is vulnerable, you
1310: will see output similar to the following:
1311: </p>
1312: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1313: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1314: <p>
1.22 jakllsch 1315: You may wish to have the
1.10 hubertf 1316: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1317: file downloaded daily so that
1318: it remains current. This may be done by adding an appropriate entry
1.79 snj 1319: 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 1320: </p>
1321: <pre class="screen">
1322: # download vulnerabilities file
1323: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1324: </pre>
1325: <p>
1326: will update the vulnerability list every day at 3AM. You may wish to do
1327: this more often than once a day.
1328:
1329: In addition, you may wish to run the package audit from the daily
1330: security script. This may be accomplished by adding the following
1331: line to <code class="filename">/etc/security.local</code>:
1332: </p>
1333: <pre class="screen">
1334: /usr/sbin/pkg_admin audit
1335: </pre>
1336: <p>
1.1 dsieger 1337: </p>
1338: </div>
1.41 asau 1339: <div class="sect2">
1.1 dsieger 1340: <div class="titlepage"><div><div><h3 class="title">
1341: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1342: <p>
1.79 snj 1343: 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 1344: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1345: argument to check if your packages are up-to-date, e.g.
1346: </p>
1347: <pre class="screen">
1348: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1349: ...
1350: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1351: </pre>
1.10 hubertf 1352: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1353: package on your system and rebuild any dependencies.
1354: </p>
1355: </div>
1.41 asau 1356: <div class="sect2">
1.1 dsieger 1357: <div class="titlepage"><div><div><h3 class="title">
1358: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1359: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1360: administrative functions on the package system.</p>
1361: </div>
1362: </div>
1.41 asau 1363: <div class="sect1">
1.1 dsieger 1364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1365: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1366: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1367: directory now contains a set of packages, organized into
1368: categories. You can browse the online index of packages, or run
1.10 hubertf 1369: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1370: directory to build local <code class="filename">README.html</code> files for
1.79 snj 1371: 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 1372: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1373: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1374: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1375: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1376: different <code class="varname">LOCALBASE</code> definitions on the same
1377: system (inside a chroot is an exception). </p>
1378: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1379: 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 1380: instructions how to create your own packages.</p>
1.41 asau 1381: <div class="sect2">
1.1 dsieger 1382: <div class="titlepage"><div><div><h3 class="title">
1383: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1384: <p>To build packages from source, you need a working C
1385: compiler. On NetBSD, you need to install the
1.23 wiz 1386: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1387: sets. If you want to build X11-related packages, the
1.23 wiz 1388: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1389: sets are required, too.</p>
1390: </div>
1.41 asau 1391: <div class="sect2">
1.1 dsieger 1392: <div class="titlepage"><div><div><h3 class="title">
1393: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1394: <p>The first step for building a package is downloading the
1395: distfiles (i.e. the unmodified source). If they have not yet been
1396: downloaded, pkgsrc will fetch them automatically.</p>
1397: <p>If you have all files that you need in the
1398: <code class="filename">distfiles</code> directory,
1399: you don't need to connect. If the distfiles are on CD-ROM, you can
1400: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1401: </p>
1402: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1403: <p>
1.10 hubertf 1404: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1405: <p>By default a list of distribution sites will be randomly
1406: intermixed to prevent huge load on servers which holding popular
1407: packages (for example, SourceForge.net mirrors). Thus, every
1408: time when you need to fetch yet another distfile all the mirrors
1409: will be tried in new (random) order. You can turn this feature
1410: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1411: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1412: <p>You can overwrite some of the major distribution sites to
1413: fit to sites that are close to your own. By setting one or two
1414: variables you can modify the order in which the master sites are
1415: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1416: delimited list of domain suffixes.
1417: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1418: contains a whitespace delimited list of regular expressions. It
1419: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1420: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1421: some examples. This may save some of your bandwidth and
1422: time.</p>
1423: <p>You can change these settings either in your shell's environment, or,
1424: if you want to keep the settings, by editing the
1.10 hubertf 1425: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1426: and adding the definitions there.</p>
1427: <p>
1428: If a package depends on many other packages (such as
1.79 snj 1429: <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 1430: alternate between periods of
1431: downloading source, and compiling. To ensure you have all the source
1432: downloaded initially you can run the command:
1433: </p>
1434: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1435: <p>
1436: which will output and run a set of shell commands to fetch the
1437: necessary files into the <code class="filename">distfiles</code> directory. You can
1438: also choose to download the files manually.
1439: </p>
1440: </div>
1.41 asau 1441: <div class="sect2">
1.1 dsieger 1442: <div class="titlepage"><div><div><h3 class="title">
1443: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1444: <p>
1445: Once the software has downloaded, any patches will be applied, then it
1446: will be compiled for you. This may take some time depending on your
1447: computer, and how many other packages the software depends on and their
1448: compile time.
1449: </p>
1.41 asau 1450: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1451: <h3 class="title">Note</h3>
1452: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1453: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1454: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1455: </div>
1456: <p>For example, type</p>
1457: <pre class="screen">
1458: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1459: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1460: </pre>
1461: <p>at the shell prompt to build the various components of the
1462: package.</p>
1463: <p>The next stage is to actually install the newly compiled
1464: program onto your system. Do this by entering:
1465:
1466: </p>
1467: <pre class="screen">
1468: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1469: </pre>
1470: <p>
1471:
1472: while you are still in the directory for whatever package you
1473: are installing.</p>
1474: <p>Installing the package on your system may require you to
1475: be root. However, pkgsrc has a
1476: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1477: to only become root for the actual installation step.</p>
1478: <p>That's it, the software should now be installed and setup for use.
1479: You can now enter:
1480:
1481: </p>
1482: <pre class="screen">
1483: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1484: </pre>
1485: <p>
1486:
1487: to remove the compiled files in the work directory, as you shouldn't need
1488: them any more. If other packages were also added to your system
1489: (dependencies) to allow your program to compile, you can tidy these up
1490: also with the command:</p>
1491: <pre class="screen">
1492: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1493: </pre>
1494: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1495: 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 1496: <p>The program is installed under the default root of the
1497: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1498: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1499: variable in your environment, and it will use that value as the
1500: root of your packages tree. So, to use
1501: <code class="filename">/usr/local</code>, set
1502: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1503: Please note that you should use a directory which is dedicated to
1504: packages and not shared with other programs (i.e., do not try and
1505: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1506: to add any of your own files or directories (such as
1507: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1508: <code class="filename">pkgsrc/</code>) below the
1509: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1510: conflicts between programs and other files installed by the
1511: package system and whatever else may have been installed
1512: there.</p>
1.10 hubertf 1513: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1514: alter some configuration options at build time. Have a look at
1515: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1516: of what will be set there by default. Environment variables such
1517: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1518: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1519: set them each time you want to use pkgsrc.</p>
1.23 wiz 1520: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1521: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1522: or being installed. This may be for debugging purposes, or out of
1523: simple curiosity. A number of utility values have been added to
1524: help with this.</p>
1.23 wiz 1525: <div class="orderedlist"><ol class="orderedlist" type="1">
1526: <li class="listitem">
1.79 snj 1527: <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 1528: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1529: information will be displayed. For example,</p>
1530: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1531: <p>will show all the commands that are invoked, up to and
1.23 wiz 1532: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1533: </li>
1.23 wiz 1534: <li class="listitem">
1.79 snj 1535: <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 1536: definition, then the <code class="varname">VARNAME</code> definition
1537: should be used, in conjunction with the show-var
1.79 snj 1538: 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 1539: variable <code class="varname">LOCALBASE</code>:</p>
1540: <pre class="screen">
1541: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1542: /usr/pkg
1543: <code class="prompt">%</code>
1544: </pre>
1545: </li>
1546: </ol></div>
1547: <p>If you want to install a binary package that you've either
1548: created yourself (see next section), that you put into
1549: pkgsrc/packages manually or that is located on a remote FTP
1550: server, you can use the "bin-install" target. This target will
1.79 snj 1551: 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 1552: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1553: sites searched is kept in the variable
1554: <code class="varname">BINPKG_SITES</code>, which defaults to
1.79 snj 1555: 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 1556: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1557: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1558: details.</p>
1559: <p>A final word of warning: If you set up a system that has a
1560: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1561: set that before any packages are installed, as you cannot use
1562: several directories for the same purpose. Doing so will result in
1563: pkgsrc not being able to properly detect your installed packages,
1564: and fail miserably. Note also that precompiled binary packages are
1565: usually built with the default <code class="varname">LOCALBASE</code> of
1566: <code class="filename">/usr/pkg</code>, and that you should
1567: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1568: <code class="varname">LOCALBASE</code>.</p>
1569: </div>
1570: </div>
1571: </div>
1.41 asau 1572: <div class="chapter">
1.1 dsieger 1573: <div class="titlepage"><div><div><h2 class="title">
1574: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
1575: <div class="toc">
1576: <p><b>Table of Contents</b></p>
1.100 leot 1577: <dl class="toc">
1.1 dsieger 1578: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
1579: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 1580: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 1581: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 1582: <dd><dl>
1.4 rillig 1583: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 1584: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1585: <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 1586: </dl></dd>
1.4 rillig 1587: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
1588: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1589: </dl>
1590: </div>
1.4 rillig 1591: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1592: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1593: that file depends on the installation. On NetBSD, when you use
1.79 snj 1594: <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 1595: <code class="filename">/etc/</code>. In all other cases the default location is
1596: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1597: bootstrap program to install the binary packages.</p>
1598: <p>The format of the configuration file is that of the usual
1599: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1600: is done by setting variables in this file. Note that you can define all
1601: kinds of variables, and no special error checking (for example for
1.112 ! rillig 1602: spelling mistakes) takes place.</p>
1.41 asau 1603: <div class="sect1">
1.1 dsieger 1604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1605: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.112 ! rillig 1606: <p>The following variables apply to all
1.1 dsieger 1607: pkgsrc packages. A complete list of the variables that can be
1608: configured by the user is available in
1609: <code class="filename">mk/defaults/mk.conf</code>, together with some
1610: comments that describe each variable's intent.</p>
1.41 asau 1611: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1612: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1613: packages will be installed. The default is
1614: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1615: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1616: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1617: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1618: installed. The default is
1619: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1620: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1621: X11 is installed on the system. The default is
1.84 wiz 1622: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1623: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1624: downloaded copies of the original source distributions used
1625: for building pkgsrc packages. The default is
1626: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1627: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1628: database about installed packages is stored. The default is
1629: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 1630: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1631: If set, override the packages'
1632: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1633: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1634: Backup location(s) for distribution files and patch files
1635: if not found locally or in
1636: <code class="filename">${MASTER_SITES}</code> or
1637: <code class="filename">${PATCH_SITES}</code> respectively.
1638: The defaults are
1.25 spz 1639: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 1640: and
1641: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1642: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1643: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1644: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1645: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1646: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1647: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1648: List of acceptable licenses. License names are case-sensitive.
1649: Whenever you try to build a package whose license is not in this
1650: list, you will get an error message. If the license condition is
1651: simple enough, the error message will include specific
1652: instructions on how to change this variable.</p></li>
1.1 dsieger 1653: </ul></div>
1654: </div>
1.41 asau 1655: <div class="sect1">
1.1 dsieger 1656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1657: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1658: <p>
1.1 dsieger 1659: </p>
1.41 asau 1660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1661: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1662: directory for the binary packages. The default is
1663: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1664: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1665: The top level directory where, if defined, the separate
1666: working directories will get created, and symbolically
1667: linked to from <code class="filename">${WRKDIR}</code> (see below).
1668: This is useful for building packages on several
1669: architectures, then <code class="filename">${PKGSRCDIR}</code>
1670: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1671: is local to every architecture. (It should be noted that
1672: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1673: — it is an internal definition which refers to the
1.1 dsieger 1674: root of the pkgsrc tree. It is possible to have many
1675: pkgsrc tree instances.)</p></li>
1.23 wiz 1676: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1677: Directory for local patches that aren't part of pkgsrc.
1.108 rillig 1678: 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 1679: information.</p></li>
1.23 wiz 1680: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1681: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1682: BSD-style Makefile. If this is not set,
1683: <code class="varname">MAKECONF</code> is set to
1684: <code class="filename">/dev/null</code> to avoid picking up
1685: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 1686: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 1687: By default, dependencies are only installed, and no binary
1688: package is created for them. You can set this variable to
1.66 asau 1689: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 1690: packages after installing dependencies. Please note that the
1.84 wiz 1691: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 1692: <code class="literal">yes</code> to preserve binary packages when
1693: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 1694: </ul></div>
1695: </div>
1.41 asau 1696: <div class="sect1">
1.1 dsieger 1697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 1698: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.107 jnemeth 1699: <p>Packages have to support installation into a
1.4 rillig 1700: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1701: to be built, before the actual filesystem is touched. DESTDIR
1702: support exists in two variations:</p>
1.41 asau 1703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1704: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1705: installation and packaging is still run as root.</p></li>
1706: <li class="listitem"><p>Full DESTDIR support can run the complete
1707: build, installation and packaging as normal user. Root
1708: privileges are only needed to add packages.</p></li>
1709: </ul></div>
1.4 rillig 1710: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1711: clean</code></strong> needs to be run as root.</p>
1.17 imil 1712: <p>Considering the <code class="filename">foo/bar</code> package,
1713: DESTDIR full support can be tested using the following commands
1714:
1715: </p>
1716: <pre class="programlisting">
1717: <code class="prompt">$</code> id
1718: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1719: <code class="prompt">$</code> mkdir $HOME/packages
1720: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1721: </pre>
1722: <p>
1723:
1724: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1725: should be needed
1726:
1727: </p>
1728: <pre class="programlisting">
1.66 asau 1729: <code class="prompt">$</code> make stage-install
1.17 imil 1730: </pre>
1731: <p>
1732:
1733: Create a package without root privileges
1734:
1735: </p>
1736: <pre class="programlisting">
1.66 asau 1737: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1738: </pre>
1739: <p>
1740:
1741: For the following command, you must be able to gain root
1.79 snj 1742: 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 1743:
1744: </p>
1745: <pre class="programlisting">
1.66 asau 1746: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1747: </pre>
1748: <p>
1749:
1750: Then, as a simple user
1751:
1752: </p>
1753: <pre class="programlisting">
1754: <code class="prompt">$</code> make clean
1755: </pre>
1756: <p>
1757:
1758: </p>
1.4 rillig 1759: </div>
1.41 asau 1760: <div class="sect1">
1.4 rillig 1761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1762: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1763: <div class="sect2">
1.1 dsieger 1764: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1765: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1766: <p>By default, pkgsrc will use GCC to build packages. This may be
1767: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1768: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1769: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1770: <dd>
1771: <p>This is a list of values specifying the chain of
1772: compilers to invoke when building packages. Valid values
1773: are:</p>
1.41 asau 1774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1775: <li class="listitem"><p><code class="varname">ccc</code>:
1776: Compaq C Compilers (Tru64)</p></li>
1777: <li class="listitem"><p><code class="varname">ccache</code>:
1778: compiler cache (chainable)</p></li>
1779: <li class="listitem"><p><code class="varname">clang</code>:
1780: Clang C and Objective-C compiler</p></li>
1.23 wiz 1781: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1782: distributed C/C++ (chainable)</p></li>
1.66 asau 1783: <li class="listitem"><p><code class="varname">f2c</code>:
1784: Fortran 77 to C compiler (chainable)</p></li>
1785: <li class="listitem"><p><code class="varname">icc</code>:
1786: Intel C++ Compiler (Linux)</p></li>
1787: <li class="listitem"><p><code class="varname">ido</code>:
1788: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1789: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1790: GNU C/C++ Compiler</p></li>
1.66 asau 1791: <li class="listitem"><p><code class="varname">hp</code>:
1792: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1793: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1794: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1795: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1796: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1797: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1798: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1799: <li class="listitem"><p><code class="varname">xlc</code>:
1800: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 1801: </ul></div>
1802: <p>The default is
1.23 wiz 1803: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1804: <code class="varname">ccache</code> and/or
1805: <code class="varname">distcc</code> with an appropriate
1806: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1807: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1808: variable should always be terminated with a value for
1809: a real compiler. Note that only one real compiler
1.23 wiz 1810: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1811: is not allowed).</p>
1812: </dd>
1813: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1814: <dd><p>This specifies the minimum version of GCC to use
1815: when building packages. If the system GCC doesn't
1816: satisfy this requirement, then pkgsrc will build and
1817: install one of the GCC packages to use instead.</p></dd>
1818: </dl></div>
1819: </div>
1.41 asau 1820: <div class="sect2">
1.1 dsieger 1821: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1822: <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 1823: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1824: please make sure to use the <code class="literal">+=</code> operator
1825: instead of the <code class="literal">=</code> operator:</p>
1826: <pre class="programlisting">
1827: CFLAGS+= -your -flags
1828: </pre>
1829: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1830: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1831: need to add their own flags. You may want to take a look
1.79 snj 1832: 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 1833: package if you're interested in optimization specifically
1834: for the current CPU. </p>
1.1 dsieger 1835: </div>
1.41 asau 1836: <div class="sect2">
1.1 dsieger 1837: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1838: <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 1839: <p>If you want to pass flags to the linker, both in the configure
1840: step and the build step, you can do this in two ways. Either set
1841: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1842: between the two is that <code class="varname">LIBS</code> will be appended to
1843: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1844: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1845: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1846: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1847: <code class="varname">CFLAGS</code>, if you do not wish to override these
1848: settings, use the <code class="literal">+=</code> operator:</p>
1849: <pre class="programlisting">
1850: LDFLAGS+= -your -linkerflags
1851: </pre>
1852: </div>
1853: </div>
1.41 asau 1854: <div class="sect1">
1.1 dsieger 1855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1856: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1857: <p>
1.1 dsieger 1858: </p>
1.41 asau 1859: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1860: <li class="listitem">
1.1 dsieger 1861: <p><code class="varname">PKG_DEVELOPER</code>:
1862: Run some sanity checks that package developers want:
1863: </p>
1.41 asau 1864: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1865: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1866: fuzz</p></li>
1.23 wiz 1867: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1868: binaries will find their shared libs.</p></li>
1869: </ul></div>
1870: <p>
1871: </p>
1872: </li>
1.23 wiz 1873: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1874: of debugging output which is displayed whilst making and
1875: installing the package. The default value for this is 0,
1876: which will not display the commands as they are executed
1877: (normal, default, quiet operation); the value 1 will display
1878: all shell commands before their invocation, and the value 2
1879: will display both the shell commands before their invocation,
1.112 ! rillig 1880: as well as their actual execution progress with <span class="command"><strong>set
! 1881: -x</strong></span>.</p></li>
1.1 dsieger 1882: </ul></div>
1883: <p>
1884: </p>
1885: </div>
1.41 asau 1886: <div class="sect1">
1.1 dsieger 1887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1888: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1889: <p>Some packages have build time options, usually to select
1890: between different dependencies, enable optional support for big
1891: dependencies or enable experimental features.</p>
1892: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1893: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1894: show-options</strong></span>, for example:</p>
1895: <pre class="programlisting">
1896: The following options are supported by this package:
1897: ssl Enable SSL support.
1898: Exactly one of the following gecko options is required:
1899: firefox Use firefox as gecko rendering engine.
1900: mozilla Use mozilla as gecko rendering engine.
1901: At most one of the following database options may be selected:
1902: mysql Enable support for MySQL database.
1903: pgsql Enable support for PostgreSQL database.
1904:
1905: These options are enabled by default: firefox
1906: These options are currently enabled: mozilla ssl
1907: </pre>
1908: <p>The following variables can be defined in
1.10 hubertf 1909: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1910: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1911: which can be used to select or disable options for all packages
1912: that support them, and
1913: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1914: which can be used to select or disable options specifically for
1915: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1916: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1917: are disabled. A few examples:</p>
1918: <pre class="screen">
1.10 hubertf 1919: <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 1920: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1921: PKG_OPTIONS.kdebase= debug -sasl
1922: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1923: <p>It is important to note that options that were specifically
1.18 snj 1924: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1925: you do not wish to include the option. If you are unsure you can view
1926: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1927: <p>The following settings are consulted in the order given, and
1928: the last setting that selects or disables an option is
1929: used:</p>
1.23 wiz 1930: <div class="orderedlist"><ol class="orderedlist" type="1">
1931: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1932: maintainer</p></li>
1.23 wiz 1933: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1934: variables (see below)</p></li>
1.23 wiz 1935: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1936: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1937: </ol></div>
1938: <p>For groups of mutually exclusive options, the last option
1939: selected is used, all others are automatically disabled. If an
1940: option of the group is explicitly disabled, the previously
1941: selected option, if any, is used. It is an error if no option
1942: from a required group of options is selected, and building the
1943: package will fail.</p>
1944: <p>Before the options framework was introduced, build options
1945: were selected by setting a variable (often named
1946: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 1947: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 1948: transition to the options framework for the user, these legacy
1949: variables are converted to the appropriate options setting
1950: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1951: automatically. A warning is issued to prompt the user to update
1.10 hubertf 1952: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 1953: directly. Support for the legacy variables will be removed
1954: eventually.</p>
1955: </div>
1956: </div>
1.41 asau 1957: <div class="chapter">
1.1 dsieger 1958: <div class="titlepage"><div><div><h2 class="title">
1959: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
1960: <div class="toc">
1961: <p><b>Table of Contents</b></p>
1.100 leot 1962: <dl class="toc">
1.1 dsieger 1963: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
1964: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1965: </dl>
1966: </div>
1.41 asau 1967: <div class="sect1">
1.1 dsieger 1968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1969: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1970: <p>Once you have built and installed a package, you can create
1971: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.79 snj 1972: 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 1973: the same package on a group of hosts and wasting CPU time. It also
1974: provides a simple means for others to install your package, should
1975: you distribute it.</p>
1976: <p>To create a binary package, change into the appropriate
1.10 hubertf 1977: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 1978: package</strong></span>:</p>
1979: <pre class="screen">
1.112 ! rillig 1980: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
! 1981: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
! 1982: </pre>
1.1 dsieger 1983: <p>This will build and install your package (if not already done),
1984: and then build a binary package from what was installed. You can
1.10 hubertf 1985: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 1986: it. Binary packages are created by default in
1987: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 1988: 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 1989: 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 1990: <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 1991: such a binary package.</p>
1992: </div>
1.41 asau 1993: <div class="sect1">
1.1 dsieger 1994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1995: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 1996: <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 1997: </div>
1998: </div>
1.41 asau 1999: <div class="chapter">
1.6 rillig 2000: <div class="titlepage"><div><div><h2 class="title">
2001: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2002: builds)</h2></div></div></div>
2003: <div class="toc">
2004: <p><b>Table of Contents</b></p>
1.100 leot 2005: <dl class="toc">
1.71 wiz 2006: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2007: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2008: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2009: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2010: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2011: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2012: </dl>
2013: </div>
1.71 wiz 2014: <p>For a number of reasons you may want to build binary packages
2015: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2016: For instance, when you have multiple machines that should run the same software,
2017: it is wasted time if they all build their packages themselves from source.
2018: Or you may want to build a list of packages you want and check them before
2019: deploying onto production system.
2020: There is a way of getting a set of binary packages:
1.112 ! rillig 2021: The bulk build system, or pbulk ("p" stands for "parallel").
! 2022: This chapter describes how to set it up.</p>
1.41 asau 2023: <div class="sect1">
1.6 rillig 2024: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2025: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2026: <p>First of all, you have to decide whether you build all packages
2027: or a limited set of them. Full bulk builds usually consume a lot more resources,
2028: both space and time, than builds for some practical sets of packages.
2029: There exists a number of particularly heavy packages that are not actually
2030: interesting to a wide audience.
2031:
2032: For a limited bulk builds you need to make a list of packages you want to build.
1.112 ! rillig 2033: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2034: </p>
2035: <p>During bulk builds various packages are installed and deinstalled
2036: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2037: so make sure that you don't need any package during the builds.
1.112 ! rillig 2038: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2039: or something even more restrictive, depending on what the operating system provides,
2040: or dedicate the whole physical machine.
2041: As a useful side effect this makes sure that bulk builds cannot
2042: break anything in your system. There have been numerous cases where
1.6 rillig 2043: certain packages tried to install files outside the
2044: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2045: <code class="filename">/etc</code>.
2046: </p>
1.6 rillig 2047: </div>
1.41 asau 2048: <div class="sect1">
1.6 rillig 2049: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2050: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2051: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2052: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2053: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2054: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2055: </ul></div>
1.41 asau 2056: <div class="sect2">
1.15 rillig 2057: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2058: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.112 ! rillig 2059: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2060: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2061: Configure network access to fetch distribution files.
1.112 ! rillig 2062: Create a user with name "pbulk".</p>
1.68 asau 2063: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2064: <pre class="screen">
1.72 wiz 2065: <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>
2066: <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>
2067: <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 2068: </pre>
2069: <p>Or any other way that fits (e.g., curl, wget).</p>
2070: <p>Deploy and configure pbulk tools, e.g.:</p>
2071: <pre class="screen">
2072: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2073: <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>
2074: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2075: </pre>
2076: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2077: <h3 class="title">Note</h3>
2078: <p><code class="filename">mk.conf.frag</code> is a fragment of
2079: <code class="filename">mk.conf</code> that contains settings you want to
2080: apply to packages you build. For instance,</p>
2081: <pre class="programlisting">
1.112 ! rillig 2082: PKG_DEVELOPER= yes # perform more checks
! 2083: X11_TYPE= modular # use pkgsrc X11
! 2084: SKIP_LICENSE_CHECK= yes # accept all licences (useful
! 2085: # when building all packages)
1.68 asau 2086: </pre>
2087: </div>
2088: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 ! rillig 2089: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2090: <pre class="programlisting">
2091: www/firefox
2092: mail/thunderbird
2093: misc/libreoffice4
2094: </pre>
1.69 asau 2095: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2096: and make final amendments, if wanted.</p>
1.68 asau 2097: <p>Start it:</p>
2098: <pre class="screen">
2099: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2100: </pre>
2101: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2102: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2103: </p>
2104: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2105: <h3 class="title">Note</h3>
2106: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2107: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2108: The script is kept small enough for better understanding.</p>
2109: </div>
2110: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2111: <h3 class="title">Note</h3>
2112: <p>The <code class="filename">pbulk.sh</code> script supports running
2113: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2114: </div>
1.6 rillig 2115: </div>
2116: </div>
1.41 asau 2117: <div class="sect1">
1.6 rillig 2118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2119: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2120: <p>A complete bulk build requires lots of disk space. Some of the
2121: disk space can be read-only, some other must be writable. Some can be on
2122: remote filesystems (such as NFS) and some should be local. Some can be
2123: temporary filesystems, others must survive a sudden reboot.</p>
2124: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2125: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2126: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2127: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2128: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2129: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2130: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2131: </ul></div>
2132: </div>
2133: <div class="sect1">
2134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2135: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2136: <p>After your pkgsrc bulk-build has completed, you may wish to
2137: create a CD-ROM set of the resulting binary packages to assist
2138: in installing packages on other machines. The
1.79 snj 2139: <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 2140: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2141: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2142: way that keeps all the dependencies for a given package on the same
2143: CD as that package.</p>
1.41 asau 2144: <div class="sect2">
1.1 dsieger 2145: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2146: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2147: <p>Complete documentation for cdpack is found in the cdpack(1)
2148: man page. The following short example assumes that the binary
2149: packages are left in
2150: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2151: sufficient disk space exists in <code class="filename">/u2</code> to
2152: hold the ISO 9660 images.</p>
2153: <pre class="screen">
2154: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2155: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2156: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2157: </pre>
2158: <p>If you wish to include a common set of files
2159: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2160: etc.) on each CD in the collection, then you need to create a
2161: directory which contains these files. e.g.</p>
2162: <pre class="screen">
2163: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2164: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2165: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2166: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2167: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2168: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2169: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2170: </pre>
2171: <p>Now create the images:</p>
2172: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2173: <p>Each image will contain <code class="filename">README</code>,
2174: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2175: in their root directories.</p>
2176: </div>
2177: </div>
2178: </div>
1.41 asau 2179: <div class="chapter">
1.1 dsieger 2180: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2181: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2182: <div class="toc">
2183: <p><b>Table of Contents</b></p>
1.100 leot 2184: <dl class="toc">
1.23 wiz 2185: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2186: <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 2187: </dl>
2188: </div>
2189: <p>The files that are installed by pkgsrc are organized in a way that
2190: is similar to what you find in the <code class="filename">/usr</code> directory
2191: of the base system. But some details are different. This is because
2192: pkgsrc initially came from FreeBSD and had adopted its file system
2193: hierarchy. Later it was largely influenced by NetBSD. But no matter
2194: which operating system you are using pkgsrc with, you can expect the
2195: same layout for pkgsrc.</p>
2196: <p>There are mainly four root directories for pkgsrc, which are all
2197: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2198: When pkgsrc has been installed as root, the default locations
2199: are:</p>
2200: <pre class="programlisting">
2201: LOCALBASE= /usr/pkg
2202: PKG_SYSCONFBASE= /usr/pkg/etc
2203: VARBASE= /var
2204: PKG_DBDIR= /var/db/pkg
2205: </pre>
2206: <p>In unprivileged mode (when pkgsrc has been installed as any other
2207: user), the default locations are:</p>
2208: <pre class="programlisting">
2209: LOCALBASE= ${HOME}/pkg
2210: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2211: VARBASE= ${HOME}/pkg/var
2212: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2213: </pre>
2214: <p>What these four directories are for, and what they look like is
2215: explained below.</p>
1.41 asau 2216: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2217: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2218: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2219: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2220: the well-known subdirectories like <code class="filename">bin</code>,
2221: <code class="filename">include</code>, <code class="filename">lib</code>,
2222: <code class="filename">share</code> and
2223: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2224: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2225: <code class="filename">/var</code> in the base system. Some programs (especially
2226: games, network daemons) need write access to it during normal
2227: operation.</p></li>
1.23 wiz 2228: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2229: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2230: 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 2231: itself.</p></li>
2232: </ul></div>
1.41 asau 2233: <div class="sect1">
1.1 dsieger 2234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2235: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2236: </h2></div></div></div>
2237: <p>The following directories exist in a typical pkgsrc installation
2238: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2239: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2240: <dt><span class="term"><code class="filename">bin</code></span></dt>
2241: <dd><p>Contains executable programs that are intended to be
2242: directly used by the end user.</p></dd>
2243: <dt><span class="term"><code class="filename">emul</code></span></dt>
2244: <dd><p>Contains files for the emulation layers of various other
2245: operating systems, especially for
2246: NetBSD.</p></dd>
2247: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2248: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2249: <dd><p>Contains
2250: the configuration files.</p></dd>
2251: <dt><span class="term"><code class="filename">include</code></span></dt>
2252: <dd><p>Contains headers for the C and C++ programming
2253: languages.</p></dd>
2254: <dt><span class="term"><code class="filename">info</code></span></dt>
2255: <dd><p>Contains GNU info files of various
2256: packages.</p></dd>
2257: <dt><span class="term"><code class="filename">lib</code></span></dt>
2258: <dd><p>Contains shared and static
2259: libraries.</p></dd>
2260: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2261: <dd><p>Contains data files that don't change after
2262: installation. Other data files belong into
2263: <code class="filename">${VARBASE}</code>.</p></dd>
2264: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2265: <dd><p>Contains programs that are not intended to be used by
2266: end users, such as helper programs or network
2267: daemons.</p></dd>
2268: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2269: <dd><p>Contains programs that are intended to be executed as
2270: CGI scripts by a web server.</p></dd>
2271: <dt><span class="term"><code class="filename">man</code> (the usual value of
2272: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2273: <dd><p>Contains brief
2274: documentation in form of manual pages.</p></dd>
2275: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2276: <dd><p>Contains programs that are intended to be used only by
2277: the super-user.</p></dd>
2278: <dt><span class="term"><code class="filename">share</code></span></dt>
2279: <dd><p>Contains platform-independent data files that don't
2280: change after installation.</p></dd>
2281: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2282: <dd><p>Contains documentation files provided by the
2283: packages.</p></dd>
2284: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2285: <dd><p>Contains example files provided by the packages. Among
2286: others, the original configuration files are saved here and copied to
2287: <code class="filename">${PKG_SYSCONFDIR}</code> during
2288: installation.</p></dd>
2289: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2290: <dd><p>Contains the original files for rc.d
2291: scripts.</p></dd>
2292: <dt><span class="term"><code class="filename">var</code> (the usual location of
2293: <code class="filename">${VARBASE}</code>)</span></dt>
2294: <dd><p>Contains files
2295: that may be modified after
2296: installation.</p></dd>
2297: </dl></div>
2298: </div>
1.41 asau 2299: <div class="sect1">
1.1 dsieger 2300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2301: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2302: </h2></div></div></div>
1.41 asau 2303: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2304: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2305: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2306: <dd><p>Contains
2307: information about the currently installed
2308: packages.</p></dd>
2309: <dt><span class="term"><code class="filename">games</code></span></dt>
2310: <dd><p>Contains highscore
2311: files.</p></dd>
2312: <dt><span class="term"><code class="filename">log</code></span></dt>
2313: <dd><p>Contains log files.</p></dd>
2314: <dt><span class="term"><code class="filename">run</code></span></dt>
2315: <dd><p>Contains informational files about daemons that are
2316: currently running.</p></dd>
2317: </dl></div>
2318: </div>
2319: </div>
1.41 asau 2320: <div class="chapter">
1.1 dsieger 2321: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2322: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2323: <div class="toc">
2324: <p><b>Table of Contents</b></p>
1.100 leot 2325: <dl class="toc">
1.6 rillig 2326: <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 2327: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2328: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2329: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2330: <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>
2331: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2332: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2333: <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>
2334: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2335: <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 2336: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2337: <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>
2338: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2339: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2340: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2341: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2342: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2343: <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 2344: </dl>
2345: </div>
2346: <p>This section contains hints, tips & tricks on special things in
2347: pkgsrc that we didn't find a better place for in the previous chapters, and
2348: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2349: <div class="sect1">
1.1 dsieger 2350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2351: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2352: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2353: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2354: <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 2355: This is a general purpose list for most issues regarding
2356: pkgsrc, regardless of platform, e.g. soliciting user help
2357: for pkgsrc configuration, unexpected build failures, using
2358: particular packages, upgrading pkgsrc installations,
2359: questions regarding the pkgsrc release branches, etc. General announcements or
2360: proposals for changes that impact the pkgsrc user community,
2361: e.g. major infrastructure changes, new features, package
2362: removals, etc., may also be posted.</p></li>
1.23 wiz 2363: <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 2364: A list where the results of pkgsrc bulk builds are sent and
2365: discussed.</p></li>
1.23 wiz 2366: <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 2367: This list is for those who are interested in getting a
2368: commit message for every change committed to pkgsrc. It is
2369: also available in digest form, meaning one daily message
2370: containing all commit messages for changes to the package
2371: source tree in that 24 hour period.</p></li>
2372: </ul></div>
2373: <p>To subscribe, do:</p>
2374: <pre class="programlisting">
2375: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2376: </pre>
2377: <p>Archives for all these mailing lists are available from
1.10 hubertf 2378: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2379: </div>
1.41 asau 2380: <div class="sect1">
1.1 dsieger 2381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2382: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2383: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2384: a number of useful utilities for both users and developers of pkgsrc. This
2385: section attempts only to make the reader aware of the utilities and when
2386: they might be useful, and not to duplicate the documentation that comes
2387: with each package.</p>
2388: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.79 snj 2389: <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 2390: Symlinks for use by buildlink.</p></li></ul></div>
2391: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2392: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2393: <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 2394: Calculates various kinds of checksums (including SHA1).</p></li>
1.79 snj 2395: <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 2396: Compatibility library for pkgsrc tools.</p></li>
1.79 snj 2397: <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 2398: non-BSD systems due to lack of native mtree.</p></li>
1.79 snj 2399: <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 2400: Up-to-date replacement for
2401: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2402: systems where pkg_install is not present.</p></li>
2403: </ul></div>
2404: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2405: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2406: <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 2407: Create a binary package from an
1.10 hubertf 2408: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2409: save the old package.</p></li>
1.79 snj 2410: <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 2411: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2412: from multiple locations. It currently supports the following
2413: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.79 snj 2414: <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 2415: the best compiler flags to optimise code for your current
1.23 wiz 2416: CPU and compiler. </p></li>
1.1 dsieger 2417: </ul></div>
2418: <p>Utilities for keeping track of installed packages, being up to date,
2419: etc:</p>
1.41 asau 2420: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2421: <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 2422: update tool similar to apt(1). Download, install, and upgrade
2423: binary packages easily.</p></li>
1.79 snj 2424: <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 2425: packages whose installed versions do not match the latest pkgsrc
2426: entries.</p></li>
1.79 snj 2427: <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 2428: dependency graphs of packages, to aid in choosing a strategy for
2429: updating.</p></li>
1.79 snj 2430: <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
2431: 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>
2432: <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 2433: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.79 snj 2434: <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 2435: does various checks on the complete pkgsrc system.</p></li>
1.79 snj 2436: <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 2437: packages you have installed.</p></li>
2438: </ul></div>
2439: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2440: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2441: <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 2442: making and maintaining patches for a package (includes pkgdiff,
2443: pkgvi, mkpatches, etc.).</p></li>
1.79 snj 2444: <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 2445: converting to pkgsrc.</p></li>
2446: </ul></div>
2447: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2448: utilities)</p>
1.41 asau 2449: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2450: <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 2451: packages in a chrooted area.</p></li>
1.79 snj 2452: <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 2453: kernel version for chrooted cross builds.</p></li>
2454: </ul></div>
2455: </div>
1.41 asau 2456: <div class="sect1">
1.1 dsieger 2457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2458: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2459: <p>To install packages from source as a non-root user, download
2460: 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
2461: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2462: --unprivileged</strong></span>.</p>
2463: <p>This will install the binary part of pkgsrc to
2464: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2465: into <code class="filename">~/pkg/etc</code>.</p>
2466: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2467: </div>
1.41 asau 2468: <div class="sect1">
1.1 dsieger 2469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2470: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2471: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2472: enable this feature by adding the option
2473: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2474: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2475: distfile is found, pkgsrc will try to resume it.</p>
2476: <p>You can also
1.61 wiz 2477: use a different program than the platform default program by changing the
1.16 jnemeth 2478: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2479: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2480: by using the value manual. A value of custom disables the system defaults
2481: and dependency tracking for the fetch program. In that case you have to
2482: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2483: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2484: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2485: <p>For example, if you want to use
1.16 jnemeth 2486: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2487: like:</p>
2488: <pre class="programlisting">
1.112 ! rillig 2489: FETCH_USING= wget
1.1 dsieger 2490: </pre>
2491: </div>
1.41 asau 2492: <div class="sect1">
1.1 dsieger 2493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2494: <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 2495: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2496: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2497: you will have to add the following line into
1.10 hubertf 2498: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2499: <pre class="programlisting">
1.4 rillig 2500: X11_TYPE=modular
1.1 dsieger 2501: </pre>
1.41 asau 2502: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 2503: <h3 class="title">Note</h3>
1.4 rillig 2504: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
2505: </p>
1.1 dsieger 2506: </div>
2507: </div>
1.41 asau 2508: <div class="sect1">
1.1 dsieger 2509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2510: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2511: <p>If you are sitting behind a firewall which does not allow direct
2512: connections to Internet hosts (i.e. non-NAT), you may specify the
2513: relevant proxy hosts. This is done using an environment variable in the
2514: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2515: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2516: port 80 as the proxy port number. So the proxy environment variables
2517: are:</p>
2518: <pre class="programlisting">
2519: ftp_proxy=ftp://orpheus.amdahl.com:80/
2520: http_proxy=http://orpheus.amdahl.com:80/
2521: </pre>
2522: </div>
1.41 asau 2523: <div class="sect1">
1.1 dsieger 2524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2525: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2526: <p>Some fetch tools are not prepared to support HTTPS by default
2527: (for example, the one in NetBSD 6.0), or the one installed by the
2528: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2529: dependency graph).</p>
2530: <p>Usually you won't notice, because distribution files are
2531: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2532: be often enough if you are following pkgsrc-current. In that case, set
2533: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2534: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2535: with HTTPS support by default. Of course, these tools need to be
2536: installed before you can use them this way.</p>
2537: </div>
2538: <div class="sect1">
2539: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2540: <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 2541: <p>This depends on which utility is used to retrieve distfiles. From
2542: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2543: the first available command from the following list:</p>
1.41 asau 2544: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2545: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2546: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2547: </ul></div>
2548: <p>On a default NetBSD installation, this will be
2549: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2550: connections first, and falls back to active connections if the server
2551: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2552: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2553: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2554: <p>Having that option present will prevent
2555: <code class="filename">/usr/bin/ftp</code> from falling back to active
2556: transfers.</p>
2557: </div>
1.41 asau 2558: <div class="sect1">
1.1 dsieger 2559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2560: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2561: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2562: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2563: 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 2564: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2565: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2566: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2567: resulting list to your machine at work/school and use it there. If you
1.79 snj 2568: 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 2569: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2570: URL:</p>
2571: <p>At home:</p>
2572: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2573: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2574: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2575: <p>At work:</p>
2576: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2577: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2578: home.</p>
2579: <p>If you have a machine running NetBSD, and you want to get
2580: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2581: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2582: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2583: directly by running:</p>
2584: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2585: <p>If you even decide to ignore
2586: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2587: by running:</p>
2588: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2589: </div>
1.41 asau 2590: <div class="sect1">
1.1 dsieger 2591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2592: <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 2593: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.79 snj 2594: <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 2595: package, you get the error from make that it doesn't know how to make
2596: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2597: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2598: the NetBSD base distribution on your machine. It is recommended to do
2599: that to format man pages.</p>
1.79 snj 2600: <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 2601: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2602: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2603: </div>
1.41 asau 2604: <div class="sect1">
1.1 dsieger 2605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2606: <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 2607: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2608: when you installed your NetBSD machine. Please get and install it, by
2609: extracting it in <code class="filename">/</code>:</p>
2610: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2611: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2612: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2613: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2614: -r</strong></span>).</p>
2615: </div>
1.41 asau 2616: <div class="sect1">
1.1 dsieger 2617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2618: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2619: <p>When installing packages as non-root user and using the just-in-time
1.79 snj 2620: <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 2621: password for each required package installed. To avoid this, the sudo
2622: package can be used, which does password caching over a limited time. To
2623: use it, install sudo (either as binary package or from
1.79 snj 2624: <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 2625: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2626: <span class="emphasis"><em>after</em></span> the definition of the
2627: <code class="varname">LOCALBASE</code> variable:</p>
2628: <pre class="programlisting">
2629: .if exists(${LOCALBASE}/bin/sudo)
2630: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2631: .endif
2632: </pre>
2633: </div>
1.41 asau 2634: <div class="sect1">
1.1 dsieger 2635: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2636: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2637: <p>As the system administrator, you can choose where configuration files
2638: are installed. The default settings make all these files go into
2639: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2640: be suboptimal depending on your expectations (e.g., a read-only,
2641: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2642: configuration of the provided packages).</p>
2643: <p>In order to change the defaults, you can modify the
2644: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2645: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2646: directory; some common examples include <code class="filename">/etc</code> or
2647: <code class="filename">/etc/pkg</code>.</p>
2648: <p>Furthermore, you can change this value on a per-package basis by
2649: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2650: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2651: package you would like to modify, that is, the contents of
2652: <code class="varname">PKGBASE</code>.</p>
2653: <p>Note that after changing these settings, you must rebuild and
2654: reinstall any affected packages.</p>
2655: </div>
1.41 asau 2656: <div class="sect1">
1.1 dsieger 2657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2658: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2659: <p>Please be aware that there can often be bugs in third-party software,
2660: and some of these bugs can leave a machine vulnerable to exploitation by
2661: attackers. In an effort to lessen the exposure, the NetBSD packages team
2662: maintains a database of known-exploits to packages which have at one time
2663: been included in pkgsrc. The database can be downloaded automatically, and
2664: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2665: do this, refer to the following two tools (installed as part of the
1.79 snj 2666: <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 2667: <div class="orderedlist"><ol class="orderedlist" type="1">
2668: <li class="listitem">
1.20 snj 2669: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2670: download a list of the security vulnerabilities information. This list
1.25 spz 2671: is kept up to date by the pkgsrc security team, and is distributed
2672: from the NetBSD ftp server:</p>
2673: <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 2674: </li>
1.23 wiz 2675: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2676: current machine, checking each known vulnerability. If a
1.1 dsieger 2677: vulnerable package is installed, it will be shown by output to stdout,
2678: including a description of the type of vulnerability, and a URL
2679: containing more information.</p></li>
2680: </ol></div>
1.14 jmcneill 2681: <p>Use of these tools is strongly recommended! After
1.23 wiz 2682: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 2683: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 2684: pkg_install</code></strong>.</p>
1.1 dsieger 2685: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 2686: 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 2687: check.</p>
2688: </div>
1.41 asau 2689: <div class="sect1">
1.1 dsieger 2690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2691: <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 2692: <p>When you add your own preferences to the
2693: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2694: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2695: environment variables to the <code class="filename">./configure</code>
1.79 snj 2696: 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 2697: <code class="varname">CFLAGS</code> from the environment variable by
2698: overriding them in the <code class="filename">Makefile</code>s of their
2699: package.</p>
2700: <p>Currently there is no solution to this problem. If you
2701: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2702: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2703: directory and then inspect any <code class="filename">Makefile</code> and
2704: <code class="filename">Makefile.in</code> for whether they define
2705: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2706: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2707: programmers write so bad code that it only works for the
2708: specific combination of <code class="varname">CFLAGS</code> they have
2709: chosen.</p>
2710: </div>
1.41 asau 2711: <div class="sect1">
1.1 dsieger 2712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2713: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2714: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2715: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2716: case that occurs often is that people only update pkgsrc in
2717: parts, because of performance reasons. Since pkgsrc is one large
2718: system, not a collection of many small systems, there are
2719: sometimes changes that only work when the whole pkgsrc tree is
2720: updated.</p></li>
1.41 asau 2721: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2722: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2723: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2724: files.</p></li>
1.41 asau 2725: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2726: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2727: verify this.</p></li>
1.108 rillig 2728: <li class="step"><p>If you are a package developer who wants to invest
2729: 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 2730: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2731: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2732: </ol></div>
2733: </div>
1.41 asau 2734: <div class="sect1">
1.1 dsieger 2735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2736: <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 2737: <p>You have modified a file from pkgsrc, and someone else has
2738: modified that same file afterwards in the CVS repository. Both changes
2739: are in the same region of the file, so when you updated pkgsrc, the
2740: <code class="literal">cvs</code> command marked the conflicting changes in the
2741: file. Because of these markers, the file is no longer a valid
2742: <code class="filename">Makefile</code>.</p>
2743: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2744: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2745: -dP</strong></span> in that directory to download the current version.</p>
2746: </div>
2747: </div>
2748: </div>
1.41 asau 2749: <div class="part">
1.1 dsieger 2750: <div class="titlepage"><div><div><h1 class="title">
2751: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2752: <div class="partintro">
1.1 dsieger 2753: <div></div>
2754: <p>This part of the book deals with creating and
1.23 wiz 2755: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2756: guide on creating a new package. The remaining chapters are more
2757: like a reference manual for pkgsrc.</p>
2758: <div class="toc">
2759: <p><b>Table of Contents</b></p>
1.100 leot 2760: <dl class="toc">
1.6 rillig 2761: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2762: <dd><dl>
1.6 rillig 2763: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2764: <dd><dl>
1.6 rillig 2765: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 2766: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 2767: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 2768: </dl></dd>
1.6 rillig 2769: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
2770: <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>
2771: </dl></dd>
2772: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
2773: <dd><dl>
1.23 wiz 2774: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
2775: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 2776: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2777: <dd><dl>
2778: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
2779: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
2780: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
2781: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
2782: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
2783: </dl></dd>
2784: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
2785: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
2786: <dd><dl>
2787: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
2788: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
2789: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
2790: </dl></dd>
1.23 wiz 2791: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
2792: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2793: </dl></dd>
1.23 wiz 2794: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2795: <dd><dl>
2796: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 2797: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 2798: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
2799: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
2800: <dd><dl>
2801: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 2802: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
2803: <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>
2804: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2805: </dl></dd>
2806: </dl></dd>
2807: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
2808: <dd><dl>
2809: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 2810: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2811: <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 2812: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
2813: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 2814: <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 2815: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 2816: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
2817: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2818: </dl></dd>
2819: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
2820: <dd><dl>
2821: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 2822: <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 2823: <dd><dl>
2824: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 2825: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
2826: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2827: and
2828: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2829: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2830: </dl></dd>
1.23 wiz 2831: <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 2832: <dd><dl>
1.23 wiz 2833: <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 2834: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
2835: </dl></dd>
2836: </dl></dd>
2837: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
2838: <dd><dl>
2839: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
2840: <dd><dl>
2841: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
2842: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
2843: </dl></dd>
2844: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
2845: <dd><dl>
1.23 wiz 2846: <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 2847: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
2848: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
2849: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
2850: </dl></dd>
2851: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
2852: <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>
2853: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
2854: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
2855: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
2856: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
2857: <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>
2858: </dl></dd>
2859: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
2860: <dd><dl>
2861: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 2862: <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 2863: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 2864: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 2865: </dl></dd>
2866: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
2867: <dd><dl>
2868: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
2869: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
2870: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
2871: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 2872: <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 2873: <dd><dl>
2874: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
2875: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
2876: </dl></dd>
1.23 wiz 2877: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2878: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2879: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2880: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2881: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2882: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2883: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2884: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2885: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2886: <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 2887: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
2888: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
2889: </dl></dd>
2890: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
2891: <dd><dl>
2892: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
2893: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
2894: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
2895: </dl></dd>
2896: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
2897: <dd><dl>
2898: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
2899: <dd><dl>
1.108 rillig 2900: <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>
2901: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
2902: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
2903: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
2904: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
2905: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
2906: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
2907: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
2908: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
2909: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2910: <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 2911: </dl></dd>
1.108 rillig 2912: <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 2913: <dd><dl>
2914: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2915: <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 2916: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 2917: </dl></dd>
1.108 rillig 2918: <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 2919: <dd><dl>
2920: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
2921: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2922: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
2923: </dl></dd>
2924: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
2925: <dd><dl>
2926: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
2927: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
2928: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 2929: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
2930: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 2931: </dl></dd>
1.108 rillig 2932: <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 2933: <dd><dl>
2934: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
2935: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 2936: <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 2937: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
2938: </dl></dd>
1.108 rillig 2939: <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 2940: <dd><dl>
2941: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
2942: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
2943: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
2944: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
2945: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2946: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
2947: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
2948: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 2949: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 2950: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 2951: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
2952: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
2953: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
2954: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
2955: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
2956: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
2957: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
2958: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 2959: emulation</a></span></dt>
1.6 rillig 2960: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
2961: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 2962: </dl></dd>
1.6 rillig 2963: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 2964: </dl></dd>
1.6 rillig 2965: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
2966: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 2967: <dd><dl>
1.6 rillig 2968: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
2969: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
2970: <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 2971: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 2972: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 2973: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
2974: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 2975: </dl></dd>
2976: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
2977: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
2978: <dd><dl>
2979: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
2980: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
2981: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
2982: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 2983: </dl></dd>
2984: </dl>
2985: </div>
2986: </div>
1.41 asau 2987: <div class="chapter">
1.1 dsieger 2988: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2989: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 2990: <div class="toc">
2991: <p><b>Table of Contents</b></p>
1.100 leot 2992: <dl class="toc">
1.6 rillig 2993: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2994: <dd><dl>
1.6 rillig 2995: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 2996: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 2997: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 2998: </dl></dd>
1.6 rillig 2999: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3000: <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 3001: </dl>
3002: </div>
3003: <p>When you find a package that is not yet in pkgsrc, you
3004: most likely have a URL from where you can download the source
3005: code. Starting with this URL, creating a package involves only a
3006: few steps.</p>
1.23 wiz 3007: <div class="procedure"><ol class="procedure" type="1">
1.79 snj 3008: <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 3009: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3010: category in which you want to place your package. You can also create a
3011: directory of your own (maybe called <code class="filename">local</code>). In that
3012: category directory, create another directory for your package and change
3013: into it.</p></li>
1.41 asau 3014: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3015: you for a URL. Enter the URL of the distribution file (in most cases a
3016: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3017: of your package are created automatically. The distribution file is
3018: extracted automatically to fill in some details in the
3019: <code class="filename">Makefile</code> that would otherwise have to be done
3020: manually.</p></li>
1.41 asau 3021: <li class="step">
1.1 dsieger 3022: <p>Examine the extracted files to determine the dependencies of
3023: your package. Ideally, this is mentioned in some
3024: <code class="filename">README</code> file, but things may differ. For each of
3025: these dependencies, look where it exists in pkgsrc, and if there is a
3026: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3027: line to your package <code class="filename">Makefile</code> which includes that
3028: file just before the last line. If the
1.25 spz 3029: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3030: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3031: <p>If you just need binaries from a package, add a
1.1 dsieger 3032: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3033: version of the dependency and where it can be found in pkgsrc. This line
3034: should be placed in the third paragraph. If the dependency is only
3035: needed for building the package, but not when using it, use
3036: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3037: Your package may then look like this:</p>
3038: <pre class="programlisting">
3039: [...]
3040:
1.66 asau 3041: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3042: DEPENDS+= screen-[0-9]*:../../misc/screen
3043: DEPENDS+= screen>=4.0:../../misc/screen
3044:
3045: [...]
3046:
3047: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3048: .include "../../devel/glib2/buildlink3.mk"
3049: .include "../../mk/bsd.pkg.mk"
3050: </pre>
3051: </li>
1.41 asau 3052: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3053: 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 3054: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3055: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3056: -e</strong></span>, which outputs additional
3057: explanations.</p></li>
1.41 asau 3058: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3059: 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 3060: over there, you can hopefully continue here.</p></li>
1.41 asau 3061: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3062: directory from the extracted files. Besides these files, a lot of cache
3063: files and other system information has been saved in the working
3064: directory, which may become wrong after you edited the
3065: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3066: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3067: 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 3068: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3069: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3070: everything works.</p></li>
1.41 asau 3071: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3072: contains a list of the files that are installed by the package, is
1.10 hubertf 3073: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3074: >PLIST</strong></span> to generate a probably correct list. Check
3075: the file using your preferred text editor to see if the list of
3076: files looks plausible.</p></li>
1.41 asau 3077: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3078: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3079: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3080: has been registered in the database of installed files, but with an
1.10 hubertf 3081: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3082: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3083: registered with the list of files from
3084: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3085: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3086: package from the set of installed files.</p></li>
3087: </ol></div>
1.41 asau 3088: <div class="sect1">
1.1 dsieger 3089: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3090: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3091: <div class="sect2">
1.1 dsieger 3092: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3093: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3094: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3095: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3096: </div>
1.41 asau 3097: <div class="sect2">
1.1 dsieger 3098: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 3099: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3100: <p>KDE3 applications should always include
1.1 dsieger 3101: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 asau 3102: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3103: </div>
1.41 asau 3104: <div class="sect2">
1.17 imil 3105: <div class="titlepage"><div><div><h3 class="title">
3106: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3107: <p>Python modules and programs packages are easily created using a
3108: set of predefined variables.</p>
3109: <p>
1.63 wiz 3110: If some Python versions are not supported by the software, set the
3111: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3112: that are not supported, e.g.
1.17 imil 3113: </p>
3114: <pre class="programlisting">
1.93 sevan 3115: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3116: </pre>
3117: <p>
1.103 wiz 3118: If the packaged software is a Python module, include one of
3119: <code class="filename">../../lang/python/egg.mk</code>,
3120: <code class="filename">../../lang/python/distutils.mk</code>, or
3121: <code class="filename">../../lang/python/extension.mk</code>.</p>
3122: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3123: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3124: if the packaged software is using setuptools, you only need
3125: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3126: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3127: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3128: so pkgsrc will use this framework.
3129: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3130: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3131: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3132: to the name of the script.</p>
3133: <p>Either way, the package directory should be called
1.23 wiz 3134: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3135: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3136: </p>
3137: <pre class="programlisting">
3138: DISTNAME= foopymodule-1.2.10
3139: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3140: </pre>
1.63 wiz 3141: <p>If it is an application, include
3142: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3143: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3144: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3145: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3146: For example:
1.17 imil 3147: </p>
3148: <pre class="programlisting">
1.35 wiz 3149: REPLACE_PYTHON= *.py
1.17 imil 3150: </pre>
1.63 wiz 3151: <p>Some Python modules have separate distributions for Python-2.x
3152: and Python-3.x support. In pkgsrc this is handled by the
3153: <code class="filename">versioned_dependencies.mk</code> file. Set
3154: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3155: packages that should be depended upon and include
3156: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3157: then the pkgsrc infrastructure will depend on the appropriate package
3158: version. For example:
3159: </p>
3160: <pre class="programlisting">
1.110 wiz 3161: PYTHON_VERSIONED_DEPENDENCIES=dateutil
1.63 wiz 3162: </pre>
3163: <p>
3164: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3165: of supported packages.</p>
1.17 imil 3166: </div>
1.1 dsieger 3167: </div>
1.41 asau 3168: <div class="sect1">
1.1 dsieger 3169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3170: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3171: <div class="sect2">
1.1 dsieger 3172: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3173: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3174: <div class="sect3">
1.1 dsieger 3175: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3176: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3177: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3178: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3179: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3180: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3181: <pre class="programlisting">
3182: <code class="prompt">$</code> mkdir www/nvu
3183: <code class="prompt">$</code> cd www/nvu
3184: </pre>
3185: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3186: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3187: <pre class="programlisting">
3188: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3189: </pre>
3190: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3191: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3192: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3193: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3194: <code class="varname">COMMENT</code> fields. Then the package
3195: <code class="filename">Makefile</code> looked like that:</p>
3196: <pre class="programlisting">
3197: # $NetBSD$
3198: #
3199:
3200: DISTNAME= nvu-1.0-sources
3201: PKGNAME= nvu-1.0
3202: CATEGORIES= www
3203: MASTER_SITES= http://cvs.nvu.com/download/
3204: EXTRACT_SUFX= .tar.bz2
3205:
3206: MAINTAINER= rillig@NetBSD.org
3207: HOMEPAGE= http://cvs.nvu.com/
3208: COMMENT= Web Authoring System
3209:
3210: # url2pkg-marker (please do not remove this line.)
3211: .include "../../mk/bsd.pkg.mk"
3212: </pre>
3213: <p>Then, I quit the editor and watched pkgsrc downloading a large
3214: source archive:</p>
3215: <pre class="programlisting">
3216: url2pkg> Running "make makesum" ...
3217: => Required installed package digest>=20010302: digest-20060826 found
3218: => Fetching nvu-1.0-sources.tar.bz2
3219: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3220: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3221: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3222: url2pkg> Running "make extract" ...
3223: => Required installed package digest>=20010302: digest-20060826 found
3224: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3225: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3226: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3227: ===> Installing dependencies for nvu-1.0
3228: ===> Overriding tools for nvu-1.0
3229: ===> Extracting for nvu-1.0
3230: url2pkg> Adjusting the Makefile.
3231:
3232: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3233:
3234: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3235: </pre>
3236: </div>
1.41 asau 3237: <div class="sect3">
1.1 dsieger 3238: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3239: <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 3240: <p>Now that the package has been extracted, let's see what's inside
3241: it. The package has a <code class="filename">README.txt</code>, but that only
3242: says something about mozilla, so it's probably useless for seeing what
3243: dependencies this package has. But since there is a GNU configure script
3244: in the package, let's hope that it will complain about everything it
3245: needs.</p>
3246: <pre class="programlisting">
3247: <code class="prompt">$</code> bmake
3248: => Required installed package digest>=20010302: digest-20060826 found
3249: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3250: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3251: ===> Patching for nvu-1.0
3252: ===> Creating toolchain wrappers for nvu-1.0
3253: ===> Configuring for nvu-1.0
3254: [...]
3255: configure: error: Perl 5.004 or higher is required.
3256: [...]
3257: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3258: [...]
3259: </pre>
3260: <p>That worked quite well. So I opened the package Makefile in my
3261: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3262: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3263: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3264: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3265: from scratch.</p>
3266: <pre class="programlisting">
3267: <code class="prompt">$</code> bmake clean
3268: ===> Cleaning for nvu-1.0
3269: <code class="prompt">$</code> bmake
3270: [...]
3271: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3272: GNU Make. You will not be able to build Mozilla without GNU Make.
3273: [...]
3274: </pre>
1.23 wiz 3275: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3276: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3277: <pre class="programlisting">
3278: [...]
3279: checking for GTK - version >= 1.2.0... no
3280: *** Could not run GTK test program, checking why...
3281: [...]
3282: </pre>
3283: <p>Now to the other dependencies. The first question is: Where is the
3284: GTK package hidden in pkgsrc?</p>
3285: <pre class="programlisting">
3286: <code class="prompt">$</code> echo ../../*/gtk*
3287: [many packages ...]
3288: <code class="prompt">$</code> echo ../../*/gtk
3289: ../../x11/gtk
3290: <code class="prompt">$</code> echo ../../*/gtk2
3291: ../../x11/gtk2
3292: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3293: ../../x11/gtk2/buildlink3.mk
3294: </pre>
3295: <p>The first try was definitely too broad. The second one had exactly
3296: one result, which is very good. But there is one pitfall with GNOME
3297: packages. Before GNOME 2 had been released, there were already many
3298: GNOME 1 packages in pkgsrc. To be able to continue to use these
3299: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3300: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3301: whether this was the case here, and indeed it was.</p>
3302: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3303: file, adding the dependency is very easy. I just inserted an
3304: <code class="literal">.include</code> line before the last line of the package
3305: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3306: <pre class="programlisting">
3307: [...]
3308: .include "../../x11/gtk2/buildlink3.mk"
3309: .include "../../mk/bsd.pkg.mk
3310: </pre>
1.10 hubertf 3311: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3312: was:</p>
3313: <pre class="programlisting">
3314: [...]
3315: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3316: checking for GTK - version >= 1.2.0... no
3317: *** Could not run GTK test program, checking why...
3318: *** The test program failed to compile or link. See the file config.log for the
3319: *** exact error that occured. This usually means GTK was incorrectly installed
3320: *** or that you have moved GTK since it was installed. In the latter case, you
3321: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3322: configure: error: Test for GTK failed.
3323: [...]
3324: </pre>
1.23 wiz 3325: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3326: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3327: told me that this package really wanted to have the GNOME 1 version of
3328: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3329: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3330: So I changed the <code class="literal">x11/gtk2</code> to
3331: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3332: and tried again.</p>
3333: <pre class="programlisting">
3334: [...]
1.59 jnemeth 3335: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3336: In file included from xpidl.c:42:
3337: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3338: In file included from xpidl.c:42:
3339: xpidl.h:132: error: parse error before "IDL_ns"
3340: [...]
3341: </pre>
3342: <p>The package still does not find all of its dependencies. Now the
3343: question is: Which package provides the
3344: <code class="filename">libIDL/IDL.h</code> header file?</p>
3345: <pre class="programlisting">
3346: <code class="prompt">$</code> echo ../../*/*idl*
3347: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3348: <code class="prompt">$</code> echo ../../*/*IDL*
3349: ../../net/libIDL
3350: </pre>
3351: <p>Let's take the one from the second try. So I included the
3352: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3353: again. But the error didn't change. After digging through some of the
3354: code, I concluded that the build process of the package was broken and
3355: couldn't have ever worked, but since the Mozilla source tree is quite
3356: large, I didn't want to fix it. So I added the following to the package
3357: <code class="filename">Makefile</code> and tried again:</p>
3358: <pre class="programlisting">
3359: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3360: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3361: </pre>
3362: <p>The latter line is needed because the package expects the library
3363: <code class="filename">libIDL.so</code>, but only
3364: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3365: wrapper to rewrite that on the fly.</p>
3366: <p>The next problem was related to a recent change of the FreeType
1.79 snj 3367: 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 3368: which patch files were relevant for this issue and copied them to the
3369: <code class="filename">patches</code> directory. Then I retried, fixed the
3370: patches so that they applied cleanly and retried again. This time,
3371: everything worked.</p>
3372: </div>
1.41 asau 3373: <div class="sect3">
1.1 dsieger 3374: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3375: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3376: <pre class="programlisting">
3377: <code class="prompt">$</code> bmake CHECK_FILES=no install
3378: [...]
3379: <code class="prompt">$</code> bmake print-PLIST >PLIST
3380: <code class="prompt">$</code> bmake deinstall
3381: <code class="prompt">$</code> bmake install
3382: </pre>
3383: </div>
3384: </div>
3385: </div>
3386: </div>
1.41 asau 3387: <div class="chapter">
1.1 dsieger 3388: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3389: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3390: <div class="toc">
3391: <p><b>Table of Contents</b></p>
1.100 leot 3392: <dl class="toc">
1.23 wiz 3393: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3394: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 3395: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3396: <dd><dl>
3397: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3398: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3399: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3400: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3401: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3402: </dl></dd>
3403: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3404: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3405: <dd><dl>
3406: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3407: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3408: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3409: </dl></dd>
1.23 wiz 3410: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3411: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3412: </dl>
3413: </div>
3414: <p>Whenever you're preparing a package, there are a number of
3415: files involved which are described in the following
3416: sections.</p>
1.41 asau 3417: <div class="sect1">
1.1 dsieger 3418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3419: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3420: </h2></div></div></div>
3421: <p>Building, installation and creation of a binary package are all
3422: controlled by the package's <code class="filename">Makefile</code>.
3423: The <code class="filename">Makefile</code> describes various things about
3424: a package, for example from where to get it, how to configure,
3425: build, and install it.</p>
3426: <p>A package <code class="filename">Makefile</code> contains several
3427: sections that describe the package.</p>
3428: <p>In the first section there are the following variables, which
3429: should appear exactly in the order given here. The order and
3430: grouping of the variables is mostly historical and has no further
3431: meaning.</p>
1.41 asau 3432: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3433: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3434: distribution file to be downloaded from the package's
3435: website.</p></li>
1.23 wiz 3436: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3437: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3438: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3439: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3440: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3441: directory name together with the version number. It must match the
3442: regular expression
3443: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3444: starts with a letter or digit, and contains only letters, digits,
3445: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3446: <li class="listitem">
1.1 dsieger 3447: <p><code class="varname">CATEGORIES</code> is a list of categories
3448: which the package fits in. You can choose any of the top-level
3449: directories of pkgsrc for it.</p>
3450: <p>Currently the following values are available for
3451: <code class="varname">CATEGORIES</code>. If more than
3452: one is used, they need to be separated by spaces:</p>
3453: <pre class="programlisting">
3454: archivers cross geography meta-pkgs security
3455: audio databases graphics misc shells
3456: benchmarks devel ham multimedia sysutils
3457: biology editors inputmethod net textproc
3458: cad emulators lang news time
3459: chat finance mail parallel wm
3460: comms fonts math pkgtools www
3461: converters games mbone print x11
3462: </pre>
3463: </li>
1.23 wiz 3464: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3465: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3466: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3467: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 3468: <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 3469: </ul></div>
3470: <p>The second section contains information about separately
3471: downloaded patches, if any.
3472: </p>
1.41 asau 3473: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3474: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3475: Name(s) of additional files that contain distribution patches.
3476: There is no default. pkgsrc will look for them at
3477: <code class="varname">PATCH_SITES</code>.
3478: They will automatically be uncompressed before patching if
3479: the names end with <code class="filename">.gz</code> or
3480: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3481: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3482: Primary location(s) for distribution patch files (see
1.80 wiz 3483: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3484: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
3485: 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
3486: help find the correct files to patch. It defaults to
3487: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3488: </ul></div>
3489: <p>The third section contains the following variables.
3490: </p>
1.41 asau 3491: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3492: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3493: address of the person who feels responsible for this package,
3494: and who is most likely to look at problems or questions regarding
1.79 snj 3495: 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 3496: Other developers may contact the <code class="varname">MAINTAINER</code>
3497: before making changes to the package, but are not required to
3498: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3499: to yourself. If you really can't maintain the package for future
3500: updates, set it to
1.10 hubertf 3501: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3502: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3503: of <code class="varname">MAINTAINER</code> when you do not want other
3504: developers to update or change the package without contacting
3505: you first. A package Makefile should contain one of
3506: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3507: not both. </p></li>
1.23 wiz 3508: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3509: find more information about the package.</p></li>
1.23 wiz 3510: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3511: description of the package (should not include the package
3512: name).</p></li>
3513: </ul></div>
3514: <p>Other variables that affect the build:
3515: </p>
1.41 asau 3516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3517: <p><code class="varname">WRKSRC</code>: The directory where the
3518: interesting distribution files of the package are found. The
3519: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3520: works for most packages.</p>
3521: <p>If a package doesn't create a subdirectory for itself
3522: (most GNU software does, for instance), but extracts itself in
3523: the current directory, you should set
3524: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3525: <p>If a package doesn't create a subdirectory with the
3526: name of <code class="varname">DISTNAME</code> but some different name,
3527: set <code class="varname">WRKSRC</code> to point to the proper name in
3528: <code class="filename">${WRKDIR}</code>, for example
3529: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.79 snj 3530: <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 3531: <p>The name of the working directory created by pkgsrc is
3532: taken from the <code class="varname">WRKDIR_BASENAME</code>
3533: variable. By default, its value is
3534: <code class="filename">work</code>. If you want to use the same
3535: pkgsrc tree for building different kinds of binary packages,
3536: you can change the variable according to your needs. Two
3537: other variables handle common cases of setting
3538: <code class="varname">WRKDIR_BASENAME</code> individually. If
3539: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3540: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3541: the host's name is attached to the directory name. If
3542: <code class="varname">OBJMACHINE</code> is defined, the platform name
3543: is attached, which might look like
3544: <code class="filename">work.i386</code> or
3545: <code class="filename">work.sparc</code>.</p>
3546: </li></ul></div>
3547: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3548: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3549: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3550: installed in compressed form by the package. For packages using
3551: BSD-style makefiles which honor MANZ, there is
3552: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3553: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3554: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3555: below).</p></li>
1.23 wiz 3556: <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 3557: </ul></div>
3558: </div>
1.41 asau 3559: <div class="sect1">
1.1 dsieger 3560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3561: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 3562: </h2></div></div></div>
3563: <p>The <code class="filename">distinfo</code> file contains the message
3564: digest, or checksum, of each distfile needed for the package. This
3565: ensures that the distfiles retrieved from the Internet have not been
3566: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3567: a security hole. To provide maximum security, all distfiles are
3568: protected using three different message digest algorithms (SHA1,
3569: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3570: <p>The <code class="filename">distinfo</code> file also contains the
3571: checksums for all the patches found in the
1.108 rillig 3572: <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 3573: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3574: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3575: <p>Some packages have different sets of distfiles depending on
1.79 snj 3576: 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 3577: <code class="filename">distinfo</code> file and care should be taken when
3578: upgrading such a package to ensure distfile information is not
3579: lost.</p>
3580: </div>
1.41 asau 3581: <div class="sect1">
1.1 dsieger 3582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 3583: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
3584: </h2></div></div></div>
3585: <p>Some packages don't work out-of-the box on the various
3586: platforms that are supported by pkgsrc. These packages need
3587: to be patched to make them work. The patch files can be
1.1 dsieger 3588: found in the <code class="filename">patches/</code> directory.</p>
3589: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3590: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3591: extracting them, in alphabetic order.</p>
1.41 asau 3592: <div class="sect2">
1.1 dsieger 3593: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3594: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3595: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3596: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3597: problems. (To force patches to apply with fuzz you can set
3598: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3599: should contain only changes for a single file, and no file should be
3600: patched by more than one patch file. This helps to keep future
3601: modifications simple.</p>
3602: <p>Each patch file is structured as follows: In the first line,
3603: there is the RCS Id of the patch itself. The second line should be
3604: empty for aesthetic reasons. After that, there should be a comment for
3605: each change that the patch does. There are a number of standard
3606: cases:</p>
1.41 asau 3607: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3608: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3609: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3610: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3611: platform and other environment (for example, the compiler) that the
3612: patch is needed for.</p></li>
3613: </ul></div>
1.108 rillig 3614: <p>The patch should be commented so that any
1.1 dsieger 3615: developer who knows the code of the application can make some use of
3616: the patch. Special care should be taken for the upstream developers,
3617: since we generally want that they accept our patches, so we have less
3618: work in the future.</p>
3619: </div>
1.41 asau 3620: <div class="sect2">
1.1 dsieger 3621: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3622: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3623: <p>One important thing to mention is to pay attention that no RCS
3624: IDs get stored in the patch files, as these will cause problems when
3625: later checked into the NetBSD CVS tree. Use the
1.79 snj 3626: <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 3627: problems.</p>
3628: <p>For even more automation, we recommend using
1.10 hubertf 3629: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3630: whole set of patches. You just have to backup files before you
3631: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3632: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3633: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3634: you upgrade a package this way, you can easily compare the new
3635: set of patches with the previously existing one with
1.24 wiz 3636: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3637: are replaced by new files, so carefully check if you want to take all
3638: the changes.</p>
1.1 dsieger 3639: <p>When you have finished a package, remember to generate
1.10 hubertf 3640: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 3641: 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 3642: <p>When adding a patch that corrects a problem in the
3643: distfile (rather than e.g. enforcing pkgsrc's view of where
3644: man pages should go), send the patch as a bug report to the
3645: maintainer. This benefits non-pkgsrc users of the package,
3646: and usually makes it possible to remove the patch in future
3647: version.</p>
1.2 rillig 3648: <p>The file names of the patch files are usually of the form
1.24 wiz 3649: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3650: Many packages still use the previous convention
3651: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3652: but new patches should be of the form containing the filename.
1.79 snj 3653: <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 3654: automatically.</p>
1.1 dsieger 3655: </div>
1.41 asau 3656: <div class="sect2">
1.1 dsieger 3657: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3658: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3659: <p>If you want to share patches between multiple packages
3660: in pkgsrc, e.g. because they use the same distfiles, set
3661: <code class="varname">PATCHDIR</code> to the path where the patch files
3662: can be found, e.g.:</p>
3663: <pre class="programlisting">
3664: PATCHDIR= ${.CURDIR}/../xemacs/patches
3665: </pre>
3666: <p>Patch files that are distributed by the author or other
3667: maintainers can be listed in
3668: <code class="varname">PATCHFILES</code>.</p>
3669: <p>If it is desired to store any patches that should not be
3670: committed into pkgsrc, they can be kept outside the pkgsrc
3671: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3672: directory tree there is expected to have the same
1.23 wiz 3673: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3674: patches are expected to be stored inside these dirs (also
3675: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3676: example, if you want to keep a private patch for
3677: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3678: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3679: files in the named directory are expected to be patch files,
3680: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3681: applied</em></span>.</p>
3682: </div>
1.41 asau 3683: <div class="sect2">
1.1 dsieger 3684: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3685: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3686: <p>When fixing a portability issue in the code do not use
3687: preprocessor magic to check for the current operating system nor
3688: platform. Doing so hurts portability to other platforms because
3689: the OS-specific details are not abstracted appropriately.</p>
3690: <p>The general rule to follow is: instead of checking for the
3691: operating system the application is being built on, check for the
3692: specific <span class="emphasis"><em>features</em></span> you need. For example,
3693: instead of assuming that kqueue is available under NetBSD and
3694: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3695: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3696: yes, this generally involves patching the
1.10 hubertf 3697: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3698: that prevents some OSes from adopting interfaces from other OSes
3699: (e.g. Linux implementing kqueue), something that the above checks
3700: cannot take into account.</p>
3701: <p>Of course, checking for features generally involves more
3702: work on the developer's side, but the resulting changes are
3703: cleaner and there are chances they will work on many other
3704: platforms. Not to mention that there are higher chances of being
3705: later integrated into the mainstream sources. Remember:
3706: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3707: <p>Some typical examples:</p>
3708: <div class="table">
1.6 rillig 3709: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.106 tnn 3710: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3711: <colgroup>
3712: <col>
3713: <col>
3714: <col>
3715: </colgroup>
3716: <thead><tr>
3717: <th>Where</th>
3718: <th>Incorrect</th>
3719: <th>Correct</th>
3720: </tr></thead>
3721: <tbody>
3722: <tr>
3723: <td>configure script</td>
3724: <td>
3725: <pre class="programlisting">
3726: case ${target_os} in
3727: netbsd*) have_kvm=yes ;;
3728: *) have_kvm=no ;;
3729: esac
3730: </pre>
3731: </td>
3732: <td>
3733: <pre class="programlisting">
3734: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3735: </pre>
3736: </td>
3737: </tr>
3738: <tr>
3739: <td>C source file</td>
3740: <td>
3741: <pre class="programlisting">
3742: #if defined(__NetBSD__)
3743: # include <sys/event.h>
3744: #endif
3745: </pre>
3746: </td>
3747: <td>
3748: <pre class="programlisting">
3749: #if defined(HAVE_SYS_EVENT_H)
3750: # include <sys/event.h>
3751: #endif
3752: </pre>
3753: </td>
3754: </tr>
3755: <tr>
3756: <td>C source file</td>
3757: <td>
3758: <pre class="programlisting">
3759: int
3760: monitor_file(...)
3761: {
3762: #if defined(__NetBSD__)
3763: int fd = kqueue();
3764: ...
3765: #else
3766: ...
3767: #endif
3768: }
3769: </pre>
3770: </td>
3771: <td>
3772: <pre class="programlisting">
3773: int
3774: monitor_file(...)
3775: {
3776: #if defined(HAVE_KQUEUE)
3777: int fd = kqueue();
3778: ...
3779: #else
1.112 ! rillig 3780: ...
1.1 dsieger 3781: #endif
3782: }
3783: </pre>
3784: </td>
3785: </tr>
3786: </tbody>
3787: </table></div>
3788: </div>
3789: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 3790: 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
3791: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 3792: 2</a>). It summarizes multiple details on how to make
3793: software easier to package; all the suggestions in it were
3794: collected from our experience in pkgsrc work, so they are possibly
3795: helpful when creating patches too.</p>
3796: </div>
1.41 asau 3797: <div class="sect2">
1.1 dsieger 3798: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3799: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3800: <p>Always, always, <span class="strong"><strong>always</strong></span>
3801: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3802: improvements you do to a package to the mainstream developers.
3803: This is the only way to get their attention on portability issues
3804: and to ensure that future versions can be built out-of-the box on
3805: NetBSD. Furthermore, any user that gets newer distfiles will get
3806: the fixes straight from the packaged code.</p>
3807: <p>This generally involves cleaning up the patches
3808: (because sometimes the patches that are
1.40 wiz 3809: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3810: appropriate trackers for the projects and working with the
3811: mainstream authors to accept your changes. It is
3812: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3813: the packages in pkgsrc are kept simple and thus further changes
3814: can be done without much hassle.</p>
1.24 wiz 3815: <p>When you have done this, please add a URL to the upstream
3816: bug report to the patch comment.</p>
1.1 dsieger 3817: <p>Support the idea of free software!</p>
3818: </div>
3819: </div>
1.41 asau 3820: <div class="sect1">
1.1 dsieger 3821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3822: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 3823: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3824: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3825: <dd><p>A multi-line description of the piece of software. This should include
3826: any credits where they are due. Please bear in mind that others do not
3827: share your sense of humour (or spelling idiosyncrasies), and that others
3828: will read everything that you write here.</p></dd>
3829: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3830: <dd><p>This file governs the files that are installed on your
3831: system: all the binaries, manual pages, etc. There are other
3832: directives which may be entered in this file, to control the
3833: creation and deletion of directories, and the location of
1.10 hubertf 3834: 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 3835: information.</p></dd>
3836: </dl></div>
3837: </div>
1.41 asau 3838: <div class="sect1">
1.1 dsieger 3839: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3840: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 3841: <div class="sect2">
1.1 dsieger 3842: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3843: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 3844: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3845: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 3846: <dd>
1.79 snj 3847: <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 3848: First time after package extraction and before files are
3849: moved in place, the second time after the files to install
3850: are moved in place. This can be used to do any custom
3851: procedures not possible with @exec commands in
1.79 snj 3852: <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
3853: <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 3854: Please note that you can modify variables in it easily by using
3855: <code class="varname">FILES_SUBST</code> in the package's
3856: <code class="filename">Makefile</code>:</p>
3857: <pre class="programlisting">
3858: FILES_SUBST+= SOMEVAR="somevalue"
3859: </pre>
3860: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3861: <code class="filename">INSTALL</code>. By default, substitution is
3862: performed for <code class="varname">PREFIX</code>,
3863: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3864: <code class="varname">VARBASE</code>, and a few others, type
3865: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3866: complete list.</p>
3867: </dd>
1.1 dsieger 3868: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3869: <dd><p>This script is executed before and after any files are removed. It is
3870: this script's responsibility to clean up any additional messy details
3871: around the package's installation, since all pkg_delete knows is how to
3872: delete the files created in the original distribution.
1.79 snj 3873: 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>
3874: 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 3875: The same methods to replace variables can be used as for
3876: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 3877: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3878: <dd>
3879: <p>This file is displayed after installation of the package.
3880: Useful for things like legal notices on almost-free
3881: software and hints for updating config files after
3882: installing modules for apache, PHP etc.
3883: Please note that you can modify variables in it easily by using
3884: <code class="varname">MESSAGE_SUBST</code> in the package's
3885: <code class="filename">Makefile</code>:</p>
3886: <pre class="programlisting">
3887: MESSAGE_SUBST+= SOMEVAR="somevalue"
3888: </pre>
1.23 wiz 3889: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 3890: <code class="filename">MESSAGE</code>. By default, substitution is
3891: performed for <code class="varname">PKGNAME</code>,
3892: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 3893: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 3894: <code class="varname">PKG_SYSCONFDIR</code>,
3895: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 3896: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 3897: <p>You can display a different or additional files by
3898: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3899: default is <code class="filename">MESSAGE</code>, if the file
3900: exists.</p>
3901: </dd>
3902: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 3903: <dd>
3904: <p>This file is used by the alternatives framework.
3905: It creates, configures, and destroys generic wrappers used to
3906: run programs with similar interfaces.
3907: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3908: for more information.</p>
3909: <p>Each line of the file contains two filenames, first
3910: the wrapper and then the alternative provided by the package.
3911: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3912: </dd>
1.1 dsieger 3913: </dl></div>
3914: </div>
1.41 asau 3915: <div class="sect2">
1.1 dsieger 3916: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3917: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 3918: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3919: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3920: <dd><p>This file contains arbitrary things that could
3921: also go into a <code class="filename">Makefile</code>, but its purpose is
3922: to be used by more than one package. This file should only be
3923: used when the packages that will use the file are known in
3924: advance. For other purposes it is often better to write a
3925: <code class="filename">*.mk</code> file and give it a good name that
3926: describes what it does.</p></dd>
3927: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3928: <dd><p>This file contains the dependency information
1.10 hubertf 3929: 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 3930: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3931: <dd><p>This file contains workarounds for compiler bugs
3932: and similar things. It is included automatically by the pkgsrc
3933: infrastructure, so you don't need an extra
3934: <code class="literal">.include</code> line for
3935: it.</p></dd>
3936: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3937: <dd><p>This file contains the code for the
1.10 hubertf 3938: 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 3939: selected by the user. If a package has only one or two options,
3940: it is equally acceptable to put the code directly into the
3941: <code class="filename">Makefile</code>.</p></dd>
3942: </dl></div>
3943: </div>
1.41 asau 3944: <div class="sect2">
1.1 dsieger 3945: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3946: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 3947: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3948: <dt><span class="term"><code class="filename">README*</code></span></dt>
3949: <dd><p>These files do not take place in the creation of
3950: a package and thus are purely informative to the package
3951: developer.</p></dd>
3952: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3953: <dd><p>This file contains things that need to be done
3954: to make the package even
3955: better.</p></dd>
3956: </dl></div>
3957: </div>
3958: </div>
1.41 asau 3959: <div class="sect1">
1.1 dsieger 3960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3961: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 3962: </h2></div></div></div>
1.10 hubertf 3963: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 3964: unpacked into the directory denoted by
3965: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 3966: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 3967: directory is also used to keep various timestamp files.
3968: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3969: The default is <code class="filename">${.CURDIR}/work</code>
3970: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3971: if <code class="varname">OBJMACHINE</code> is set.</p>
3972: </div>
1.41 asau 3973: <div class="sect1">
1.1 dsieger 3974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3975: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 3976: </h2></div></div></div>
3977: <p>If you have any files that you wish to be placed in the package prior
3978: to configuration or building, you could place these files here and use
1.10 hubertf 3979: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 3980: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 3981: this. Alternatively, you could simply diff the file against
3982: <code class="filename">/dev/null</code> and use the patch mechanism to manage
3983: the creation of this file.</p>
3984: <p>If you want to share files in this way with other
3985: packages, set the <code class="varname">FILESDIR</code> variable to point
3986: to the other package's <code class="filename">files</code> directory,
3987: e.g.:</p>
3988: <pre class="programlisting">
3989: FILESDIR=${.CURDIR}/../xemacs/files
3990: </pre>
3991: </div>
3992: </div>
1.41 asau 3993: <div class="chapter">
1.1 dsieger 3994: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3995: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 3996: <div class="toc">
3997: <p><b>Table of Contents</b></p>
1.100 leot 3998: <dl class="toc">
1.6 rillig 3999: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4000: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4001: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4002: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4003: <dd><dl>
4004: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 4005: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
4006: <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>
4007: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4008: </dl></dd>
4009: </dl>
4010: </div>
4011: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4012: each of which forms a well-defined part of the pkgsrc system. Using
1.79 snj 4013: 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 4014: like pkgsrc requires some discipline to keep the code correct and
4015: understandable.</p>
4016: <p>The basic ingredients for <code class="filename">Makefile</code>
4017: programming are variables (which are actually macros) and shell
4018: commands. Among these shell commands may even be more complex ones
1.79 snj 4019: 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 4020: as intended it is necessary to quote all variables correctly when they
4021: are used.</p>
4022: <p>This chapter describes some patterns, that appear quite often in
4023: <code class="filename">Makefile</code>s, including the pitfalls that come along
4024: with them.</p>
1.41 asau 4025: <div class="sect1">
1.1 dsieger 4026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4027: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4028: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4029: <p>When you are creating a file as a
4030: target of a rule, always write the data to a temporary file first
4031: and finally rename that file. Otherwise there might occur an error
4032: in the middle of generating the file, and when the user runs
1.79 snj 4033: <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 4034: regenerated properly. Example:</p>
4035: <pre class="programlisting">
4036: wrong:
4037: @echo "line 1" > ${.TARGET}
4038: @echo "line 2" >> ${.TARGET}
4039: @false
4040:
4041: correct:
4042: @echo "line 1" > ${.TARGET}.tmp
4043: @echo "line 2" >> ${.TARGET}.tmp
4044: @false
4045: @mv ${.TARGET}.tmp ${.TARGET}
4046: </pre>
1.10 hubertf 4047: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4048: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4049: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4050: correct</strong></span> gives an error message twice, as expected.</p>
1.79 snj 4051: <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 4052: <code class="literal">${.TARGET}</code> in case of error, but this only
4053: happens when it is interrupted, for example by pressing
4054: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.79 snj 4055: 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 4056: </li></ul></div>
4057: </div>
1.41 asau 4058: <div class="sect1">
1.1 dsieger 4059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4060: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4061: <p><code class="filename">Makefile</code> variables contain strings that
4062: can be processed using the five operators ``='', ``+='', ``?='',
1.79 snj 4063: ``:='', 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 4064: page.</p>
4065: <p>When a variable's value is parsed from a
4066: <code class="filename">Makefile</code>, the hash character ``#'' and the
4067: backslash character ``\'' are handled specially. If a backslash is
4068: followed by a newline, any whitespace immediately in front of the
4069: backslash, the backslash, the newline, and any whitespace
4070: immediately behind the newline are replaced with a single space. A
4071: backslash character and an immediately following hash character are
4072: replaced with a single hash character. Otherwise, the backslash is
4073: passed as is. In a variable assignment, any hash character that is
4074: not preceded by a backslash starts a comment that continues upto the
4075: end of the logical line.</p>
1.108 rillig 4076: <p>The evaluation of variables either happens immediately or lazy.
4077: It happens immediately when the variable occurs
4078: on the right-hand side of the ``:='' or the ``!='' operator, in a
4079: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4080: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4081: <p>Some of the modifiers split the string into words and then
4082: operate on the words, others operate on the string as a whole. When
1.108 rillig 4083: 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 4084: <p>There are several types of variables that should be handled
4085: differently. Strings and two types of lists.</p>
1.41 asau 4086: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4087: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4088: characters. Nevertheless, you should restrict yourself to only
4089: using printable characters. Examples are
4090: <code class="varname">PREFIX</code> and
4091: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4092: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4093: are never exported to any shell command. Their elements are
4094: separated by whitespace. Therefore, the elements themselves cannot
4095: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4096: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4097: Examples are <code class="varname">DEPENDS</code> and
4098: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4099: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4100: may be exported to a shell command. Their elements can contain any
4101: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4102: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4103: <code class="varname">DISTFILES</code> and
4104: <code class="varname">MASTER_SITES</code>.</p></li>
4105: </ul></div>
1.41 asau 4106: <div class="sect2">
1.1 dsieger 4107: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4108: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4109: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4110: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4111: are reserved for use by the pkgsrc infrastructure. They shall
4112: not be used by package
4113: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4114: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4115: lowercase variable names for the iteration
4116: variables.</p></li>
1.23 wiz 4117: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4118: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4119: <code class="varname">DISTFILES</code>.</p></li>
4120: </ul></div>
4121: </div>
4122: </div>
1.41 asau 4123: <div class="sect1">
1.1 dsieger 4124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4125: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.41 asau 4126: <div class="sect2">
1.1 dsieger 4127: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4128: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4129: <p>When adding a string that possibly contains whitespace or quotes to
4130: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4131: modifier.</p>
4132: <p>When adding another list to a list (example 2), it must not be
4133: quoted, since its elements are already quoted.</p>
1.1 dsieger 4134: <pre class="programlisting">
1.108 rillig 4135: STRING= foo * bar `date`
4136: LIST= # empty
4137: ANOTHER_LIST= a=b c=d
4138:
4139: LIST+= ${STRING:Q} # 1
4140: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4141: </pre>
4142: </div>
1.41 asau 4143: <div class="sect2">
1.1 dsieger 4144: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4145: <a name="echo-literal"></a>12.3.2. Echoing a string exacty as-is</h3></div></div></div>
4146: <p>Echoing a string containing special characters needs special
4147: work.</p>
1.1 dsieger 4148: <pre class="programlisting">
4149: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4150: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4151:
4152: all:
4153: echo ${STRING} # 1
1.108 rillig 4154: echo ${STRING:Q} # 2
4155: printf '%s\n' ${STRING:Q}'' # 3
4156: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4157: </pre>
4158: <p>Example 1 leads to a syntax error in the shell, as the characters
4159: are just copied.</p>
4160: <p>Example 2 quotes the string so that the shell interprets it
4161: correctly. But the echo command may additionally interpret strings with a
4162: leading dash or those containing backslashes.</p>
4163: <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
4164: interprets the format string, but not the next argument.</p>
4165: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4166: need to be quoted because the quoting has already been done
4167: when adding elements to the list.</p>
1.1 dsieger 4168: </div>
1.41 asau 4169: <div class="sect2">
1.1 dsieger 4170: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4171: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4172: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4173: GNU-style configure script (especially those that call other configure
4174: scripts), it must not have leading or trailing whitespace, since
4175: otherwise the configure script gets confused. To trim leading and
4176: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4177: following example:</p>
1.1 dsieger 4178: <pre class="programlisting">
4179: CPPFLAGS= # empty
1.108 rillig 4180: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4181: CPPFLAGS+= ${MY_CPPFLAGS}
4182:
4183: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4184:
4185: all:
4186: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4187: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4188: </pre>
1.108 rillig 4189: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4190: trailing whitespace because the <code class="code">+=</code> operator always adds a
4191: space.</p>
4192: </div>
4193: <div class="sect2">
4194: <div class="titlepage"><div><div><h3 class="title">
4195: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4196: <p>When a possibly empty variable is used in a shell program, it may
4197: lead to a syntax error.</p>
4198: <pre class="programlisting">
4199: EGFILES= # empty
4200:
4201: install-examples: # produces a syntax error in the shell
4202: for egfile in ${EGFILES}; do \
4203: echo "Installing $$egfile"; \
4204: done
4205: </pre>
4206: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
4207: <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>.
4208: To fix this syntax error, use one of the snippets below.</p>
4209: <pre class="programlisting">
4210: EMPTY= # empty
4211:
4212: install-examples:
4213: for egfile in ${EGFILES} ""; do \
4214: [ -n "$$egfile" ] || continue; \
4215: echo "Installing $$egfile"; \
1.1 dsieger 4216: done
1.108 rillig 4217: </pre>
4218: <p>In this case, an empty string is appended to the iteration list (to
4219: prevent the syntax error) and filtered out later.</p>
4220: <pre class="programlisting">
4221: EGFILES= # empty
1.1 dsieger 4222:
1.108 rillig 4223: install-examples:
4224: .for egfile in ${EGFILES}
4225: echo "Installing ${egfile}"
1.1 dsieger 4226: .endfor
4227: </pre>
1.108 rillig 4228: <p>This variant only works when <code class="varname">EGFILES</code> does not
4229: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4230: simple whitespace.</p>
4231: <p>To have a shell command test whether a make variable is empty, use
4232: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4233: </div>
4234: </div>
4235: </div>
1.41 asau 4236: <div class="chapter">
1.1 dsieger 4237: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4238: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4239: <div class="toc">
4240: <p><b>Table of Contents</b></p>
1.100 leot 4241: <dl class="toc">
1.6 rillig 4242: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4243: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4244: <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 4245: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4246: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4247: <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 4248: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4249: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4250: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4251: </dl>
4252: </div>
4253: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4254: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4255: the package (relative to the <code class="filename">${PREFIX}</code>
4256: directory it's been installed in) plus some additional statements
1.79 snj 4257: - 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 4258: This chapter addresses some issues that need attention when
4259: dealing with the <code class="filename">PLIST</code> file (or files, see
4260: below!).</p>
1.41 asau 4261: <div class="sect1">
1.1 dsieger 4262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4263: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4264: <p>Be sure to add a RCS ID line as the first thing in any
4265: <code class="filename">PLIST</code> file you write:</p>
4266: <pre class="programlisting">
4267: @comment $NetBSD$
1.111 sevan 4268: </pre>
1.1 dsieger 4269: </div>
1.41 asau 4270: <div class="sect1">
1.1 dsieger 4271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4272: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4273: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4274: to output a PLIST that matches any new files since the package
1.10 hubertf 4275: 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 4276: more information on this target.</p>
4277: </div>
1.41 asau 4278: <div class="sect1">
1.1 dsieger 4279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4280: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4281: </h2></div></div></div>
4282: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4283: of AWK patterns and actions that are used to filter the output of
4284: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4285: scripting you like to it, but be careful with quoting.</p>
4286: <p>For example, to get all files inside the
4287: <code class="filename">libdata/foo</code> directory removed from the
4288: resulting PLIST:</p>
4289: <pre class="programlisting">
4290: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4291: </pre>
1.1 dsieger 4292: </div>
1.41 asau 4293: <div class="sect1">
1.1 dsieger 4294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4295: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4296: <p>A number of variables are substituted automatically in
4297: PLISTs when a package is installed on a system. This includes the
4298: following variables:</p>
1.41 asau 4299: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4300: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4301: <dd>
4302: <p>Some packages like emacs and perl embed information
4303: about which architecture they were built on into the
4304: pathnames where they install their files. To handle this
4305: case, PLIST will be preprocessed before actually used, and
4306: the symbol
1.23 wiz 4307: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4308: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4309: same is done if the string
4310: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4311: PLIST somewhere - use this on packages that have GNU
4312: autoconf-created configure scripts.</p>
1.41 asau 4313: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4314: <h3 class="title">Legacy note</h3>
4315: <p>There used to be a symbol
1.23 wiz 4316: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4317: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4318: -m</strong></span>, but that's no longer supported and has
4319: been removed.</p>
4320: </div>
4321: </dd>
4322: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4323: <dd>
4324: <p>Some packages want to embed the OS name and version
4325: into some paths. To do this, use these variables in the
4326: <code class="filename">PLIST</code>:
4327: </p>
1.41 asau 4328: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4329: <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>
4330: <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>
4331: <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 4332: </ul></div>
4333: </dd>
4334: </dl></div>
1.88 tnn 4335: <p>For a list of values which are replaced by
4336: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4337: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4338: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4339: <p>If you want to change other variables not listed above, you
4340: can add variables and their expansions to this variable in the
1.10 hubertf 4341: 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 4342: <pre class="programlisting">
4343: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4344: </pre>
1.23 wiz 4345: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4346: in the <code class="filename">PLIST</code> with
1.23 wiz 4347: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4348: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4349: the common case of conditionally including some
4350: <code class="filename">PLIST</code> entries. It can be done by adding
4351: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4352: setting the corresponding <code class="varname">PLIST.foo</code> variable
4353: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4354: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4355: in the <code class="filename">PLIST</code> with either
1.23 wiz 4356: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4357: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4358: For example, in <code class="filename">Makefile</code>:</p>
4359: <pre class="programlisting">
1.112 ! rillig 4360: PLIST_VARS+= foo
1.18 snj 4361: .if <em class="replaceable"><code>condition</code></em>
1.112 ! rillig 4362: PLIST.foo= yes
1.18 snj 4363: .else
1.111 sevan 4364: </pre>
1.18 snj 4365: <p>And then in <code class="filename">PLIST</code>:</p>
4366: <pre class="programlisting">
4367: @comment $NetBSD$
4368: bin/bar
4369: man/man1/bar.1
4370: ${PLIST.foo}bin/foo
4371: ${PLIST.foo}man/man1/foo.1
4372: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4373: </pre>
1.1 dsieger 4374: </div>
1.41 asau 4375: <div class="sect1">
1.1 dsieger 4376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4377: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 4378: <p>Man pages should be installed in compressed form if
4379: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4380: and uncompressed otherwise. To handle this in the
1.23 wiz 4381: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4382: appended/removed automatically for man pages according to
4383: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4384: or not, see above for details. This modification of the
4385: <code class="filename">PLIST</code> file is done on a copy of it, not
4386: <code class="filename">PLIST</code> itself.</p>
4387: </div>
1.41 asau 4388: <div class="sect1">
1.1 dsieger 4389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4390: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4391: </h2></div></div></div>
4392: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4393: in generating the binary package, set the variable
4394: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.79 snj 4395: 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 4396: important. The default for <code class="varname">PLIST_SRC</code> is
4397: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4398: </div>
1.41 asau 4399: <div class="sect1">
1.1 dsieger 4400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4401: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4402: <p>Some packages decide to install a different set of files based on
4403: the operating system being used. These differences can be
4404: automatically handled by using the following files:</p>
1.41 asau 4405: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4406: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4407: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4408: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4409: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4410: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4411: </ul></div>
4412: </div>
1.41 asau 4413: <div class="sect1">
1.1 dsieger 4414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 4415: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4416: <p>Some packages decide to generate hard-to-guess file names
4417: during installation that are hard to wire down.</p>
4418: <p>In such cases, you can set the
4419: <code class="varname">GENERATE_PLIST</code> variable to shell code
4420: terminated (with a semicolon) that will output PLIST entries which
4421: will be appended to the PLIST</p>
4422: <p>You can find one example in editors/xemacs:</p>
4423: <pre class="programlisting">
1.111 sevan 4424: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4425: </pre>
1.86 wiz 4426: <p>which will append something like
4427: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4428: <code class="filename">PLIST</code>.
4429: </p>
4430: </div>
4431: <div class="sect1">
4432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4433: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4434: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4435: multiple (and unrelated) packages install files. These
1.22 jakllsch 4436: directories were problematic because you had to add special
4437: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4438: centralized package handle them.</p>
1.22 jakllsch 4439: <p>In pkgsrc, it is now easy: Each package should create
4440: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4441: will remove any directories left empty after uninstalling a
4442: package.</p>
4443: <p>If a package needs an empty directory to work, create
4444: the directory during installation as usual, and also add an
4445: entry to the PLIST:
1.111 sevan 4446:
4447: </p>
1.1 dsieger 4448: <pre class="programlisting">
1.22 jakllsch 4449: @pkgdir path/to/empty/directory
1.111 sevan 4450: </pre>
1.22 jakllsch 4451: <p>
1.111 sevan 4452:
1.86 wiz 4453: or take a look at <code class="varname">MAKE_DIRS</code> and
4454: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4455: </p>
1.1 dsieger 4456: </div>
4457: </div>
1.41 asau 4458: <div class="chapter">
1.1 dsieger 4459: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4460: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4461: <div class="toc">
4462: <p><b>Table of Contents</b></p>
1.100 leot 4463: <dl class="toc">
1.6 rillig 4464: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 4465: <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 4466: <dd><dl>
1.6 rillig 4467: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 4468: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
4469: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4470: and
4471: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4472: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4473: </dl></dd>
1.23 wiz 4474: <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 4475: <dd><dl>
1.23 wiz 4476: <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 4477: <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 4478: </dl></dd>
4479: </dl>
4480: </div>
4481: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4482: are seen by a package's configure and build processes. This is implemented
4483: in a two step process:</p>
1.23 wiz 4484: <div class="orderedlist"><ol class="orderedlist" type="1">
4485: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4486: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4487: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4488: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4489: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4490: <code class="option">-L${LOCALBASE}/lib</code> into references to
4491: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4492: native compiler on some operating systems look like GCC, so that
4493: packages that expect GCC won't require modifications to build with
4494: those native compilers.</p></li>
4495: </ol></div>
4496: <p>This normalizes the environment in which a package is built so that the
4497: package may be built consistently despite what other software may be
4498: installed. Please note that the normal system header and library paths,
4499: e.g. <code class="filename">/usr/include</code>,
4500: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4501: designed to insulate the package build from non-system-supplied
4502: software.</p>
1.41 asau 4503: <div class="sect1">
1.1 dsieger 4504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4505: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4506: <p>The process of converting packages to use the buildlink3
1.23 wiz 4507: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4508: The things to keep in mind are:</p>
1.23 wiz 4509: <div class="orderedlist"><ol class="orderedlist" type="1">
4510: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4511: instead of the actual toolchain. Some packages are tricky,
4512: and the only way to know for sure is the check
4513: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4514: wrappers are being invoked.</p></li>
1.23 wiz 4515: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4516: the package Makefile, e.g. Java VMs, standalone shells,
4517: etc., because the code to symlink files into
4518: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4519: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4520: </p></li>
1.23 wiz 4521: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4522: <code class="filename">buildlink3.mk</code> files that you list in a
4523: package's Makefile are added as dependencies for that package.
4524: </p></li>
4525: </ol></div>
4526: <p>If a dependency on a particular package is required for its libraries and
4527: headers, then we replace:</p>
4528: <pre class="programlisting">
4529: DEPENDS+= foo>=1.1.0:../../category/foo
4530: </pre>
4531: <p>with</p>
4532: <pre class="programlisting">
4533: .include "../../category/foo/buildlink3.mk"
4534: </pre>
4535: <p>The buildlink3.mk files usually define the required dependencies.
4536: If you need a newer version of the dependency when using buildlink3.mk
4537: files, then you can define it in your Makefile; for example:</p>
4538: <pre class="programlisting">
4539: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4540: .include "../../category/foo/buildlink3.mk"
4541: </pre>
4542: <p>There are several <code class="filename">buildlink3.mk</code>
4543: files in <code class="filename">pkgsrc/mk</code>
4544: that handle special package issues:</p>
1.41 asau 4545: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4546: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4547: the native or a pkgsrc Berkeley DB implementation based on
4548: the values of <code class="varname">BDB_ACCEPTED</code> and
4549: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4550: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4551: comes with neither Curses nor NCurses, this will take care
1.79 snj 4552: 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 4553: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4554: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4555: adding a dependency on Heimdal or MIT-krb5 for packages that
4556: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4557: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4558: system-provided Motif installation or adds a dependency on
1.79 snj 4559: <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 4560: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 4561: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
4562: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 4563: which Motif version will be used.</p></li>
1.55 ryoon 4564: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4565: system-provided GNU readline or editline (libedit) installation,
1.79 snj 4566: 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>,
4567: <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 4568: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4569: If your package really needs GNU readline library, its Makefile
4570: should include <code class="filename">devel/readline/buildlink3.mk</code>
4571: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4572: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4573: variables that may be used by packages that use the
4574: Open Sound System (OSS) API.</p></li>
1.23 wiz 4575: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4576: any of the Postgres versions in the variable
4577: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4578: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4579: the file for more information.</p></li>
1.23 wiz 4580: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4581: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.79 snj 4582: 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 4583: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4584: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4585: library.</p></li>
4586: </ul></div>
4587: <p>The comments in those <code class="filename">buildlink3.mk</code>
4588: files provide a more complete
4589: description of how to use them properly.</p>
4590: </div>
1.41 asau 4591: <div class="sect1">
1.1 dsieger 4592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4593: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4594: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4595: included by Makefiles to indicate the need to compile and link
4596: against header files and libraries provided by the package. A
4597: <code class="filename">buildlink3.mk</code> file should always provide
4598: enough information to add the correct type of dependency
4599: relationship and include any other
4600: <code class="filename">buildlink3.mk</code> files that it needs to find
4601: headers and libraries that it needs in turn.</p>
4602: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.79 snj 4603: 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 4604: package is highly recommended. For most packages, the following
4605: command will generate a good starting point for
4606: <code class="filename">buildlink3.mk</code> files:</p>
4607: <pre class="screen">
4608: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4609: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4610: </pre>
1.41 asau 4611: <div class="sect2">
1.1 dsieger 4612: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4613: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4614: <p>The following real-life example
4615: <code class="filename">buildlink3.mk</code> is taken
4616: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4617: <pre class="programlisting">
1.18 snj 4618: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4619:
1.112 ! rillig 4620: BUILDLINK_TREE+= tiff
1.1 dsieger 4621:
1.18 snj 4622: .if !defined(TIFF_BUILDLINK3_MK)
4623: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4624:
1.112 ! rillig 4625: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
! 4626: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
! 4627: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4628:
4629: .include "../../devel/zlib/buildlink3.mk"
4630: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4631: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4632:
1.112 ! rillig 4633: BUILDLINK_TREE+= -tiff
1.1 dsieger 4634: </pre>
4635: <p>The header and footer manipulate
1.18 snj 4636: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4637: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4638: the dependency tree.</p>
4639: <p>The main section is protected from multiple inclusion
1.1 dsieger 4640: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4641: added. Several important variables are set in the section:</p>
1.41 asau 4642: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4643: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4644: is the actual dependency recorded in the installed
4645: package; this should always be set using
1.10 hubertf 4646: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4647: we're appending to any pre-existing list of values. This
4648: variable should be set to the first version of the
1.26 wiz 4649: package that had an backwards-incompatible API change.
1.1 dsieger 4650: </p></li>
1.23 wiz 4651: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4652: is the location of the <em class="replaceable"><code>pkg</code></em>
4653: pkgsrc directory.</p></li>
1.23 wiz 4654: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4655: (not shown above) controls whether we use
4656: <code class="varname">BUILD_DEPENDS</code> or
4657: <code class="varname">DEPENDS</code> to add the dependency on
4658: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4659: selected by setting
4660: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4661: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4662: used.</p></li>
1.23 wiz 4663: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4664: and
4665: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4666: (not shown above) are lists of subdirectories of
4667: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4668: to add to the header and library search paths. These
1.23 wiz 4669: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4670: respectively.</p></li>
1.23 wiz 4671: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4672: (not shown above) is the list of preprocessor flags to add
4673: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4674: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4675: should be avoided and instead be handled using
4676: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4677: above.</p></li>
4678: </ul></div>
4679: <p>The following variables are all optionally defined within
4680: this second section (protected against multiple inclusion) and
4681: control which package files are symlinked into
4682: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4683: transformed during the symlinking:</p>
1.41 asau 4684: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4685: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4686: (not shown above) is a shell glob pattern relative to
4687: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4688: to be symlinked into
4689: <code class="filename">${BUILDLINK_DIR}</code>,
4690: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4691: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4692: (not shown above) is a shell pipeline that
4693: outputs to stdout a list of files relative to
4694: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4695: The resulting files are to be symlinked
4696: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4697: this takes the <code class="filename">+CONTENTS</code> of a
4698: <em class="replaceable"><code>pkg</code></em> and filters it through
4699: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4700: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4701: (not shown above) is a filter command that filters
4702: <code class="filename">+CONTENTS</code> input into a list of files
4703: relative to
4704: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4705: on stdout. By default,
1.1 dsieger 4706: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4707: outputs the contents of the <code class="filename">include</code>
4708: and <code class="filename">lib</code> directories in the package
1.84 wiz 4709: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4710: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4711: (not shown above) is a list of sed arguments used to
4712: transform the name of the source filename into a
1.10 hubertf 4713: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4714: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4715: </ul></div>
1.18 snj 4716: <p>This section can additionally include any
1.1 dsieger 4717: <code class="filename">buildlink3.mk</code> needed for
4718: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4719: Including these <code class="filename">buildlink3.mk</code> files
4720: means that the headers and libraries for these
4721: dependencies are also symlinked into
4722: <code class="filename">${BUILDLINK_DIR}</code>
4723: whenever the <em class="replaceable"><code>pkg</code></em>
4724: <code class="filename">buildlink3.mk</code>
1.18 snj 4725: file is included. Dependencies are only added for directly
4726: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4727: <p>When providing a <code class="filename">buildlink3.mk</code> and
4728: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4729: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4730: header files are automatically exposed when the package is
4731: use.</p>
4732: <p>In particular, if only an executable
4733: (<code class="filename">bin/foo</code>) is linked against a library, that
4734: library does not need to be propagated in the
4735: <code class="filename">buildlink3.mk</code> file.</p>
4736: <p>The following steps should help you decide if a
4737: <code class="filename">buildlink3.mk</code> file needs to be included:
4738: </p>
4739: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4740: <li class="listitem"><p>Look at the installed header files: What
4741: headers do they include? The packages providing these files
4742: must be buildlinked.</p></li>
1.49 wiz 4743: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4744: libraries and look against what other libraries they link.
4745: Some of the packages providing these probably need to be
4746: buildlinked; however, it's not automatic, since e.g. GTK on
4747: some systems pulls in the X libraries, so they will show up in
4748: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4749: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4750: used as a hint.</p></li>
1.47 wiz 4751: </ul></div>
4752: <p>
4753: </p>
1.1 dsieger 4754: </div>
1.41 asau 4755: <div class="sect2">
1.1 dsieger 4756: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 4757: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 4758: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4759: and
4760: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4761: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4762: <p>These two variables differ in that one describes source
4763: compatibility (API) and the other binary compatibility (ABI).
4764: The difference is that a change in the API breaks compilation of
4765: programs while changes in the ABI stop compiled programs from
4766: running.</p>
4767: <p>Changes to the
1.27 wiz 4768: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4769: variable in a <code class="filename">buildlink3.mk</code> file happen
4770: very rarely. One possible reason is that all packages depending
4771: on this already need a newer version. In case it is bumped see
4772: the description below.</p>
4773: <p>The most common example of an ABI change is that the major
4774: version of a shared library is increased. In this case,
4775: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4776: should be adjusted to require at least the new package version.
4777: Then the packages that depend on this package need their
4778: <code class="varname">PKGREVISION</code>s increased and, if they have
4779: <code class="filename">buildlink3.mk</code> files, their
4780: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4781: adjusted, too. This is needed so pkgsrc will require the correct
4782: package dependency and not settle for an older one when building
4783: the source.</p>
1.108 rillig 4784: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.26 wiz 4785: more information about dependencies on other packages,
4786: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4787: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4788: <p>Please take careful consideration before adjusting
4789: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4790: or
4791: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4792: as we don't want to cause unneeded package deletions and
4793: rebuilds. In many cases, new versions of packages work just
4794: fine with older dependencies.</p>
4795: <p>Also it is not needed to set
1.26 wiz 4796: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4797: when it is identical to
1.1 dsieger 4798: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4799: </div>
4800: </div>
1.41 asau 4801: <div class="sect1">
1.1 dsieger 4802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4803: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4804: <p>Some packages in pkgsrc install headers and libraries that
4805: coincide with headers and libraries present in the base system.
4806: Aside from a <code class="filename">buildlink3.mk</code> file, these
4807: packages should also include a <code class="filename">builtin.mk</code>
4808: file that includes the necessary checks to decide whether using
4809: the built-in software or the pkgsrc software is
4810: appropriate.</p>
4811: <p>The only requirements of a builtin.mk file for
4812: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4813: <div class="orderedlist"><ol class="orderedlist" type="1">
4814: <li class="listitem"><p>It should set
1.1 dsieger 4815: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4816: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4817: after it is included.</p></li>
1.23 wiz 4818: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4819: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4820: which is already set before the
4821: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4822: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4823: is <span class="emphasis"><em>very</em></span> important and takes careful
4824: attention to <code class="filename">Makefile</code> coding.</p></li>
4825: </ol></div>
1.41 asau 4826: <div class="sect2">
1.1 dsieger 4827: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4828: <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 4829: <p>The following is the recommended template for builtin.mk
4830: files:</p>
4831: <pre class="programlisting">
4832: .if !defined(IS_BUILTIN.foo)
4833: #
4834: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4835: # genuinely exists in the system or not.
4836: #
4837: IS_BUILTIN.foo?= no
4838:
4839: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4840: # version can be determined.
4841: #
4842: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4843: BUILTIN_PKG.foo?= foo-1.0
4844: . endif
4845: .endif # IS_BUILTIN.foo
4846:
4847: .if !defined(USE_BUILTIN.foo)
4848: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4849: . if defined(BUILTIN_PKG.foo)
4850: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4851: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4852: USE_BUILTIN.foo!= \
4853: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4854: && ${ECHO} "yes" || ${ECHO} "no"
4855: . endif
4856: . endfor
4857: . endif
4858: .endif # USE_BUILTIN.foo
4859:
4860: CHECK_BUILTIN.foo?= no
4861: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4862: #
4863: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4864: # "yes" or "no".
4865: #
4866: .endif # CHECK_BUILTIN.foo
4867: </pre>
4868: <p>The first section sets
4869: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4870: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4871: in the base system. This should not be a base system software
4872: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 4873: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 4874: included as part of the base system. This variable is only
4875: used internally within the <code class="filename">builtin.mk</code>
4876: file.</p>
4877: <p>The second section sets
4878: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4879: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4880: system if it exists (if
4881: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4882: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 4883: within the <code class="filename">builtin.mk</code> file.</p>
4884: <p>The third section sets
4885: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4886: and is <span class="emphasis"><em>required</em></span> in all
4887: <code class="filename">builtin.mk</code> files. The code in this
4888: section must make the determination whether the built-in
4889: software is adequate to satisfy the dependencies listed in
4890: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4891: This is typically done by comparing
4892: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4893: against each of the dependencies in
4894: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4895: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4896: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4897: end of the <code class="filename">builtin.mk</code> file. Note that
4898: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4899: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 4900: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4901: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 4902: that the built-in version of the software is similar enough to
4903: be used as a replacement.</p>
4904: <p>The last section is guarded by
4905: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4906: and includes code that uses the value of
4907: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4908: set in the previous section. This typically includes, e.g.,
4909: adding additional dependency restrictions and listing additional
4910: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4911: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
4912: </div>
1.41 asau 4913: <div class="sect2">
1.1 dsieger 4914: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4915: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 4916: <p>When building packages, it's possible to choose whether to set
4917: a global preference for using either the built-in (native)
4918: version or the pkgsrc version of software to satisfy a
4919: dependency. This is controlled by setting
4920: <code class="varname">PREFER_PKGSRC</code> and
4921: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 4922: 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 4923: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4924: use the pkgsrc versions of software, while
4925: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4926: built-in versions. Preferences are determined by the most
4927: specific instance of the package in either
4928: <code class="varname">PREFER_PKGSRC</code> or
4929: <code class="varname">PREFER_NATIVE</code>. If a package is specified
4930: in neither or in both variables, then
4931: <code class="varname">PREFER_PKGSRC</code> has precedence over
4932: <code class="varname">PREFER_NATIVE</code>. For example, to require
4933: using pkgsrc versions of software for all but the most basic
4934: bits on a NetBSD system, you can set:</p>
4935: <pre class="programlisting">
4936: PREFER_PKGSRC= yes
4937: PREFER_NATIVE= getopt skey tcp_wrappers
4938: </pre>
4939: <p>A package <span class="emphasis"><em>must</em></span> have a
4940: <code class="filename">builtin.mk</code>
4941: file to be listed in <code class="varname">PREFER_NATIVE</code>,
4942: otherwise it is simply ignored in that list.</p>
4943: </div>
4944: </div>
4945: </div>
1.41 asau 4946: <div class="chapter">
1.1 dsieger 4947: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4948: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 4949: <div class="toc">
4950: <p><b>Table of Contents</b></p>
1.100 leot 4951: <dl class="toc">
1.6 rillig 4952: <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 4953: <dd><dl>
1.6 rillig 4954: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
4955: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 4956: </dl></dd>
1.6 rillig 4957: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 4958: <dd><dl>
1.23 wiz 4959: <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 4960: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
4961: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
4962: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
4963: </dl></dd>
4964: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
4965: <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>
4966: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
4967: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
4968: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
4969: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
4970: <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 4971: </dl>
4972: </div>
4973: <p>This chapter describes the framework known as
4974: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 4975: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4976: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 4977: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 4978: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 4979: provided that packages are correctly designed.</p></li>
1.23 wiz 4980: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
4981: <li class="listitem"><p>Registration of system users and groups.</p></li>
4982: <li class="listitem"><p>Registration of system shells.</p></li>
4983: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 4984: </ul></div>
4985: <p>The following sections inspect each of the above points in detail.</p>
4986: <p>You may be thinking that many of the things described here could be
4987: easily done with simple code in the package's post-installation target
4988: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
4989: as the code in them is only executed when building from source. Machines
4990: using binary packages could not benefit from it at all (as the code itself
4991: could be unavailable). Therefore, the only way to achieve any of the items
4992: described above is by means of the installation scripts, which are
4993: automatically generated by pkginstall.</p>
1.41 asau 4994: <div class="sect1">
1.1 dsieger 4995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4996: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 4997: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
4998: of files and directories that belong to a package. The names used in it
4999: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5000: which means that it cannot register files outside this directory (absolute
5001: path names are not allowed). Despite this restriction, some packages need
5002: to install files outside this location; e.g., under
5003: <code class="filename">${VARBASE}</code> or
5004: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5005: is to create such files during installation time by using
5006: installation scripts.</p>
5007: <p>The generic installation scripts are shell scripts that can
5008: contain arbitrary code. The list of scripts to execute is taken from
5009: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5010: <code class="filename">INSTALL</code>. A similar variable exists for package
5011: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5012: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5013: commands, so they have the potential to create and manage files
5014: anywhere in the file system.</p>
5015: <p>Using these general installation files is not recommended, but
5016: may be needed in some special cases. One reason for avoiding them is
5017: that the user has to trust the packager that there is no unwanted or
5018: simply erroneous code included in the installation script. Also,
5019: previously there were many similar scripts for the same functionality,
5020: and fixing a common error involved finding and changing all of
5021: them.</p>
5022: <p>The pkginstall framework offers another, standardized way. It
5023: provides generic scripts to abstract the manipulation of such files
5024: and directories based on variables set in the package's
5025: <code class="filename">Makefile</code>. The rest of this section describes
5026: these variables.</p>
1.41 asau 5027: <div class="sect2">
1.1 dsieger 5028: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5029: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5030: <p>The following variables can be set to request the creation of
5031: directories anywhere in the file system:</p>
1.41 asau 5032: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5033: <li class="listitem">
5034: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5035: contain a list of directories that should be created and should attempt
5036: to be destroyed by the installation scripts. The difference between
5037: the two is that the latter prompts the administrator to remove any
5038: directories that may be left after deinstallation (because they were
1.108 rillig 5039: not empty), while the former does not. Example:</p>
5040: <pre class="programlisting">
5041: MAKE_DIRS+= ${VARBASE}/foo/private
5042: </pre>
5043: </li>
1.23 wiz 5044: <li class="listitem">
1.1 dsieger 5045: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5046: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5047: which directories should be created and should attempt to be destroyed
5048: by the installation scripts. Each tuple holds the following values,
5049: separated by spaces: the directory name, its owner, its group and its
5050: numerical mode. For example:</p>
5051: <pre class="programlisting">
1.108 rillig 5052: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5053: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5054: </pre>
5055: <p>The difference between the two is exactly the same as their
5056: non-<code class="varname">PERMS</code> counterparts.</p>
5057: </li>
5058: </ul></div>
5059: </div>
1.41 asau 5060: <div class="sect2">
1.1 dsieger 5061: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5062: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5063: <p>Creating non-empty files outside the installation prefix is tricky
5064: because the <code class="filename">PLIST</code> forces all files to be inside it.
5065: To overcome this problem, the only solution is to extract the file in the
5066: known place (i.e., inside the installation prefix) and copy it to the
5067: appropriate location during installation (done by the installation scripts
5068: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5069: file</em></span> in the following paragraphs, which describe the variables
5070: that can be used to automatically and consistently handle files outside the
5071: installation prefix:</p>
1.41 asau 5072: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5073: <li class="listitem">
1.1 dsieger 5074: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5075: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5076: During installation time, the master file is copied to the target one
5077: if and only if the latter does not exist. Upon deinstallation, the
5078: target file is removed provided that it was not modified by the
5079: installation.</p>
5080: <p>The difference between the two is that the latter prompts the
5081: administrator to remove any files that may be left after
5082: deinstallation (because they were not empty), while the former does
5083: not.</p>
5084: </li>
1.23 wiz 5085: <li class="listitem">
1.1 dsieger 5086: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5087: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5088: files as well as their target locations. For each of them, it also
5089: specifies their owner, their group and their numeric permissions, in
5090: this order. For example:</p>
5091: <pre class="programlisting">
1.108 rillig 5092: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5093: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5094: </pre>
5095: <p>The difference between the two is exactly the same as their
5096: non-<code class="varname">PERMS</code> counterparts.</p>
5097: </li>
5098: </ul></div>
5099: </div>
5100: </div>
1.41 asau 5101: <div class="sect1">
1.1 dsieger 5102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5103: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5104: <p>Configuration files are special in the sense that they are installed
5105: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5106: need special treatment during installation (most of which is automated by
5107: pkginstall). The main concept you must bear in mind is that files marked
5108: as configuration files are automatically copied to the right place (somewhere
5109: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5110: and only if</em></span> they didn't exist before. Similarly, they will not
5111: be removed if they have local modifications. This ensures that
5112: administrators never lose any custom changes they may have made.</p>
1.41 asau 5113: <div class="sect2">
1.1 dsieger 5114: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5115: <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 5116: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5117: specifies where configuration files shall be installed. Its contents are
5118: set based upon the following variables:</p>
1.41 asau 5119: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5120: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5121: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5122: be overridden by the user to point to his preferred location (e.g.,
5123: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5124: Packages must not use it directly.</p></li>
1.23 wiz 5125: <li class="listitem">
1.1 dsieger 5126: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5127: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5128: for the package being built shall be installed. The definition of this
5129: variable only makes sense in the package's
5130: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5131: <p>As an example, consider the Apache package,
1.79 snj 5132: <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 5133: configuration files under the
5134: <code class="filename">httpd/</code> subdirectory of
5135: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5136: Makefile.</p>
5137: </li>
1.23 wiz 5138: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5139: variable that holds this package's configuration directory (if
5140: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5141: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5142: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5143: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5144: directory where the configuration files for the package identified by
5145: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5146: </ul></div>
5147: <p>Based on the above variables, pkginstall determines the value of
5148: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5149: variable that can be used within a package to refer to its configuration
5150: directory. The algorithm used to set its value is basically the
5151: following:</p>
1.23 wiz 5152: <div class="orderedlist"><ol class="orderedlist" type="1">
5153: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5154: its value is used.</p></li>
1.23 wiz 5155: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5156: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5157: <code class="filename">Makefile</code>, the resulting value is
5158: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5159: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5160: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5161: </ol></div>
5162: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5163: 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
5164: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5165: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5166: </div>
1.41 asau 5167: <div class="sect2">
1.1 dsieger 5168: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5169: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5170: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5171: known place, you need to teach each package where it shall install its
5172: files. In some cases you will have to patch the package Makefiles to
5173: achieve it. If you are lucky, though, it may be as easy as passing an
5174: extra flag to the configuration script; this is the case of GNU Autoconf-
5175: generated files:</p>
5176: <pre class="programlisting">
5177: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5178: </pre>
5179: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5180: for</em></span> its configuration files, not where they will be originally
5181: installed (although the difference is never explicit,
5182: unfortunately).</p>
5183: </div>
1.41 asau 5184: <div class="sect2">
1.1 dsieger 5185: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5186: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5187: <p>As said before, pkginstall automatically handles configuration files.
5188: This means that <span class="strong"><strong>the packages themselves must not
5189: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5190: directly</strong></span>. Bad news is that many software installation scripts
5191: will, out of the box, mess with the contents of that directory. So what is
5192: the correct procedure to fix this issue?</p>
5193: <p>You must teach the package (usually by manually patching it) to
5194: install any configuration files under the examples hierarchy,
5195: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5196: <code class="filename">PLIST</code> registers them and the administrator always
5197: has the original copies available.</p>
5198: <p>Once the required configuration files are in place (i.e., under the
5199: examples hierarchy), the pkginstall framework can use them as master copies
5200: during the package installation to update what is in
5201: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5202: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5203: 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 5204: about their syntax and their purpose. Here is an example, taken from the
1.79 snj 5205: <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 5206: <pre class="programlisting">
5207: EGDIR= ${PREFIX}/share/doc/mutt/samples
5208: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5209: </pre>
5210: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5211: package and has no meaning outside it.</p>
5212: </div>
1.41 asau 5213: <div class="sect2">
1.1 dsieger 5214: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5215: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5216: <p>The automatic copying of config files can be toggled by setting the
5217: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5218: installation.</p>
5219: </div>
5220: </div>
1.41 asau 5221: <div class="sect1">
1.1 dsieger 5222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5223: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5224: <p>System startup scripts are special files because they must be
5225: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5226: 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 5227: can be used. However, pkginstall provides a special mechanism to handle
5228: these files.</p>
5229: <p>In order to provide system startup scripts, the package has
5230: to:</p>
1.23 wiz 5231: <div class="orderedlist"><ol class="orderedlist" type="1">
5232: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5233: the <code class="literal">.sh</code> suffix appended. Considering the
1.79 snj 5234: <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 5235: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5236: <li class="listitem">
1.1 dsieger 5237: <p>Tell pkginstall to handle it, appending the name of the script,
5238: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5239: Continuing the previous example:</p>
5240: <pre class="programlisting">
5241: RCD_SCRIPTS+= cupsd
5242: </pre>
5243: </li>
5244: </ol></div>
5245: <p>Once this is done, pkginstall will do the following steps for each
5246: script in an automated fashion:</p>
1.23 wiz 5247: <div class="orderedlist"><ol class="orderedlist" type="1">
5248: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5249: substitutions described in the <code class="filename">FILES_SUBST</code>
5250: variable.</p></li>
1.23 wiz 5251: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5252: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5253: that this master file must be explicitly registered in the
5254: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5255: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5256: from the examples hierarchy into the system-wide startup scripts
5257: directory.</p></li>
5258: </ol></div>
1.41 asau 5259: <div class="sect2">
1.1 dsieger 5260: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5261: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5262: <p>The automatic copying of config files can be toggled by setting the
5263: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5264: installation. Note that the scripts will be always copied inside the
5265: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5266: matter what the value of this variable is.</p>
5267: </div>
5268: </div>
1.41 asau 5269: <div class="sect1">
1.1 dsieger 5270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5271: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5272: <p>If a package needs to create special users and/or groups during
5273: installation, it can do so by using the pkginstall framework.</p>
5274: <p>Users can be created by adding entries to the
5275: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5276: syntax:</p>
5277: <pre class="programlisting">
5278: user:group
5279: </pre>
5280: <p>Further specification of user details may be done by setting
5281: per-user variables.
5282: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5283: numeric UID for the user.
5284: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5285: user's description or comment.
5286: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5287: user's home directory, and defaults to
5288: <code class="filename">/nonexistent</code> if not specified.
5289: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5290: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5291: not specified.</p>
5292: <p>Similarly, groups can be created by adding entries to the
5293: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5294: <pre class="programlisting">
5295: group
5296: </pre>
5297: <p>The numeric GID of the group may be set by defining
5298: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5299: <p>If a package needs to create the users and groups at an earlier
5300: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5301: either <code class="literal">configure</code> or <code class="literal">build</code> to
5302: indicate the phase before which the users and groups are created. In
5303: this case, the numeric UIDs and GIDs of the created users and groups
5304: are automatically hardcoded into the final installation scripts.</p>
5305: </div>
1.41 asau 5306: <div class="sect1">
1.1 dsieger 5307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5308: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5309: <p>Packages that install system shells should register them in the shell
5310: database, <code class="filename">/etc/shells</code>, to make things easier to the
5311: administrator. This must be done from the installation scripts to keep
5312: binary packages working on any system. pkginstall provides an easy way to
5313: accomplish this task.</p>
5314: <p>When a package provides a shell interpreter, it has to set the
5315: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5316: add some hooks to the installation scripts to handle it. Consider the
1.79 snj 5317: 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 5318: <pre class="programlisting">
5319: PKG_SHELL= ${PREFIX}/bin/zsh
5320: </pre>
1.41 asau 5321: <div class="sect2">
1.1 dsieger 5322: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5323: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5324: <p>The automatic registration of shell interpreters can be disabled by
5325: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5326: environment variable to <code class="literal">NO</code>.</p>
5327: </div>
5328: </div>
1.41 asau 5329: <div class="sect1">
1.1 dsieger 5330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5331: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5332: <p>Packages that install X11 fonts should update the database files
5333: that index the fonts within each fonts directory. This can easily be
5334: accomplished within the pkginstall framework.</p>
5335: <p>When a package installs X11 fonts, it must list the directories in
5336: which fonts are installed in the
5337: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5338: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5339: <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 5340: installation scripts to run the appropriate commands to update the fonts
5341: database files within each of those directories. For convenience, if the
5342: directory path is relative, it is taken to be relative to the package's
1.79 snj 5343: 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 5344: <pre class="programlisting">
1.67 wiz 5345: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5346: </pre>
1.41 asau 5347: <div class="sect2">
1.1 dsieger 5348: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5349: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5350: <p>The automatic update of fonts databases can be disabled by
5351: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5352: environment variable to <code class="literal">NO</code>.</p>
5353: </div>
5354: </div>
5355: </div>
1.41 asau 5356: <div class="chapter">
1.1 dsieger 5357: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5358: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5359: <div class="toc">
5360: <p><b>Table of Contents</b></p>
1.100 leot 5361: <dl class="toc">
1.6 rillig 5362: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5363: <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 5364: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5365: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5366: </dl>
5367: </div>
5368: <p>Many packages have the ability to be built to support different
5369: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5370: in pkgsrc that provides generic handling of those options that
5371: determine different ways in which the packages can be built. It's
5372: possible for the user to specify exactly which sets of options will be
5373: built into a package or to allow a set of global default options
5374: apply.</p>
1.7 rillig 5375: <p>There are two broad classes of behaviors that one might want to
5376: control via options. One is whether some particular feature is
5377: enabled in a program that will be built anyway, often by including or
5378: not including a dependency on some other package. The other is
5379: whether or not an additional program will be built as part of the
5380: package. Generally, it is better to make a split package for such
5381: additional programs instead of using options, because it enables
5382: binary packages to be built which can then be added separately. For
5383: example, the foo package might have minimal dependencies (those
5384: packages without which foo doesn't make sense), and then the foo-gfoo
5385: package might include the GTK frontend program gfoo. This is better
5386: than including a gtk option to foo that adds gfoo, because either that
5387: option is default, in which case binary users can't get foo without
5388: gfoo, or not default, in which case they can't get gfoo. With split
5389: packages, they can install foo without having GTK, and later decide to
5390: install gfoo (pulling in GTK at that time). This is an advantage to
5391: source users too, avoiding the need for rebuilds.</p>
5392: <p>Plugins with widely varying dependencies should usually be split
5393: instead of options.</p>
5394: <p>It is often more work to maintain split packages, especially if
5395: the upstream package does not support this. The decision of split
5396: vs. option should be made based on the likelihood that users will want
5397: or object to the various pieces, the size of the dependencies that are
5398: included, and the amount of work.</p>
5399: <p>A further consideration is licensing. Non-free parts, or parts
5400: that depend on non-free dependencies (especially plugins) should
5401: almost always be split if feasible.</p>
1.41 asau 5402: <div class="sect1">
1.1 dsieger 5403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5404: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 5405: <p>Global default options are listed in
5406: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5407: that should be built into every package if that option is supported.
1.10 hubertf 5408: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5409: </div>
1.41 asau 5410: <div class="sect1">
1.1 dsieger 5411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5412: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5413: </h2></div></div></div>
5414: <p>The following example shows how
5415: <code class="filename">bsd.options.mk</code> should be used
5416: by the hypothetical ``wibble'' package, either in the package
5417: <code class="filename">Makefile</code>, or in a file,
5418: e.g. <code class="filename">options.mk</code>, that is included by the
5419: main package <code class="filename">Makefile</code>.</p>
5420: <pre class="programlisting">
5421: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5422: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5423: PKG_OPTIONS_OPTIONAL_GROUPS= database
5424: PKG_OPTIONS_GROUP.database= mysql pgsql
5425: PKG_SUGGESTED_OPTIONS= wibble-foo
5426: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5427: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5428:
5429: .include "../../mk/bsd.prefs.mk"
5430:
5431: # this package was previously named wibble2
5432: .if defined(PKG_OPTIONS.wibble2)
5433: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5434: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5435: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5436: .endif
5437:
5438: .include "../../mk/bsd.options.mk"
5439:
5440: # Package-specific option-handling
5441:
5442: ###
5443: ### FOO support
5444: ###
5445: .if !empty(PKG_OPTIONS:Mwibble-foo)
5446: CONFIGURE_ARGS+= --enable-foo
5447: .endif
5448:
5449: ###
5450: ### LDAP support
5451: ###
5452: .if !empty(PKG_OPTIONS:Mldap)
5453: . include "../../databases/openldap-client/buildlink3.mk"
5454: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5455: .endif
5456:
5457: ###
5458: ### database support
5459: ###
5460: .if !empty(PKG_OPTIONS:Mmysql)
5461: . include "../../mk/mysql.buildlink3.mk"
5462: .endif
5463: .if !empty(PKG_OPTIONS:Mpgsql)
5464: . include "../../mk/pgsql.buildlink3.mk"
5465: .endif
5466: </pre>
5467: <p>The first section contains the information about which build
5468: options are supported by the package, and any default options settings
5469: if needed.</p>
1.23 wiz 5470: <div class="orderedlist"><ol class="orderedlist" type="1">
5471: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.79 snj 5472: <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 5473: options. It should be set to
5474: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5475: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5476: at the point where the options are processed.</p></li>
1.23 wiz 5477: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5478: build options supported by the package.</p></li>
1.23 wiz 5479: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5480: list of names of groups of mutually exclusive options. The options in
5481: each group are listed in
5482: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5483: The most specific setting of any option from the group takes
5484: precedence over all other options in the group. Options from the
5485: groups will be automatically added to
5486: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5487: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5488: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5489: packages will fail if no option from the group is
5490: selected.</p></li>
1.23 wiz 5491: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5492: of names of sets of options. At least one option from each set must
5493: be selected. The options in each set are listed in
5494: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5495: Options from the sets will be automatically added to
5496: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5497: fail if no option from the set is selected.</p></li>
1.23 wiz 5498: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5499: build options which are enabled by default.</p></li>
1.23 wiz 5500: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5501: of
1.23 wiz 5502: <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 5503: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5504: their option counterparts. Pairs should be added with
1.23 wiz 5505: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5506: warning will be issued if the user uses a legacy
5507: variable.</p></li>
1.23 wiz 5508: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5509: of
1.23 wiz 5510: <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 5511: pairs that map options that have been renamed to their new
1.23 wiz 5512: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5513: the listing of global legacy options. A warning will be issued if
5514: the user uses a legacy option.</p></li>
1.23 wiz 5515: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5516: options implied by deprecated variables used. This can be used for
5517: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5518: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5519: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5520: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5521: a list of warnings about deprecated variables or options used, and
5522: what to use instead.</p></li>
5523: </ol></div>
5524: <p>A package should never modify
5525: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5526: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5527: To suggest a default set of options, use
5528: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5529: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5530: including <code class="filename">bsd.options.mk</code>. If none of
5531: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5532: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5533: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5534: happen with platform-specific options if none of them is supported on
5535: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5536: empty list and the package is otherwise treated as not using the
5537: options framework.</p>
5538: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5539: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5540: build options, properly filtered to remove unsupported and duplicate
5541: options.</p>
5542: <p>The remaining sections contain the logic that is specific to
5543: each option. The correct way to check for an option is to check
5544: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5545: <pre class="programlisting">
5546: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5547: </pre>
5548: </div>
1.41 asau 5549: <div class="sect1">
1.1 dsieger 5550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5551: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 5552: <p>Options that enable similar features in different packages (like
5553: optional support for a library) should use a common name in all
5554: packages that support it (like the name of the library). If another
5555: package already has an option with the same meaning, use the same
5556: name.</p>
5557: <p>Options that enable features specific to one package, where it's
5558: unlikely that another (unrelated) package has the same (or a similar)
5559: optional feature, should use a name prefixed with
5560: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5561: <p>If a group of related packages share an optional feature
5562: specific to that group, prefix it with the name of the
1.23 wiz 5563: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5564: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5565: <p>For new options, add a line to
5566: <code class="filename">mk/defaults/options.description</code>. Lines have two
5567: fields, separated by tab. The first field is the option name, the
5568: second its description. The description should be a whole sentence
5569: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5570: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5571: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5572: </div>
1.41 asau 5573: <div class="sect1">
1.7 rillig 5574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5575: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5576: <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 5577: different dependencies based on the options with which the package was
5578: built. For querying these options, the file
5579: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5580: typical example looks like this:</p>
5581: <pre class="programlisting">
5582: pkgbase := libpurple
5583: .include "../../mk/pkg-build-options.mk"
5584:
5585: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5586: ...
5587: .endif
5588: </pre>
5589: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5590: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5591: options of the libpurple package, which can then be queried like
5592: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5593: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5594: details.</p>
5595: </div>
1.1 dsieger 5596: </div>
1.41 asau 5597: <div class="chapter">
1.1 dsieger 5598: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5599: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 5600: <div class="toc">
5601: <p><b>Table of Contents</b></p>
1.100 leot 5602: <dl class="toc">
1.6 rillig 5603: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
5604: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
5605: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
5606: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 5607: <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 5608: <dd><dl>
5609: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
5610: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
5611: </dl></dd>
1.23 wiz 5612: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5613: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5614: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5615: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5616: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5617: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5618: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5619: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5620: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5621: <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 5622: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
5623: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 5624: </dl>
5625: </div>
1.41 asau 5626: <div class="sect1">
1.1 dsieger 5627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5628: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 5629: <p>This chapter gives a detailed description on how a package is
5630: built. Building a package is separated into different
5631: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5632: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5633: described in the following sections. Each phase is split into
1.1 dsieger 5634: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5635: containing phase, prefixed by one of <code class="varname">pre-</code>,
5636: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5637: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5638: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5639: <p>Never override the regular targets (like
5640: <code class="varname">fetch</code>), if you have to, override the
5641: <code class="varname">do-*</code> ones instead.</p>
5642: <p>The basic steps for building a program are always the same. First
5643: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5644: the local system and then extracted. After any pkgsrc-specific patches
5645: to compile properly are applied, the software can be configured, then
5646: built (usually by compiling), and finally the generated binaries, etc.
5647: can be put into place on the system.</p>
5648: <p>To get more details about what is happening at each step,
5649: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5650: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5651: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5652: </div>
1.41 asau 5653: <div class="sect1">
1.1 dsieger 5654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5655: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 5656: <p>Before outlining the process performed by the NetBSD package system in
5657: the next section, here's a brief discussion on where programs are
5658: installed, and which variables influence this.</p>
5659: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5660: where all files of the final program shall be installed. It is
5661: usually set to <code class="varname">LOCALBASE</code>
5662: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5663: for pkgs in the <code class="filename">cross</code> category. The value of
5664: <code class="varname">PREFIX</code> needs to be put
5665: into the various places in the program's source where paths to
1.108 rillig 5666: 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 5667: <p>When choosing which of these variables to use,
5668: follow the following rules:</p>
1.41 asau 5669: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5670: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5671: where the current pkg will be installed. When referring to a
5672: pkg's own installation path, use
1.23 wiz 5673: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5674: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5675: are installed. If you need to construct a -I or -L argument
5676: to the compiler to find includes and libraries installed by
1.23 wiz 5677: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5678: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5679: installed all packages in <code class="filename">/usr/local</code>. As
5680: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5681: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5682: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5683: distribution (from xsrc, etc.) is installed. When looking for
5684: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5685: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5686: <li class="listitem"><p>X11-based packages using imake must set
5687: <code class="varname">USE_IMAKE</code> to be installed correctly under
5688: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5689: <li class="listitem">
1.99 sevan 5690: <p>To determine the prefix of an
1.1 dsieger 5691: installed package, the <code class="varname">EVAL_PREFIX</code>
5692: definition can be used. It takes pairs in the format
1.79 snj 5693: <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 5694: variable <code class="varname">DIRNAME</code> will be set to the prefix
5695: of the installed package <package>, or
1.99 sevan 5696: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> if the package is not
1.1 dsieger 5697: installed.</p>
5698: <p>This is best illustrated by example.</p>
5699: <p>The following lines are taken from
5700: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
5701: <pre class="programlisting">
5702: EVAL_PREFIX+= GTKDIR=gtk+
5703: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
5704: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
5705: CONFIGURE_ARGS+= --enable-multibyte
5706: </pre>
5707: <p>Specific defaults can be defined for the packages
5708: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
5709: definition of the form:</p>
5710: <pre class="programlisting">
5711: GTKDIR_DEFAULT= ${LOCALBASE}
5712: </pre>
5713: <p>where <code class="varname">GTKDIR</code> corresponds
5714: to the first definition in
5715: the <code class="varname">EVAL_PREFIX</code> pair.</p>
5716: </li>
1.23 wiz 5717: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.79 snj 5718: 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 5719: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5720: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5721: </ul></div>
5722: </div>
1.41 asau 5723: <div class="sect1">
1.1 dsieger 5724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5725: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5726: <p>When building a package, various directories are used to store
1.1 dsieger 5727: source files, temporary files, pkgsrc-internal files, and so on. These
5728: directories are explained here.</p>
5729: <p>Some of the directory variables contain relative pathnames. There
5730: are two common base directories for these relative directories:
5731: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5732: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5733: inside the package itself.</p>
1.41 asau 5734: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5735: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5736: <dd><p>This is an absolute pathname that points to the pkgsrc
5737: root directory. Generally, you don't need
5738: it.</p></dd>
5739: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5740: <dd><p>This is an absolute pathname that points to the
5741: current package.</p></dd>
5742: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5743: <dd><p>This is a pathname relative to
5744: <code class="varname">PKGSRCDIR</code> that points to the current
5745: package.</p></dd>
5746: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5747: <dd><p>This is an absolute pathname pointing to the directory
5748: where all work takes place. The distfiles are extracted to this
5749: directory. It also contains temporary directories and log files used by
5750: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5751: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5752: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5753: <dd><p>This is an absolute pathname pointing to the directory
5754: where the distfiles are extracted. It is usually a direct subdirectory
5755: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5756: that isn't hidden. This variable may be changed by a package
5757: <code class="filename">Makefile</code>.</p></dd>
5758: </dl></div>
1.14 jmcneill 5759: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5760: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5761: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5762: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5763: If users would like to have their pkgsrc trees behave in a
5764: read-only manner, then the value of
5765: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5766: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5767: </div>
1.41 asau 5768: <div class="sect1">
1.1 dsieger 5769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5770: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 5771: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5772: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5773: phase. This will automatically run all phases that are required for this
5774: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5775: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5776: the package will be built, but not installed.</p>
5777: </div>
1.41 asau 5778: <div class="sect1">
1.1 dsieger 5779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5780: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5781: <p>The first step in building a package is to fetch the
5782: distribution files (distfiles) from the sites that are providing
5783: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5784: phase.</p>
1.41 asau 5785: <div class="sect2">
1.1 dsieger 5786: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5787: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 5788: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5789: defines all URLs from where the distfile, whose name is
5790: derived from the <code class="varname">DISTNAME</code> variable, is
5791: fetched. The more complicated cases are described
5792: below.</p>
5793: <p>The variable <code class="varname">DISTFILES</code> specifies
5794: the list of distfiles that have to be fetched. Its value
1.66 asau 5795: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5796: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5797: so that most packages don't need to define it at all.
5798: <code class="varname">EXTRACT_SUFX</code> is
5799: <code class="literal">.tar.gz</code> by default, but can be changed
5800: freely. Note that if your package requires additional
5801: distfiles to the default one, you cannot just append the
5802: additional filenames using the <code class="literal">+=</code>
5803: operator, but you have write for example:</p>
5804: <pre class="programlisting">
1.66 asau 5805: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5806: </pre>
5807: <p>Each distfile is fetched from a list of sites, usually
5808: <code class="varname">MASTER_SITES</code>. If the package has multiple
5809: <code class="varname">DISTFILES</code> or multiple
5810: <code class="varname">PATCHFILES</code> from different sites, you can
5811: set
5812: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5813: to the list of URLs where the file
5814: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5815: (including the suffix) can be found.</p>
5816: <pre class="programlisting">
5817: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5818: DISTFILES+= foo-file.tar.gz
5819: SITES.foo-file.tar.gz= \
5820: http://www.somewhere.com/somehow/ \
5821: http://www.somewhereelse.com/mirror/somehow/
5822: </pre>
5823: <p>When actually fetching the distfiles, each item from
5824: <code class="varname">MASTER_SITES</code> or
5825: <code class="varname">SITES.*</code> gets the name of each distfile
5826: appended to it, without an intermediate slash. Therefore,
5827: all site values have to end with a slash or other separator
5828: character. This allows for example to set
5829: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5830: that gets the name of the distfile as a parameter. In this
5831: case, the definition would look like:</p>
5832: <pre class="programlisting">
5833: MASTER_SITES= http://www.example.com/download.cgi?file=
5834: </pre>
1.22 jakllsch 5835: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5836: In that case the URL is taken as is, fetched and the result
5837: stored under the name of the distfile. You can use this style
5838: for the case when the download URL style does not match the
5839: above common case. For example, if permanent download URL is a
5840: redirector to the real download URL, or the download file name
5841: is offered by an HTTP Content-Disposition header. In the
5842: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5843: created instead of the default
5844: <code class="filename">v1.0.0.tar.gz</code>.</p>
5845: <pre class="programlisting">
5846: DISTNAME= foo-1.0.0
5847: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5848: </pre>
1.1 dsieger 5849: <p>There are some predefined values for
5850: <code class="varname">MASTER_SITES</code>, which can be used in
5851: packages. The names of the variables should speak for
5852: themselves.</p>
5853: <pre class="programlisting">
5854: ${MASTER_SITE_APACHE}
5855: ${MASTER_SITE_BACKUP}
5856: ${MASTER_SITE_CYGWIN}
5857: ${MASTER_SITE_DEBIAN}
5858: ${MASTER_SITE_FREEBSD}
5859: ${MASTER_SITE_FREEBSD_LOCAL}
5860: ${MASTER_SITE_GENTOO}
5861: ${MASTER_SITE_GNOME}
5862: ${MASTER_SITE_GNU}
5863: ${MASTER_SITE_GNUSTEP}
1.66 asau 5864: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 5865: ${MASTER_SITE_IFARCHIVE}
5866: ${MASTER_SITE_KDE}
5867: ${MASTER_SITE_MOZILLA}
1.66 asau 5868: ${MASTER_SITE_MOZILLA_ALL}
5869: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 5870: ${MASTER_SITE_MYSQL}
1.66 asau 5871: ${MASTER_SITE_NETLIB}
1.1 dsieger 5872: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 5873: ${MASTER_SITE_OSDN}
1.1 dsieger 5874: ${MASTER_SITE_PERL_CPAN}
5875: ${MASTER_SITE_PGSQL}
1.66 asau 5876: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 5877: ${MASTER_SITE_R_CRAN}
5878: ${MASTER_SITE_SOURCEFORGE}
5879: ${MASTER_SITE_SUNSITE}
5880: ${MASTER_SITE_SUSE}
5881: ${MASTER_SITE_TEX_CTAN}
5882: ${MASTER_SITE_XCONTRIB}
5883: ${MASTER_SITE_XEMACS}
1.66 asau 5884: ${MASTER_SITE_XORG}
1.1 dsieger 5885: </pre>
5886: <p>Some explanations for the less self-explaining ones:
5887: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 5888: 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 5889: 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 5890: <p>If you choose one of these predefined sites, you may
5891: want to specify a subdirectory of that site. Since these
5892: macros may expand to more than one actual site, you
5893: <span class="emphasis"><em>must</em></span> use the following construct to
5894: specify a subdirectory:</p>
5895: <pre class="programlisting">
5896: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5897: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5898: </pre>
5899: <p>Note the trailing slash after the subdirectory
5900: name.</p>
5901: </div>
1.41 asau 5902: <div class="sect2">
1.1 dsieger 5903: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5904: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 5905: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5906: all the distfiles exist in a local directory
5907: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
5908: user). If the files do not exist, they are fetched using
5909: commands of the form</p>
5910: <pre class="programlisting">
5911: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5912: </pre>
5913: <p>where <code class="literal">${site}</code> varies through
5914: several possibilities in turn: first,
5915: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
5916: sites specified in either <code class="varname">SITES.file</code> if
5917: defined, else <code class="varname">MASTER_SITES</code> or
5918: <code class="varname">PATCH_SITES</code>, as applies, then finally the
5919: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
5920: all except the first and the last can be optionally sorted
5921: by the user, via setting either
5922: <code class="varname">MASTER_SORT_RANDOM</code>, and
5923: <code class="varname">MASTER_SORT_AWK</code> or
5924: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 5925: <p> The specific command and arguments used depend on the
5926: <code class="varname">FETCH_USING</code> parameter. The example above is
5927: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 5928: <p>The distfiles mirror run by the NetBSD Foundation uses the
5929: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
5930: distfiles, if they are freely distributable. Packages setting
5931: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 5932: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 5933: mirrored.</p>
5934: </div>
5935: </div>
1.41 asau 5936: <div class="sect1">
1.1 dsieger 5937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5938: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 5939: <p>After the distfile(s) are fetched, their checksum is
5940: generated and compared with the checksums stored in the
5941: distinfo file. If the checksums don't match, the build is
5942: aborted. This is to ensure the same distfile is used for
5943: building, and that the distfile wasn't changed, e.g. by some
5944: malign force, deliberately changed distfiles on the master
5945: distribution site or network lossage.</p>
5946: </div>
1.41 asau 5947: <div class="sect1">
1.1 dsieger 5948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5949: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 5950: <p>When the distfiles are present on the local system, they
5951: need to be extracted, as they usually come in the form of some
5952: compressed archive format.</p>
5953: <p>By default, all <code class="varname">DISTFILES</code> are
5954: extracted. If you only need some of them, you can set the
5955: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
5956: files.</p>
5957: <p>Extracting the files is usually done by a little
5958: program, <code class="filename">mk/extract/extract</code>, which
5959: already knows how to extract various archive formats, so most
5960: likely you will not need to change anything here. But if you
5961: need, the following variables may help you:</p>
1.41 asau 5962: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5963: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
5964: <dd><p>Use these variables to override the default
5965: options for an extract command, which are defined in
5966: <code class="filename">mk/extract/extract</code>.</p></dd>
5967: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
5968: <dd><p>This variable can be set to
1.14 jmcneill 5969: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
5970: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 5971: absolute pathname pointing to the command with which tar
1.14 jmcneill 5972: archives should be extracted. It is preferred to choose bsdtar over gtar
5973: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 5974: </dl></div>
5975: <p>If the <code class="filename">extract</code> program doesn't
5976: serve your needs, you can also override the
5977: <code class="varname">EXTRACT_CMD</code> variable, which holds the
5978: command used for extracting the files. This command is
5979: executed in the <code class="filename">${WRKSRC}</code>
5980: directory. During execution of this command, the shell
5981: variable <code class="varname">extract_file</code> holds the absolute
5982: pathname of the file that is going to be extracted.</p>
5983: <p>And if that still does not suffice, you can override the
5984: <code class="varname">do-extract</code> target in the package
5985: Makefile.</p>
5986: </div>
1.41 asau 5987: <div class="sect1">
1.1 dsieger 5988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5989: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 5990: <p>After extraction, all the patches named by the
5991: <code class="varname">PATCHFILES</code>, those present in the patches
5992: subdirectory of the package as well as in
5993: $LOCALPATCHES/$PKGPATH (e.g.
5994: <code class="filename">/usr/local/patches/graphics/png</code>) are
5995: applied. Patchfiles ending in <code class="filename">.Z</code> or
5996: <code class="filename">.gz</code> are uncompressed before they are
5997: applied, files ending in <code class="filename">.orig</code> or
5998: <code class="filename">.rej</code> are ignored. Any special options to
1.79 snj 5999: <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 6000: <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 6001: <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 6002: it fail if the patches apply with some lines of fuzz. Please
6003: fix (regen) the patches so that they apply cleanly. The
6004: rationale behind this is that patches that don't apply cleanly
6005: may end up being applied in the wrong place, and cause severe
6006: harm there.</p>
6007: </div>
1.41 asau 6008: <div class="sect1">
1.1 dsieger 6009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6010: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6011: <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 6012: </p>
6013: </div>
1.41 asau 6014: <div class="sect1">
1.1 dsieger 6015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6016: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6017: <p>This phase creates wrapper programs for the compilers and
6018: linkers. The following variables can be used to tweak the
6019: wrappers.</p>
1.41 asau 6020: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6021: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6022: <dd><p>The command used to print progress
6023: messages. Does nothing by default. Set to
6024: <code class="literal">${ECHO}</code> to see the progress
6025: messages.</p></dd>
6026: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6027: <dd><p>This variable can be set to
6028: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6029: depending on whether you want additional information in the
6030: wrapper log file.</p></dd>
6031: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6032: <dd><p>This variable can be set to
6033: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6034: on whether the wrapper should use its cache, which will
6035: improve the speed. The default value is
6036: <code class="literal">yes</code>, but is forced to
6037: <code class="literal">no</code> if the platform does not support
6038: it.</p></dd>
6039: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6040: <dd><p>A list of reordering commands. A reordering
6041: command has the form
6042: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6043: It ensures that that
6044: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6045: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6046: </p></dd>
6047: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6048: <dd><p>A list of transformation commands. [TODO:
6049: investigate further]</p></dd>
6050: </dl></div>
6051: </div>
1.41 asau 6052: <div class="sect1">
1.1 dsieger 6053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6054: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6055: <p>Most pieces of software need information on the header
6056: files, system calls, and library routines which are available
6057: on the platform they run on. The process of determining this
6058: information is known as configuration, and is usually
6059: automated. In most cases, a script is supplied with the
6060: distfiles, and its invocation results in generation of header
6061: files, Makefiles, etc.</p>
6062: <p>If the package contains a configure script, this can be
6063: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6064: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6065: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6066: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6067: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6068: <pre class="programlisting">
6069: .for d in ${CONFIGURE_DIRS}
6070: cd ${WRKSRC} \
6071: && cd ${d} \
6072: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6073: .endfor
6074: </pre>
6075: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6076: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6077: <code class="varname">WRKSRC</code>. In each of these directories, the
6078: configure script is run with the environment
6079: <code class="varname">CONFIGURE_ENV</code> and arguments
6080: <code class="varname">CONFIGURE_ARGS</code>. The variables
6081: <code class="varname">CONFIGURE_ENV</code>,
6082: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6083: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6084: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6085: package.</p>
1.37 wiz 6086: <p>If the program uses the Perl way of configuration (mainly Perl
6087: modules, but not only), i.e. a file called
6088: <code class="filename">Makefile.PL</code>, it should include
6089: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6090: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6091: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6092: <p>If the program uses an <code class="filename">Imakefile</code>
6093: for configuration, the appropriate steps can be invoked by
6094: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6095: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6096: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6097: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6098: <p>If the program uses <code class="filename">cmake</code>
6099: for configuration, the appropriate steps can be invoked by
1.23 wiz 6100: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6101: You can add variables to cmake's environment by adding them to the
6102: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6103: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6104: The top directory argument is given by the
6105: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6106: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6107: <p>If there is no configure step at all, set
1.23 wiz 6108: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6109: </div>
1.41 asau 6110: <div class="sect1">
1.1 dsieger 6111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6112: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6113: <p>For building a package, a rough equivalent of the
6114: following code is executed.</p>
6115: <pre class="programlisting">
6116: .for d in ${BUILD_DIRS}
6117: cd ${WRKSRC} \
6118: && cd ${d} \
6119: && env ${MAKE_ENV} \
6120: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6121: -f ${MAKE_FILE} \
6122: ${BUILD_TARGET}
6123: .endfor
6124: </pre>
6125: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6126: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6127: <code class="varname">WRKSRC</code>. In each of these directories,
6128: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6129: <code class="varname">MAKE_ENV</code> and arguments
6130: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6131: <code class="varname">MAKE_ENV</code>,
6132: <code class="varname">BUILD_MAKE_FLAGS</code>,
6133: <code class="varname">MAKE_FILE</code> and
6134: <code class="varname">BUILD_TARGET</code> may all be changed by the
6135: package.</p>
6136: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6137: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6138: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6139: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6140: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6141: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6142: <p>If there is no build step at all, set
1.23 wiz 6143: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6144: </div>
1.41 asau 6145: <div class="sect1">
1.1 dsieger 6146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6147: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6148: <p>[TODO]</p>
6149: </div>
1.41 asau 6150: <div class="sect1">
1.1 dsieger 6151: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6152: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6153: <p>Once the build stage has completed, the final step is to
6154: install the software in public directories, so users can
6155: access the programs and files.</p>
6156: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6157: equivalent of the following code is executed. Additionally,
6158: before and after this code, much magic is performed to do
6159: consistency checks, registering the package, and so on.</p>
6160: <pre class="programlisting">
6161: .for d in ${INSTALL_DIRS}
6162: cd ${WRKSRC} \
6163: && cd ${d} \
6164: && env ${MAKE_ENV} \
6165: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6166: -f ${MAKE_FILE} \
6167: ${INSTALL_TARGET}
6168: .endfor
6169: </pre>
6170: <p>The variable's meanings are analogous to the ones in the
6171: <span class="emphasis"><em>build</em></span> phase.
6172: <code class="varname">INSTALL_DIRS</code> defaults to
6173: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6174: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6175: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6176: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6177: defined.</p>
6178: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6179: variables are useful. They are all variations of the
1.79 snj 6180: <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 6181: permissions preset. <code class="varname">INSTALL</code> is the plain
6182: install command. The specialized variants, together with their
6183: intended use, are:</p>
1.41 asau 6184: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6185: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6186: <dd><p>directories that contain
6187: binaries</p></dd>
6188: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6189: <dd><p>directories that contain
6190: scripts</p></dd>
6191: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6192: <dd><p>directories that contain shared and static
6193: libraries</p></dd>
6194: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6195: <dd><p>directories that contain data
6196: files</p></dd>
6197: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6198: <dd><p>directories that contain man
6199: pages</p></dd>
1.100 leot 6200: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6201: <dd><p>directories that contain data files for games
6202: </p></dd>
1.1 dsieger 6203: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6204: <dd><p>binaries that can be stripped from debugging
6205: symbols</p></dd>
6206: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6207: <dd><p>binaries that cannot be
6208: stripped</p></dd>
6209: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6210: <dd><p>game
6211: binaries</p></dd>
6212: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6213: <dd><p>shared and static
6214: libraries</p></dd>
6215: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6216: <dd><p>data files</p></dd>
6217: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6218: <dd><p>data files for
6219: games</p></dd>
6220: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6221: <dd><p>man pages</p></dd>
6222: </dl></div>
6223: <p>Some other variables are:</p>
1.41 asau 6224: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6225: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
6226: <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>
6227: when installing binaries. Any debugging sections and symbols present in
6228: binaries will be preserved.
6229: </p></dd>
1.1 dsieger 6230: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6231: <dd><p>A list of directories relative to
6232: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6233: beginning of the <span class="emphasis"><em>install</em></span> phase.
6234: The package is supposed to create all needed directories itself
6235: before installing files to it and list all other directories here.
6236: </p></dd>
6237: </dl></div>
6238: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6239: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6240: mostly relevant for packages in the <code class="filename">regress</code>
6241: category.</p>
6242: </div>
1.41 asau 6243: <div class="sect1">
1.1 dsieger 6244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6245: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6246: <p>Once the install stage has completed, a binary package of
6247: the installed files can be built. These binary packages can be
6248: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6249: the <span class="command"><strong>make bin-install</strong></span> or by using
6250: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6251: <p>By default, the binary packages are created in
6252: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6253: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6254: one for each category in the <code class="varname">CATEGORIES</code>
6255: variable. <code class="varname">PACKAGES</code> defaults to
6256: <code class="filename">pkgsrc/packages</code>.</p>
6257: </div>
1.41 asau 6258: <div class="sect1">
1.1 dsieger 6259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6260: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6261: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6262: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6263: to clean the work directories of all dependencies too, use
1.10 hubertf 6264: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6265: </div>
1.41 asau 6266: <div class="sect1">
1.1 dsieger 6267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6268: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6269: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6270: <dt><span class="term">pre/post-*</span></dt>
6271: <dd><p>For any of the main targets described in the
6272: previous section, two auxiliary targets exist with
1.23 wiz 6273: <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 6274: prefix for the main target's name. These targets are
6275: invoked before and after the main target is called,
6276: allowing extra configuration or installation steps be
6277: performed from a package's Makefile, for example, which
6278: a program's configure script or install target
6279: omitted.</p></dd>
6280: <dt><span class="term">do-*</span></dt>
6281: <dd><p>Should one of the main targets do the wrong thing,
6282: and should there be no variable to fix this, you can
6283: redefine it with the do-* target. (Note that redefining
6284: the target itself instead of the do-* target is a bad
6285: idea, as the pre-* and post-* targets won't be called
6286: anymore, etc.) You will not usually need to do
6287: this.</p></dd>
6288: <dt><span class="term">reinstall</span></dt>
6289: <dd>
1.10 hubertf 6290: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6291: you noticed some file was not installed properly, you
6292: can repeat the installation with this target, which will
1.23 wiz 6293: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6294: <p>This is the default value of
6295: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6296: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6297: package</strong></span>, where the defaults are
1.23 wiz 6298: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6299: respectively.</p>
6300: </dd>
6301: <dt><span class="term">deinstall</span></dt>
6302: <dd>
1.79 snj 6303: <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 6304: current directory, effectively de-installing the
6305: package. The following variables can be used to tune the
6306: behaviour:</p>
1.41 asau 6307: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6308: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.79 snj 6309: <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 6310: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6311: <dd><p>Remove all packages that require (depend on)
6312: the given package. This can be used to remove any
6313: packages that may have been pulled in by a given
1.10 hubertf 6314: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6315: DEINSTALLDEPENDS=1</strong></span> is done in
6316: <code class="filename">pkgsrc/x11/kde</code>, this is
6317: likely to remove whole KDE. Works by adding
1.79 snj 6318: <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 6319: command line.</p></dd>
6320: </dl></div>
6321: </dd>
6322: <dt><span class="term">bin-install</span></dt>
6323: <dd><p>Install a binary package from local disk and via FTP
6324: from a list of sites (see the
6325: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6326: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6327: available anywhere. The arguments given to
1.10 hubertf 6328: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6329: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6330: operation, etc.</p></dd>
1.95 wiz 6331: <dt><span class="term">install-clean</span></dt>
6332: <dd><p>This target removes the state files for the "install" and later
6333: phases so that the "install" target may be re-invoked. This can be
6334: used after editing the PLIST to install the package without
6335: rebuilding it.</p></dd>
6336: <dt><span class="term">build-clean</span></dt>
6337: <dd><p>This target removes the state files for the "build" and later
6338: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6339: <dt><span class="term">update</span></dt>
6340: <dd>
6341: <p>This target causes the current package to be
6342: updated to the latest version. The package and all
6343: depending packages first get de-installed, then current
6344: versions of the corresponding packages get compiled and
6345: installed. This is similar to manually noting which
6346: packages are currently installed, then performing a
1.10 hubertf 6347: series of <span class="command"><strong>make deinstall</strong></span> and
6348: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6349: <code class="varname">UPDATE_TARGET</code> is set to) for these
6350: packages.</p>
1.23 wiz 6351: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6352: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6353: update</strong></span> was interrupted for some reason.
6354: However, in this case, make sure you don't call
1.10 hubertf 6355: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6356: list of dependent packages in <code class="varname">WRKDIR</code>.
6357: Otherwise, you lose the ability to automatically update
6358: the current package along with the dependent packages
6359: you have installed.</p>
1.10 hubertf 6360: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6361: update</strong></span> will only work as long as the package
6362: tree remains unchanged. If the source code for one of
6363: the packages to be updated has been changed, resuming
1.10 hubertf 6364: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6365: fail!</p>
6366: <p>The following variables can be used either on the
1.10 hubertf 6367: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6368: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6369: update</strong></span>:</p>
1.41 asau 6370: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6371: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6372: <dd><p>Install target to recursively use for the
6373: updated package and the dependent packages.
6374: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6375: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6376: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6377: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6378: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6379: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6380: endless loop!</p></dd>
6381: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6382: <dd><p>Don't clean up after updating. Useful if
6383: you want to leave the work sources of the updated
6384: packages around for inspection or other purposes.
6385: Be sure you eventually clean up the source tree
1.23 wiz 6386: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6387: or you may run into troubles with old source code
6388: still lying around on your next
1.10 hubertf 6389: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6390: update</strong></span>.</p></dd>
6391: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6392: <dd><p>Deinstall each package before installing
6393: (making <code class="varname">DEPENDS_TARGET</code>). This
6394: may be necessary if the
1.23 wiz 6395: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6396: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6397: update</strong></span>.</p></dd>
6398: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6399: <dd><p>Allows you to disable recursion and hardcode
6400: the target for packages. The default is
1.23 wiz 6401: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6402: facilitating a recursive update of prerequisite
6403: packages. Only set
6404: <code class="varname">DEPENDS_TARGET</code> if you want to
6405: disable recursive updates. Use
6406: <code class="varname">UPDATE_TARGET</code> instead to just
6407: set a specific target for each package to be
1.10 hubertf 6408: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6409: (see above).</p></dd>
6410: </dl></div>
6411: </dd>
6412: <dt><span class="term">clean-update</span></dt>
6413: <dd>
6414: <p>Clean the source tree for all packages that would
1.10 hubertf 6415: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6416: from the current directory. This target should not be
6417: used if the current package (or any of its depending
6418: packages) have already been de-installed (e.g., after
1.10 hubertf 6419: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6420: some packages you intended to update. As a rule of
6421: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6422: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6423: and only if you have a dirty package tree (e.g., if you
6424: used <code class="varname">NOCLEAN</code>).</p>
6425: <p>If you are unsure about whether your tree is
1.10 hubertf 6426: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6427: clean</strong></span> at the top of the tree, or use the
6428: following sequence of commands from the directory of the
6429: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6430: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6431: time, otherwise you lose all the packages you wanted to
6432: update!):</p>
6433: <pre class="screen">
6434: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6435: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6436: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6437: </pre>
6438: <p>The following variables can be used either on the
1.10 hubertf 6439: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6440: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6441: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6442: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6443: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6444: reconstruct the list of directories to update for
1.10 hubertf 6445: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6446: update</strong></span> successfully installed all
6447: packages you wanted to update. Normally, this is
1.10 hubertf 6448: done automatically on <span class="command"><strong>make
1.1 dsieger 6449: update</strong></span>, but may have been suppressed by
6450: the <code class="varname">NOCLEAN</code> variable (see
6451: above).</p></dd>
6452: </dl></div>
6453: </dd>
6454: <dt><span class="term">replace</span></dt>
6455: <dd>
6456: <p>Update the installation of the current package. This
6457: differs from update in that it does not replace dependent
1.79 snj 6458: 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 6459: target to work.</p>
6460: <p><span class="emphasis"><em>Be careful when using this
6461: target!</em></span> There are no guarantees that dependent
6462: packages will still work, in particular they will most
1.10 hubertf 6463: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6464: library package whose shared library major version changed
6465: between your installed version and the new one. For this
6466: reason, this target is not officially supported and only
6467: recommended for advanced users.</p>
6468: </dd>
6469: <dt><span class="term">info</span></dt>
1.79 snj 6470: <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 6471: package. You can use this to check which version of a
6472: package is installed.</p></dd>
6473: <dt><span class="term">index</span></dt>
6474: <dd>
6475: <p>This is a top-level command, i.e. it should be used in
6476: the <code class="filename">pkgsrc</code> directory. It creates a
6477: database of all packages in the local pkgsrc tree, including
6478: dependencies, comment, maintainer, and some other useful
6479: information. Individual entries are created by running
1.10 hubertf 6480: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6481: directories. This index file is saved as
6482: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6483: verbose format by running <span class="command"><strong>make
1.1 dsieger 6484: print-index</strong></span>. You can search in it with
1.10 hubertf 6485: <span class="command"><strong>make search
1.1 dsieger 6486: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6487: extract a list of all packages that depend on a particular
1.10 hubertf 6488: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6489: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6490: <p>Running this command takes a very long time, some
6491: hours even on fast machines!</p>
6492: </dd>
6493: <dt><span class="term">readme</span></dt>
6494: <dd>
6495: <p>This target generates a
6496: <code class="filename">README.html</code> file, which can be
1.79 snj 6497: 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 6498: contain references to any packages which are in the
6499: <code class="varname">PACKAGES</code> directory on the local
6500: host. The generated files can be made to refer to URLs
6501: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6502: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6503: wanted to generate <code class="filename">README.html</code>
6504: files which pointed to binary packages on the local
6505: machine, in the directory
6506: <code class="filename">/usr/packages</code>, set
6507: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6508: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6509: <code class="varname">${PACKAGES}</code> directory and its
6510: subdirectories will be searched for all the binary
6511: packages.</p>
6512: <p>The target can be run at the toplevel or in category
6513: directories, in which case it descends recursively.</p>
6514: </dd>
6515: <dt><span class="term">readme-all</span></dt>
6516: <dd><p>This is a top-level command, run it in
6517: <code class="filename">pkgsrc</code>. Use this target to create a
6518: file <code class="filename">README-all.html</code> which contains a
6519: list of all packages currently available in the NetBSD
6520: Packages Collection, together with the category they belong
6521: to and a short description. This file is compiled from the
6522: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6523: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6524: readme</strong></span>.</p></dd>
6525: <dt><span class="term">cdrom-readme</span></dt>
6526: <dd><p>This is very much the same as the
1.23 wiz 6527: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6528: used when generating a pkgsrc tree to be written to a
6529: CD-ROM. This target also produces
6530: <code class="filename">README.html</code> files, and can be made
6531: to refer to URLs based on
6532: <code class="varname">CDROM_PKG_URL_HOST</code> and
6533: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6534: <dt><span class="term">show-distfiles</span></dt>
6535: <dd><p>This target shows which distfiles and patchfiles
6536: are needed to build the package
6537: (<code class="varname">ALLFILES</code>, which contains all
6538: <code class="varname">DISTFILES</code> and
6539: <code class="varname">PATCHFILES</code>, but not
6540: <code class="filename">patches/*</code>).</p></dd>
6541: <dt><span class="term">show-downlevel</span></dt>
6542: <dd><p>This target shows nothing if the package is not
6543: installed. If a version of this package is installed,
6544: but is not the version provided in this version of
6545: pkgsrc, then a warning message is displayed. This target
6546: can be used to show which of your installed packages are
6547: downlevel, and so the old versions can be deleted, and
6548: the current ones added.</p></dd>
6549: <dt><span class="term">show-pkgsrc-dir</span></dt>
6550: <dd><p>This target shows the directory in the pkgsrc
6551: hierarchy from which the package can be built and
6552: installed. This may not be the same directory as the one
6553: from which the package was installed. This target is
6554: intended to be used by people who may wish to upgrade
6555: many packages on a single host, and can be invoked from
6556: the top-level pkgsrc Makefile by using the
1.23 wiz 6557: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6558: <dt><span class="term">show-installed-depends</span></dt>
6559: <dd><p>This target shows which installed packages match
6560: the current package's <code class="varname">DEPENDS</code>. Useful
6561: if out of date dependencies are causing build
6562: problems.</p></dd>
1.95 wiz 6563: <dt><span class="term">print-build-depends-list</span></dt>
6564: <dd><p>This target shows the list of packages that the current package
6565: depends on for building.</p></dd>
6566: <dt><span class="term">print-run-depends-list</span></dt>
6567: <dd><p>This target shows the list of packages that the current package
6568: depends on for running.</p></dd>
1.1 dsieger 6569: <dt><span class="term">check-shlibs</span></dt>
6570: <dd><p>After a package is installed, check all its
6571: binaries and (on ELF platforms) shared libraries to see
6572: if they find the shared libs they need. Run by default
1.10 hubertf 6573: 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 6574: <dt><span class="term">print-PLIST</span></dt>
6575: <dd>
1.23 wiz 6576: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6577: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6578: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6579: -newer work/.extract_done</strong></span>. An attempt is made
6580: to care for shared libs etc., but it is
6581: <span class="emphasis"><em>strongly</em></span> recommended to review the
6582: result before putting it into
6583: <code class="filename">PLIST</code>. On upgrades, it's useful to
6584: diff the output of this command against an already
6585: existing <code class="filename">PLIST</code> file.</p>
1.79 snj 6586: <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 6587: other methods that don't update file access times, be
6588: sure to add these files manually to your
1.23 wiz 6589: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6590: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6591: them!</p>
1.23 wiz 6592: <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 6593: information on this target.</p>
6594: </dd>
6595: <dt><span class="term">bulk-package</span></dt>
6596: <dd>
6597: <p>Used to do bulk builds. If an appropriate binary
6598: package already exists, no action is taken. If not, this
6599: target will compile, install and package it (and its
6600: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 6601: 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
6602: builds)</i></a>).
1.1 dsieger 6603: After creating the binary package, the sources, the
6604: just-installed package and its required packages are
6605: removed, preserving free disk space.</p>
6606: <p><span class="emphasis"><em>Beware that this target may deinstall
6607: all packages installed on a system!</em></span></p>
6608: </dd>
6609: <dt><span class="term">bulk-install</span></dt>
6610: <dd>
6611: <p>Used during bulk-installs to install required
6612: packages. If an up-to-date binary package is available,
1.79 snj 6613: 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 6614: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6615: but the installed binary won't be removed.</p>
6616: <p>A binary package is considered
1.23 wiz 6617: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.79 snj 6618: <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 6619: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6620: <li class="listitem"><p>None of the package's files
1.1 dsieger 6621: (<code class="filename">Makefile</code>, ...) were modified
6622: since it was built.</p></li>
1.23 wiz 6623: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6624: packages were modified since it was built.</p></li>
6625: </ul></div>
6626: <p><span class="emphasis"><em>Beware that this target may deinstall
6627: all packages installed on a system!</em></span></p>
6628: </dd>
6629: </dl></div>
6630: </div>
6631: </div>
1.41 asau 6632: <div class="chapter">
1.1 dsieger 6633: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6634: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6635: <div class="toc">
6636: <p><b>Table of Contents</b></p>
1.100 leot 6637: <dl class="toc">
1.6 rillig 6638: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
6639: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
6640: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6641: </dl>
6642: </div>
6643: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6644: by pkgsrc and also for individual packages to define what commands
6645: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
6646: or for later run-time of an installed packaged (such as
6647: <code class="varname">DEPENDS</code>).
6648: If the native system provides an adequate tool, then in many cases, a pkgsrc
6649: package will not be used.</p>
6650: <p>When building a package, the replacement tools are
6651: made available in a directory (as symlinks or wrapper scripts)
6652: that is early in the executable search path. Just like the buildlink
6653: system, this helps with consistent builds.</p>
6654: <p>A tool may be needed to help build a specific package. For example,
6655: perl, GNU make (gmake) or yacc may be needed.</p>
6656: <p>Also a tool may be needed, for example, because the native system's supplied
6657: tool may be inefficient for building a package with pkgsrc.
6658: For example, a package may need GNU awk, bison (instead of
6659: yacc) or a better sed.</p>
6660: <p>The tools used by a package can be listed by running
1.10 hubertf 6661: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6662: <div class="sect1">
1.1 dsieger 6663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6664: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6665: <p>The default set of tools used by pkgsrc is defined in
6666: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6667: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6668: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6669: These can be seen by running:
1.10 hubertf 6670: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6671: <p>If a package needs a specific program to build
6672: then the <code class="varname">USE_TOOLS</code> variable can be used
6673: to define the tools needed.</p>
6674: </div>
1.41 asau 6675: <div class="sect1">
1.1 dsieger 6676: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6677: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6678: <p>In the following examples, the :run means that it is needed at
6679: run-time (and becomes a DEPENDS).
1.1 dsieger 6680: The default is a build dependency which can be set with
6681: :build. (So in this example, it is the same as gmake:build
6682: and pkg-config:build.)</p>
6683: <pre class="programlisting">
6684: USE_TOOLS+= gmake perl:run pkg-config
6685: </pre>
6686: <p>When using the tools framework, a
6687: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6688: which contains the full path to the appropriate tool. For example,
1.23 wiz 6689: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6690: on Linux systems.</p>
6691: <p>If you always need a pkgsrc version of the
6692: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6693: </p>
6694: </div>
1.41 asau 6695: <div class="sect1">
1.1 dsieger 6696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6697: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6698: <p>When improving or porting pkgsrc to a new platform, have a look
6699: at (or create) the corresponding platform specific make file fragment under
6700: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6701: the name of the common tools. For example:</p>
6702: <pre class="programlisting">
6703: .if exists(/usr/bin/bzcat)
6704: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6705: .elif exists(/usr/bin/bzip2)
6706: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6707: .endif
6708:
6709: TOOLS_PLATFORM.true?= true # shell builtin
6710: </pre>
6711: </div>
6712: </div>
1.41 asau 6713: <div class="chapter">
1.1 dsieger 6714: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6715: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 6716: <div class="toc">
6717: <p><b>Table of Contents</b></p>
1.100 leot 6718: <dl class="toc">
1.6 rillig 6719: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 6720: <dd><dl>
1.108 rillig 6721: <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>
6722: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
6723: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
6724: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
6725: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
6726: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
6727: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
6728: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
6729: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
6730: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6731: <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 6732: </dl></dd>
1.108 rillig 6733: <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 6734: <dd><dl>
6735: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6736: <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 6737: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 6738: </dl></dd>
1.108 rillig 6739: <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 6740: <dd><dl>
6741: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
6742: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6743: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
6744: </dl></dd>
6745: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
6746: <dd><dl>
6747: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
6748: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
6749: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 6750: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
6751: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 6752: </dl></dd>
1.108 rillig 6753: <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 6754: <dd><dl>
6755: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
6756: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 6757: <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 6758: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
6759: </dl></dd>
1.108 rillig 6760: <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 6761: <dd><dl>
6762: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
6763: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
6764: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
6765: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
6766: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6767: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
6768: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
6769: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 6770: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 6771: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 6772: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
6773: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
6774: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
6775: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
6776: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
6777: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
6778: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
6779: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 6780: emulation</a></span></dt>
1.6 rillig 6781: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
6782: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6783: </dl></dd>
1.6 rillig 6784: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6785: </dl>
6786: </div>
1.41 asau 6787: <div class="sect1">
1.1 dsieger 6788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6789: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 6790: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6791: different platforms. As a result, it is important to ensure,
6792: where possible, that packages in pkgsrc are portable. This
6793: chapter mentions some particular details you should pay
6794: attention to while working on pkgsrc.</p>
1.41 asau 6795: <div class="sect2">
1.1 dsieger 6796: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6797: <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 6798: </h3></div></div></div>
6799: <p>The pkgsrc user can configure pkgsrc by overriding several
6800: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6801: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6802: want to use those variables in the preprocessor directives of
1.79 snj 6803: <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 6804: <code class="literal">.for</code>), you need to include the file
6805: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6806: loads the user preferences.</p>
6807: <p>But note that some variables may not be completely defined
6808: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6809: included, as they may contain references to variables that are
1.108 rillig 6810: not yet defined. In shell commands (the lines in
6811: <code class="filename">Makefile</code> that are indented with a tab) this
6812: is no problem, since variables are only expanded when they are
6813: used. But in the preprocessor directives mentioned above and in
6814: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6815: dependencies</code>) the variables are expanded at load
6816: time.</p>
1.41 asau 6817: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6818: <h3 class="title">Note</h3>
1.108 rillig 6819: <p>To check whether a variable can be used at load time,
6820: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6821: </div>
6822: </div>
1.41 asau 6823: <div class="sect2">
1.1 dsieger 6824: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6825: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6826: <p>Occasionally, packages require interaction from the user,
6827: and this can be in a number of ways:</p>
1.41 asau 6828: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6829: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 6830: interaction such as entering username/password or accepting a
6831: license on a web page.</p></li>
1.23 wiz 6832: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 6833: passwords.</p></li>
1.23 wiz 6834: <li class="listitem"><p>help to configure the package before it is built</p></li>
6835: <li class="listitem"><p>help during the build process</p></li>
6836: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 6837: </ul></div>
1.108 rillig 6838: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6839: variable to define which stages need interaction. This should be
6840: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 6841: <pre class="programlisting">
6842: INTERACTIVE_STAGE= configure install
1.111 sevan 6843: </pre>
1.1 dsieger 6844: <p>The user can then decide to skip this package by setting the
1.108 rillig 6845: <code class="varname">BATCH</code> variable. Packages that require interaction
6846: are also excluded from bulk builds.</p>
1.1 dsieger 6847: </div>
1.41 asau 6848: <div class="sect2">
1.1 dsieger 6849: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6850: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 6851: <p>Authors of software can choose the licence under which software
6852: can be copied. The Free Software Foundation has declared some
6853: licenses "Free", and the Open Source Initiative has a definition of
6854: "Open Source".</p>
6855: <p>By default, pkgsrc allows packages with Free or Open Source
6856: licenses to be built. To allow packages with other licenses to be
6857: built as well, the pkgsrc user needs to add these licenses to the
6858: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6859: that this variable only affects which packages may be
6860: <span class="emphasis"><em>built</em></span>, while the license terms often also
6861: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 6862: <p>One might want to only install packages with a BSD license,
1.108 rillig 6863: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 6864: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 6865: user can override the default by setting the
6866: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 6867: of "+=". The licenses accepted by default are defined in the
6868: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6869: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 6870: <p>The license tag mechanism is intended to address
6871: copyright-related issues surrounding building, installing and
6872: using a package, and not to address redistribution issues (see
6873: <code class="varname">RESTRICTED</code> and
1.111 sevan 6874: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 6875: Packages with redistribution restrictions should set these
6876: tags.</p>
1.1 dsieger 6877: <p>Denoting that a package may be copied according to a
6878: particular license is done by placing the license in
6879: <code class="filename">pkgsrc/licenses</code> and setting the
6880: <code class="varname">LICENSE</code> variable to a string identifying the
1.79 snj 6881: 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 6882: <pre class="programlisting">
6883: LICENSE= xv-license
1.111 sevan 6884: </pre>
1.1 dsieger 6885: <p>When trying to build, the user will get a notice that the
6886: package is covered by a license which has not been placed in the
6887: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
6888: <pre class="programlisting">
6889: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6890: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6891: ===> To view the license, enter "/usr/bin/make show-license".
6892: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6893: ===> ACCEPTABLE_LICENSES+=xv-license
6894: *** Error code 1
1.111 sevan 6895: </pre>
1.10 hubertf 6896: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 6897: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 6898: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 6899: convey to pkgsrc that it should not in the future fail because of
6900: that license:</p>
6901: <pre class="programlisting">
6902: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 6903: </pre>
6904: <p>The use of <code class="varname">LICENSE=shareware</code>,
6905: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
6906: is deprecated because it does not crisply refer to a particular
6907: license text. Another problem with such usage is that it does not
6908: enable a user to tell pkgsrc to proceed for a single package
6909: without also telling pkgsrc to proceed for all packages with that
6910: tag.</p>
6911: <div class="sect3">
6912: <div class="titlepage"><div><div><h4 class="title">
6913: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 6914: <p>When adding a package with a new license, the following steps
6915: are required:</p>
6916: <div class="orderedlist"><ol class="orderedlist" type="1">
6917: <li class="listitem">
1.111 sevan 6918: <p>Check whether the license qualifies as Free or Open
6919: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
6920: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
6921: Open Source Initiative</a>. If this is the case, the filename in
6922: <code class="filename">pkgsrc/licenses/</code> does not need the
6923: <code class="filename">-license</code> suffix, and the license name should be
6924: added to:</p>
1.48 rodent 6925: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6926: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
6927: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
6928: </ul></div>
6929: </li>
6930: <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>
6931: </ol></div>
1.111 sevan 6932: </div>
6933: <div class="sect3">
6934: <div class="titlepage"><div><div><h4 class="title">
6935: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 6936: <p>When the license changes (in a way other than formatting),
1.111 sevan 6937: make sure that the new license has a different name (e.g.,
1.1 dsieger 6938: append the version number if it exists, or the date). Just
6939: because a user told pkgsrc to build programs under a previous
6940: version of a license does not mean that pkgsrc should build
6941: programs under the new licenses. The higher-level point is that
6942: pkgsrc does not evaluate licenses for reasonableness; the only
6943: test is a mechanistic test of whether a particular text has been
1.111 sevan 6944: approved by either of two bodies (FSF or OSI).</p>
6945: </div>
1.1 dsieger 6946: </div>
1.41 asau 6947: <div class="sect2">
1.1 dsieger 6948: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6949: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 6950: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 6951: By declaring the restrictions, package tools can
1.1 dsieger 6952: automatically refrain from e.g. placing binary packages on FTP
6953: sites.</p>
1.111 sevan 6954: <p>There are four possible restrictions, which are
1.1 dsieger 6955: the cross product of sources (distfiles) and binaries not being
6956: placed on FTP sites and CD-ROMs. Because this is rarely the exact
6957: language in any license, and because non-Free licenses tend to be
6958: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 6959: CD-ROM.
6960:
6961: "FTP" means making the source or binary file available over the
6962: Internet at no charge.
6963:
6964: "CD-ROM" means making the source or binary available on some kind of
6965: media, together with other source and binary packages, which is sold
6966: for a distribution charge.
1.1 dsieger 6967: </p>
6968: <p>In order to encode these restrictions, the package system
6969: defines five make variables that can be set to note these
6970: restrictions:</p>
1.41 asau 6971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6972: <li class="listitem">
1.1 dsieger 6973: <p><code class="varname">RESTRICTED</code></p>
6974: <p>This variable should be set whenever a restriction
6975: exists (regardless of its kind). Set this variable to a
6976: string containing the reason for the restriction. It should
6977: be understood that those wanting to understand the restriction
6978: will have to read the license, and perhaps seek advice of
6979: counsel.</p>
6980: </li>
1.23 wiz 6981: <li class="listitem">
1.1 dsieger 6982: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
6983: <p>Binaries may not be placed on CD-ROM containing other
6984: binary packages, for which a distribution charge may be made.
6985: In this case, set this variable to
6986: <code class="varname">${RESTRICTED}</code>.</p>
6987: </li>
1.23 wiz 6988: <li class="listitem">
1.1 dsieger 6989: <p><code class="varname">NO_BIN_ON_FTP</code></p>
6990: <p>Binaries may not made available on the Internet without
6991: charge. In this case, set this variable to
6992: <code class="varname">${RESTRICTED}</code>. If this variable is set,
6993: binary packages will not be included on ftp.NetBSD.org.</p>
6994: </li>
1.23 wiz 6995: <li class="listitem">
1.1 dsieger 6996: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
6997: <p>Distfiles may not be placed on CD-ROM, together with
6998: other distfiles, for which a fee may be charged. In this
6999: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7000: </p>
7001: </li>
1.23 wiz 7002: <li class="listitem">
1.1 dsieger 7003: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7004: <p>Distfiles may not made available via FTP at no charge.
7005: In this case, set this variable to
7006: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7007: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7008: </li>
7009: </ul></div>
1.111 sevan 7010: <p>Please note that packages will be removed from pkgsrc when the
7011: distfiles are not distributable and cannot be obtained for a period
7012: of one full quarter branch. Packages with manual/interactive fetch
7013: must have a maintainer and it is his/her responsibility to ensure
7014: this.</p>
1.1 dsieger 7015: </div>
1.41 asau 7016: <div class="sect2">
1.1 dsieger 7017: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7018: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7019: <p>Your package may depend on some other package being present
7020: - and there are various ways of expressing this dependency.
7021: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7022: <code class="varname">DEPENDS</code> definitions, the
7023: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7024: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7025: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7026: 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 7027: <p>The basic difference between the two variables is as
7028: follows: The <code class="varname">DEPENDS</code> definition registers
7029: that pre-requisite in the binary package so it will be pulled in
7030: when the binary package is later installed, whilst the
7031: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7032: dependency that is only needed for building the package.</p>
7033: <p>This means that if you only need a package present whilst
7034: you are building, it should be noted as a
7035: <code class="varname">BUILD_DEPENDS</code>.</p>
7036: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7037: <code class="varname">DEPENDS</code> definition is:</p>
7038: <pre class="programlisting">
7039: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7040: </pre>
1.23 wiz 7041: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7042: may include any of the wildcard version numbers recognized by
1.79 snj 7043: <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 7044: <div class="orderedlist"><ol class="orderedlist" type="1">
7045: <li class="listitem">
1.1 dsieger 7046: <p>If your package needs another package's binaries or
1.54 wiz 7047: libraries to build and run, and if that package has a
1.1 dsieger 7048: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7049: <pre class="programlisting">
7050: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7051: </pre>
1.1 dsieger 7052: </li>
1.23 wiz 7053: <li class="listitem">
1.54 wiz 7054: <p>If your package needs another package's binaries or
7055: libraries only for building, and if that package has a
7056: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7057: <pre class="programlisting">
7058: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7059: </pre>
1.54 wiz 7060: <p>but set
7061: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7062: to make it a build dependency only. This case is rather
7063: rare.</p>
7064: </li>
7065: <li class="listitem">
1.25 spz 7066: <p>If your package needs binaries from another package to build,
7067: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7068: <pre class="programlisting">
1.25 spz 7069: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.111 sevan 7070: </pre>
1.1 dsieger 7071: </li>
1.25 spz 7072: <li class="listitem"><p>If your package needs a library with which to link and
7073: there is no <code class="filename">buildlink3.mk</code> file
7074: available, create one. Using
7075: <code class="varname">DEPENDS</code> won't be sufficient because the
7076: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7077: <li class="listitem">
1.25 spz 7078: <p>If your package needs some executable to be able to run
7079: correctly and if there's no
7080: <code class="filename">buildlink3.mk</code> file, this is specified
7081: using the <code class="varname">DEPENDS</code> variable. The
1.79 snj 7082: <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 7083: be able to execute the latex binary from the teTeX package
7084: when it runs, and that is specified:</p>
1.1 dsieger 7085: <pre class="programlisting">
1.25 spz 7086: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.111 sevan 7087: </pre>
1.25 spz 7088: </li>
7089: <li class="listitem">
7090: <p>You can use wildcards in package dependencies. Note that
7091: such wildcard dependencies are retained when creating binary
7092: packages. The dependency is checked when installing the binary
7093: package and any package which matches the pattern will be
7094: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7095: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7096: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7097: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7098: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7099: <p>Wildcards can also be used to specify that a package
7100: will only build against a certain minimum version of a
7101: pre-requisite:</p>
7102: <pre class="programlisting">
1.25 spz 7103: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7104: </pre>
1.25 spz 7105: <p>This means that the package will build using version 6.0
7106: of ImageMagick or newer. Such a dependency may be warranted
7107: if, for example, the command line options of an executable
7108: have changed.</p>
7109: <p>If you need to depend on minimum versions of libraries,
7110: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7111: <p>For security fixes, please update the package
1.108 rillig 7112: 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 7113: information.</p>
7114: </li>
7115: </ol></div>
7116: <p>If your package needs files from another package to build,
7117: add the relevant distribution files to
7118: <code class="varname">DISTFILES</code>, so they will be extracted
1.79 snj 7119: 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 7120: (It relies on the jpeg sources being present in source form
7121: during the build.)</p>
7122: </div>
1.41 asau 7123: <div class="sect2">
1.1 dsieger 7124: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7125: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7126: <p>Your package may conflict with other packages a user might
7127: already have installed on his system, e.g. if your package
7128: installs the same set of files as another package in the pkgsrc
1.80 wiz 7129: tree or has the same <code class="varname">PKGNAME</code>.</p>
7130: <p>These cases are handled automatically by the packaging tools
7131: at package installation time and do not need to be handled
7132: manually.</p>
7133: <p>In case the conflicts can not be recognized automatically
7134: (e.g., packages using the same config file location but no other
7135: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7136: space-separated list of packages (including version string) your
7137: package conflicts with.</p>
1.80 wiz 7138: <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>
7139: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7140: use the same config file, you would set in
7141: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7142: <pre class="programlisting">
1.80 wiz 7143: CONFLICTS= baz-[0-9]*
1.111 sevan 7144: </pre>
1.80 wiz 7145: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7146: <pre class="programlisting">
1.80 wiz 7147: CONFLICTS= bar-[0-9]*
1.111 sevan 7148: </pre>
1.1 dsieger 7149: </div>
1.41 asau 7150: <div class="sect2">
1.1 dsieger 7151: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7152: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7153: <p>There are several reasons why a package might be
7154: instructed to not build under certain circumstances. If the
7155: package builds and runs on most platforms, the exceptions
1.83 dholland 7156: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7157: the package builds and runs on a small handful of platforms,
7158: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7159: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7160: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7161: (OS-version-platform) that can use glob-style
7162: wildcards.</p>
7163: <p>If a package is not appropriate for some platforms (as
7164: oopposed to merely broken), a different set of variables should be
7165: used as this affects failure reporting and statistics.
7166: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7167: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7168: the package is appropriate for only a small handful of platforms
7169: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7170: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7171: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7172: (OS-version-platform) that can use glob-style
7173: wildcards.</p>
7174: <p>Some packages are tightly bound to a specific version of an
1.79 snj 7175: 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 7176: backwards compatible with other versions of the OS, and should be
7177: uploaded to a version specific directory on the FTP server. Mark
7178: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7179: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7180: the package system internals, but may be used in the
7181: future.</p>
7182: <p>If the package should be skipped (for example, because it
7183: provides functionality already provided by the system), set
7184: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7185: the package should fail because some preconditions are not met,
7186: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7187: message.</p>
7188: </div>
1.41 asau 7189: <div class="sect2">
1.1 dsieger 7190: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7191: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7192: <p>To ensure that a package may not be deleted, once it has been
7193: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7194: be set in the package Makefile. This will be carried into any
7195: binary package that is made from this pkgsrc entry. A
1.23 wiz 7196: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.79 snj 7197: 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 7198: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7199: </div>
1.41 asau 7200: <div class="sect2">
1.1 dsieger 7201: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7202: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7203: <p>When a vulnerability is found, this should be noted in
7204: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7205: and after committing that file, ask pkgsrc-security@NetBSD.org to
7206: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7207: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7208: <code class="varname">PKGREVISION</code> should be increased (this is of
7209: course not necessary if the problem is fixed by using a newer
7210: release of the software), and the pattern in the
7211: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7212: <p>Also, if the fix should be applied to the stable pkgsrc
7213: branch, be sure to submit a pullup request!</p>
7214: <p>Binary packages already on ftp.NetBSD.org will be handled
7215: semi-automatically by a weekly cron job.</p>
7216: </div>
1.41 asau 7217: <div class="sect2">
1.1 dsieger 7218: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7219: <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 7220: <p>When making fixes to an existing package it can be useful
7221: to change the version number in <code class="varname">PKGNAME</code>. To
7222: avoid conflicting with future versions by the original author, a
1.23 wiz 7223: <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 7224: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7225: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7226: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7227: <pre class="programlisting">
7228: DISTNAME= foo-17.42
7229: PKGREVISION= 9
1.111 sevan 7230: </pre>
1.1 dsieger 7231: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7232: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7233: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7234: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7235: <code class="varname">PKGNAME_NOREV</code>.</p>
7236: <p>When a new release of the package is released, the
7237: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7238: minor release of the above package, things should be like:</p>
7239: <pre class="programlisting">
7240: DISTNAME= foo-17.43
1.111 sevan 7241: </pre>
1.1 dsieger 7242: <p><code class="varname">PKGREVISION</code> should be incremented for any
7243: non-trivial change in the resulting binary package. Without a
7244: <code class="varname">PKGREVISION</code> bump, someone with the previous
7245: version installed has no way of knowing that their package is out
7246: of date. Thus, changes without increasing
7247: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7248: trivial that no reasonable person would want to upgrade", and this
7249: is the rough test for when increasing
7250: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7251: changes that do not merit increasing
7252: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7253: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7254: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7255: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7256: or comments in Makefile.</p></li>
1.23 wiz 7257: <li class="listitem"><p>
1.1 dsieger 7258: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7259: <li class="listitem"><p>
1.1 dsieger 7260: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7261: <li class="listitem"><p>
1.1 dsieger 7262: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7263: </ul></div>
7264: <p>Examples of changes that do merit an increase to
7265: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7266: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7267: <li class="listitem"><p>
1.1 dsieger 7268: Security fixes</p></li>
1.23 wiz 7269: <li class="listitem"><p>
1.1 dsieger 7270: Changes or additions to a patch file</p></li>
1.23 wiz 7271: <li class="listitem"><p>
1.1 dsieger 7272: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 7273: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 7274: </ul></div>
7275: <p>PKGREVISION must also be incremented when dependencies have ABI
7276: changes.</p>
7277: </div>
1.41 asau 7278: <div class="sect2">
1.1 dsieger 7279: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7280: <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 7281: <p>When you want to replace the same text in multiple files
7282: or when the replacement text varies, patches alone cannot help.
7283: This is where the SUBST framework comes in. It provides an
7284: easy-to-use interface for replacing text in files.
7285: Example:</p>
7286: <pre class="programlisting">
7287: SUBST_CLASSES+= fix-paths
7288: SUBST_STAGE.fix-paths= pre-configure
7289: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7290: SUBST_FILES.fix-paths= src/*.c
7291: SUBST_FILES.fix-paths+= scripts/*.sh
7292: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7293: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 sevan 7294: </pre>
1.1 dsieger 7295: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7296: that are used to identify the different SUBST blocks that are
7297: defined. The SUBST framework is heavily used by pkgsrc, so it is
7298: important to always use the <code class="literal">+=</code> operator with
7299: this variable. Otherwise some substitutions may be
7300: skipped.</p>
7301: <p>The remaining variables of each SUBST block are
7302: parameterized with the identifier from the first line
7303: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7304: parameters to a function call.</p>
7305: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7306: which the replacement will take place. All combinations of
7307: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7308: <code class="literal">post-</code> together with a phase name are
7309: possible, though only few are actually used. Most commonly used
7310: are <code class="literal">post-patch</code> and
7311: <code class="literal">pre-configure</code>. Of these two,
7312: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7313: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7314: have the state after applying the patches but before making any
7315: other changes. This is especially useful when you are debugging
7316: a package in order to create new patches for it. Similarly,
7317: <code class="literal">post-build</code> is preferred over
7318: <code class="literal">pre-install</code>, because the install phase should
7319: generally be kept as simple as possible. When you use
7320: <code class="literal">post-build</code>, you have the same files in the
7321: working directory that will be installed later, so you can check
7322: if the substitution has succeeded.</p>
7323: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7324: that is printed just before the substitution is done.</p>
7325: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7326: globbing patterns that specifies the files in which the
7327: substitution will take place. The patterns are interpreted
7328: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7329: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.79 snj 7330: <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 7331: command should be prefixed with <code class="literal">-e</code>, so that
7332: all SUBST blocks look uniform.</p>
7333: <p>There are some more variables, but they are so seldomly
7334: used that they are only documented in the
7335: <code class="filename">mk/subst.mk</code> file.</p>
7336: </div>
7337: </div>
1.41 asau 7338: <div class="sect1">
1.1 dsieger 7339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7340: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7341: <div class="sect2">
1.1 dsieger 7342: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7343: <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 7344: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7345: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7346: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7347: with the name of each file to download as an argument, expecting
7348: it to output the URL of the directory from which to download
1.79 snj 7349: 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 7350: example of this usage.</p>
7351: <p>If the download can't be automated, because the user must
7352: submit personal information to apply for a password, or must pay
7353: for the source, or whatever, you can set
7354: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7355: displayed to the user before aborting the build. Example:</p>
7356: <pre class="programlisting">
7357: FETCH_MESSAGE= "Please download the files"
7358: FETCH_MESSAGE+= " "${DISTFILES:Q}
7359: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7360: </pre>
1.1 dsieger 7361: </div>
1.41 asau 7362: <div class="sect2">
1.1 dsieger 7363: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7364: <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 7365: <p>Sometimes authors of a software package make some
7366: modifications after the software was released, and they put up a
7367: new distfile without changing the package's version number. If a
7368: package is already in pkgsrc at that time, the checksum will
7369: no longer match. The contents of the new distfile should be
7370: compared against the old one before changing anything, to make
7371: sure the distfile was really updated on purpose, and that
7372: no trojan horse or so crept in.
7373: Please mention that the distfiles were compared and what was found
1.53 rodent 7374: in your commit message.</p>
1.109 wiz 7375: <p>Then, the correct way to work around this is to set
7376: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7377: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7378: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7379: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7380: <code class="varname">PATCHFILES</code> for this package will be put in that
1.109 wiz 7381: 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 7382: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7383: including the <code class="filename">nbX</code> suffix) or a date stamp can
7384: be appended, like
7385: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53 rodent 7386: <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>
7387: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7388: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7389: path in the filenames.
1.53 rodent 7390: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7391: Furthermore, a mail to the package's authors seems appropriate
7392: telling them that changing distfiles after releases without
7393: changing the file names is not good practice.</p>
7394: </div>
1.88 tnn 7395: <div class="sect2">
7396: <div class="titlepage"><div><div><h3 class="title">
7397: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 7398: <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:
7399: </p>
1.88 tnn 7400: <div class="sect3">
7401: <div class="titlepage"><div><div><h4 class="title">
7402: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
7403: <p>
7404: 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.
7405: </p>
7406: <pre class="programlisting">
7407: DISTNAME= exampleproject-1.0
1.90 tnn 7408: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7409: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7410: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7411: EXTRACT_SUFX= .zip
7412: </pre>
7413: </div>
7414: <div class="sect3">
7415: <div class="titlepage"><div><div><h4 class="title">
7416: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
7417: <p>
7418: 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.
7419: </p>
7420: <pre class="programlisting">
7421: DISTNAME= example-1.0
1.107 jnemeth 7422: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7423: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7424: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7425: </pre>
1.88 tnn 7426: </div>
7427: <div class="sect3">
7428: <div class="titlepage"><div><div><h4 class="title">
7429: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
7430: <p>
7431: 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.
7432: </p>
7433: <pre class="programlisting">
7434: DISTNAME= offensive-1.6
1.90 tnn 7435: PKGNAME= ${DISTNAME:S/offensive/proper/}
7436: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7437: GITHUB_PROJECT= exampleproject
7438: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7439: EXTRACT_SUFX= .zip
1.111 sevan 7440: </pre>
1.88 tnn 7441: </div>
7442: </div>
1.1 dsieger 7443: </div>
1.41 asau 7444: <div class="sect1">
1.1 dsieger 7445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7446: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7447: <div class="sect2">
1.1 dsieger 7448: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7449: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7450: <p>pkgsrc supports many different machines, with different
7451: object formats like a.out and ELF, and varying abilities to do
7452: shared library and dynamic loading at all. To accompany this,
7453: varying commands and options have to be passed to the
7454: compiler, linker, etc. to get the Right Thing, which can be
7455: pretty annoying especially if you don't have all the machines
7456: at your hand to test things. The
1.79 snj 7457: <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 7458: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7459: both static and dynamic libraries from a set of source files,
7460: thus being platform-independent.</p>
7461: <p>Here's how to use libtool in a package in seven simple
7462: steps:</p>
1.23 wiz 7463: <div class="orderedlist"><ol class="orderedlist" type="1">
7464: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7465: Makefile.</p></li>
1.23 wiz 7466: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7467: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7468: add it to the definition of <code class="varname">CC</code>, if only
7469: libraries are being built in a given Makefile. This one command
7470: will build both PIC and non-PIC library objects, so you need not
7471: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7472: <li class="listitem">
1.1 dsieger 7473: <p>For the linking of the library, remove any
1.23 wiz 7474: <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
7475: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7476: <pre class="programlisting">
7477: ${LIBTOOL} --mode=link \
7478: ${CC} -o ${.TARGET:.a=.la} \
7479: ${OBJS:.o=.lo} \
7480: -rpath ${PREFIX}/lib \
7481: -version-info major:minor
1.111 sevan 7482: </pre>
1.1 dsieger 7483: <p>Note that the library is changed to have a
7484: <code class="filename">.la</code> extension, and the objects are
7485: changed to have a <code class="filename">.lo</code>
7486: extension. Change <code class="varname">OBJS</code> as
7487: necessary. This automatically creates all of the
7488: <code class="filename">.a</code>,
7489: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7490: necessary) in the build directory. Be sure to include
1.23 wiz 7491: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7492: minor are zero, as libtool will otherwise strip off the
7493: shared library version.</p>
7494: <p>From the libtool manual:</p>
7495: <pre class="programlisting">
7496: So, libtool library versions are described by three integers:
7497:
7498: CURRENT
7499: The most recent interface number that this library implements.
7500:
7501: REVISION
7502: The implementation number of the CURRENT interface.
7503:
7504: AGE
7505: The difference between the newest and oldest interfaces that
7506: this library implements. In other words, the library implements
7507: all the interface numbers in the range from number `CURRENT -
7508: AGE' to `CURRENT'.
7509:
7510: If two libraries have identical CURRENT and AGE numbers, then the
7511: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 7512: </pre>
1.23 wiz 7513: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7514: different results for a.out and ELF (excluding symlinks)
7515: in only one case. An ELF library of the form
1.23 wiz 7516: <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 7517: will have a symlink of
1.23 wiz 7518: <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 7519: on an a.out platform. This is handled
7520: automatically.</p>
1.23 wiz 7521: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7522: directory of the library being built.</p>
7523: <p>In the <code class="filename">PLIST</code>, include only the
7524: <code class="filename">.la</code> file, the other files will be
7525: added automatically.</p>
7526: </li>
1.23 wiz 7527: <li class="listitem">
1.1 dsieger 7528: <p>When linking shared object (<code class="filename">.so</code>)
1.79 snj 7529: 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 7530: shared libraries, use <span class="quote">“<span class="quote">-module
7531: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7532: tacked on.</p>
7533: <p>The <code class="filename">PLIST</code> file gets the
7534: <code class="filename">foo.so</code> entry.</p>
7535: </li>
1.23 wiz 7536: <li class="listitem">
1.1 dsieger 7537: <p>When linking programs that depend on these libraries
7538: <span class="emphasis"><em>before</em></span> they are installed, preface
1.79 snj 7539: 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 7540: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7541: libraries (static or shared), but please be aware that
7542: libtool will not allow you to specify a relative path in
1.23 wiz 7543: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7544: expects you to change that argument to be the
7545: <code class="filename">.la</code> file. e.g.</p>
7546: <pre class="programlisting">
7547: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 7548: </pre>
1.1 dsieger 7549: <p>should be changed to:</p>
7550: <pre class="programlisting">
7551: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 7552: </pre>
1.1 dsieger 7553: <p>and it will do the right thing with the libraries.</p>
7554: </li>
1.23 wiz 7555: <li class="listitem">
1.79 snj 7556: <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>
7557: 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 7558: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7559: <code class="filename">.la</code>. e.g.</p>
7560: <pre class="programlisting">
1.22 jakllsch 7561: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 7562: </pre>
1.1 dsieger 7563: <p>This will install the static <code class="filename">.a</code>,
7564: shared library, any needed symlinks, and run
1.79 snj 7565: <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 7566: </li>
1.23 wiz 7567: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7568: the <code class="filename">.la</code>
7569: file (this is a change from previous behaviour).</p></li>
7570: </ol></div>
7571: </div>
1.41 asau 7572: <div class="sect2">
1.1 dsieger 7573: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7574: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7575: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7576: package Makefile. This will override the package's own libtool
7577: in most cases. For older libtool using packages, libtool is
7578: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7579: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7580: configure; find work*/ -name libtool</strong></span>.</p>
7581: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7582: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7583: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7584: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7585: package's libtool script(s), set it as appropriate.</p>
7586: <p>If you do not need <code class="filename">*.a</code> static
7587: libraries built and installed, then use
7588: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7589: <p>If your package makes use of the platform-independent library
7590: for loading dynamic shared objects, that comes with libtool
7591: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7592: <p>Some packages use libtool incorrectly so that the package
7593: may not work or build in some circumstances. Some of the more
7594: common errors are:</p>
1.41 asau 7595: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7596: <li class="listitem">
1.1 dsieger 7597: <p>The inclusion of a shared object (-module) as a dependent library in an
7598: executable or library. This in itself isn't a problem if one of two things
7599: has been done:</p>
1.23 wiz 7600: <div class="orderedlist"><ol class="orderedlist" type="1">
7601: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7602: <code class="filename">libfoo.la</code>, not
7603: <code class="filename">foo.la</code></p></li>
1.23 wiz 7604: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7605: </ol></div>
7606: </li>
1.23 wiz 7607: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7608: The function lt_dlinit() should be called and the macro
7609: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7610: executables.</p></li>
7611: </ul></div>
7612: </div>
1.41 asau 7613: <div class="sect2">
1.1 dsieger 7614: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7615: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7616: <p>If a package needs GNU autoconf or automake to be executed
7617: to regenerate the configure script and Makefile.in makefile
7618: templates, then they should be executed in a pre-configure
7619: target.</p>
7620: <p>For packages that need only autoconf:</p>
7621: <pre class="programlisting">
7622: AUTOCONF_REQD= 2.50 # if default version is not good enough
7623: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7624: ...
7625:
7626: pre-configure:
7627: cd ${WRKSRC} && autoconf
7628:
7629: ...
1.111 sevan 7630: </pre>
1.1 dsieger 7631: <p>and for packages that need automake and autoconf:</p>
7632: <pre class="programlisting">
7633: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7634: USE_TOOLS+= automake # use "automake14" for automake-1.4
7635: ...
7636:
7637: pre-configure:
7638: set -e; cd ${WRKSRC}; \
7639: aclocal; autoheader; automake -a --foreign -i; autoconf
7640:
7641: ...
1.111 sevan 7642: </pre>
1.1 dsieger 7643: <p>Packages which use GNU Automake will almost certainly
7644: require GNU Make.</p>
7645: <p>There are times when the configure process makes
7646: additional changes to the generated files, which then causes
7647: the build process to try to re-execute the automake sequence.
7648: This is prevented by touching various files in the configure
7649: stage. If this causes problems with your package you can set
7650: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7651: Makefile.</p>
7652: </div>
7653: </div>
1.41 asau 7654: <div class="sect1">
1.1 dsieger 7655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7656: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 7657: <div class="sect2">
1.1 dsieger 7658: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7659: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7660: <p>Compilers for the C, C++, and Fortran languages comes with
7661: the NetBSD base system. By default, pkgsrc assumes that a package
7662: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 7663: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7664: <p>To declare which language's compiler a package needs, set
7665: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7666: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7667: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7668: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7669: written in C++, usually need a C compiler for the configure
7670: phase.</p>
7671: </div>
1.41 asau 7672: <div class="sect2">
1.1 dsieger 7673: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7674: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 7675: <p>If a program is written in Java, use the Java framework in
7676: pkgsrc. The package must include
7677: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7678: provides the following variables:</p>
1.41 asau 7679: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7680: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7681: dependency on the JDK is added. If
1.23 wiz 7682: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7683: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7684: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7685: JDK.</p></li>
1.23 wiz 7686: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7687: a package needs a Java2 implementation. The supported values
1.23 wiz 7688: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7689: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7690: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7691: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7692: above. This variable is not set by default.</p></li>
1.24 wiz 7693: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7694: automatically set to the runtime location of the used Java
7695: implementation dependency. It may be used to set
7696: <code class="varname">JAVA_HOME</code> to a good value if the program
7697: needs this variable to be defined.
7698: </p></li>
1.1 dsieger 7699: </ul></div>
7700: </div>
1.41 asau 7701: <div class="sect2">
1.1 dsieger 7702: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7703: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7704: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7705: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7706: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7707: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7708: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7709: that you want adjusted. Every occurrence of
7710: <code class="filename">*/bin/perl</code> in a she-bang line will be
7711: replaced with the full path to the perl executable.</p>
1.1 dsieger 7712: <p>If a particular version of perl is needed, set the
7713: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7714: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 7715: <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 7716: about handling perl modules.</p>
7717: </div>
1.41 asau 7718: <div class="sect2">
1.1 dsieger 7719: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 7720: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
7721: <p><code class="varname">REPLACE_SH</code>,
7722: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7723: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7724: hash bangs in files. Please use the appropriate one, prefering
7725: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7726: Each should contain a list of scripts, relative to
7727: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7728: occurrence of the matching shell in a she-bang line will be
7729: replaced with the full path to the shell executable.
1.40 wiz 7730: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7731: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7732: </div>
1.41 asau 7733: <div class="sect2">
1.40 wiz 7734: <div class="titlepage"><div><div><h3 class="title">
7735: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7736: <p>Currently, there is no special handling for other languages
7737: in pkgsrc. If a compiler package provides a
7738: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7739: just add a (build) dependency on the appropriate compiler
7740: package.</p>
7741: </div>
7742: </div>
1.41 asau 7743: <div class="sect1">
1.1 dsieger 7744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7745: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7746: <p>The most common failures when building a package are that
7747: some platforms do not provide certain header files, functions or
7748: libraries, or they provide the functions in a library that the
7749: original package author didn't know. To work around this, you
7750: can rewrite the source code in most cases so that it does not
7751: use the missing functions or provides a replacement function.</p>
1.41 asau 7752: <div class="sect2">
1.1 dsieger 7753: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7754: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7755: <p>If a package already comes with a GNU configure script, the
7756: preferred way to fix the build failure is to change the
7757: configure script, not the code. In the other cases, you can
7758: utilize the C preprocessor, which defines certain macros
7759: depending on the operating system and hardware architecture it
7760: compiles for. These macros can be queried using for example
7761: <code class="varname">#if defined(__i386)</code>. Almost every operating
7762: system, hardware architecture and compiler has its own macro.
7763: For example, if the macros <code class="varname">__GNUC__</code>,
7764: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7765: are all defined, you know that you are using NetBSD on an i386
7766: compatible CPU, and your compiler is GCC.</p>
7767: <p>The list of the following macros for hardware and
7768: operating system depends on the compiler that is used. For
7769: example, if you want to conditionally compile code on Solaris,
7770: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7771: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7772: <div class="sect3">
1.1 dsieger 7773: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7774: <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 7775: <p>To distinguish between 4.4 BSD-derived systems and the
7776: rest of the world, you should use the following code.</p>
7777: <pre class="programlisting">
7778: #include <sys/param.h>
7779: #if (defined(BSD) && BSD >= 199306)
7780: /* BSD-specific code goes here */
7781: #else
7782: /* non-BSD-specific code goes here */
7783: #endif
7784: </pre>
7785: <p>If this distinction is not fine enough, you can also test
7786: for the following macros.</p>
7787: <pre class="programlisting">
1.45 obache 7788: Cygwin __CYGWIN__
7789: DragonFly __DragonFly__
1.1 dsieger 7790: FreeBSD __FreeBSD__
1.45 obache 7791: Haiku __HAIKU__
1.1 dsieger 7792: Interix __INTERIX
7793: IRIX __sgi (TODO: get a definite source for this)
7794: Linux linux, __linux, __linux__
1.83 dholland 7795: Mac OS X __APPLE__
1.45 obache 7796: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7797: Minix3 __minix
1.1 dsieger 7798: NetBSD __NetBSD__
7799: OpenBSD __OpenBSD__
7800: Solaris sun, __sun
7801: </pre>
7802: </div>
1.41 asau 7803: <div class="sect3">
1.1 dsieger 7804: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7805: <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 7806: <pre class="programlisting">
7807: i386 i386, __i386, __i386__
7808: MIPS __mips
7809: SPARC sparc, __sparc
7810: </pre>
7811: </div>
1.41 asau 7812: <div class="sect3">
1.1 dsieger 7813: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7814: <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 7815: <pre class="programlisting">
7816: GCC __GNUC__ (major version), __GNUC_MINOR__
7817: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7818: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7819: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7820: </pre>
7821: </div>
7822: </div>
1.41 asau 7823: <div class="sect2">
1.1 dsieger 7824: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7825: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 7826: <p>Some source files trigger bugs in the compiler, based on
7827: combinations of compiler version and architecture and almost
7828: always relation to optimisation being enabled. Common symptoms
7829: are gcc internal errors or never finishing compiling a
7830: file.</p>
7831: <p>Typically, a workaround involves testing the
7832: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7833: optimisation for that combination of file,
1.87 tnn 7834: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7835: <p>This used to be a big problem in the past, but is rarely
7836: needed now as compiler technology has matured. If you still need
7837: to add a compiler specific workaround, please do so in the file
7838: <code class="filename">hacks.mk</code> and describe the symptom and
7839: compiler version as detailed as possible.</p>
1.1 dsieger 7840: </div>
1.41 asau 7841: <div class="sect2">
1.1 dsieger 7842: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 7843: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
7844: </h3></div></div></div>
1.1 dsieger 7845: <p>This error message often means that a package did not
7846: link to a shared library it needs. The following functions are
7847: known to cause this error message over and over.</p>
7848: <div class="informaltable">
1.106 tnn 7849: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 7850: <colgroup>
7851: <col>
7852: <col>
7853: <col>
7854: </colgroup>
7855: <thead><tr>
7856: <th>Function</th>
7857: <th>Library</th>
7858: <th>Affected platforms</th>
7859: </tr></thead>
7860: <tbody>
7861: <tr>
7862: <td>accept, bind, connect</td>
7863: <td>-lsocket</td>
7864: <td>Solaris</td>
7865: </tr>
7866: <tr>
7867: <td>crypt</td>
7868: <td>-lcrypt</td>
7869: <td>DragonFly, NetBSD</td>
7870: </tr>
7871: <tr>
7872: <td>dlopen, dlsym</td>
7873: <td>-ldl</td>
7874: <td>Linux</td>
7875: </tr>
7876: <tr>
7877: <td>gethost*</td>
7878: <td>-lnsl</td>
7879: <td>Solaris</td>
7880: </tr>
7881: <tr>
7882: <td>inet_aton</td>
7883: <td>-lresolv</td>
7884: <td>Solaris</td>
7885: </tr>
7886: <tr>
7887: <td>nanosleep, sem_*, timer_*</td>
7888: <td>-lrt</td>
7889: <td>Solaris</td>
7890: </tr>
7891: <tr>
7892: <td>openpty</td>
7893: <td>-lutil</td>
7894: <td>Linux</td>
7895: </tr>
7896: </tbody>
7897: </table>
7898: </div>
7899: <p>To fix these linker errors, it is often sufficient to say
7900: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
7901: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 7902: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 7903: bmake</strong></span>.</p>
1.41 asau 7904: <div class="sect3">
1.1 dsieger 7905: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7906: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 7907: <p>When you are using the SunPro compiler, there is another
7908: possibility. That compiler cannot handle the following code:</p>
7909: <pre class="programlisting">
7910: extern int extern_func(int);
7911:
7912: static inline int
7913: inline_func(int x)
7914: {
7915: return extern_func(x);
7916: }
7917:
7918: int main(void)
7919: {
7920: return 0;
7921: }
7922: </pre>
7923: <p>It generates the code for <code class="function">inline_func</code> even if
7924: that function is never used. This code then refers to
7925: <code class="function">extern_func</code>, which can usually not be resolved. To
7926: solve this problem you can try to tell the package to disable inlining
7927: of functions.</p>
7928: </div>
7929: </div>
1.41 asau 7930: <div class="sect2">
1.1 dsieger 7931: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7932: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 7933: <p>Sometimes packages fail to build because the compiler runs
7934: into an operating system specific soft limit. With the
7935: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 7936: to unlimit the resources. Currently, the allowed values are any combination of
7937: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
7938: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 7939: Setting this variable is similar to running the shell builtin
1.10 hubertf 7940: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 7941: segment size or maximum stack size of a process, respectively, to
7942: their hard limits.</p>
7943: </div>
7944: </div>
1.41 asau 7945: <div class="sect1">
1.1 dsieger 7946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7947: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 7948: <div class="sect2">
1.1 dsieger 7949: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7950: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 7951: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 7952: with some operating systems cannot create more than one
7953: directory at a time. As such, you should call
7954: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
7955: <pre class="programlisting">
7956: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7957: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 7958: </pre>
1.23 wiz 7959: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
7960: dir2</code></span>”</span> to the
1.1 dsieger 7961: <code class="varname">INSTALLATION_DIRS</code> variable, which will
7962: automatically do the right thing.</p>
7963: </div>
1.41 asau 7964: <div class="sect2">
1.1 dsieger 7965: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7966: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 7967: <p>In general, documentation should be installed into
7968: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7969: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
7970: includes the version number of the package).</p>
7971: <p>Many modern packages using GNU autoconf allow to set the
7972: directory where HTML documentation is installed with the
1.23 wiz 7973: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 7974: is needed because otherwise the documentation ends up in
7975: <code class="filename">${PREFIX}/share/doc/html</code> or other
7976: places.</p>
7977: <p>An exception to the above is that library API documentation
1.79 snj 7978: 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 7979: browsers (devhelp) should be left at their default location, which
7980: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
7981: documentation can be recognized from files ending in
7982: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
7983: (It is also acceptable to install such files in
7984: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7985: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
7986: <code class="filename">.devhelp*</code> file must be directly in that
7987: directory then, no additional subdirectory level is allowed in
7988: this case. This is usually achieved by using
1.23 wiz 7989: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 7990: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
7991: though.)</p>
7992: </div>
1.41 asau 7993: <div class="sect2">
1.1 dsieger 7994: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7995: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 7996: <p>Certain packages, most of them in the games category, install
7997: a score file that allows all users on the system to record their
7998: highscores. In order for this to work, the binaries need to be
7999: installed setgid and the score files owned by the appropriate
1.35 wiz 8000: group and/or owner (traditionally the "games" user/group). Set
8001: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8002: following variables, documented in more detail in
8003: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8004: behaviour: <code class="varname">GAMEDATAMODE</code>,
8005: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8006: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8007: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8008: <code class="varname">GAMEDATA_PERMS</code> and
8009: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8010: <p>An example that illustrates some of the variables described above is
8011: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8012: used to properly set directory permissions of the directory where the
8013: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8014: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8015: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8016: binary:</p>
8017: <pre class="programlisting">
1.112 ! rillig 8018: USE_GAMESGROUP= yes
1.100 leot 8019:
1.112 ! rillig 8020: BUILD_DEFS+= VARBASE
1.100 leot 8021:
1.112 ! rillig 8022: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
! 8023: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
! 8024: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8025: </pre>
1.100 leot 8026: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8027: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8028: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8029: needed to be accessed by setgid games and
8030: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8031: <p>A package should therefore never hard code file ownership or
1.100 leot 8032: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8033: or alternatively on <code class="varname">INSTALL_GAME</code>,
8034: <code class="varname">INSTALL_GAME_DATA</code> and
8035: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8036: </div>
1.41 asau 8037: <div class="sect2">
1.1 dsieger 8038: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8039: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8040: <p><code class="varname">DESTDIR</code> support means that a package
8041: installs into a staging directory, not the final location of the
8042: files. Then a binary package is created which can be used for
8043: installation as usual. There are two ways: Either the package must
1.23 wiz 8044: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8045: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8046: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8047: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 8048: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8049: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8050: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8051: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8052: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8053: the inclusion.</p></li>
1.23 wiz 8054: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8055: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8056: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8057: automatically. Many manual rules and pre/post-install often are
8058: incorrect; fix them.</p></li>
1.23 wiz 8059: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8060: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8061: <li class="listitem"><p>In general, packages should support
1.4 rillig 8062: <code class="varname">UNPRIVILEGED</code> to be able to use
8063: DESTDIR.</p></li>
8064: </ul></div>
8065: </div>
1.41 asau 8066: <div class="sect2">
1.4 rillig 8067: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8068: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8069: <p>Your package may also contain scripts with hardcoded paths to
8070: other interpreters besides (or as well as) perl. To correct the
8071: full pathname to the script interpreter, you need to set the
8072: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8073: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8074: <pre class="programlisting">
8075: REPLACE_INTERPRETER+= tcl
8076: REPLACE.tcl.old= .*/bin/tclsh
8077: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8078: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8079: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8080: </pre>
1.41 asau 8081: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8082: <h3 class="title">Note</h3>
8083: <p>Before March 2006, these variables were called
8084: <code class="varname">_REPLACE.*</code> and
8085: <code class="varname">_REPLACE_FILES.*</code>.</p>
8086: </div>
8087: </div>
1.41 asau 8088: <div class="sect2">
1.1 dsieger 8089: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8090: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8091: <p>Makefiles of packages providing perl5 modules should include
8092: the Makefile fragment
8093: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8094: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8095: configuration for such modules as well as various hooks to tune
8096: this configuration. See comments in this file for
8097: details.</p>
8098: <p>Perl5 modules will install into different places depending
8099: on the version of perl used during the build process. To
8100: address this, pkgsrc will append lines to the
8101: <code class="filename">PLIST</code> corresponding to the files listed in
8102: the installed <code class="filename">.packlist</code> file generated by
8103: most perl5 modules. This is invoked by defining
8104: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8105: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8106: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8107: e.g.:</p>
1.1 dsieger 8108: <pre class="programlisting">
1.47 wiz 8109: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8110: </pre>
1.47 wiz 8111: <p>The perl5 config variables
8112: <code class="varname">installarchlib</code>,
8113: <code class="varname">installscript</code>,
8114: <code class="varname">installvendorbin</code>,
8115: <code class="varname">installvendorscript</code>,
8116: <code class="varname">installvendorarch</code>,
8117: <code class="varname">installvendorlib</code>,
8118: <code class="varname">installvendorman1dir</code>, and
8119: <code class="varname">installvendorman3dir</code> represent those
8120: locations in which components of perl5 modules may be installed,
8121: provided as variable with uppercase and prefixed with
8122: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8123: and may be used by perl5 packages that don't have a packlist.
8124: These variables are also substituted for in the
8125: <code class="filename">PLIST</code> as uppercase prefixed with
8126: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8127: </div>
1.41 asau 8128: <div class="sect2">
1.1 dsieger 8129: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8130: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8131: <p>Some packages install info files or use the
1.23 wiz 8132: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8133: commands. <code class="varname">INFO_FILES</code> should be defined in
8134: the package Makefile so that <code class="filename">INSTALL</code> and
8135: <code class="filename">DEINSTALL</code> scripts will be generated to
8136: handle registration of the info files in the Info directory
1.23 wiz 8137: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8138: files registration is either provided by the system, or by a
8139: special purpose package automatically added as dependency if
8140: needed.</p>
8141: <p><code class="varname">PKGINFODIR</code> is the directory under
8142: <code class="filename">${PREFIX}</code> where info files are primarily
8143: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8144: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8145: <p>The info files for the package should be listed in the
8146: package <code class="filename">PLIST</code>; however any split info files
8147: need not be listed.</p>
1.23 wiz 8148: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8149: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8150: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8151: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8152: should be noted with the <code class="varname">TEXINFO_REQD</code>
8153: variable in the package <code class="filename">Makefile</code>. By
8154: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8155: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8156: does not match the required minimum, a build dependency on the
1.79 snj 8157: <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 8158: be added automatically.</p>
8159: <p>The build and installation process of the software provided
8160: by the package should not use the
1.10 hubertf 8161: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8162: info files is the task of the package
8163: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8164: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8165: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8166: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8167: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8168: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8169: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8170: no effect except the logging of a message. The script overriding
1.10 hubertf 8171: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8172: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8173: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8174: </div>
1.41 asau 8175: <div class="sect2">
1.1 dsieger 8176: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8177: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8178: <p>All packages that install manual pages should install them
8179: into the same directory, so that there is one common place to look
8180: for them. In pkgsrc, this place is
8181: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8182: should be used in packages. The default for
8183: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8184: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8185: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8186: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8187: <h3 class="title">Note</h3>
8188: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8189: is far from complete.</p>
8190: </div>
8191: <p>The <code class="filename">PLIST</code> files can just use
8192: <code class="filename">man/</code> as the top level directory for the man
8193: page file entries, and the pkgsrc framework will convert as
8194: needed. In all other places, the correct
8195: <code class="varname">PKGMANDIR</code> must be used.</p>
8196: <p>Packages that are
8197: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8198: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8199: <code class="filename">./configure</code>
8200: --mandir switch to set where the man pages should be installed.
8201: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8202: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8203: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8204: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8205: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8206: Or if the <code class="filename">./configure</code> script uses
8207: a non-standard use of --mandir, you can set
8208: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8209: <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 8210: information on installation of compressed manual pages.</p>
8211: </div>
1.41 asau 8212: <div class="sect2">
1.1 dsieger 8213: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8214: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8215: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8216: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8217: you need to take some extra steps to make sure they get registered
8218: in the database:</p>
1.23 wiz 8219: <div class="orderedlist"><ol class="orderedlist" type="1">
8220: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8221: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8222: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8223: deinstallation time, and tells the package where to install
1.7 rillig 8224: GConf data files using some standard configure arguments. It
1.1 dsieger 8225: also disallows any access to the database directly from the
8226: package.</p></li>
1.23 wiz 8227: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8228: <code class="filename">.schemas</code> files under
8229: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8230: installed under <code class="filename">${PREFIX}/etc</code>, you will
8231: need to manually patch the package.</p></li>
1.23 wiz 8232: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8233: directory, as they will be handled automatically. See
1.84 wiz 8234: <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 8235: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8236: your <code class="filename">Makefile</code> with a list of all
8237: <code class="filename">.schemas</code> files installed by the package, if
8238: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8239: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8240: your <code class="filename">Makefile</code> with a
8241: list of all <code class="filename">.entries</code> files installed by the
8242: package, if any. Names must not contain any directories in
8243: them.</p></li>
8244: </ol></div>
8245: </div>
1.41 asau 8246: <div class="sect2">
1.1 dsieger 8247: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8248: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8249: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8250: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8251: get registered in the database:</p>
1.23 wiz 8252: <div class="orderedlist"><ol class="orderedlist" type="1">
8253: <li class="listitem"><p>Include
1.18 snj 8254: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8255: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8256: takes care of rebuilding the scrollkeeper database at
8257: installation and deinstallation time, and disallows any access
8258: to it directly from the package.</p></li>
1.23 wiz 8259: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8260: <code class="filename">libdata/scrollkeeper</code> directory, as they
8261: will be handled automatically.</p></li>
1.23 wiz 8262: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8263: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8264: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8265: </ol></div>
8266: </div>
1.41 asau 8267: <div class="sect2">
1.1 dsieger 8268: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8269: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8270: <p>If a package installs font files, you will need to rebuild
8271: the fonts database in the directory where they get installed at
8272: installation and deinstallation time. This can be automatically
8273: done by using the pkginstall framework.</p>
8274: <p>You can list the directories where fonts are installed in the
8275: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8276: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8277: <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 8278: Also make sure that the database file
8279: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8280: <p>Note that you should not create new directories for fonts;
8281: instead use the standard ones to avoid that the user needs to
8282: manually configure his X server to find them.</p>
8283: </div>
1.41 asau 8284: <div class="sect2">
1.1 dsieger 8285: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8286: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8287: <p>If a package installs GTK2 immodules or loaders, you need to
8288: take some extra steps to get them registered in the GTK2 database
8289: properly:</p>
1.23 wiz 8290: <div class="orderedlist"><ol class="orderedlist" type="1">
8291: <li class="listitem"><p>Include
1.1 dsieger 8292: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8293: <code class="filename">buildlink3.mk</code> file. This takes care of
8294: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8295: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8296: your package installs GTK2 immodules.</p></li>
1.23 wiz 8297: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8298: GTK2 loaders.</p></li>
1.23 wiz 8299: <li class="listitem">
1.1 dsieger 8300: <p>Patch the package to not touch any of the GTK2
8301: databases directly. These are:</p>
1.41 asau 8302: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8303: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8304: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8305: </ul></div>
8306: </li>
1.23 wiz 8307: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8308: any entries under the <code class="filename">libdata/gtk-2.0</code>
8309: directory, as they will be handled automatically.</p></li>
8310: </ol></div>
8311: </div>
1.41 asau 8312: <div class="sect2">
1.1 dsieger 8313: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8314: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8315: <p>If a package installs SGML or XML data files that need to be
8316: registered in system-wide catalogs (like DTDs, sub-catalogs,
8317: etc.), you need to take some extra steps:</p>
1.23 wiz 8318: <div class="orderedlist"><ol class="orderedlist" type="1">
8319: <li class="listitem"><p>Include
1.1 dsieger 8320: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8321: your <code class="filename">Makefile</code>, which takes care of
8322: registering those files in system-wide catalogs at
8323: installation and deinstallation time.</p></li>
1.23 wiz 8324: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8325: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8326: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8327: any XML catalogs installed by the package.</p></li>
1.23 wiz 8328: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8329: to be added to the SGML catalog. These come in groups of
8330: three strings; see xmlcatmgr(1) for more information
8331: (specifically, arguments recognized by the 'add' action).
8332: Note that you will normally not use this variable.</p></li>
1.23 wiz 8333: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8334: to be added to the XML catalog. These come in groups of three
8335: strings; see xmlcatmgr(1) for more information (specifically,
8336: arguments recognized by the 'add' action). Note that you will
8337: normally not use this variable.</p></li>
8338: </ol></div>
8339: </div>
1.41 asau 8340: <div class="sect2">
1.1 dsieger 8341: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8342: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8343: <p>If a package provides extensions to the MIME database by
8344: installing <code class="filename">.xml</code> files inside
8345: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8346: need to take some extra steps to ensure that the database is kept
8347: consistent with respect to these new files:</p>
1.23 wiz 8348: <div class="orderedlist"><ol class="orderedlist" type="1">
8349: <li class="listitem"><p>Include
1.1 dsieger 8350: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8351: (avoid using the <code class="filename">buildlink3.mk</code> file from
8352: this same directory, which is reserved for inclusion from
8353: other <code class="filename">buildlink3.mk</code> files). It takes
8354: care of rebuilding the MIME database at installation and
8355: deinstallation time, and disallows any access to it directly
8356: from the package.</p></li>
1.23 wiz 8357: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8358: <code class="filename">share/mime</code> directory,
8359: <span class="emphasis"><em>except</em></span> for files saved under
8360: <code class="filename">share/mime/packages</code>. The former are
8361: handled automatically by
8362: the update-mime-database program, but the latter are
8363: package-dependent and must be removed by the package that
8364: installed them in the first place.</p></li>
1.23 wiz 8365: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8366: from the PLIST. They will be handled by the shared-mime-info
8367: package.</p></li>
8368: </ol></div>
8369: </div>
1.41 asau 8370: <div class="sect2">
1.1 dsieger 8371: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8372: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8373: <p>If a package uses intltool during its build, add
8374: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8375: which forces it to use the intltool package provided by pkgsrc,
8376: instead of the one bundled with the distribution file.</p>
8377: <p>This tracks intltool's build-time dependencies and uses the
8378: latest available version; this way, the package benefits of any
8379: bug fixes that may have appeared since it was released.</p>
8380: </div>
1.41 asau 8381: <div class="sect2">
1.1 dsieger 8382: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8383: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8384: <p>If a package contains a rc.d script, it won't be copied into
8385: the startup directory by default, but you can enable it, by adding
8386: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8387: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8388: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8389: it will automatically remove the scripts when the package is
8390: deinstalled.</p>
8391: </div>
1.41 asau 8392: <div class="sect2">
1.1 dsieger 8393: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8394: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8395: <p>If a package installs TeX packages into the texmf tree,
8396: the <code class="filename">ls-R</code> database of the tree needs to be
8397: updated.</p>
1.41 asau 8398: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8399: <h3 class="title">Note</h3>
1.22 jakllsch 8400: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8401: packages should install files
1.22 jakllsch 8402: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8403: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8404: </div>
1.23 wiz 8405: <div class="orderedlist"><ol class="orderedlist" type="1">
8406: <li class="listitem"><p>Include
1.22 jakllsch 8407: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8408: takes care of rebuilding the <code class="filename">ls-R</code>
8409: database at installation and deinstallation time.</p></li>
1.23 wiz 8410: <li class="listitem">
1.1 dsieger 8411: <p>If your package installs files into a texmf
8412: tree other than the one
1.22 jakllsch 8413: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8414: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8415: trees that need database update.</p>
8416: <p>If your package also installs font map files that need
1.10 hubertf 8417: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8418: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8419: set <code class="varname">TEX_MAP_FILES</code> and/or
8420: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8421: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8422: be run automatically at installation/deinstallation to
8423: enable/disable font map files for TeX output
8424: drivers.</p>
8425: </li>
1.23 wiz 8426: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8427: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8428: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8429: </ol></div>
8430: </div>
1.41 asau 8431: <div class="sect2">
1.1 dsieger 8432: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8433: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 8434: emulation</h3></div></div></div>
8435: <p>There are some packages that provide libraries and
8436: executables for running binaries from a one operating system
8437: on a different one (if the latter supports it). One example
8438: is running Linux binaries on NetBSD.</p>
1.79 snj 8439: <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 8440: helps in extracting and packaging Linux rpm packages.</p>
8441: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8442: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8443: if all libraries for each installed executable can be found by
8444: the dynamic linker. Since the standard dynamic linker is run,
8445: this fails for emulation packages, because the libraries used
8446: by the emulation are not in the standard directories.</p>
8447: </div>
1.41 asau 8448: <div class="sect2">
1.1 dsieger 8449: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8450: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8451: <p>If a package installs images under the
8452: <code class="filename">share/icons/hicolor</code> and/or updates the
8453: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8454: database, you need to take some extra steps to make sure that the
8455: shared theme directory is handled appropriately and that the cache
8456: database is rebuilt:</p>
1.23 wiz 8457: <div class="orderedlist"><ol class="orderedlist" type="1">
8458: <li class="listitem"><p>Include
1.1 dsieger 8459: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8460: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8461: entry that refers to the theme cache.</p></li>
1.23 wiz 8462: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8463: directories from the <code class="filename">share/icons/hicolor</code>
8464: hierarchy because they will be handled automatically.</p></li>
8465: </ol></div>
8466: <p>The best way to verify that the PLIST is correct with
8467: respect to the last two points is to regenerate it using
1.10 hubertf 8468: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8469: </div>
1.41 asau 8470: <div class="sect2">
1.1 dsieger 8471: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8472: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8473: <p>If a package installs <code class="filename">.desktop</code> files
8474: under <code class="filename">share/applications</code> and these include
1.53 rodent 8475: MIME information (MimeType key), you need to take extra steps to
8476: ensure that they are registered into the MIME database:</p>
1.23 wiz 8477: <div class="orderedlist"><ol class="orderedlist" type="1">
8478: <li class="listitem"><p>Include
1.1 dsieger 8479: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8480: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8481: <code class="filename">share/applications/mimeinfo.cache</code> file.
8482: It will be handled automatically.</p></li>
8483: </ol></div>
8484: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8485: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8486: print-PLIST</strong></span>.</p>
8487: </div>
8488: </div>
1.41 asau 8489: <div class="sect1">
1.1 dsieger 8490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8491: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8492: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8493: immediately. In this case, one can plainly mark a package as broken. For
8494: this, one just sets the variable <code class="varname">BROKEN</code> to the
8495: reason why the package is broken (similar to the
8496: <code class="varname">RESTRICTED</code> variable). A user trying to build
8497: the package will immediately be shown this message, and the build
8498: will not be even tried.</p>
8499: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8500: intervals.</p>
8501: </div>
8502: </div>
1.41 asau 8503: <div class="chapter">
1.1 dsieger 8504: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8505: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 8506: <p>To check out all the gotchas when building a package, here are
8507: the steps that I do in order to get a package working. Please note
8508: this is basically the same as what was explained in the previous
8509: sections, only with some debugging aids.</p>
1.41 asau 8510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8511: <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>
8512: <li class="listitem">
1.79 snj 8513: <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 8514: create a directory for a new package, change into it, then run
1.10 hubertf 8515: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8516: <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>
8517: <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>
8518: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8519: </li>
1.23 wiz 8520: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8521: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8522: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8523: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8524: configure step to the package's
8525: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8526: <li class="listitem">
1.1 dsieger 8527: <p>Make the package compile, doing multiple rounds of</p>
8528: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8529: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8530: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8531: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8532: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8533: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8534: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8535: <p>Doing this step as non-root user will ensure that no files
8536: are modified that shouldn't be, especially during the build
1.10 hubertf 8537: phase. <span class="command"><strong>mkpatches</strong></span>,
8538: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.79 snj 8539: 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 8540: package.</p>
8541: </li>
1.23 wiz 8542: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
8543: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
8544: <li class="listitem">
1.1 dsieger 8545: <p>Generate a <code class="filename">PLIST</code>:</p>
8546: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8547: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8548: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8549: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8550: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8551: <p>You usually need to be <code class="username">root</code> to do
8552: this. Look if there are any files left:</p>
8553: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8554: <p>If this reveals any files that are missing in
8555: <code class="filename">PLIST</code>, add them.</p>
8556: </li>
1.23 wiz 8557: <li class="listitem">
1.1 dsieger 8558: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8559: package again and make a binary package:</p>
8560: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8561: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8562: </li>
1.23 wiz 8563: <li class="listitem">
1.1 dsieger 8564: <p>Delete the installed package:</p>
8565: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8566: </li>
1.23 wiz 8567: <li class="listitem">
1.10 hubertf 8568: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8569: command, which shouldn't find anything now:</p>
8570: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8571: </li>
1.23 wiz 8572: <li class="listitem">
1.1 dsieger 8573: <p>Reinstall the binary package:</p>
8574: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8575: </li>
1.23 wiz 8576: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8577: <li class="listitem">
1.79 snj 8578: <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 8579: reports:</p>
8580: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8581: </li>
1.23 wiz 8582: <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 8583: </ul></div>
8584: </div>
1.41 asau 8585: <div class="chapter">
1.1 dsieger 8586: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8587: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8588: <div class="toc">
8589: <p><b>Table of Contents</b></p>
1.100 leot 8590: <dl class="toc">
1.6 rillig 8591: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
8592: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8593: <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 8594: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 8595: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 8596: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
8597: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8598: </dl>
8599: </div>
1.41 asau 8600: <div class="sect1">
1.1 dsieger 8601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8602: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8603: <p>Our policy is that we accept binaries only from pkgsrc
8604: developers to guarantee that the packages don't contain any
8605: trojan horses etc. This is not to annoy anyone but rather to
8606: protect our users! You're still free to put up your home-made
8607: binary packages and tell the world where to get them. NetBSD
8608: developers doing bulk builds and wanting to upload them please
1.66 asau 8609: 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
8610: builds)</i></a>.</p>
1.1 dsieger 8611: </div>
1.41 asau 8612: <div class="sect1">
1.1 dsieger 8613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8614: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8615: <p>First, check that your package is complete, compiles and
1.10 hubertf 8616: 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 8617: 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 8618: archive that contains all files that make up the package.
8619: Finally, send this package to the pkgsrc bug tracking system,
1.79 snj 8620: 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 8621: that, go to the web page
1.10 hubertf 8622: <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 8623: which contains some instructions and a link to a form where you
8624: can submit packages. The
1.79 snj 8625: <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 8626: also available as a substitute for either of the above two tools.
8627: </p>
1.1 dsieger 8628: <p>In the form of the problem report, the category should be
1.23 wiz 8629: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8630: and version number, and the description field should contain a
8631: short description of your package (contents of the COMMENT
8632: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8633: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8634: <p>If you want to submit several packages, please send a
8635: separate PR for each one, it's easier for us to track things
8636: that way.</p>
8637: <p>Alternatively, you can also import new packages into
1.23 wiz 8638: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8639: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8640: for details.</p>
8641: </div>
1.41 asau 8642: <div class="sect1">
1.1 dsieger 8643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8644: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8645: <p>Please note all package additions, updates, moves, and
8646: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8647: important to keep this file up to date and conforming to the
8648: existing format, because it will be used by scripts to
1.10 hubertf 8649: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8650: sites. Additionally, check the
8651: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
8652: for the package you updated or removed, in case it was mentioned
8653: there.</p>
8654: <p>When the <code class="varname">PKGREVISION</code> of a package is
8655: bumped, the change should appear in
8656: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
8657: related or otherwise relevant. Mass bumps that result from a
8658: dependency being updated should not be mentioned. In all other
8659: cases it's the developer's decision.</p>
8660: <p>There is a make target that helps in creating proper
1.10 hubertf 8661: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 8662: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8663: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
8664: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
8665: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 8666: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8667: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 8668: For new packages, or package moves or removals, set the
8669: <code class="varname">CTYPE</code> variable on the command line to "Added",
8670: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 8671: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 8672: not the same as your NetBSD login name. The target also automatically
8673: removes possibly existing entries for the package in the
8674: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 8675: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 8676: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
8677: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8678: makes the cvs commands use the main repository.
8679: </p>
1.1 dsieger 8680: </div>
1.41 asau 8681: <div class="sect1">
1.1 dsieger 8682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 8683: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 8684: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 8685: access to the pkgsrc repository.</p>
8686: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8687: Start by adding the directory and then files in the directory. Don't
8688: forget to add the new package to the category's
8689: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8690: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8691: <pre class="programlisting">
8692: <code class="prompt">$</code> cd .../pkgsrc/category
8693: <code class="prompt">$</code> cvs add pkgname
8694: <code class="prompt">$</code> cd pkgname
8695: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8696: <code class="prompt">$</code> cvs add patches/p*
8697: <code class="prompt">$</code> cvs status | less
1.34 wiz 8698: <code class="prompt">$</code> cvs commit
1.33 wiz 8699: <code class="prompt">$</code> cd ..
8700: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 8701: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 8702: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 8703: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 8704: </pre>
1.1 dsieger 8705: <p>The commit message of the initial import should include part of the
8706: <code class="filename">DESCR</code> file, so people reading the mailing lists know
8707: what the package is/does.</p>
1.33 wiz 8708: <p>Also mention the new package in
8709: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8710: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8711: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 8712: </div>
1.41 asau 8713: <div class="sect1">
1.1 dsieger 8714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8715: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 8716: <p>Please always put a concise, appropriate and relevant summary of the
8717: changes between old and new versions into the commit log when updating
8718: a package. There are various reasons for this:</p>
1.41 asau 8719: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8720: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 8721: or its information may be overwritten by newer information.</p></li>
1.23 wiz 8722: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8723: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 8724: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8725: repository is very useful for people who read the pkgsrc-changes mailing
8726: list, so that they can make tactical decisions about when to upgrade
8727: the package.</p></li>
8728: </ul></div>
8729: <p>Please also recognize that, just because a new version of a package
8730: has been released, it should not automatically be upgraded in the CVS
8731: repository. We prefer to be conservative in the packages that are
8732: included in pkgsrc - development or beta packages are not really the
8733: best thing for most places in which pkgsrc is used. Please use your
8734: judgement about what should go into pkgsrc, and bear in mind that
8735: stability is to be preferred above new and possibly untested features.</p>
8736: </div>
1.41 asau 8737: <div class="sect1">
1.1 dsieger 8738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 8739: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
8740: <p>Renaming packages is not recommended.</p>
8741: <p>When renaming packages, be sure to fix any references to old name
8742: in other Makefiles, options, buildlink files, etc.</p>
8743: <p>Also When renaming a package, please define
8744: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8745: pattern(s) of the previous package name.
8746: This may be repeated for multiple renames.
8747: The new package would be an exact replacement.
8748: </p>
1.23 wiz 8749: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 8750: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8751: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8752: not be an exact replacement but is a suggestion for the replaced
8753: functionality.</p>
8754: </div>
1.41 asau 8755: <div class="sect1">
1.20 snj 8756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8757: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
8758: <p>It is preferred that packages are not renamed or moved, but if needed
8759: please follow these steps.
8760: </p>
1.23 wiz 8761: <div class="orderedlist"><ol class="orderedlist" type="1">
8762: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8763: <li class="listitem">
1.1 dsieger 8764: <p>Remove all CVS dirs.</p>
8765: <p>Alternatively to the first two steps you can also do:</p>
8766: <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>
8767: <p>and use that for further work.</p>
8768: </li>
1.23 wiz 8769: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8770: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8771: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8772: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 8773: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8774: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8775: for doing an update using pkgsrc building; for example, it can
1.79 snj 8776: 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 8777: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8778: new <code class="varname">PKGPATH</code> for that moved package. Note that
8779: it may have multiple matches, so the tool should also check on the
8780: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8781: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8782: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 8783: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 8784: place.</p></li>
1.23 wiz 8785: <li class="listitem">
1.1 dsieger 8786: <p>Check if any package depends on it:
8787: </p>
8788: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8789: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8790: </li>
1.23 wiz 8791: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8792: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8793: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8794: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8795: <li class="listitem">
1.1 dsieger 8796: <p>Commit the changed and removed files:</p>
8797: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
8798: <p>(and any packages from step 5, of course).</p>
8799: </li>
8800: </ol></div>
8801: </div>
8802: </div>
1.41 asau 8803: <div class="chapter">
1.1 dsieger 8804: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8805: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 8806: <p>This section contains the answers to questions that may
8807: arise when you are writing a package. If you don't find your
8808: question answered here, first have a look in the other chapters,
8809: and if you still don't have the answer, ask on the
8810: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 8811: <div class="qandaset">
1.112 ! rillig 8812: <a name="idm87310496"></a><dl>
1.6 rillig 8813: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 8814: MAKEFLAGS, .MAKEFLAGS and
8815: MAKE_FLAGS?</a>
8816: </dt>
1.6 rillig 8817: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 8818: MAKE, GMAKE and
8819: MAKE_PROGRAM?</a>
8820: </dt>
1.6 rillig 8821: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 8822: CC, PKG_CC and
8823: PKGSRC_COMPILER?</a>
8824: </dt>
1.6 rillig 8825: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 8826: BUILDLINK_LDFLAGS,
8827: BUILDLINK_LDADD and
8828: BUILDLINK_LIBS?</a>
8829: </dt>
1.6 rillig 8830: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 8831: VARNAME=BUILDLINK_PREFIX.foo
8832: say it's empty?</a>
8833: </dt>
1.6 rillig 8834: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 8835: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
8836: don't understand the := inside
8837: it.</a>
8838: </dt>
1.6 rillig 8839: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 8840: developers?</a>
8841: </dt>
1.6 rillig 8842: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 8843: documentation?</a>
8844: </dt>
1.6 rillig 8845: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 8846: do?</a>
8847: </dt>
8848: </dl>
1.41 asau 8849: <table border="0" style="width: 100%;">
8850: <colgroup>
1.1 dsieger 8851: <col align="left" width="1%">
1.23 wiz 8852: <col>
1.41 asau 8853: </colgroup>
1.1 dsieger 8854: <tbody>
1.41 asau 8855: <tr class="question">
1.1 dsieger 8856: <td align="left" valign="top">
1.112 ! rillig 8857: <a name="devfaq.makeflags"></a><a name="idm87310112"></a><p><b>22.1.</b></p>
1.1 dsieger 8858: </td>
8859: <td align="left" valign="top"><p>What is the difference between
8860: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
8861: <code class="varname">MAKE_FLAGS</code>?</p></td>
8862: </tr>
8863: <tr class="answer">
8864: <td align="left" valign="top"></td>
8865: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.79 snj 8866: 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 8867: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
8868: the <code class="varname">MAKE_PROGRAM</code> when building the
8869: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
8870: </tr>
1.41 asau 8871: <tr class="question">
1.1 dsieger 8872: <td align="left" valign="top">
1.112 ! rillig 8873: <a name="devfaq.make"></a><a name="idm87297824"></a><p><b>22.2.</b></p>
1.1 dsieger 8874: </td>
8875: <td align="left" valign="top"><p>What is the difference between
8876: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
8877: <code class="varname">MAKE_PROGRAM</code>?</p></td>
8878: </tr>
8879: <tr class="answer">
8880: <td align="left" valign="top"></td>
8881: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.79 snj 8882: <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 8883: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
8884: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
8885: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
8886: Make program that is used for building the
8887: package.</p></td>
8888: </tr>
1.41 asau 8889: <tr class="question">
1.1 dsieger 8890: <td align="left" valign="top">
1.112 ! rillig 8891: <a name="devfaq.cc"></a><a name="idm87293472"></a><p><b>22.3.</b></p>
1.1 dsieger 8892: </td>
8893: <td align="left" valign="top"><p>What is the difference between
8894: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
8895: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
8896: </tr>
8897: <tr class="answer">
8898: <td align="left" valign="top"></td>
8899: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
8900: compiler, which can be configured by the pkgsrc user.
8901: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
8902: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
8903: path to a compiler, but the type of compiler that should be
8904: used. See <code class="filename">mk/compiler.mk</code> for more
8905: information about the latter variable.</p></td>
8906: </tr>
1.41 asau 8907: <tr class="question">
1.1 dsieger 8908: <td align="left" valign="top">
1.112 ! rillig 8909: <a name="devfaq.bl3flags"></a><a name="idm87289248"></a><p><b>22.4.</b></p>
1.1 dsieger 8910: </td>
8911: <td align="left" valign="top"><p>What is the difference between
8912: <code class="varname">BUILDLINK_LDFLAGS</code>,
8913: <code class="varname">BUILDLINK_LDADD</code> and
8914: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
8915: </tr>
8916: <tr class="answer">
8917: <td align="left" valign="top"></td>
8918: <td align="left" valign="top"><p>[FIXME]</p></td>
8919: </tr>
1.41 asau 8920: <tr class="question">
1.1 dsieger 8921: <td align="left" valign="top">
1.112 ! rillig 8922: <a name="devfaq.bl3prefix"></a><a name="idm87287072"></a><p><b>22.5.</b></p>
1.1 dsieger 8923: </td>
1.10 hubertf 8924: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 8925: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
8926: say it's empty?</p></td>
8927: </tr>
8928: <tr class="answer">
8929: <td align="left" valign="top"></td>
8930: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 8931: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
8932: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 8933: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 8934: command.</p></td>
8935: </tr>
1.41 asau 8936: <tr class="question">
1.1 dsieger 8937: <td align="left" valign="top">
1.112 ! rillig 8938: <a name="devfaq.master_sites"></a><a name="idm87284000"></a><p><b>22.6.</b></p>
1.1 dsieger 8939: </td>
8940: <td align="left" valign="top"><p>What does
1.108 rillig 8941: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
8942: don't understand the <code class="code">:=</code> inside
1.1 dsieger 8943: it.</p></td>
8944: </tr>
8945: <tr class="answer">
8946: <td align="left" valign="top"></td>
1.108 rillig 8947: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
8948: assignment operator, although it looks like it.
1.1 dsieger 8949: Instead, it is a degenerate form of
1.108 rillig 8950: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
8951: 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
8952: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 8953: case of <code class="varname">MASTER_SITE_*</code>,
8954: <em class="replaceable"><code>old_string</code></em> is the empty string and
8955: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 8956: <code class="code">package/</code>. That's where the
8957: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 8958: together.</p></td>
8959: </tr>
1.41 asau 8960: <tr class="question">
1.1 dsieger 8961: <td align="left" valign="top">
1.112 ! rillig 8962: <a name="devfaq.mailinglists"></a><a name="idm87277088"></a><p><b>22.7.</b></p>
1.1 dsieger 8963: </td>
8964: <td align="left" valign="top"><p>Which mailing lists are there for package
8965: developers?</p></td>
8966: </tr>
8967: <tr class="answer">
8968: <td align="left" valign="top"></td>
1.41 asau 8969: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 8970: <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 8971: <dd><p>This is a list for technical discussions related
8972: to pkgsrc development, e.g. soliciting feedback for changes to
8973: pkgsrc infrastructure, proposed new features, questions related
8974: to porting pkgsrc to a new platform, advice for maintaining a
8975: package, patches that affect many packages, help requests moved
8976: from pkgsrc-users when an infrastructure bug is found,
8977: etc.</p></dd>
1.10 hubertf 8978: <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 8979: <dd><p>All bug reports in category "pkg" sent with
1.79 snj 8980: <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 8981: directly; use one of the other mailing
8982: lists.</p></dd>
8983: </dl></div></td>
8984: </tr>
1.41 asau 8985: <tr class="question">
1.1 dsieger 8986: <td align="left" valign="top">
1.112 ! rillig 8987: <a name="devfaq.documentation"></a><a name="idm87273248"></a><p><b>22.8.</b></p>
1.1 dsieger 8988: </td>
8989: <td align="left" valign="top"><p>Where is the pkgsrc
8990: documentation?</p></td>
8991: </tr>
8992: <tr class="answer">
8993: <td align="left" valign="top"></td>
8994: <td align="left" valign="top">
8995: <p>There are many places where you can find
8996: documentation about pkgsrc:</p>
1.41 asau 8997: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8998: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 8999: of chapters that explain large parts of pkgsrc, but some
9000: chapters tend to be outdated. Which ones they are is hard to
9001: say.</p></li>
1.23 wiz 9002: <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 9003: about certain features, announcements of new parts of the pkgsrc
9004: infrastructure and sometimes even announcements that a certain
9005: feature has been marked as obsolete. The benefit here is that
9006: each message has a date appended to it.</p></li>
1.23 wiz 9007: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9008: <code class="filename">mk/</code> directory start with a comment that
9009: describes the purpose of the file and how it can be used by the
9010: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9011: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9012: help</strong></span>.</p></li>
1.23 wiz 9013: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9014: information, but they tend to be highly abbreviated, especially
9015: for actions that occur often. Some contain a detailed
9016: description of what has changed, but they are geared towards the
9017: other pkgsrc developers, not towards an average pkgsrc user.
9018: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9019: don't know what has been before, these messages may not be worth
9020: too much to you.</p></li>
1.23 wiz 9021: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9022: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9023: mind of the developer who wrote the code. To get this
1.10 hubertf 9024: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9025: to see who has written it and ask on the
9026: <code class="literal">tech-pkg</code> mailing list, so that others can
9027: find your questions later (see above). To be sure that the
9028: developer in charge reads the mail, you may CC him or
9029: her.</p></li>
9030: </ul></div>
9031: </td>
9032: </tr>
1.41 asau 9033: <tr class="question">
1.1 dsieger 9034: <td align="left" valign="top">
1.112 ! rillig 9035: <a name="devfaq.too-much-time"></a><a name="idm87266720"></a><p><b>22.9.</b></p>
1.1 dsieger 9036: </td>
9037: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9038: do?</p></td>
9039: </tr>
9040: <tr class="answer">
9041: <td align="left" valign="top"></td>
9042: <td align="left" valign="top">
9043: <p>This is not really an FAQ yet, but here's the answer
9044: anyway.</p>
1.41 asau 9045: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9046: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.79 snj 9047: <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 9048: will tell you about newer versions of installed packages that are
9049: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9050: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9051: — it contains a list of suggested new packages and a list of
1.1 dsieger 9052: cleanups and enhancements for pkgsrc that would be nice to
9053: have.</p></li>
1.23 wiz 9054: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9055: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9056: mailing list.</p></li>
9057: </ul></div>
9058: </td>
9059: </tr>
9060: </tbody>
9061: </table>
9062: </div>
9063: </div>
1.41 asau 9064: <div class="chapter">
1.1 dsieger 9065: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9066: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9067: <div class="toc">
9068: <p><b>Table of Contents</b></p>
1.100 leot 9069: <dl class="toc">
1.6 rillig 9070: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9071: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9072: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9073: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9074: </dl>
9075: </div>
1.10 hubertf 9076: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9077: site</a>:</p>
9078: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9079: environment, an intuitive and attractive desktop for users, and the
9080: GNOME development platform, an extensive framework for building
9081: applications that integrate into the rest of the desktop.</p></blockquote></div>
9082: <p>pkgsrc provides a seamless way to automatically build and install
9083: a complete GNOME environment <span class="emphasis"><em>under many different
9084: platforms</em></span>. We can say with confidence that pkgsrc is one of
9085: the most advanced build and packaging systems for GNOME due to its
9086: included technologies buildlink3, the wrappers and tools framework and
9087: automatic configuration file management. Lots of efforts are put into
9088: achieving a completely clean deinstallation of installed software
9089: components.</p>
1.10 hubertf 9090: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9091: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9092: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9093: pkgsrc as its preferred packaging system, contributing lots of
9094: portability fixes to make GNOME build and install under it.</p>
9095: <p>This chapter is aimed at pkgsrc developers and other people
9096: interested in helping our GNOME porting and packaging efforts. It
9097: provides instructions on how to manage the existing packages and some
9098: important information regarding their internals.</p>
1.41 asau 9099: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9100: <h3 class="title">We need your help!</h3>
9101: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9102: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9103: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9104: work</a> list! There is still a long way to go to get a
9105: fully-functional GNOME desktop under NetBSD and we need your help to
9106: achieve it!</p>
9107: </div>
1.41 asau 9108: <div class="sect1">
1.1 dsieger 9109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9110: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9111: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 9113: <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 9114: the core GNOME desktop environment. It only includes the necessary
9115: bits to get it to boot correctly, although it may lack important
9116: functionality for daily operation. The idea behind this package is
9117: to let end users build their own configurations on top of this one,
9118: first installing this meta package to achieve a functional setup and
9119: then adding individual applications.</p></li>
1.79 snj 9120: <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 9121: complete installation of the GNOME platform and desktop as defined
9122: by the GNOME project; this is based on the components distributed in
9123: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9124: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9125: official FTP server. Developer-only tools found in those
9126: directories are not installed unless required by some other
9127: component to work properly. Similarly, packages from the bindings
9128: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9129: in unless required as a dependency for an end-user component. This
1.79 snj 9130: 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>
9131: <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 9132: Installs all the tools required to build a GNOME component when
9133: fetched from the CVS repository. These are required to let the
1.10 hubertf 9134: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9135: </ul></div>
9136: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9137: sorted in a way that eases updates: a package may depend on other
9138: packages listed before it but not on any listed after it. It is very
9139: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9140: change it to alphabetical sorting!</em></span></p>
9141: </div>
1.41 asau 9142: <div class="sect1">
1.1 dsieger 9143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9144: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9145: <p>Almost all GNOME applications are written in C and use a common
9146: set of tools as their build system. Things get different with the new
9147: bindings to other languages (such as Python), but the following will
9148: give you a general idea on the minimum required tools:</p>
1.41 asau 9149: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9150: <li class="listitem">
1.1 dsieger 9151: <p>Almost all GNOME applications use the GNU Autotools as their
9152: build system. As a general rule you will need to tell this to your
9153: package:</p>
9154: <pre class="programlisting">
9155: GNU_CONFIGURE=yes
9156: USE_LIBTOOL=yes
9157: USE_TOOLS+=gmake
9158: </pre>
9159: </li>
1.23 wiz 9160: <li class="listitem">
1.1 dsieger 9161: <p>If the package uses pkg-config to detect dependencies, add this
9162: tool to the list of required utilities:</p>
1.111 sevan 9163: <pre class="programlisting">
9164: USE_TOOLS+=pkg-config
9165: </pre>
1.79 snj 9166: <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 9167: the end of the build process to ensure that you did not miss to
9168: specify any dependency in your package and that the version
9169: requirements are all correct.</p>
9170: </li>
1.23 wiz 9171: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9172: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9173: to handle dependencies and to force the package to use the latest
9174: available version.</p></li>
1.23 wiz 9175: <li class="listitem">
1.1 dsieger 9176: <p>If the package uses gtk-doc (a documentation generation
9177: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9178: tool is rather big and the distfile should come with pregenerated
9179: documentation anyway; if it does not, it is a bug that you ought to
9180: report. For such packages you should disable gtk-doc (unless it is
9181: the default):</p>
1.111 sevan 9182: <pre class="programlisting">
9183: CONFIGURE_ARGS+=--disable-gtk-doc
9184: </pre>
1.1 dsieger 9185: <p>The default location of installed HTML files
9186: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9187: and should not be changed unless the package insists on installing
9188: them somewhere else. Otherwise programs as
1.10 hubertf 9189: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9190: do that with an entry similar to:</p>
1.111 sevan 9191: <pre class="programlisting">
9192: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9193: </pre>
1.1 dsieger 9194: </li>
9195: </ul></div>
9196: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9197: files under the installation prefix to maintain databases. In this
9198: context, shared means that those exact same directories and files are
9199: used among several different packages, leading to conflicts in the
9200: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9201: handle the most common cases, so you have to forget about using
9202: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9203: omitting shared files from them. If you find yourself doing those,
9204: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9205: <p>The following table lists the common situations that result in
9206: using shared directories or files. For each of them, the appropriate
9207: solution is given. After applying the solution be sure to
9208: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9209: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9210: <div class="table">
1.6 rillig 9211: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9212: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9213: <colgroup>
9214: <col>
9215: <col>
9216: </colgroup>
9217: <thead><tr>
9218: <th>If the package...</th>
9219: <th>Then...</th>
9220: </tr></thead>
9221: <tbody>
9222: <tr>
9223: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9224: <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 9225: </tr>
9226: <tr>
9227: <td>Installs icons under the
9228: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9229: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9230: <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 9231: </tr>
9232: <tr>
9233: <td>Installs files under
9234: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9235: <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 9236: </tr>
9237: <tr>
9238: <td>Installs <code class="filename">.desktop</code> files under
9239: <code class="filename">share/applications</code> and these include MIME
9240: information.</td>
1.10 hubertf 9241: <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 9242: </tr>
9243: </tbody>
9244: </table></div>
9245: </div>
9246: <br class="table-break">
9247: </div>
1.41 asau 9248: <div class="sect1">
1.1 dsieger 9249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9250: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9251: <p>When seeing GNOME as a whole, there are two kinds of
9252: updates:</p>
1.41 asau 9253: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9254: <dt><span class="term">Major update</span></dt>
9255: <dd>
9256: <p>Given that there is still a very long way for GNOME 3 (if it
9257: ever appears), we consider a major update one that goes from a
9258: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9259: where <code class="literal">Y</code> is even and greater than
9260: <code class="literal">X</code>. These are hard to achieve because they
9261: introduce lots of changes in the components' code and almost all
9262: GNOME distfiles are updated to newer versions. Some of them can
9263: even break API and ABI compatibility with the previous major
9264: version series. As a result, the update needs to be done all at
9265: once to minimize breakage.</p>
9266: <p>A major update typically consists of around 80 package
9267: updates and the addition of some new ones.</p>
9268: </dd>
9269: <dt><span class="term">Minor update</span></dt>
9270: <dd>
9271: <p>We consider a minor update one that goes from a
9272: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9273: one where <code class="literal">Y</code> is greater than
9274: <code class="literal">X</code>. These are easy to achieve because they do
9275: not update all GNOME components, can be done in an incremental way
9276: and do not break API nor ABI compatibility.</p>
9277: <p>A minor update typically consists of around 50 package
9278: updates, although the numbers here may vary a lot.</p>
9279: </dd>
9280: </dl></div>
9281: <p>In order to update the GNOME components in pkgsrc to a new stable
9282: release (either major or minor), the following steps should be
9283: followed:</p>
1.23 wiz 9284: <div class="orderedlist"><ol class="orderedlist" type="1">
9285: <li class="listitem">
1.1 dsieger 9286: <p>Get a list of all the tarballs that form the new release by
9287: using the following commands. These will leave the full list of the
1.18 snj 9288: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9289: file:</p>
9290: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9291: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9292: awk '{ print $9 }' >list.txt</code></strong>
9293: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9294: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9295: awk '{ print $9 }' >>list.txt</code></strong></pre>
9296: </li>
1.23 wiz 9297: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9298: bump their version to the release you are updating them to. The
9299: three meta packages should be always consistent with versioning.
9300: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9301: in them.</p></li>
1.23 wiz 9302: <li class="listitem">
1.1 dsieger 9303: <p>For each meta package, update all its
9304: <code class="varname">DEPENDS</code> lines to match the latest versions as
9305: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9306: newer version (even if found in the FTP) because the meta packages
9307: are supposed to list the exact versions that form a specific GNOME
9308: release. Exceptions are permitted here if a newer version solves a
9309: serious issue in the overall desktop experience; these typically
9310: come in the form of a revision bump in pkgsrc, not in newer versions
9311: from the developers.</p>
9312: <p>Packages not listed in the <code class="filename">list.txt</code> file
9313: should be updated to the latest version available (if found in
9314: pkgsrc). This is the case, for example, of the dependencies on the
1.79 snj 9315: 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 9316: </li>
1.23 wiz 9317: <li class="listitem">
1.1 dsieger 9318: <p>Generate a patch from the modified meta packages and extract the
9319: list of "new" lines. This will provide you an outline on what
9320: packages need to be updated in pkgsrc and in what order:</p>
9321: <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>
9322: </li>
1.23 wiz 9323: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9324: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9325: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9326: of <code class="filename">todo.txt</code> and update the packages listed in
9327: it in order. For major desktop updates none of these should be
9328: committed until the entire set is completed because there are chances
9329: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9330: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9331: the tree one by one with appropriate log messages. At the end,
9332: commit the three meta package updates and all the corresponding
9333: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9334: <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>
9335: </ol></div>
9336: </div>
1.41 asau 9337: <div class="sect1">
1.1 dsieger 9338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9339: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9340: <p>GNOME is a very big component in pkgsrc which approaches 100
9341: packages. Please, it is very important that you always, always,
9342: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9343: 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 9344: their attention on portability issues and to ensure that future versions
9345: can be built out-of-the box on NetBSD. The less custom patches in
9346: pkgsrc, the easier further updates are. Those developers in charge of
9347: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9348: <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 9349: Bugzilla</a>. Not all components use these to track bugs, but most
9350: of them do. Do not be short on your reports: always provide detailed
9351: explanations of the current failure, how it can be improved to achieve
9352: maximum portability and, if at all possible, provide a patch against CVS
9353: head. The more verbose you are, the higher chances of your patch being
9354: accepted.</p>
9355: <p>Also, please avoid using preprocessor magic to fix portability
9356: issues. While the FreeBSD GNOME people are doing a great job in porting
9357: GNOME to their operating system, the official GNOME sources are now
9358: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9359: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 9360: 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 9361: details.</p>
9362: </div>
9363: </div>
9364: </div>
1.41 asau 9365: <div class="part">
1.1 dsieger 9366: <div class="titlepage"><div><div><h1 class="title">
9367: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9368: <div class="partintro">
1.1 dsieger 9369: <div></div>
9370: <p>This part of the guide deals with everything
9371: from the infrastructure that is behind the interfaces described
9372: in the developer's guide. A casual package maintainer should not
9373: need anything from this part.</p>
9374: <div class="toc">
9375: <p><b>Table of Contents</b></p>
1.100 leot 9376: <dl class="toc">
1.6 rillig 9377: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9378: <dd><dl>
1.6 rillig 9379: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9380: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9381: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9382: <dd><dl>
1.6 rillig 9383: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9384: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9385: </dl></dd>
1.6 rillig 9386: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9387: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9388: <dd><dl>
1.6 rillig 9389: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9390: <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 9391: </dl></dd>
1.6 rillig 9392: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9393: <dd><dl>
1.23 wiz 9394: <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>
9395: <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 9396: </dl></dd>
9397: </dl></dd>
1.6 rillig 9398: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 9399: <dd><dl>
1.108 rillig 9400: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9401: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9402: <dd><dl>
1.108 rillig 9403: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9404: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9405: </dl></dd>
9406: </dl></dd>
1.6 rillig 9407: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 9408: <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 9409: </dl>
9410: </div>
9411: </div>
1.41 asau 9412: <div class="chapter">
1.1 dsieger 9413: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9414: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9415: <div class="toc">
9416: <p><b>Table of Contents</b></p>
1.100 leot 9417: <dl class="toc">
1.6 rillig 9418: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9419: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9420: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9421: <dd><dl>
1.6 rillig 9422: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9423: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9424: </dl></dd>
1.6 rillig 9425: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9426: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9427: <dd><dl>
1.6 rillig 9428: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9429: <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 9430: </dl></dd>
1.6 rillig 9431: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9432: <dd><dl>
1.23 wiz 9433: <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>
9434: <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 9435: </dl></dd>
9436: </dl>
9437: </div>
9438: <p>The pkgsrc infrastructure consists of many small Makefile
9439: fragments. Each such fragment needs a properly specified
9440: interface. This chapter explains how such an interface looks
9441: like.</p>
1.41 asau 9442: <div class="sect1">
1.1 dsieger 9443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9444: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9445: <p>Whenever a variable is defined in the pkgsrc
9446: infrastructure, the location and the way of definition provide
9447: much information about the intended use of that variable.
9448: Additionally, more documentation may be found in a header
9449: comment or in this pkgsrc guide.</p>
9450: <p>A special file is
9451: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9452: variables that are intended to be user-defined. They are either
9453: defined using the <code class="literal">?=</code> operator or they are
9454: left undefined because defining them to anything would
1.23 wiz 9455: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9456: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9457: file.</p>
9458: <p>Outside this file, the following conventions apply:
9459: Variables that are defined using the <code class="literal">?=</code>
9460: operator may be overridden by a package.</p>
9461: <p>Variables that are defined using the <code class="literal">=</code>
9462: operator may be used read-only at run-time.</p>
9463: <p>Variables whose name starts with an underscore must not be
9464: accessed outside the pkgsrc infrastructure at all. They may
9465: change without further notice.</p>
1.41 asau 9466: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9467: <h3 class="title">Note</h3>
9468: <p>These conventions are currently not applied
9469: consistently to the complete pkgsrc
9470: infrastructure.</p>
9471: </div>
9472: </div>
1.41 asau 9473: <div class="sect1">
1.1 dsieger 9474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9475: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9476: <p>All variables that contain lists of things should default
9477: to being empty. Two examples that do not follow this rule are
9478: <code class="varname">USE_LANGUAGES</code> and
9479: <code class="varname">DISTFILES</code>. These variables cannot simply be
9480: modified using the <code class="literal">+=</code> operator in package
9481: <code class="filename">Makefile</code>s (or other files included by
9482: them), since there is no guarantee whether the variable is
9483: already set or not, and what its value is. In the case of
1.23 wiz 9484: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9485: the default value and just define it as in the following
9486: example.</p>
9487: <pre class="programlisting">
9488: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9489: </pre>
9490: <p>Because of the selection of this default value, the same
9491: value appears in many package Makefiles. Similarly for
9492: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9493: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9494: doesn't stand out. Nevertheless it is mentioned in many
9495: files.</p>
9496: </div>
1.41 asau 9497: <div class="sect1">
1.1 dsieger 9498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9499: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 9500: <div class="sect2">
1.1 dsieger 9501: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9502: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 9503: <p>Variable evaluation takes place either at load time or at
9504: runtime, depending on the context in which they occur. The
9505: contexts where variables are evaluated at load time are:</p>
1.41 asau 9506: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9507: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9508: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9509: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9510: <code class="literal">.for</code>,</p></li>
1.23 wiz 9511: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9512: </ul></div>
9513: <p>A special exception are references to the iteration
9514: variables of <code class="literal">.for</code> loops, which are expanded
9515: inline, no matter in which context they appear.</p>
9516: <p>As the values of variables may change during load time,
9517: care must be taken not to evaluate them by accident. Typical
9518: examples for variables that should not be evaluated at load time
9519: are <code class="varname">DEPENDS</code> and
9520: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9521: clear, here is an example:</p>
9522: <pre class="programlisting">
9523: CONFIGURE_ARGS= # none
9524: CFLAGS= -O
9525: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9526:
9527: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9528:
9529: CFLAGS+= -Wall
1.111 sevan 9530: </pre>
1.1 dsieger 9531: <p>This code shows how the use of the <code class="literal">:=</code>
9532: operator can quickly lead to unexpected results. The first
9533: paragraph is fairly common code. The second paragraph evaluates
9534: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9535: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9536: <code class="literal">-Wall</code> is appended to the
9537: <code class="varname">CFLAGS</code>, but this addition will not appear in
9538: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9539: paragraphs from above typically occur in completely unrelated
9540: files.</p>
9541: </div>
1.41 asau 9542: <div class="sect2">
1.1 dsieger 9543: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9544: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9545: <p>After all the files have been loaded, the values of the
9546: variables cannot be changed anymore. Variables that are used in
9547: the shell commands are expanded at this point.</p>
9548: </div>
9549: </div>
1.41 asau 9550: <div class="sect1">
1.1 dsieger 9551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9552: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9553: <p>There are many ways in which the definition and use of a
1.108 rillig 9554: variable can be restricted in order to detect bugs and violations
9555: of the (mostly unwritten) policies. A package can be checked with
9556: <code class="literal">pkglint -Wall</code> to see whether it meets these
9557: rules.</p>
1.1 dsieger 9558: </div>
1.41 asau 9559: <div class="sect1">
1.1 dsieger 9560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9561: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9562: <p>Most of the <code class="filename">.mk</code> files fall into one
9563: of the following classes. Cases where a file falls into more
9564: than one class should be avoided as it often leads to subtle
9565: bugs.</p>
1.41 asau 9566: <div class="sect2">
1.1 dsieger 9567: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9568: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9569: <p>In a traditional imperative programming language some of
9570: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9571: procedures. They take some input parameters and—after
9572: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9573: variables in <code class="filename">Makefile</code>s have global scope
9574: care must be taken not to use parameter names that have already
9575: another meaning. For example, <code class="varname">PKGNAME</code> is a
9576: bad choice for a parameter name.</p>
9577: <p>Procedures are completely evaluated at preprocessing time.
9578: That is, when calling a procedure all input parameters must be
9579: completely resolvable. For example,
9580: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9581: parameter since it is very likely that further text will be
9582: added after calling the procedure, which would effectively apply
9583: the procedure to only a part of the variable. Also, references
1.108 rillig 9584: to other variables will be modified after calling the
1.1 dsieger 9585: procedure.</p>
9586: <p>A procedure can declare its output parameters either as
9587: suitable for use in preprocessing directives or as only
9588: available at runtime. The latter alternative is for variables
9589: that contain references to other runtime variables.</p>
9590: <p>Procedures shall be written such that it is possible to
9591: call the procedure more than once. That is, the file must not
9592: contain multiple-inclusion guards.</p>
9593: <p>Examples for procedures are
9594: <code class="filename">mk/bsd.options.mk</code> and
9595: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9596: that the parameters are evaluated at load time, they should be
9597: assigned using the <code class="literal">:=</code> operator, which should
9598: be used only for this purpose.</p>
9599: </div>
1.41 asau 9600: <div class="sect2">
1.1 dsieger 9601: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9602: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9603: <p>Action files take some input parameters and may define
9604: runtime variables. They shall not define loadtime variables.
9605: There are action files that are included implicitly by the
9606: pkgsrc infrastructure, while other must be included
9607: explicitly.</p>
9608: <p>An example for action files is
9609: <code class="filename">mk/subst.mk</code>.</p>
9610: </div>
9611: </div>
1.41 asau 9612: <div class="sect1">
1.1 dsieger 9613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9614: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 9615: <p>Package <code class="filename">Makefile</code>s usually consist of
9616: a set of variable definitions, and include the file
9617: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9618: Before that, they may also include various other
9619: <code class="filename">*.mk</code> files if they need to query the
9620: availability of certain features like the type of compiler or
9621: the X11 implementation. Due to the heavy use of preprocessor
9622: directives like <code class="literal">.if</code> and
9623: <code class="literal">.for</code>, the order in which the files are loaded
9624: matters.</p>
9625: <p>This section describes at which point the various files
9626: are loaded and gives reasons for that order.</p>
1.41 asau 9627: <div class="sect2">
1.1 dsieger 9628: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9629: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 9630: </h3></div></div></div>
9631: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
9632: is to define some essential variables like
9633: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9634: <code class="varname">MACHINE_ARCH</code>.</p>
9635: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 9636: 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 9637: After that, those variables
1.1 dsieger 9638: that have not been overridden by the user are loaded from
9639: <code class="filename">mk/defaults/mk.conf</code>.</p>
9640: <p>After the user settings, the system settings and platform
9641: settings are loaded, which may override the user
9642: settings.</p>
9643: <p>Then, the tool definitions are loaded. The tool wrappers
9644: are not yet in effect. This only happens when building a
9645: package, so the proper variables must be used instead of the
9646: direct tool names.</p>
9647: <p>As the last steps, some essential variables from the
9648: wrapper and the package system flavor are loaded, as well as the
9649: variables that have been cached in earlier phases of a package
9650: build.</p>
9651: </div>
1.41 asau 9652: <div class="sect2">
1.1 dsieger 9653: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9654: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 9655: </h3></div></div></div>
9656: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9657: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9658: loaded, which fill default values for those variables that have
9659: not been defined by the package. These variables may later
9660: be used even in unrelated files.</p>
9661: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9662: provides the target <code class="literal">error-check</code> that is added
9663: as a special dependency to all other targets that use
9664: <code class="varname">DELAYED_ERROR_MSG</code> or
9665: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9666: <p>Then, the package-specific hacks from
9667: <code class="filename">hacks.mk</code> are included.</p>
9668: <p>Then, various other files follow. Most of them don't have
9669: any dependencies on what they need to have included before or
9670: after them, though some do.</p>
9671: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9672: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9673: restricts the use of these variables to all the files that have
9674: been included before. Appearances in later files will be
9675: silently ignored.</p>
9676: <p>Then, the files for the main targets are included, in the
9677: order of later execution, though the actual order should not
9678: matter.</p>
9679: <p>At last, some more files are included that don't set any
9680: interesting variables but rather just define make targets to be
9681: executed.</p>
9682: </div>
9683: </div>
9684: </div>
1.41 asau 9685: <div class="chapter">
1.1 dsieger 9686: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9687: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 9688: <div class="toc">
9689: <p><b>Table of Contents</b></p>
1.100 leot 9690: <dl class="toc">
1.108 rillig 9691: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9692: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9693: <dd><dl>
1.108 rillig 9694: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9695: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9696: </dl></dd>
9697: </dl>
9698: </div>
9699: <p>The pkgsrc infrastructure consists of a large codebase,
9700: and there are many corners where every little bit of a file is
9701: well thought out, making pkgsrc likely to fail as soon as
9702: anything is changed near those parts. To prevent most changes
9703: from breaking anything, a suite of regression tests should go
9704: along with every important part of the pkgsrc infrastructure.
9705: This chapter describes how regression tests work in pkgsrc and
9706: how you can add new tests.</p>
1.41 asau 9707: <div class="sect1">
1.1 dsieger 9708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9709: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.79 snj 9710: <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 9711: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 9712: can simply run that command, which will run all tests in the
9713: <code class="filename">regress</code> category.</p>
9714: </div>
1.41 asau 9715: <div class="sect1">
1.1 dsieger 9716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9717: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.1 dsieger 9718: <p>Every directory in the <code class="filename">regress</code>
9719: category that contains a file called <code class="filename">spec</code>
9720: is considered a regression test. This file is a shell program
1.10 hubertf 9721: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 9722: The following functions can be overridden to suit your
9723: needs.</p>
1.41 asau 9724: <div class="sect2">
1.1 dsieger 9725: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9726: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
9727: <p>These functions do not take any parameters. Although they
9728: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9729: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9730: question</a> for details.</p>
1.41 asau 9731: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9732: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 9733: <dd><p>This function prepares the environment for the
9734: test. By default it does nothing.</p></dd>
1.108 rillig 9735: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9736: <dd>
9737: <p>This function runs the actual test. By default,
1.1 dsieger 9738: it calls <code class="varname">TEST_MAKE</code> with the arguments
9739: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9740: error messages into the file
1.108 rillig 9741: <code class="varname">TEST_OUTFILE</code>.</p>
9742: <p>When defining this function, make sure that all output that
9743: needs to be checked is written to the correct output file.
9744: Example:</p>
9745: <pre class="programlisting">
9746: do_test() {
1.112 ! rillig 9747: echo "Example output"
1.108 rillig 9748: } 1>$TEST_OUTFILE 2>&1
9749: </pre>
9750: </dd>
9751: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9752: <dd>
9753: <p>This function is run after the test and is
1.1 dsieger 9754: typically used to compare the actual output from the one that is
9755: expected. It can make use of the various helper functions from
1.108 rillig 9756: the next section. Example:</p>
9757: <pre class="programlisting">
9758: check_result() {
1.112 ! rillig 9759: exit_status 0
! 9760: output_require "Example"
! 9761: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
! 9762: output_prohibit "no such file or directory"
1.108 rillig 9763: }
9764: </pre>
9765: </dd>
9766: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 9767: <dd><p>This function cleans everything up after the
9768: test has been run. By default it does nothing.</p></dd>
9769: </dl></div>
9770: </div>
1.41 asau 9771: <div class="sect2">
1.1 dsieger 9772: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9773: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.41 asau 9774: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9775: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 9776: <dd><p>This function compares the exitcode of the
1.108 rillig 9777: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 9778: If they differ, the test will fail.</p></dd>
1.108 rillig 9779: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9780: <dd>
9781: <p>This function checks for each of its parameters
9782: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 9783: extended regular expression. If it does not, the test will
1.108 rillig 9784: fail. Example:</p>
9785: <pre class="programlisting">
9786: output_require "looks fine"
9787: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9788: </pre>
9789: </dd>
1.1 dsieger 9790: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9791: <dd><p>This function checks for each of its parameters
1.10 hubertf 9792: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 9793: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9794: If any of the regular expressions matches, the test will
9795: fail.</p></dd>
9796: </dl></div>
9797: </div>
9798: </div>
9799: </div>
1.41 asau 9800: <div class="chapter">
1.1 dsieger 9801: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9802: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 9803: <div class="toc">
9804: <p><b>Table of Contents</b></p>
1.108 rillig 9805: <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 9806: </div>
9807: <p>The pkgsrc system has already been ported to many
9808: operating systems, hardware architectures and compilers. This
9809: chapter explains the necessary steps to make pkgsrc even more
9810: portable.</p>
1.41 asau 9811: <div class="sect1">
1.1 dsieger 9812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9813: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 9814: <p>To port pkgsrc to a new operating system (called
9815: <code class="literal">MyOS</code> in this example), you need to touch the
9816: following files:</p>
1.41 asau 9817: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9818: <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>
9819: <dd><p>This file contains some basic definitions, for
9820: example the name of the C
9821: compiler.</p></dd>
9822: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
9823: <dd><p>Insert code that defines the variables
9824: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
9825: <code class="varname">LOWER_OS_VERSION</code>,
9826: <code class="varname">LOWER_VENDOR</code>,
9827: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
9828: <code class="varname">APPEND_ELF</code>, and the other variables that
9829: appear in this file.</p></dd>
9830: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9831: <dd><p>This file contains the platform-specific
9832: definitions that are used by pkgsrc. Start by copying one of the
9833: other files and edit it to your
9834: needs.</p></dd>
9835: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9836: <dd><p>This file defines the paths to all the tools
9837: that are needed by one or the other package in pkgsrc, as well
9838: as by pkgsrc itself. Find out where these tools are on your
9839: platform and add them.</p></dd>
9840: </dl></div>
9841: <p>Now, you should be able to build some basic packages, like
1.79 snj 9842: <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 9843: </div>
9844: </div>
9845: </div>
1.41 asau 9846: <div class="appendix">
9847: <div class="titlepage"><div><div><h1 class="title">
9848: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 9849: <div class="toc">
9850: <p><b>Table of Contents</b></p>
1.100 leot 9851: <dl class="toc">
1.1 dsieger 9852: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
9853: <dd><dl>
9854: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
9855: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
9856: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 9857: <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 9858: </dl></dd>
9859: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
9860: </dl>
9861: </div>
9862: <p>We checked to find a piece of software that wasn't in the packages
9863: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 9864: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 9865: present in the tree is beyond us, but it's useful for the purposes of
9866: this exercise.</p>
1.41 asau 9867: <div class="sect1">
1.1 dsieger 9868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9869: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 9870: <div class="sect2">
1.1 dsieger 9871: <div class="titlepage"><div><div><h3 class="title">
9872: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
9873: <pre class="programlisting">
9874: # $NetBSD$
9875: #
9876:
9877: DISTNAME= bison-1.25
9878: CATEGORIES= devel
9879: MASTER_SITES= ${MASTER_SITE_GNU}
9880:
1.29 dholland 9881: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 9882: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
9883: COMMENT= GNU yacc clone
9884:
9885: GNU_CONFIGURE= yes
1.46 wiz 9886: INFO_FILES= yes
1.1 dsieger 9887:
9888: .include "../../mk/bsd.pkg.mk"
9889: </pre>
9890: </div>
1.41 asau 9891: <div class="sect2">
1.1 dsieger 9892: <div class="titlepage"><div><div><h3 class="title">
9893: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
9894: <pre class="programlisting">
9895: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.79 snj 9896: 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 9897: of the NetBSD source tree is beyond me.
9898: </pre>
9899: </div>
1.41 asau 9900: <div class="sect2">
1.1 dsieger 9901: <div class="titlepage"><div><div><h3 class="title">
9902: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
9903: <pre class="programlisting">
9904: @comment $NetBSD$
9905: bin/bison
9906: man/man1/bison.1.gz
9907: share/bison.simple
9908: share/bison.hairy
9909: </pre>
9910: </div>
1.41 asau 9911: <div class="sect2">
1.1 dsieger 9912: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 9913: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 9914: </h3></div></div></div>
9915: <p>The NetBSD package system comes with
1.79 snj 9916: <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 9917: which helps to check the contents of these
9918: files. After installation it is quite easy to use, just change to the
9919: directory of the package you wish to examine and execute
1.10 hubertf 9920: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 9921: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
9922: looks fine.</pre>
9923: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 9924: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 9925: -Wall</strong></span> for a very thorough check.</p>
9926: </div>
9927: </div>
1.41 asau 9928: <div class="sect1">
1.1 dsieger 9929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9930: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
9931: <p>Create the directory where the package lives,
9932: plus any auxiliary directories:</p>
9933: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
9934: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
9935: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
9936: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
9937: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 9938: <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 9939: then continue with fetching the distfile:</p>
9940: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
9941: >> bison-1.25.tar.gz doesn't seem to exist on this system.
9942: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
9943: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9944: ftp: Error retrieving file: 500 Internal error
9945:
9946: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
9947: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9948: ftp: Error retrieving file: 500 Internal error
9949:
9950: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
9951: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9952: Successfully retrieved file.</pre>
9953: <p>Generate the checksum of the distfile into
9954: <code class="filename">distinfo</code>:</p>
9955: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
9956: <p>Now compile:</p>
9957: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
9958: >> Checksum OK for bison-1.25.tar.gz.
9959: ===> Extracting for bison-1.25
9960: ===> Patching for bison-1.25
9961: ===> Ignoring empty patch directory
9962: ===> Configuring for bison-1.25
9963: creating cache ./config.cache
9964: checking for gcc... cc
9965: checking whether we are using GNU C... yes
9966: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
9967: checking how to run the C preprocessor... cc -E
9968: checking for minix/config.h... no
9969: checking for POSIXized ISC... no
9970: checking whether cross-compiling... no
9971: checking for ANSI C header files... yes
9972: checking for string.h... yes
9973: checking for stdlib.h... yes
9974: checking for memory.h... yes
9975: checking for working const... yes
9976: checking for working alloca.h... no
9977: checking for alloca... yes
9978: checking for strerror... yes
9979: updating cache ./config.cache
9980: creating ./config.status
9981: creating Makefile
9982: ===> Building for bison-1.25
9983: 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
9984: 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
9985: 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
9986: 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
9987: 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
9988: 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
9989: 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
9990: 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
9991: 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
9992: 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
9993: 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
9994: 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
9995: 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
9996: 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
9997: 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
9998: 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
9999: 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
10000: 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
10001: 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
10002: 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
10003: 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
10004: 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
10005: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10006: rm -f bison.s1
10007: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10008: <p>Everything seems OK, so install the files:</p>
10009: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10010: >> Checksum OK for bison-1.25.tar.gz.
10011: ===> Installing for bison-1.25
10012: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10013: rm -f /usr/pkg/bin/bison
10014: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10015: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10016: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10017: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10018: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10019: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10020: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10021: ===> Registering installation for bison-1.25</pre>
10022: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10023: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10024: binary package, do this now:</p>
10025: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10026: >> Checksum OK for bison-1.25.tar.gz.
10027: ===> Building package for bison-1.25
10028: Creating package bison-1.25.tgz
10029: Registering depends:.
10030: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10031: <p>Now that you don't need the source and object files
10032: any more, clean up:</p>
10033: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10034: ===> Cleaning for bison-1.25</pre>
10035: </div>
10036: </div>
1.41 asau 10037: <div class="appendix">
10038: <div class="titlepage"><div><div><h1 class="title">
10039: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10040: <div class="toc">
10041: <p><b>Table of Contents</b></p>
1.100 leot 10042: <dl class="toc">
1.1 dsieger 10043: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10044: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10045: </dl>
10046: </div>
1.41 asau 10047: <div class="sect1">
1.1 dsieger 10048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10049: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10050: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10051: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10052: => figlet221.tar.gz doesn't seem to exist on this system.
10053: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10054: => [172219 bytes]
10055: Connected to ftp.plig.net.
10056: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10057: 331 Guest login ok, send your complete e-mail address as password.
10058: 230-You are user #5 of 500 simultaneous users allowed.
10059: 230-
10060: 230- ___ _ _ _
10061: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10062: 230- | _| _| . |_| . | | | . |_| . | _| . |
10063: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10064: 230- |_| |_| |___| |___|
10065: 230-
10066: 230-** Welcome to ftp.plig.org **
10067: 230-
10068: 230-Please note that all transfers from this FTP site are logged. If you
10069: 230-do not like this, please disconnect now.
10070: 230-
1.18 snj 10071: 230-This archive is available via
1.1 dsieger 10072: 230-
10073: 230-HTTP: http://ftp.plig.org/
10074: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10075: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10076: 230-
10077: 230-Please email comments, bug reports and requests for packages to be
10078: 230-mirrored to ftp-admin@plig.org.
10079: 230-
10080: 230-
10081: 230 Logged in anonymously.
10082: Remote system type is UNIX.
10083: Using binary mode to transfer files.
10084: 200 Type okay.
10085: 250 "/pub" is new cwd.
10086: 250-"/pub/figlet" is new cwd.
10087: 250-
10088: 250-Welcome to the figlet archive at ftp.figlet.org
10089: 250-
10090: 250- ftp://ftp.figlet.org/pub/figlet/
10091: 250-
10092: 250-The official FIGlet web page is:
10093: 250- http://www.figlet.org/
10094: 250-
10095: 250-If you have questions, please mailto:info@figlet.org. If you want to
10096: 250-contribute a font or something else, you can email us.
10097: 250
10098: 250 "/pub/figlet/program" is new cwd.
10099: 250 "/pub/figlet/program/unix" is new cwd.
10100: local: figlet221.tar.gz remote: figlet221.tar.gz
10101: 502 Unimplemented command.
10102: 227 Entering Passive Mode (195,40,6,41,246,104)
10103: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10104: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10105: 226 Transfer completed.
10106: 172219 bytes received in 00:02 (75.99 KB/s)
10107: 221 Goodbye.
10108: => Checksum OK for figlet221.tar.gz.
10109: ===> Extracting for figlet-2.2.1nb2
10110: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10111: ===> Patching for figlet-2.2.1nb2
10112: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10113: ===> Overriding tools for figlet-2.2.1nb2
10114: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10115: ===> Configuring for figlet-2.2.1nb2
10116: ===> Building for figlet-2.2.1nb2
10117: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10118: chmod a+x figlet
10119: gcc -O2 -o chkfont chkfont.c
10120: => Unwrapping files-to-be-installed.
10121: <code class="prompt">#</code>
10122: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10123: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10124: ===> Installing for figlet-2.2.1nb2
10125: install -d -o root -g wheel -m 755 /usr/pkg/bin
10126: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10127: mkdir -p /usr/pkg/share/figlet
10128: cp figlet /usr/pkg/bin
10129: cp chkfont /usr/pkg/bin
10130: chmod 555 figlist showfigfonts
10131: cp figlist /usr/pkg/bin
10132: cp showfigfonts /usr/pkg/bin
10133: cp fonts/*.flf /usr/pkg/share/figlet
10134: cp fonts/*.flc /usr/pkg/share/figlet
10135: cp figlet.6 /usr/pkg/man/man6
10136: ===> Registering installation for figlet-2.2.1nb2
10137: <code class="prompt">#</code></pre>
10138: </div>
1.41 asau 10139: <div class="sect1">
1.1 dsieger 10140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10141: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10142: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10143: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10144: ===> Packaging figlet-2.2.1nb2
10145: ===> Building binary package for figlet-2.2.1nb2
10146: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10147: Using SrcDir value of /usr/pkg
10148: Registering depends:.
10149: <code class="prompt">#</code></pre>
10150: </div>
10151: </div>
1.41 asau 10152: <div class="appendix">
10153: <div class="titlepage"><div><div><h1 class="title">
10154: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10155: <div class="toc">
10156: <p><b>Table of Contents</b></p>
1.100 leot 10157: <dl class="toc">
1.23 wiz 10158: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10159: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10160: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10161: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10162: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10163: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10164: source packages</a></span></dt>
10165: </dl>
10166: </div>
10167: <p>As in other big projects, the directory layout of pkgsrc
10168: is quite complex for newbies. This chapter explains where you
10169: find things on the FTP server. The base directory on
1.10 hubertf 10170: <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 10171: On other servers it may be different, but inside this directory,
10172: everything should look the same, no matter on which server you
10173: are. This directory contains some subdirectories, which are
10174: explained below.</p>
1.41 asau 10175: <div class="sect1">
1.1 dsieger 10176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10177: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10178: <p>The directory <code class="filename">distfiles</code> contains lots
10179: of archive files from all pkgsrc packages, which are mirrored
10180: here. The subdirectories are called after their package names
10181: and are used when the distributed files have names that don't
10182: explicitly contain a version number or are otherwise too generic
10183: (for example <code class="filename">release.tar.gz</code>).</p>
10184: </div>
1.41 asau 10185: <div class="sect1">
1.1 dsieger 10186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10187: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10188: <p>This directory contains things that individual pkgsrc
10189: developers find worth publishing.</p>
10190: </div>
1.41 asau 10191: <div class="sect1">
1.1 dsieger 10192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10193: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10194: <p>This directory contains binary packages for the various
10195: platforms that are supported by pkgsrc.
10196: 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 10197: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10198: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10199: operating system for which the packages have been built. The
1.10 hubertf 10200: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10201: command, so it may differ from the one you are used to
10202: hear.</p></li>
1.23 wiz 10203: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10204: architecture of the platform for which the packages have been
1.10 hubertf 10205: built. It also includes the <code class="varname">ABI</code> (Application
10206: Binary Interface) for platforms that have several of
10207: them.</p></li>
1.23 wiz 10208: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10209: the operating system. For version numbers that change often (for
10210: example NetBSD-current), the often-changing part should be
10211: replaced with an <code class="literal">x</code>, for example
10212: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10213: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10214: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10215: for a stable branch, or <code class="literal">head</code> for packages
10216: built from the HEAD branch. The latter should only be used when
10217: the packages are updated on a regular basis. Otherwise the date
10218: from checking out pkgsrc should be appended, for example
10219: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10220: </ul></div>
10221: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10222: can quickly click through the directories on the
10223: server and find the best binary packages for their machines. Since they
10224: usually know the operating system and the hardware architecture, OPSYS
10225: and ARCH are placed first. After these choices, they can select the
10226: best combination of OSVERSION and TAG together, since it is usually the
10227: case that packages stay compatible between different version of the
10228: operating system.</p>
10229: <p>In each of these directories, there is a
10230: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10231: <code class="filename">All</code> which contains all binary packages.
10232: Besides that, there are various category directories that
10233: contain symbolic links to the real binary packages.</p>
10234: </div>
1.41 asau 10235: <div class="sect1">
1.1 dsieger 10236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10237: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10238: <p>Here are the reports from bulk builds, for those who want
10239: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10240: 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 10241: </div>
1.41 asau 10242: <div class="sect1">
1.8 rillig 10243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10244: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10245: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10246: source packages</h2></div></div></div>
1.23 wiz 10247: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10248: that is the files that define how to create binary packages from
10249: source archives.</p>
10250: <p>The directory <code class="filename">pkgsrc</code> contains a
10251: snapshot of the CVS repository, which is updated regularly. The
10252: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10253: directory, ready to be downloaded as a whole.</p>
10254: <p>In the directories for the quarterly branches, there is an
10255: additional file called
1.22 jakllsch 10256: <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 10257: which contains the state of pkgsrc when it was branched.</p>
10258: </div>
10259: </div>
1.41 asau 10260: <div class="appendix">
10261: <div class="titlepage"><div><div><h1 class="title">
10262: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10263: <div class="toc">
10264: <p><b>Table of Contents</b></p>
1.100 leot 10265: <dl class="toc">
1.1 dsieger 10266: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10267: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10268: </dl>
10269: </div>
10270: <p>This section contains information on editing the pkgsrc
10271: guide itself.</p>
1.41 asau 10272: <div class="sect1">
1.1 dsieger 10273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10274: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10275: <p>The pkgsrc guide's source code is stored in
10276: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10277: are created from it:</p>
1.41 asau 10278: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10279: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10280: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10281: <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>
10282: <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 10283: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10284: <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 10285: PostScript version of the pkgsrc guide.</p></li>
10286: </ul></div>
10287: </div>
1.41 asau 10288: <div class="sect1">
1.1 dsieger 10289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10290: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10291: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10292: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10293: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10294: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10295: documentation) installed. These are automatically installed when
1.79 snj 10296: 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 10297: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10298: right directory. All further steps will take place
10299: here.</p></li>
1.41 asau 10300: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10301: <code class="filename">files/</code>.</p></li>
1.41 asau 10302: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10303: guide for valid XML and to build the final output files. If you
10304: get any errors at this stage, you can just edit the files, as
10305: there are only symbolic links in the working directory, pointing
10306: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10307: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10308: commit)</strong></span></p></li>
1.41 asau 10309: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10310: regenerate the output files with the proper RCS
10311: Ids.</p></li>
1.41 asau 10312: <li class="step">
1.10 hubertf 10313: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10314: commit the files in both <code class="filename">pkgsrc/doc</code> and
10315: <code class="filename">htdocs</code>.</p>
1.41 asau 10316: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10317: <h3 class="title">Note</h3>
10318: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10319: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10320: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10321: directory.</p>
10322: </div>
10323: </li>
10324: </ol></div>
10325: </div>
10326: </div>
10327: </div></body>
10328: </html>
CVSweb <webmaster@jp.NetBSD.org>