Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.111
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>During the bootstrap, an example configuration file is created. To
1599: use that, you have to create the directory
1600: <code class="filename">${PREFIX}/etc</code> and copy the example file
1601: there.</p>
1602: <p>The format of the configuration file is that of the usual
1603: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1604: is done by setting variables in this file. Note that you can define all
1605: kinds of variables, and no special error checking (for example for
1606: spelling mistakes) takes place, so you have to try it out to see if it
1607: works.</p>
1.41 asau 1608: <div class="sect1">
1.1 dsieger 1609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1610: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1611: <p>In this section, you can find some variables that apply to all
1612: pkgsrc packages. A complete list of the variables that can be
1613: configured by the user is available in
1614: <code class="filename">mk/defaults/mk.conf</code>, together with some
1615: comments that describe each variable's intent.</p>
1.41 asau 1616: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1617: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1618: packages will be installed. The default is
1619: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1620: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1621: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1622: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1623: installed. The default is
1624: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1625: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1626: X11 is installed on the system. The default is
1.84 wiz 1627: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1628: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1629: downloaded copies of the original source distributions used
1630: for building pkgsrc packages. The default is
1631: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1632: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1633: database about installed packages is stored. The default is
1634: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 1635: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1636: If set, override the packages'
1637: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1638: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1639: Backup location(s) for distribution files and patch files
1640: if not found locally or in
1641: <code class="filename">${MASTER_SITES}</code> or
1642: <code class="filename">${PATCH_SITES}</code> respectively.
1643: The defaults are
1.25 spz 1644: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 1645: and
1646: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1647: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1648: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1649: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1650: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1651: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1652: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1653: List of acceptable licenses. License names are case-sensitive.
1654: Whenever you try to build a package whose license is not in this
1655: list, you will get an error message. If the license condition is
1656: simple enough, the error message will include specific
1657: instructions on how to change this variable.</p></li>
1.1 dsieger 1658: </ul></div>
1659: </div>
1.41 asau 1660: <div class="sect1">
1.1 dsieger 1661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1662: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1663: <p>
1.1 dsieger 1664: </p>
1.41 asau 1665: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1666: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1667: directory for the binary packages. The default is
1668: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1669: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1670: The top level directory where, if defined, the separate
1671: working directories will get created, and symbolically
1672: linked to from <code class="filename">${WRKDIR}</code> (see below).
1673: This is useful for building packages on several
1674: architectures, then <code class="filename">${PKGSRCDIR}</code>
1675: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1676: is local to every architecture. (It should be noted that
1677: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1678: — it is an internal definition which refers to the
1.1 dsieger 1679: root of the pkgsrc tree. It is possible to have many
1680: pkgsrc tree instances.)</p></li>
1.23 wiz 1681: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1682: Directory for local patches that aren't part of pkgsrc.
1.108 rillig 1683: 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 1684: information.</p></li>
1.23 wiz 1685: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1686: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1687: BSD-style Makefile. If this is not set,
1688: <code class="varname">MAKECONF</code> is set to
1689: <code class="filename">/dev/null</code> to avoid picking up
1690: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 1691: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 1692: By default, dependencies are only installed, and no binary
1693: package is created for them. You can set this variable to
1.66 asau 1694: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 1695: packages after installing dependencies. Please note that the
1.84 wiz 1696: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 1697: <code class="literal">yes</code> to preserve binary packages when
1698: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 1699: </ul></div>
1700: </div>
1.41 asau 1701: <div class="sect1">
1.1 dsieger 1702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 1703: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.107 jnemeth 1704: <p>Packages have to support installation into a
1.4 rillig 1705: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1706: to be built, before the actual filesystem is touched. DESTDIR
1707: support exists in two variations:</p>
1.41 asau 1708: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1709: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1710: installation and packaging is still run as root.</p></li>
1711: <li class="listitem"><p>Full DESTDIR support can run the complete
1712: build, installation and packaging as normal user. Root
1713: privileges are only needed to add packages.</p></li>
1714: </ul></div>
1.4 rillig 1715: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1716: clean</code></strong> needs to be run as root.</p>
1.17 imil 1717: <p>Considering the <code class="filename">foo/bar</code> package,
1718: DESTDIR full support can be tested using the following commands
1719:
1720: </p>
1721: <pre class="programlisting">
1722: <code class="prompt">$</code> id
1723: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1724: <code class="prompt">$</code> mkdir $HOME/packages
1725: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1726: </pre>
1727: <p>
1728:
1729: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1730: should be needed
1731:
1732: </p>
1733: <pre class="programlisting">
1.66 asau 1734: <code class="prompt">$</code> make stage-install
1.17 imil 1735: </pre>
1736: <p>
1737:
1738: Create a package without root privileges
1739:
1740: </p>
1741: <pre class="programlisting">
1.66 asau 1742: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1743: </pre>
1744: <p>
1745:
1746: For the following command, you must be able to gain root
1.79 snj 1747: 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 1748:
1749: </p>
1750: <pre class="programlisting">
1.66 asau 1751: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1752: </pre>
1753: <p>
1754:
1755: Then, as a simple user
1756:
1757: </p>
1758: <pre class="programlisting">
1759: <code class="prompt">$</code> make clean
1760: </pre>
1761: <p>
1762:
1763: </p>
1.4 rillig 1764: </div>
1.41 asau 1765: <div class="sect1">
1.4 rillig 1766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1767: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1768: <div class="sect2">
1.1 dsieger 1769: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1770: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1771: <p>By default, pkgsrc will use GCC to build packages. This may be
1772: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1773: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1774: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1775: <dd>
1776: <p>This is a list of values specifying the chain of
1777: compilers to invoke when building packages. Valid values
1778: are:</p>
1.41 asau 1779: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1780: <li class="listitem"><p><code class="varname">ccc</code>:
1781: Compaq C Compilers (Tru64)</p></li>
1782: <li class="listitem"><p><code class="varname">ccache</code>:
1783: compiler cache (chainable)</p></li>
1784: <li class="listitem"><p><code class="varname">clang</code>:
1785: Clang C and Objective-C compiler</p></li>
1.23 wiz 1786: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1787: distributed C/C++ (chainable)</p></li>
1.66 asau 1788: <li class="listitem"><p><code class="varname">f2c</code>:
1789: Fortran 77 to C compiler (chainable)</p></li>
1790: <li class="listitem"><p><code class="varname">icc</code>:
1791: Intel C++ Compiler (Linux)</p></li>
1792: <li class="listitem"><p><code class="varname">ido</code>:
1793: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1794: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1795: GNU C/C++ Compiler</p></li>
1.66 asau 1796: <li class="listitem"><p><code class="varname">hp</code>:
1797: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1798: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1799: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1800: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1801: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1802: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1803: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1804: <li class="listitem"><p><code class="varname">xlc</code>:
1805: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 1806: </ul></div>
1807: <p>The default is
1.23 wiz 1808: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1809: <code class="varname">ccache</code> and/or
1810: <code class="varname">distcc</code> with an appropriate
1811: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1812: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1813: variable should always be terminated with a value for
1814: a real compiler. Note that only one real compiler
1.23 wiz 1815: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1816: is not allowed).</p>
1817: </dd>
1818: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1819: <dd><p>This specifies the minimum version of GCC to use
1820: when building packages. If the system GCC doesn't
1821: satisfy this requirement, then pkgsrc will build and
1822: install one of the GCC packages to use instead.</p></dd>
1823: </dl></div>
1824: </div>
1.41 asau 1825: <div class="sect2">
1.1 dsieger 1826: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1827: <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 1828: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1829: please make sure to use the <code class="literal">+=</code> operator
1830: instead of the <code class="literal">=</code> operator:</p>
1831: <pre class="programlisting">
1832: CFLAGS+= -your -flags
1833: </pre>
1834: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1835: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1836: need to add their own flags. You may want to take a look
1.79 snj 1837: 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 1838: package if you're interested in optimization specifically
1839: for the current CPU. </p>
1.1 dsieger 1840: </div>
1.41 asau 1841: <div class="sect2">
1.1 dsieger 1842: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1843: <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 1844: <p>If you want to pass flags to the linker, both in the configure
1845: step and the build step, you can do this in two ways. Either set
1846: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1847: between the two is that <code class="varname">LIBS</code> will be appended to
1848: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1849: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1850: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1851: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1852: <code class="varname">CFLAGS</code>, if you do not wish to override these
1853: settings, use the <code class="literal">+=</code> operator:</p>
1854: <pre class="programlisting">
1855: LDFLAGS+= -your -linkerflags
1856: </pre>
1857: </div>
1858: </div>
1.41 asau 1859: <div class="sect1">
1.1 dsieger 1860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1861: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1862: <p>
1.1 dsieger 1863: </p>
1.41 asau 1864: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1865: <li class="listitem">
1.1 dsieger 1866: <p><code class="varname">PKG_DEVELOPER</code>:
1867: Run some sanity checks that package developers want:
1868: </p>
1.41 asau 1869: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1870: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1871: fuzz</p></li>
1.23 wiz 1872: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1873: binaries will find their shared libs.</p></li>
1874: </ul></div>
1875: <p>
1876: </p>
1877: </li>
1.23 wiz 1878: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1879: of debugging output which is displayed whilst making and
1880: installing the package. The default value for this is 0,
1881: which will not display the commands as they are executed
1882: (normal, default, quiet operation); the value 1 will display
1883: all shell commands before their invocation, and the value 2
1884: will display both the shell commands before their invocation,
1.10 hubertf 1885: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 1886: -x</strong></span> will be displayed.</p></li>
1887: </ul></div>
1888: <p>
1889: </p>
1890: </div>
1.41 asau 1891: <div class="sect1">
1.1 dsieger 1892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1893: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1894: <p>Some packages have build time options, usually to select
1895: between different dependencies, enable optional support for big
1896: dependencies or enable experimental features.</p>
1897: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1898: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1899: show-options</strong></span>, for example:</p>
1900: <pre class="programlisting">
1901: The following options are supported by this package:
1902: ssl Enable SSL support.
1903: Exactly one of the following gecko options is required:
1904: firefox Use firefox as gecko rendering engine.
1905: mozilla Use mozilla as gecko rendering engine.
1906: At most one of the following database options may be selected:
1907: mysql Enable support for MySQL database.
1908: pgsql Enable support for PostgreSQL database.
1909:
1910: These options are enabled by default: firefox
1911: These options are currently enabled: mozilla ssl
1912: </pre>
1913: <p>The following variables can be defined in
1.10 hubertf 1914: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1915: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1916: which can be used to select or disable options for all packages
1917: that support them, and
1918: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1919: which can be used to select or disable options specifically for
1920: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1921: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1922: are disabled. A few examples:</p>
1923: <pre class="screen">
1.10 hubertf 1924: <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 1925: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1926: PKG_OPTIONS.kdebase= debug -sasl
1927: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1928: <p>It is important to note that options that were specifically
1.18 snj 1929: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1930: you do not wish to include the option. If you are unsure you can view
1931: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1932: <p>The following settings are consulted in the order given, and
1933: the last setting that selects or disables an option is
1934: used:</p>
1.23 wiz 1935: <div class="orderedlist"><ol class="orderedlist" type="1">
1936: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1937: maintainer</p></li>
1.23 wiz 1938: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1939: variables (see below)</p></li>
1.23 wiz 1940: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1941: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1942: </ol></div>
1943: <p>For groups of mutually exclusive options, the last option
1944: selected is used, all others are automatically disabled. If an
1945: option of the group is explicitly disabled, the previously
1946: selected option, if any, is used. It is an error if no option
1947: from a required group of options is selected, and building the
1948: package will fail.</p>
1949: <p>Before the options framework was introduced, build options
1950: were selected by setting a variable (often named
1951: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 1952: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 1953: transition to the options framework for the user, these legacy
1954: variables are converted to the appropriate options setting
1955: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1956: automatically. A warning is issued to prompt the user to update
1.10 hubertf 1957: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 1958: directly. Support for the legacy variables will be removed
1959: eventually.</p>
1960: </div>
1961: </div>
1.41 asau 1962: <div class="chapter">
1.1 dsieger 1963: <div class="titlepage"><div><div><h2 class="title">
1964: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
1965: <div class="toc">
1966: <p><b>Table of Contents</b></p>
1.100 leot 1967: <dl class="toc">
1.1 dsieger 1968: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
1969: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1970: </dl>
1971: </div>
1.41 asau 1972: <div class="sect1">
1.1 dsieger 1973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1974: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1975: <p>Once you have built and installed a package, you can create
1976: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.79 snj 1977: 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 1978: the same package on a group of hosts and wasting CPU time. It also
1979: provides a simple means for others to install your package, should
1980: you distribute it.</p>
1981: <p>To create a binary package, change into the appropriate
1.10 hubertf 1982: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 1983: package</strong></span>:</p>
1984: <pre class="screen">
1985: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1986: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1987: </pre>
1988: <p>This will build and install your package (if not already done),
1989: and then build a binary package from what was installed. You can
1.10 hubertf 1990: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 1991: it. Binary packages are created by default in
1992: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 1993: 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 1994: 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 1995: <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 1996: such a binary package.</p>
1997: </div>
1.41 asau 1998: <div class="sect1">
1.1 dsieger 1999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2000: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2001: <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 2002: </div>
2003: </div>
1.41 asau 2004: <div class="chapter">
1.6 rillig 2005: <div class="titlepage"><div><div><h2 class="title">
2006: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2007: builds)</h2></div></div></div>
2008: <div class="toc">
2009: <p><b>Table of Contents</b></p>
1.100 leot 2010: <dl class="toc">
1.71 wiz 2011: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2012: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2013: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2014: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2015: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2016: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2017: </dl>
2018: </div>
1.71 wiz 2019: <p>For a number of reasons you may want to build binary packages
2020: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2021: For instance, when you have multiple machines that should run the same software,
2022: it is wasted time if they all build their packages themselves from source.
2023: Or you may want to build a list of packages you want and check them before
2024: deploying onto production system.
2025: There is a way of getting a set of binary packages:
1.66 asau 2026: The bulk build system, or pbulk ("p" stands for "parallel).
2027: This chapter describes how to set it up so that the packages
1.6 rillig 2028: are most likely to be usable later.</p>
1.41 asau 2029: <div class="sect1">
1.6 rillig 2030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2031: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2032: <p>First of all, you have to decide whether you build all packages
2033: or a limited set of them. Full bulk builds usually consume a lot more resources,
2034: both space and time, than builds for some practical sets of packages.
2035: There exists a number of particularly heavy packages that are not actually
2036: interesting to a wide audience.
2037:
2038: For a limited bulk builds you need to make a list of packages you want to build.
2039: Note, that all their dependencies will be built, so you don't need to track them manually.
2040: </p>
2041: <p>During bulk builds various packages are installed and deinstalled
2042: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2043: so make sure that you don't need any package during the builds.
2044: Essentially, you should provide fresh system, either a chroot environment
2045: or something even more restrictive, depending on what the operating system provides,
2046: or dedicate the whole physical machine.
2047: As a useful side effect this makes sure that bulk builds cannot
2048: break anything in your system. There have been numerous cases where
1.6 rillig 2049: certain packages tried to install files outside the
2050: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2051: <code class="filename">/etc</code>.
2052: </p>
1.6 rillig 2053: </div>
1.41 asau 2054: <div class="sect1">
1.6 rillig 2055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2056: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2057: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2058: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2059: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2060: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2061: </ul></div>
1.41 asau 2062: <div class="sect2">
1.15 rillig 2063: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2064: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.68 asau 2065: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2066: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2067: Configure network access to fetch distribution files.
2068: Create user with name "pbulk".</p>
2069: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2070: <pre class="screen">
1.72 wiz 2071: <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>
2072: <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>
2073: <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 2074: </pre>
2075: <p>Or any other way that fits (e.g., curl, wget).</p>
2076: <p>Deploy and configure pbulk tools, e.g.:</p>
2077: <pre class="screen">
2078: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2079: <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>
2080: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2081: </pre>
2082: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2083: <h3 class="title">Note</h3>
2084: <p><code class="filename">mk.conf.frag</code> is a fragment of
2085: <code class="filename">mk.conf</code> that contains settings you want to
2086: apply to packages you build. For instance,</p>
2087: <pre class="programlisting">
2088: PKG_DEVELOPER= yes # perform more checks
2089: X11_TYPE= modular # use pkgsrc X11
2090: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2091: </pre>
2092: </div>
2093: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2094: with your list of packages one per line without empty lines or comments. E.g.:</p>
2095: <pre class="programlisting">
2096: www/firefox
2097: mail/thunderbird
2098: misc/libreoffice4
2099: </pre>
1.69 asau 2100: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2101: and make final amendments, if wanted.</p>
1.68 asau 2102: <p>Start it:</p>
2103: <pre class="screen">
2104: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2105: </pre>
2106: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2107: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2108: </p>
2109: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2110: <h3 class="title">Note</h3>
2111: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2112: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2113: The script is kept small enough for better understanding.</p>
2114: </div>
2115: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2116: <h3 class="title">Note</h3>
2117: <p>The <code class="filename">pbulk.sh</code> script supports running
2118: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2119: </div>
1.6 rillig 2120: </div>
2121: </div>
1.41 asau 2122: <div class="sect1">
1.6 rillig 2123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2124: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2125: <p>A complete bulk build requires lots of disk space. Some of the
2126: disk space can be read-only, some other must be writable. Some can be on
2127: remote filesystems (such as NFS) and some should be local. Some can be
2128: temporary filesystems, others must survive a sudden reboot.</p>
2129: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2130: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2131: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2132: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2133: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2134: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2135: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2136: </ul></div>
2137: </div>
2138: <div class="sect1">
2139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2140: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2141: <p>After your pkgsrc bulk-build has completed, you may wish to
2142: create a CD-ROM set of the resulting binary packages to assist
2143: in installing packages on other machines. The
1.79 snj 2144: <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 2145: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2146: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2147: way that keeps all the dependencies for a given package on the same
2148: CD as that package.</p>
1.41 asau 2149: <div class="sect2">
1.1 dsieger 2150: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2151: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2152: <p>Complete documentation for cdpack is found in the cdpack(1)
2153: man page. The following short example assumes that the binary
2154: packages are left in
2155: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2156: sufficient disk space exists in <code class="filename">/u2</code> to
2157: hold the ISO 9660 images.</p>
2158: <pre class="screen">
2159: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2160: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2161: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2162: </pre>
2163: <p>If you wish to include a common set of files
2164: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2165: etc.) on each CD in the collection, then you need to create a
2166: directory which contains these files. e.g.</p>
2167: <pre class="screen">
2168: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2169: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2170: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2171: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2172: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2173: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2174: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2175: </pre>
2176: <p>Now create the images:</p>
2177: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2178: <p>Each image will contain <code class="filename">README</code>,
2179: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2180: in their root directories.</p>
2181: </div>
2182: </div>
2183: </div>
1.41 asau 2184: <div class="chapter">
1.1 dsieger 2185: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2186: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2187: <div class="toc">
2188: <p><b>Table of Contents</b></p>
1.100 leot 2189: <dl class="toc">
1.23 wiz 2190: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2191: <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 2192: </dl>
2193: </div>
2194: <p>The files that are installed by pkgsrc are organized in a way that
2195: is similar to what you find in the <code class="filename">/usr</code> directory
2196: of the base system. But some details are different. This is because
2197: pkgsrc initially came from FreeBSD and had adopted its file system
2198: hierarchy. Later it was largely influenced by NetBSD. But no matter
2199: which operating system you are using pkgsrc with, you can expect the
2200: same layout for pkgsrc.</p>
2201: <p>There are mainly four root directories for pkgsrc, which are all
2202: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2203: When pkgsrc has been installed as root, the default locations
2204: are:</p>
2205: <pre class="programlisting">
2206: LOCALBASE= /usr/pkg
2207: PKG_SYSCONFBASE= /usr/pkg/etc
2208: VARBASE= /var
2209: PKG_DBDIR= /var/db/pkg
2210: </pre>
2211: <p>In unprivileged mode (when pkgsrc has been installed as any other
2212: user), the default locations are:</p>
2213: <pre class="programlisting">
2214: LOCALBASE= ${HOME}/pkg
2215: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2216: VARBASE= ${HOME}/pkg/var
2217: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2218: </pre>
2219: <p>What these four directories are for, and what they look like is
2220: explained below.</p>
1.41 asau 2221: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2222: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2223: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2224: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2225: the well-known subdirectories like <code class="filename">bin</code>,
2226: <code class="filename">include</code>, <code class="filename">lib</code>,
2227: <code class="filename">share</code> and
2228: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2229: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2230: <code class="filename">/var</code> in the base system. Some programs (especially
2231: games, network daemons) need write access to it during normal
2232: operation.</p></li>
1.23 wiz 2233: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2234: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2235: 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 2236: itself.</p></li>
2237: </ul></div>
1.41 asau 2238: <div class="sect1">
1.1 dsieger 2239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2240: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2241: </h2></div></div></div>
2242: <p>The following directories exist in a typical pkgsrc installation
2243: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2244: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2245: <dt><span class="term"><code class="filename">bin</code></span></dt>
2246: <dd><p>Contains executable programs that are intended to be
2247: directly used by the end user.</p></dd>
2248: <dt><span class="term"><code class="filename">emul</code></span></dt>
2249: <dd><p>Contains files for the emulation layers of various other
2250: operating systems, especially for
2251: NetBSD.</p></dd>
2252: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2253: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2254: <dd><p>Contains
2255: the configuration files.</p></dd>
2256: <dt><span class="term"><code class="filename">include</code></span></dt>
2257: <dd><p>Contains headers for the C and C++ programming
2258: languages.</p></dd>
2259: <dt><span class="term"><code class="filename">info</code></span></dt>
2260: <dd><p>Contains GNU info files of various
2261: packages.</p></dd>
2262: <dt><span class="term"><code class="filename">lib</code></span></dt>
2263: <dd><p>Contains shared and static
2264: libraries.</p></dd>
2265: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2266: <dd><p>Contains data files that don't change after
2267: installation. Other data files belong into
2268: <code class="filename">${VARBASE}</code>.</p></dd>
2269: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2270: <dd><p>Contains programs that are not intended to be used by
2271: end users, such as helper programs or network
2272: daemons.</p></dd>
2273: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2274: <dd><p>Contains programs that are intended to be executed as
2275: CGI scripts by a web server.</p></dd>
2276: <dt><span class="term"><code class="filename">man</code> (the usual value of
2277: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2278: <dd><p>Contains brief
2279: documentation in form of manual pages.</p></dd>
2280: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2281: <dd><p>Contains programs that are intended to be used only by
2282: the super-user.</p></dd>
2283: <dt><span class="term"><code class="filename">share</code></span></dt>
2284: <dd><p>Contains platform-independent data files that don't
2285: change after installation.</p></dd>
2286: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2287: <dd><p>Contains documentation files provided by the
2288: packages.</p></dd>
2289: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2290: <dd><p>Contains example files provided by the packages. Among
2291: others, the original configuration files are saved here and copied to
2292: <code class="filename">${PKG_SYSCONFDIR}</code> during
2293: installation.</p></dd>
2294: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2295: <dd><p>Contains the original files for rc.d
2296: scripts.</p></dd>
2297: <dt><span class="term"><code class="filename">var</code> (the usual location of
2298: <code class="filename">${VARBASE}</code>)</span></dt>
2299: <dd><p>Contains files
2300: that may be modified after
2301: installation.</p></dd>
2302: </dl></div>
2303: </div>
1.41 asau 2304: <div class="sect1">
1.1 dsieger 2305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2306: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2307: </h2></div></div></div>
1.41 asau 2308: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2309: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2310: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2311: <dd><p>Contains
2312: information about the currently installed
2313: packages.</p></dd>
2314: <dt><span class="term"><code class="filename">games</code></span></dt>
2315: <dd><p>Contains highscore
2316: files.</p></dd>
2317: <dt><span class="term"><code class="filename">log</code></span></dt>
2318: <dd><p>Contains log files.</p></dd>
2319: <dt><span class="term"><code class="filename">run</code></span></dt>
2320: <dd><p>Contains informational files about daemons that are
2321: currently running.</p></dd>
2322: </dl></div>
2323: </div>
2324: </div>
1.41 asau 2325: <div class="chapter">
1.1 dsieger 2326: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2327: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2328: <div class="toc">
2329: <p><b>Table of Contents</b></p>
1.100 leot 2330: <dl class="toc">
1.6 rillig 2331: <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 2332: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2333: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2334: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2335: <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>
2336: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2337: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2338: <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>
2339: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2340: <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 2341: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2342: <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>
2343: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2344: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2345: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2346: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2347: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2348: <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 2349: </dl>
2350: </div>
2351: <p>This section contains hints, tips & tricks on special things in
2352: pkgsrc that we didn't find a better place for in the previous chapters, and
2353: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2354: <div class="sect1">
1.1 dsieger 2355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2356: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2357: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2358: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2359: <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 2360: This is a general purpose list for most issues regarding
2361: pkgsrc, regardless of platform, e.g. soliciting user help
2362: for pkgsrc configuration, unexpected build failures, using
2363: particular packages, upgrading pkgsrc installations,
2364: questions regarding the pkgsrc release branches, etc. General announcements or
2365: proposals for changes that impact the pkgsrc user community,
2366: e.g. major infrastructure changes, new features, package
2367: removals, etc., may also be posted.</p></li>
1.23 wiz 2368: <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 2369: A list where the results of pkgsrc bulk builds are sent and
2370: discussed.</p></li>
1.23 wiz 2371: <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 2372: This list is for those who are interested in getting a
2373: commit message for every change committed to pkgsrc. It is
2374: also available in digest form, meaning one daily message
2375: containing all commit messages for changes to the package
2376: source tree in that 24 hour period.</p></li>
2377: </ul></div>
2378: <p>To subscribe, do:</p>
2379: <pre class="programlisting">
2380: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2381: </pre>
2382: <p>Archives for all these mailing lists are available from
1.10 hubertf 2383: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2384: </div>
1.41 asau 2385: <div class="sect1">
1.1 dsieger 2386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2387: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2388: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2389: a number of useful utilities for both users and developers of pkgsrc. This
2390: section attempts only to make the reader aware of the utilities and when
2391: they might be useful, and not to duplicate the documentation that comes
2392: with each package.</p>
2393: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.79 snj 2394: <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 2395: Symlinks for use by buildlink.</p></li></ul></div>
2396: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2397: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2398: <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 2399: Calculates various kinds of checksums (including SHA1).</p></li>
1.79 snj 2400: <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 2401: Compatibility library for pkgsrc tools.</p></li>
1.79 snj 2402: <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 2403: non-BSD systems due to lack of native mtree.</p></li>
1.79 snj 2404: <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 2405: Up-to-date replacement for
2406: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2407: systems where pkg_install is not present.</p></li>
2408: </ul></div>
2409: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2410: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2411: <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 2412: Create a binary package from an
1.10 hubertf 2413: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2414: save the old package.</p></li>
1.79 snj 2415: <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 2416: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2417: from multiple locations. It currently supports the following
2418: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.79 snj 2419: <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 2420: the best compiler flags to optimise code for your current
1.23 wiz 2421: CPU and compiler. </p></li>
1.1 dsieger 2422: </ul></div>
2423: <p>Utilities for keeping track of installed packages, being up to date,
2424: etc:</p>
1.41 asau 2425: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2426: <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 2427: update tool similar to apt(1). Download, install, and upgrade
2428: binary packages easily.</p></li>
1.79 snj 2429: <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 2430: packages whose installed versions do not match the latest pkgsrc
2431: entries.</p></li>
1.79 snj 2432: <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 2433: dependency graphs of packages, to aid in choosing a strategy for
2434: updating.</p></li>
1.79 snj 2435: <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
2436: 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>
2437: <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 2438: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.79 snj 2439: <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 2440: does various checks on the complete pkgsrc system.</p></li>
1.79 snj 2441: <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 2442: packages you have installed.</p></li>
2443: </ul></div>
2444: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2445: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2446: <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 2447: making and maintaining patches for a package (includes pkgdiff,
2448: pkgvi, mkpatches, etc.).</p></li>
1.79 snj 2449: <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 2450: converting to pkgsrc.</p></li>
2451: </ul></div>
2452: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2453: utilities)</p>
1.41 asau 2454: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2455: <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 2456: packages in a chrooted area.</p></li>
1.79 snj 2457: <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 2458: kernel version for chrooted cross builds.</p></li>
2459: </ul></div>
2460: </div>
1.41 asau 2461: <div class="sect1">
1.1 dsieger 2462: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2463: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2464: <p>To install packages from source as a non-root user, download
2465: 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
2466: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2467: --unprivileged</strong></span>.</p>
2468: <p>This will install the binary part of pkgsrc to
2469: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2470: into <code class="filename">~/pkg/etc</code>.</p>
2471: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2472: </div>
1.41 asau 2473: <div class="sect1">
1.1 dsieger 2474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2475: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2476: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2477: enable this feature by adding the option
2478: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2479: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2480: distfile is found, pkgsrc will try to resume it.</p>
2481: <p>You can also
1.61 wiz 2482: use a different program than the platform default program by changing the
1.16 jnemeth 2483: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2484: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2485: by using the value manual. A value of custom disables the system defaults
2486: and dependency tracking for the fetch program. In that case you have to
2487: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2488: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2489: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2490: <p>For example, if you want to use
1.16 jnemeth 2491: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2492: like:</p>
2493: <pre class="programlisting">
1.16 jnemeth 2494: FETCH_USING= wget
1.1 dsieger 2495: </pre>
2496: </div>
1.41 asau 2497: <div class="sect1">
1.1 dsieger 2498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2499: <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 2500: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2501: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2502: you will have to add the following line into
1.10 hubertf 2503: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2504: <pre class="programlisting">
1.4 rillig 2505: X11_TYPE=modular
1.1 dsieger 2506: </pre>
1.41 asau 2507: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 2508: <h3 class="title">Note</h3>
1.4 rillig 2509: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
2510: </p>
1.1 dsieger 2511: </div>
2512: </div>
1.41 asau 2513: <div class="sect1">
1.1 dsieger 2514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2515: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2516: <p>If you are sitting behind a firewall which does not allow direct
2517: connections to Internet hosts (i.e. non-NAT), you may specify the
2518: relevant proxy hosts. This is done using an environment variable in the
2519: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2520: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2521: port 80 as the proxy port number. So the proxy environment variables
2522: are:</p>
2523: <pre class="programlisting">
2524: ftp_proxy=ftp://orpheus.amdahl.com:80/
2525: http_proxy=http://orpheus.amdahl.com:80/
2526: </pre>
2527: </div>
1.41 asau 2528: <div class="sect1">
1.1 dsieger 2529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2530: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2531: <p>Some fetch tools are not prepared to support HTTPS by default
2532: (for example, the one in NetBSD 6.0), or the one installed by the
2533: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2534: dependency graph).</p>
2535: <p>Usually you won't notice, because distribution files are
2536: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2537: be often enough if you are following pkgsrc-current. In that case, set
2538: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2539: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2540: with HTTPS support by default. Of course, these tools need to be
2541: installed before you can use them this way.</p>
2542: </div>
2543: <div class="sect1">
2544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2545: <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 2546: <p>This depends on which utility is used to retrieve distfiles. From
2547: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2548: the first available command from the following list:</p>
1.41 asau 2549: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2550: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2551: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2552: </ul></div>
2553: <p>On a default NetBSD installation, this will be
2554: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2555: connections first, and falls back to active connections if the server
2556: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2557: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2558: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2559: <p>Having that option present will prevent
2560: <code class="filename">/usr/bin/ftp</code> from falling back to active
2561: transfers.</p>
2562: </div>
1.41 asau 2563: <div class="sect1">
1.1 dsieger 2564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2565: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2566: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2567: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2568: 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 2569: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2570: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2571: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2572: resulting list to your machine at work/school and use it there. If you
1.79 snj 2573: 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 2574: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2575: URL:</p>
2576: <p>At home:</p>
2577: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2578: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2579: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2580: <p>At work:</p>
2581: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2582: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2583: home.</p>
2584: <p>If you have a machine running NetBSD, and you want to get
2585: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2586: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2587: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2588: directly by running:</p>
2589: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2590: <p>If you even decide to ignore
2591: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2592: by running:</p>
2593: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2594: </div>
1.41 asau 2595: <div class="sect1">
1.1 dsieger 2596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2597: <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 2598: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.79 snj 2599: <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 2600: package, you get the error from make that it doesn't know how to make
2601: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2602: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2603: the NetBSD base distribution on your machine. It is recommended to do
2604: that to format man pages.</p>
1.79 snj 2605: <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 2606: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2607: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2608: </div>
1.41 asau 2609: <div class="sect1">
1.1 dsieger 2610: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2611: <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 2612: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2613: when you installed your NetBSD machine. Please get and install it, by
2614: extracting it in <code class="filename">/</code>:</p>
2615: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2616: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2617: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2618: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2619: -r</strong></span>).</p>
2620: </div>
1.41 asau 2621: <div class="sect1">
1.1 dsieger 2622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2623: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2624: <p>When installing packages as non-root user and using the just-in-time
1.79 snj 2625: <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 2626: password for each required package installed. To avoid this, the sudo
2627: package can be used, which does password caching over a limited time. To
2628: use it, install sudo (either as binary package or from
1.79 snj 2629: <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 2630: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2631: <span class="emphasis"><em>after</em></span> the definition of the
2632: <code class="varname">LOCALBASE</code> variable:</p>
2633: <pre class="programlisting">
2634: .if exists(${LOCALBASE}/bin/sudo)
2635: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2636: .endif
2637: </pre>
2638: </div>
1.41 asau 2639: <div class="sect1">
1.1 dsieger 2640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2641: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2642: <p>As the system administrator, you can choose where configuration files
2643: are installed. The default settings make all these files go into
2644: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2645: be suboptimal depending on your expectations (e.g., a read-only,
2646: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2647: configuration of the provided packages).</p>
2648: <p>In order to change the defaults, you can modify the
2649: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2650: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2651: directory; some common examples include <code class="filename">/etc</code> or
2652: <code class="filename">/etc/pkg</code>.</p>
2653: <p>Furthermore, you can change this value on a per-package basis by
2654: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2655: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2656: package you would like to modify, that is, the contents of
2657: <code class="varname">PKGBASE</code>.</p>
2658: <p>Note that after changing these settings, you must rebuild and
2659: reinstall any affected packages.</p>
2660: </div>
1.41 asau 2661: <div class="sect1">
1.1 dsieger 2662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2663: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2664: <p>Please be aware that there can often be bugs in third-party software,
2665: and some of these bugs can leave a machine vulnerable to exploitation by
2666: attackers. In an effort to lessen the exposure, the NetBSD packages team
2667: maintains a database of known-exploits to packages which have at one time
2668: been included in pkgsrc. The database can be downloaded automatically, and
2669: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2670: do this, refer to the following two tools (installed as part of the
1.79 snj 2671: <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 2672: <div class="orderedlist"><ol class="orderedlist" type="1">
2673: <li class="listitem">
1.20 snj 2674: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2675: download a list of the security vulnerabilities information. This list
1.25 spz 2676: is kept up to date by the pkgsrc security team, and is distributed
2677: from the NetBSD ftp server:</p>
2678: <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 2679: </li>
1.23 wiz 2680: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2681: current machine, checking each known vulnerability. If a
1.1 dsieger 2682: vulnerable package is installed, it will be shown by output to stdout,
2683: including a description of the type of vulnerability, and a URL
2684: containing more information.</p></li>
2685: </ol></div>
1.14 jmcneill 2686: <p>Use of these tools is strongly recommended! After
1.23 wiz 2687: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 2688: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 2689: pkg_install</code></strong>.</p>
1.1 dsieger 2690: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 2691: 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 2692: check.</p>
2693: </div>
1.41 asau 2694: <div class="sect1">
1.1 dsieger 2695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2696: <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 2697: <p>When you add your own preferences to the
2698: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2699: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2700: environment variables to the <code class="filename">./configure</code>
1.79 snj 2701: 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 2702: <code class="varname">CFLAGS</code> from the environment variable by
2703: overriding them in the <code class="filename">Makefile</code>s of their
2704: package.</p>
2705: <p>Currently there is no solution to this problem. If you
2706: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2707: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2708: directory and then inspect any <code class="filename">Makefile</code> and
2709: <code class="filename">Makefile.in</code> for whether they define
2710: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2711: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2712: programmers write so bad code that it only works for the
2713: specific combination of <code class="varname">CFLAGS</code> they have
2714: chosen.</p>
2715: </div>
1.41 asau 2716: <div class="sect1">
1.1 dsieger 2717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2718: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2719: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2720: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2721: case that occurs often is that people only update pkgsrc in
2722: parts, because of performance reasons. Since pkgsrc is one large
2723: system, not a collection of many small systems, there are
2724: sometimes changes that only work when the whole pkgsrc tree is
2725: updated.</p></li>
1.41 asau 2726: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2727: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2728: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2729: files.</p></li>
1.41 asau 2730: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2731: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2732: verify this.</p></li>
1.108 rillig 2733: <li class="step"><p>If you are a package developer who wants to invest
2734: 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 2735: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2736: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2737: </ol></div>
2738: </div>
1.41 asau 2739: <div class="sect1">
1.1 dsieger 2740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2741: <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 2742: <p>You have modified a file from pkgsrc, and someone else has
2743: modified that same file afterwards in the CVS repository. Both changes
2744: are in the same region of the file, so when you updated pkgsrc, the
2745: <code class="literal">cvs</code> command marked the conflicting changes in the
2746: file. Because of these markers, the file is no longer a valid
2747: <code class="filename">Makefile</code>.</p>
2748: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2749: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2750: -dP</strong></span> in that directory to download the current version.</p>
2751: </div>
2752: </div>
2753: </div>
1.41 asau 2754: <div class="part">
1.1 dsieger 2755: <div class="titlepage"><div><div><h1 class="title">
2756: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2757: <div class="partintro">
1.1 dsieger 2758: <div></div>
2759: <p>This part of the book deals with creating and
1.23 wiz 2760: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2761: guide on creating a new package. The remaining chapters are more
2762: like a reference manual for pkgsrc.</p>
2763: <div class="toc">
2764: <p><b>Table of Contents</b></p>
1.100 leot 2765: <dl class="toc">
1.6 rillig 2766: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2767: <dd><dl>
1.6 rillig 2768: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2769: <dd><dl>
1.6 rillig 2770: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 2771: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 2772: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 2773: </dl></dd>
1.6 rillig 2774: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
2775: <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>
2776: </dl></dd>
2777: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
2778: <dd><dl>
1.23 wiz 2779: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
2780: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 2781: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2782: <dd><dl>
2783: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
2784: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
2785: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
2786: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
2787: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
2788: </dl></dd>
2789: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
2790: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
2791: <dd><dl>
2792: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
2793: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
2794: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
2795: </dl></dd>
1.23 wiz 2796: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
2797: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2798: </dl></dd>
1.23 wiz 2799: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2800: <dd><dl>
2801: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 2802: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 2803: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
2804: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
2805: <dd><dl>
2806: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 2807: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
2808: <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>
2809: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2810: </dl></dd>
2811: </dl></dd>
2812: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
2813: <dd><dl>
2814: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 2815: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2816: <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 2817: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
2818: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 2819: <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 2820: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 2821: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
2822: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2823: </dl></dd>
2824: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
2825: <dd><dl>
2826: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 2827: <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 2828: <dd><dl>
2829: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 2830: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
2831: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2832: and
2833: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2834: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2835: </dl></dd>
1.23 wiz 2836: <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 2837: <dd><dl>
1.23 wiz 2838: <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 2839: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
2840: </dl></dd>
2841: </dl></dd>
2842: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
2843: <dd><dl>
2844: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
2845: <dd><dl>
2846: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
2847: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
2848: </dl></dd>
2849: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
2850: <dd><dl>
1.23 wiz 2851: <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 2852: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
2853: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
2854: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
2855: </dl></dd>
2856: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
2857: <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>
2858: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
2859: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
2860: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
2861: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
2862: <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>
2863: </dl></dd>
2864: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
2865: <dd><dl>
2866: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 2867: <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 2868: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 2869: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 2870: </dl></dd>
2871: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
2872: <dd><dl>
2873: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
2874: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
2875: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
2876: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 2877: <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 2878: <dd><dl>
2879: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
2880: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
2881: </dl></dd>
1.23 wiz 2882: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2883: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2884: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2885: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2886: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2887: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2888: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2889: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2890: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2891: <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 2892: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
2893: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
2894: </dl></dd>
2895: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
2896: <dd><dl>
2897: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
2898: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
2899: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
2900: </dl></dd>
2901: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
2902: <dd><dl>
2903: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
2904: <dd><dl>
1.108 rillig 2905: <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>
2906: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
2907: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
2908: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
2909: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
2910: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
2911: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
2912: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
2913: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
2914: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2915: <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 2916: </dl></dd>
1.108 rillig 2917: <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 2918: <dd><dl>
2919: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2920: <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 2921: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 2922: </dl></dd>
1.108 rillig 2923: <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 2924: <dd><dl>
2925: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
2926: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2927: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
2928: </dl></dd>
2929: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
2930: <dd><dl>
2931: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
2932: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
2933: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 2934: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
2935: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 2936: </dl></dd>
1.108 rillig 2937: <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 2938: <dd><dl>
2939: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
2940: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 2941: <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 2942: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
2943: </dl></dd>
1.108 rillig 2944: <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 2945: <dd><dl>
2946: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
2947: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
2948: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
2949: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
2950: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2951: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
2952: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
2953: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 2954: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 2955: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 2956: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
2957: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
2958: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
2959: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
2960: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
2961: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
2962: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
2963: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 2964: emulation</a></span></dt>
1.6 rillig 2965: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
2966: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 2967: </dl></dd>
1.6 rillig 2968: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 2969: </dl></dd>
1.6 rillig 2970: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
2971: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 2972: <dd><dl>
1.6 rillig 2973: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
2974: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
2975: <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 2976: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 2977: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 2978: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
2979: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 2980: </dl></dd>
2981: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
2982: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
2983: <dd><dl>
2984: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
2985: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
2986: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
2987: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 2988: </dl></dd>
2989: </dl>
2990: </div>
2991: </div>
1.41 asau 2992: <div class="chapter">
1.1 dsieger 2993: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2994: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 2995: <div class="toc">
2996: <p><b>Table of Contents</b></p>
1.100 leot 2997: <dl class="toc">
1.6 rillig 2998: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2999: <dd><dl>
1.6 rillig 3000: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3001: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3002: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3003: </dl></dd>
1.6 rillig 3004: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3005: <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 3006: </dl>
3007: </div>
3008: <p>When you find a package that is not yet in pkgsrc, you
3009: most likely have a URL from where you can download the source
3010: code. Starting with this URL, creating a package involves only a
3011: few steps.</p>
1.23 wiz 3012: <div class="procedure"><ol class="procedure" type="1">
1.79 snj 3013: <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 3014: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3015: category in which you want to place your package. You can also create a
3016: directory of your own (maybe called <code class="filename">local</code>). In that
3017: category directory, create another directory for your package and change
3018: into it.</p></li>
1.41 asau 3019: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3020: you for a URL. Enter the URL of the distribution file (in most cases a
3021: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3022: of your package are created automatically. The distribution file is
3023: extracted automatically to fill in some details in the
3024: <code class="filename">Makefile</code> that would otherwise have to be done
3025: manually.</p></li>
1.41 asau 3026: <li class="step">
1.1 dsieger 3027: <p>Examine the extracted files to determine the dependencies of
3028: your package. Ideally, this is mentioned in some
3029: <code class="filename">README</code> file, but things may differ. For each of
3030: these dependencies, look where it exists in pkgsrc, and if there is a
3031: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3032: line to your package <code class="filename">Makefile</code> which includes that
3033: file just before the last line. If the
1.25 spz 3034: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3035: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3036: <p>If you just need binaries from a package, add a
1.1 dsieger 3037: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3038: version of the dependency and where it can be found in pkgsrc. This line
3039: should be placed in the third paragraph. If the dependency is only
3040: needed for building the package, but not when using it, use
3041: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3042: Your package may then look like this:</p>
3043: <pre class="programlisting">
3044: [...]
3045:
1.66 asau 3046: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3047: DEPENDS+= screen-[0-9]*:../../misc/screen
3048: DEPENDS+= screen>=4.0:../../misc/screen
3049:
3050: [...]
3051:
3052: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3053: .include "../../devel/glib2/buildlink3.mk"
3054: .include "../../mk/bsd.pkg.mk"
3055: </pre>
3056: </li>
1.41 asau 3057: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3058: 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 3059: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3060: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3061: -e</strong></span>, which outputs additional
3062: explanations.</p></li>
1.41 asau 3063: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3064: 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 3065: over there, you can hopefully continue here.</p></li>
1.41 asau 3066: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3067: directory from the extracted files. Besides these files, a lot of cache
3068: files and other system information has been saved in the working
3069: directory, which may become wrong after you edited the
3070: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3071: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3072: 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 3073: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3074: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3075: everything works.</p></li>
1.41 asau 3076: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3077: contains a list of the files that are installed by the package, is
1.10 hubertf 3078: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3079: >PLIST</strong></span> to generate a probably correct list. Check
3080: the file using your preferred text editor to see if the list of
3081: files looks plausible.</p></li>
1.41 asau 3082: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3083: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3084: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3085: has been registered in the database of installed files, but with an
1.10 hubertf 3086: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3087: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3088: registered with the list of files from
3089: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3090: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3091: package from the set of installed files.</p></li>
3092: </ol></div>
1.41 asau 3093: <div class="sect1">
1.1 dsieger 3094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3095: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3096: <div class="sect2">
1.1 dsieger 3097: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3098: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3099: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3100: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3101: </div>
1.41 asau 3102: <div class="sect2">
1.1 dsieger 3103: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 3104: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3105: <p>KDE3 applications should always include
1.1 dsieger 3106: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 asau 3107: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3108: </div>
1.41 asau 3109: <div class="sect2">
1.17 imil 3110: <div class="titlepage"><div><div><h3 class="title">
3111: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3112: <p>Python modules and programs packages are easily created using a
3113: set of predefined variables.</p>
3114: <p>
1.63 wiz 3115: If some Python versions are not supported by the software, set the
3116: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3117: that are not supported, e.g.
1.17 imil 3118: </p>
3119: <pre class="programlisting">
1.93 sevan 3120: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3121: </pre>
3122: <p>
1.103 wiz 3123: If the packaged software is a Python module, include one of
3124: <code class="filename">../../lang/python/egg.mk</code>,
3125: <code class="filename">../../lang/python/distutils.mk</code>, or
3126: <code class="filename">../../lang/python/extension.mk</code>.</p>
3127: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3128: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3129: if the packaged software is using setuptools, you only need
3130: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3131: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3132: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3133: so pkgsrc will use this framework.
3134: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3135: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3136: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3137: to the name of the script.</p>
3138: <p>Either way, the package directory should be called
1.23 wiz 3139: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3140: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3141: </p>
3142: <pre class="programlisting">
3143: DISTNAME= foopymodule-1.2.10
3144: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3145: </pre>
1.63 wiz 3146: <p>If it is an application, include
3147: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3148: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3149: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3150: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3151: For example:
1.17 imil 3152: </p>
3153: <pre class="programlisting">
1.35 wiz 3154: REPLACE_PYTHON= *.py
1.17 imil 3155: </pre>
1.63 wiz 3156: <p>Some Python modules have separate distributions for Python-2.x
3157: and Python-3.x support. In pkgsrc this is handled by the
3158: <code class="filename">versioned_dependencies.mk</code> file. Set
3159: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3160: packages that should be depended upon and include
3161: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3162: then the pkgsrc infrastructure will depend on the appropriate package
3163: version. For example:
3164: </p>
3165: <pre class="programlisting">
1.110 wiz 3166: PYTHON_VERSIONED_DEPENDENCIES=dateutil
1.63 wiz 3167: </pre>
3168: <p>
3169: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3170: of supported packages.</p>
1.17 imil 3171: </div>
1.1 dsieger 3172: </div>
1.41 asau 3173: <div class="sect1">
1.1 dsieger 3174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3175: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3176: <div class="sect2">
1.1 dsieger 3177: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3178: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3179: <div class="sect3">
1.1 dsieger 3180: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3181: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3182: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3183: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3184: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3185: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3186: <pre class="programlisting">
3187: <code class="prompt">$</code> mkdir www/nvu
3188: <code class="prompt">$</code> cd www/nvu
3189: </pre>
3190: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3191: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3192: <pre class="programlisting">
3193: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3194: </pre>
3195: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3196: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3197: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3198: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3199: <code class="varname">COMMENT</code> fields. Then the package
3200: <code class="filename">Makefile</code> looked like that:</p>
3201: <pre class="programlisting">
3202: # $NetBSD$
3203: #
3204:
3205: DISTNAME= nvu-1.0-sources
3206: PKGNAME= nvu-1.0
3207: CATEGORIES= www
3208: MASTER_SITES= http://cvs.nvu.com/download/
3209: EXTRACT_SUFX= .tar.bz2
3210:
3211: MAINTAINER= rillig@NetBSD.org
3212: HOMEPAGE= http://cvs.nvu.com/
3213: COMMENT= Web Authoring System
3214:
3215: # url2pkg-marker (please do not remove this line.)
3216: .include "../../mk/bsd.pkg.mk"
3217: </pre>
3218: <p>Then, I quit the editor and watched pkgsrc downloading a large
3219: source archive:</p>
3220: <pre class="programlisting">
3221: url2pkg> Running "make makesum" ...
3222: => Required installed package digest>=20010302: digest-20060826 found
3223: => Fetching nvu-1.0-sources.tar.bz2
3224: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3225: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3226: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3227: url2pkg> Running "make extract" ...
3228: => Required installed package digest>=20010302: digest-20060826 found
3229: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3230: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3231: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3232: ===> Installing dependencies for nvu-1.0
3233: ===> Overriding tools for nvu-1.0
3234: ===> Extracting for nvu-1.0
3235: url2pkg> Adjusting the Makefile.
3236:
3237: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3238:
3239: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3240: </pre>
3241: </div>
1.41 asau 3242: <div class="sect3">
1.1 dsieger 3243: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3244: <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 3245: <p>Now that the package has been extracted, let's see what's inside
3246: it. The package has a <code class="filename">README.txt</code>, but that only
3247: says something about mozilla, so it's probably useless for seeing what
3248: dependencies this package has. But since there is a GNU configure script
3249: in the package, let's hope that it will complain about everything it
3250: needs.</p>
3251: <pre class="programlisting">
3252: <code class="prompt">$</code> bmake
3253: => Required installed package digest>=20010302: digest-20060826 found
3254: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3255: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3256: ===> Patching for nvu-1.0
3257: ===> Creating toolchain wrappers for nvu-1.0
3258: ===> Configuring for nvu-1.0
3259: [...]
3260: configure: error: Perl 5.004 or higher is required.
3261: [...]
3262: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3263: [...]
3264: </pre>
3265: <p>That worked quite well. So I opened the package Makefile in my
3266: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3267: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3268: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3269: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3270: from scratch.</p>
3271: <pre class="programlisting">
3272: <code class="prompt">$</code> bmake clean
3273: ===> Cleaning for nvu-1.0
3274: <code class="prompt">$</code> bmake
3275: [...]
3276: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3277: GNU Make. You will not be able to build Mozilla without GNU Make.
3278: [...]
3279: </pre>
1.23 wiz 3280: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3281: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3282: <pre class="programlisting">
3283: [...]
3284: checking for GTK - version >= 1.2.0... no
3285: *** Could not run GTK test program, checking why...
3286: [...]
3287: </pre>
3288: <p>Now to the other dependencies. The first question is: Where is the
3289: GTK package hidden in pkgsrc?</p>
3290: <pre class="programlisting">
3291: <code class="prompt">$</code> echo ../../*/gtk*
3292: [many packages ...]
3293: <code class="prompt">$</code> echo ../../*/gtk
3294: ../../x11/gtk
3295: <code class="prompt">$</code> echo ../../*/gtk2
3296: ../../x11/gtk2
3297: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3298: ../../x11/gtk2/buildlink3.mk
3299: </pre>
3300: <p>The first try was definitely too broad. The second one had exactly
3301: one result, which is very good. But there is one pitfall with GNOME
3302: packages. Before GNOME 2 had been released, there were already many
3303: GNOME 1 packages in pkgsrc. To be able to continue to use these
3304: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3305: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3306: whether this was the case here, and indeed it was.</p>
3307: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3308: file, adding the dependency is very easy. I just inserted an
3309: <code class="literal">.include</code> line before the last line of the package
3310: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3311: <pre class="programlisting">
3312: [...]
3313: .include "../../x11/gtk2/buildlink3.mk"
3314: .include "../../mk/bsd.pkg.mk
3315: </pre>
1.10 hubertf 3316: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3317: was:</p>
3318: <pre class="programlisting">
3319: [...]
3320: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3321: checking for GTK - version >= 1.2.0... no
3322: *** Could not run GTK test program, checking why...
3323: *** The test program failed to compile or link. See the file config.log for the
3324: *** exact error that occured. This usually means GTK was incorrectly installed
3325: *** or that you have moved GTK since it was installed. In the latter case, you
3326: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3327: configure: error: Test for GTK failed.
3328: [...]
3329: </pre>
1.23 wiz 3330: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3331: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3332: told me that this package really wanted to have the GNOME 1 version of
3333: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3334: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3335: So I changed the <code class="literal">x11/gtk2</code> to
3336: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3337: and tried again.</p>
3338: <pre class="programlisting">
3339: [...]
1.59 jnemeth 3340: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3341: In file included from xpidl.c:42:
3342: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3343: In file included from xpidl.c:42:
3344: xpidl.h:132: error: parse error before "IDL_ns"
3345: [...]
3346: </pre>
3347: <p>The package still does not find all of its dependencies. Now the
3348: question is: Which package provides the
3349: <code class="filename">libIDL/IDL.h</code> header file?</p>
3350: <pre class="programlisting">
3351: <code class="prompt">$</code> echo ../../*/*idl*
3352: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3353: <code class="prompt">$</code> echo ../../*/*IDL*
3354: ../../net/libIDL
3355: </pre>
3356: <p>Let's take the one from the second try. So I included the
3357: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3358: again. But the error didn't change. After digging through some of the
3359: code, I concluded that the build process of the package was broken and
3360: couldn't have ever worked, but since the Mozilla source tree is quite
3361: large, I didn't want to fix it. So I added the following to the package
3362: <code class="filename">Makefile</code> and tried again:</p>
3363: <pre class="programlisting">
3364: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3365: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3366: </pre>
3367: <p>The latter line is needed because the package expects the library
3368: <code class="filename">libIDL.so</code>, but only
3369: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3370: wrapper to rewrite that on the fly.</p>
3371: <p>The next problem was related to a recent change of the FreeType
1.79 snj 3372: 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 3373: which patch files were relevant for this issue and copied them to the
3374: <code class="filename">patches</code> directory. Then I retried, fixed the
3375: patches so that they applied cleanly and retried again. This time,
3376: everything worked.</p>
3377: </div>
1.41 asau 3378: <div class="sect3">
1.1 dsieger 3379: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3380: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3381: <pre class="programlisting">
3382: <code class="prompt">$</code> bmake CHECK_FILES=no install
3383: [...]
3384: <code class="prompt">$</code> bmake print-PLIST >PLIST
3385: <code class="prompt">$</code> bmake deinstall
3386: <code class="prompt">$</code> bmake install
3387: </pre>
3388: </div>
3389: </div>
3390: </div>
3391: </div>
1.41 asau 3392: <div class="chapter">
1.1 dsieger 3393: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3394: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3395: <div class="toc">
3396: <p><b>Table of Contents</b></p>
1.100 leot 3397: <dl class="toc">
1.23 wiz 3398: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3399: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 3400: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3401: <dd><dl>
3402: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3403: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3404: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3405: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3406: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3407: </dl></dd>
3408: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3409: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3410: <dd><dl>
3411: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3412: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3413: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3414: </dl></dd>
1.23 wiz 3415: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3416: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3417: </dl>
3418: </div>
3419: <p>Whenever you're preparing a package, there are a number of
3420: files involved which are described in the following
3421: sections.</p>
1.41 asau 3422: <div class="sect1">
1.1 dsieger 3423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3424: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3425: </h2></div></div></div>
3426: <p>Building, installation and creation of a binary package are all
3427: controlled by the package's <code class="filename">Makefile</code>.
3428: The <code class="filename">Makefile</code> describes various things about
3429: a package, for example from where to get it, how to configure,
3430: build, and install it.</p>
3431: <p>A package <code class="filename">Makefile</code> contains several
3432: sections that describe the package.</p>
3433: <p>In the first section there are the following variables, which
3434: should appear exactly in the order given here. The order and
3435: grouping of the variables is mostly historical and has no further
3436: meaning.</p>
1.41 asau 3437: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3438: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3439: distribution file to be downloaded from the package's
3440: website.</p></li>
1.23 wiz 3441: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3442: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3443: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3444: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3445: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3446: directory name together with the version number. It must match the
3447: regular expression
3448: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3449: starts with a letter or digit, and contains only letters, digits,
3450: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3451: <li class="listitem">
1.1 dsieger 3452: <p><code class="varname">CATEGORIES</code> is a list of categories
3453: which the package fits in. You can choose any of the top-level
3454: directories of pkgsrc for it.</p>
3455: <p>Currently the following values are available for
3456: <code class="varname">CATEGORIES</code>. If more than
3457: one is used, they need to be separated by spaces:</p>
3458: <pre class="programlisting">
3459: archivers cross geography meta-pkgs security
3460: audio databases graphics misc shells
3461: benchmarks devel ham multimedia sysutils
3462: biology editors inputmethod net textproc
3463: cad emulators lang news time
3464: chat finance mail parallel wm
3465: comms fonts math pkgtools www
3466: converters games mbone print x11
3467: </pre>
3468: </li>
1.23 wiz 3469: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3470: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3471: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3472: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 3473: <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 3474: </ul></div>
3475: <p>The second section contains information about separately
3476: downloaded patches, if any.
3477: </p>
1.41 asau 3478: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3479: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3480: Name(s) of additional files that contain distribution patches.
3481: There is no default. pkgsrc will look for them at
3482: <code class="varname">PATCH_SITES</code>.
3483: They will automatically be uncompressed before patching if
3484: the names end with <code class="filename">.gz</code> or
3485: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3486: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3487: Primary location(s) for distribution patch files (see
1.80 wiz 3488: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3489: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
3490: 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
3491: help find the correct files to patch. It defaults to
3492: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3493: </ul></div>
3494: <p>The third section contains the following variables.
3495: </p>
1.41 asau 3496: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3497: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3498: address of the person who feels responsible for this package,
3499: and who is most likely to look at problems or questions regarding
1.79 snj 3500: 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 3501: Other developers may contact the <code class="varname">MAINTAINER</code>
3502: before making changes to the package, but are not required to
3503: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3504: to yourself. If you really can't maintain the package for future
3505: updates, set it to
1.10 hubertf 3506: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3507: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3508: of <code class="varname">MAINTAINER</code> when you do not want other
3509: developers to update or change the package without contacting
3510: you first. A package Makefile should contain one of
3511: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3512: not both. </p></li>
1.23 wiz 3513: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3514: find more information about the package.</p></li>
1.23 wiz 3515: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3516: description of the package (should not include the package
3517: name).</p></li>
3518: </ul></div>
3519: <p>Other variables that affect the build:
3520: </p>
1.41 asau 3521: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3522: <p><code class="varname">WRKSRC</code>: The directory where the
3523: interesting distribution files of the package are found. The
3524: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3525: works for most packages.</p>
3526: <p>If a package doesn't create a subdirectory for itself
3527: (most GNU software does, for instance), but extracts itself in
3528: the current directory, you should set
3529: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3530: <p>If a package doesn't create a subdirectory with the
3531: name of <code class="varname">DISTNAME</code> but some different name,
3532: set <code class="varname">WRKSRC</code> to point to the proper name in
3533: <code class="filename">${WRKDIR}</code>, for example
3534: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.79 snj 3535: <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 3536: <p>The name of the working directory created by pkgsrc is
3537: taken from the <code class="varname">WRKDIR_BASENAME</code>
3538: variable. By default, its value is
3539: <code class="filename">work</code>. If you want to use the same
3540: pkgsrc tree for building different kinds of binary packages,
3541: you can change the variable according to your needs. Two
3542: other variables handle common cases of setting
3543: <code class="varname">WRKDIR_BASENAME</code> individually. If
3544: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3545: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3546: the host's name is attached to the directory name. If
3547: <code class="varname">OBJMACHINE</code> is defined, the platform name
3548: is attached, which might look like
3549: <code class="filename">work.i386</code> or
3550: <code class="filename">work.sparc</code>.</p>
3551: </li></ul></div>
3552: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3554: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3555: installed in compressed form by the package. For packages using
3556: BSD-style makefiles which honor MANZ, there is
3557: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3558: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3559: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3560: below).</p></li>
1.23 wiz 3561: <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 3562: </ul></div>
3563: </div>
1.41 asau 3564: <div class="sect1">
1.1 dsieger 3565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3566: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 3567: </h2></div></div></div>
3568: <p>The <code class="filename">distinfo</code> file contains the message
3569: digest, or checksum, of each distfile needed for the package. This
3570: ensures that the distfiles retrieved from the Internet have not been
3571: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3572: a security hole. To provide maximum security, all distfiles are
3573: protected using three different message digest algorithms (SHA1,
3574: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3575: <p>The <code class="filename">distinfo</code> file also contains the
3576: checksums for all the patches found in the
1.108 rillig 3577: <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 3578: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3579: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3580: <p>Some packages have different sets of distfiles depending on
1.79 snj 3581: 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 3582: <code class="filename">distinfo</code> file and care should be taken when
3583: upgrading such a package to ensure distfile information is not
3584: lost.</p>
3585: </div>
1.41 asau 3586: <div class="sect1">
1.1 dsieger 3587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 3588: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
3589: </h2></div></div></div>
3590: <p>Some packages don't work out-of-the box on the various
3591: platforms that are supported by pkgsrc. These packages need
3592: to be patched to make them work. The patch files can be
1.1 dsieger 3593: found in the <code class="filename">patches/</code> directory.</p>
3594: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3595: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3596: extracting them, in alphabetic order.</p>
1.41 asau 3597: <div class="sect2">
1.1 dsieger 3598: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3599: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3600: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3601: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3602: problems. (To force patches to apply with fuzz you can set
3603: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3604: should contain only changes for a single file, and no file should be
3605: patched by more than one patch file. This helps to keep future
3606: modifications simple.</p>
3607: <p>Each patch file is structured as follows: In the first line,
3608: there is the RCS Id of the patch itself. The second line should be
3609: empty for aesthetic reasons. After that, there should be a comment for
3610: each change that the patch does. There are a number of standard
3611: cases:</p>
1.41 asau 3612: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3613: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3614: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3615: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3616: platform and other environment (for example, the compiler) that the
3617: patch is needed for.</p></li>
3618: </ul></div>
1.108 rillig 3619: <p>The patch should be commented so that any
1.1 dsieger 3620: developer who knows the code of the application can make some use of
3621: the patch. Special care should be taken for the upstream developers,
3622: since we generally want that they accept our patches, so we have less
3623: work in the future.</p>
3624: </div>
1.41 asau 3625: <div class="sect2">
1.1 dsieger 3626: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3627: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3628: <p>One important thing to mention is to pay attention that no RCS
3629: IDs get stored in the patch files, as these will cause problems when
3630: later checked into the NetBSD CVS tree. Use the
1.79 snj 3631: <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 3632: problems.</p>
3633: <p>For even more automation, we recommend using
1.10 hubertf 3634: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3635: whole set of patches. You just have to backup files before you
3636: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3637: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3638: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3639: you upgrade a package this way, you can easily compare the new
3640: set of patches with the previously existing one with
1.24 wiz 3641: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3642: are replaced by new files, so carefully check if you want to take all
3643: the changes.</p>
1.1 dsieger 3644: <p>When you have finished a package, remember to generate
1.10 hubertf 3645: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 3646: 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 3647: <p>When adding a patch that corrects a problem in the
3648: distfile (rather than e.g. enforcing pkgsrc's view of where
3649: man pages should go), send the patch as a bug report to the
3650: maintainer. This benefits non-pkgsrc users of the package,
3651: and usually makes it possible to remove the patch in future
3652: version.</p>
1.2 rillig 3653: <p>The file names of the patch files are usually of the form
1.24 wiz 3654: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3655: Many packages still use the previous convention
3656: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3657: but new patches should be of the form containing the filename.
1.79 snj 3658: <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 3659: automatically.</p>
1.1 dsieger 3660: </div>
1.41 asau 3661: <div class="sect2">
1.1 dsieger 3662: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3663: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3664: <p>If you want to share patches between multiple packages
3665: in pkgsrc, e.g. because they use the same distfiles, set
3666: <code class="varname">PATCHDIR</code> to the path where the patch files
3667: can be found, e.g.:</p>
3668: <pre class="programlisting">
3669: PATCHDIR= ${.CURDIR}/../xemacs/patches
3670: </pre>
3671: <p>Patch files that are distributed by the author or other
3672: maintainers can be listed in
3673: <code class="varname">PATCHFILES</code>.</p>
3674: <p>If it is desired to store any patches that should not be
3675: committed into pkgsrc, they can be kept outside the pkgsrc
3676: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3677: directory tree there is expected to have the same
1.23 wiz 3678: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3679: patches are expected to be stored inside these dirs (also
3680: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3681: example, if you want to keep a private patch for
3682: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3683: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3684: files in the named directory are expected to be patch files,
3685: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3686: applied</em></span>.</p>
3687: </div>
1.41 asau 3688: <div class="sect2">
1.1 dsieger 3689: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3690: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3691: <p>When fixing a portability issue in the code do not use
3692: preprocessor magic to check for the current operating system nor
3693: platform. Doing so hurts portability to other platforms because
3694: the OS-specific details are not abstracted appropriately.</p>
3695: <p>The general rule to follow is: instead of checking for the
3696: operating system the application is being built on, check for the
3697: specific <span class="emphasis"><em>features</em></span> you need. For example,
3698: instead of assuming that kqueue is available under NetBSD and
3699: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3700: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3701: yes, this generally involves patching the
1.10 hubertf 3702: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3703: that prevents some OSes from adopting interfaces from other OSes
3704: (e.g. Linux implementing kqueue), something that the above checks
3705: cannot take into account.</p>
3706: <p>Of course, checking for features generally involves more
3707: work on the developer's side, but the resulting changes are
3708: cleaner and there are chances they will work on many other
3709: platforms. Not to mention that there are higher chances of being
3710: later integrated into the mainstream sources. Remember:
3711: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3712: <p>Some typical examples:</p>
3713: <div class="table">
1.6 rillig 3714: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.106 tnn 3715: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3716: <colgroup>
3717: <col>
3718: <col>
3719: <col>
3720: </colgroup>
3721: <thead><tr>
3722: <th>Where</th>
3723: <th>Incorrect</th>
3724: <th>Correct</th>
3725: </tr></thead>
3726: <tbody>
3727: <tr>
3728: <td>configure script</td>
3729: <td>
3730: <pre class="programlisting">
3731: case ${target_os} in
3732: netbsd*) have_kvm=yes ;;
3733: *) have_kvm=no ;;
3734: esac
3735: </pre>
3736: </td>
3737: <td>
3738: <pre class="programlisting">
3739: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3740: </pre>
3741: </td>
3742: </tr>
3743: <tr>
3744: <td>C source file</td>
3745: <td>
3746: <pre class="programlisting">
3747: #if defined(__NetBSD__)
3748: # include <sys/event.h>
3749: #endif
3750: </pre>
3751: </td>
3752: <td>
3753: <pre class="programlisting">
3754: #if defined(HAVE_SYS_EVENT_H)
3755: # include <sys/event.h>
3756: #endif
3757: </pre>
3758: </td>
3759: </tr>
3760: <tr>
3761: <td>C source file</td>
3762: <td>
3763: <pre class="programlisting">
3764: int
3765: monitor_file(...)
3766: {
3767: #if defined(__NetBSD__)
3768: int fd = kqueue();
3769: ...
3770: #else
3771: ...
3772: #endif
3773: }
3774: </pre>
3775: </td>
3776: <td>
3777: <pre class="programlisting">
3778: int
3779: monitor_file(...)
3780: {
3781: #if defined(HAVE_KQUEUE)
3782: int fd = kqueue();
3783: ...
3784: #else
3785: ...
3786: #endif
3787: }
3788: </pre>
3789: </td>
3790: </tr>
3791: </tbody>
3792: </table></div>
3793: </div>
3794: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 3795: 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
3796: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 3797: 2</a>). It summarizes multiple details on how to make
3798: software easier to package; all the suggestions in it were
3799: collected from our experience in pkgsrc work, so they are possibly
3800: helpful when creating patches too.</p>
3801: </div>
1.41 asau 3802: <div class="sect2">
1.1 dsieger 3803: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3804: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3805: <p>Always, always, <span class="strong"><strong>always</strong></span>
3806: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3807: improvements you do to a package to the mainstream developers.
3808: This is the only way to get their attention on portability issues
3809: and to ensure that future versions can be built out-of-the box on
3810: NetBSD. Furthermore, any user that gets newer distfiles will get
3811: the fixes straight from the packaged code.</p>
3812: <p>This generally involves cleaning up the patches
3813: (because sometimes the patches that are
1.40 wiz 3814: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3815: appropriate trackers for the projects and working with the
3816: mainstream authors to accept your changes. It is
3817: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3818: the packages in pkgsrc are kept simple and thus further changes
3819: can be done without much hassle.</p>
1.24 wiz 3820: <p>When you have done this, please add a URL to the upstream
3821: bug report to the patch comment.</p>
1.1 dsieger 3822: <p>Support the idea of free software!</p>
3823: </div>
3824: </div>
1.41 asau 3825: <div class="sect1">
1.1 dsieger 3826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3827: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 3828: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3829: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3830: <dd><p>A multi-line description of the piece of software. This should include
3831: any credits where they are due. Please bear in mind that others do not
3832: share your sense of humour (or spelling idiosyncrasies), and that others
3833: will read everything that you write here.</p></dd>
3834: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3835: <dd><p>This file governs the files that are installed on your
3836: system: all the binaries, manual pages, etc. There are other
3837: directives which may be entered in this file, to control the
3838: creation and deletion of directories, and the location of
1.10 hubertf 3839: 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 3840: information.</p></dd>
3841: </dl></div>
3842: </div>
1.41 asau 3843: <div class="sect1">
1.1 dsieger 3844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3845: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 3846: <div class="sect2">
1.1 dsieger 3847: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3848: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 3849: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3850: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 3851: <dd>
1.79 snj 3852: <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 3853: First time after package extraction and before files are
3854: moved in place, the second time after the files to install
3855: are moved in place. This can be used to do any custom
3856: procedures not possible with @exec commands in
1.79 snj 3857: <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
3858: <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 3859: Please note that you can modify variables in it easily by using
3860: <code class="varname">FILES_SUBST</code> in the package's
3861: <code class="filename">Makefile</code>:</p>
3862: <pre class="programlisting">
3863: FILES_SUBST+= SOMEVAR="somevalue"
3864: </pre>
3865: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3866: <code class="filename">INSTALL</code>. By default, substitution is
3867: performed for <code class="varname">PREFIX</code>,
3868: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3869: <code class="varname">VARBASE</code>, and a few others, type
3870: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3871: complete list.</p>
3872: </dd>
1.1 dsieger 3873: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3874: <dd><p>This script is executed before and after any files are removed. It is
3875: this script's responsibility to clean up any additional messy details
3876: around the package's installation, since all pkg_delete knows is how to
3877: delete the files created in the original distribution.
1.79 snj 3878: 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>
3879: 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 3880: The same methods to replace variables can be used as for
3881: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 3882: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3883: <dd>
3884: <p>This file is displayed after installation of the package.
3885: Useful for things like legal notices on almost-free
3886: software and hints for updating config files after
3887: installing modules for apache, PHP etc.
3888: Please note that you can modify variables in it easily by using
3889: <code class="varname">MESSAGE_SUBST</code> in the package's
3890: <code class="filename">Makefile</code>:</p>
3891: <pre class="programlisting">
3892: MESSAGE_SUBST+= SOMEVAR="somevalue"
3893: </pre>
1.23 wiz 3894: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 3895: <code class="filename">MESSAGE</code>. By default, substitution is
3896: performed for <code class="varname">PKGNAME</code>,
3897: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 3898: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 3899: <code class="varname">PKG_SYSCONFDIR</code>,
3900: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 3901: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 3902: <p>You can display a different or additional files by
3903: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3904: default is <code class="filename">MESSAGE</code>, if the file
3905: exists.</p>
3906: </dd>
3907: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 3908: <dd>
3909: <p>This file is used by the alternatives framework.
3910: It creates, configures, and destroys generic wrappers used to
3911: run programs with similar interfaces.
3912: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3913: for more information.</p>
3914: <p>Each line of the file contains two filenames, first
3915: the wrapper and then the alternative provided by the package.
3916: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3917: </dd>
1.1 dsieger 3918: </dl></div>
3919: </div>
1.41 asau 3920: <div class="sect2">
1.1 dsieger 3921: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3922: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 3923: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3924: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3925: <dd><p>This file contains arbitrary things that could
3926: also go into a <code class="filename">Makefile</code>, but its purpose is
3927: to be used by more than one package. This file should only be
3928: used when the packages that will use the file are known in
3929: advance. For other purposes it is often better to write a
3930: <code class="filename">*.mk</code> file and give it a good name that
3931: describes what it does.</p></dd>
3932: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3933: <dd><p>This file contains the dependency information
1.10 hubertf 3934: 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 3935: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3936: <dd><p>This file contains workarounds for compiler bugs
3937: and similar things. It is included automatically by the pkgsrc
3938: infrastructure, so you don't need an extra
3939: <code class="literal">.include</code> line for
3940: it.</p></dd>
3941: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3942: <dd><p>This file contains the code for the
1.10 hubertf 3943: 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 3944: selected by the user. If a package has only one or two options,
3945: it is equally acceptable to put the code directly into the
3946: <code class="filename">Makefile</code>.</p></dd>
3947: </dl></div>
3948: </div>
1.41 asau 3949: <div class="sect2">
1.1 dsieger 3950: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3951: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 3952: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3953: <dt><span class="term"><code class="filename">README*</code></span></dt>
3954: <dd><p>These files do not take place in the creation of
3955: a package and thus are purely informative to the package
3956: developer.</p></dd>
3957: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3958: <dd><p>This file contains things that need to be done
3959: to make the package even
3960: better.</p></dd>
3961: </dl></div>
3962: </div>
3963: </div>
1.41 asau 3964: <div class="sect1">
1.1 dsieger 3965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3966: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 3967: </h2></div></div></div>
1.10 hubertf 3968: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 3969: unpacked into the directory denoted by
3970: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 3971: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 3972: directory is also used to keep various timestamp files.
3973: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3974: The default is <code class="filename">${.CURDIR}/work</code>
3975: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3976: if <code class="varname">OBJMACHINE</code> is set.</p>
3977: </div>
1.41 asau 3978: <div class="sect1">
1.1 dsieger 3979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3980: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 3981: </h2></div></div></div>
3982: <p>If you have any files that you wish to be placed in the package prior
3983: to configuration or building, you could place these files here and use
1.10 hubertf 3984: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 3985: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 3986: this. Alternatively, you could simply diff the file against
3987: <code class="filename">/dev/null</code> and use the patch mechanism to manage
3988: the creation of this file.</p>
3989: <p>If you want to share files in this way with other
3990: packages, set the <code class="varname">FILESDIR</code> variable to point
3991: to the other package's <code class="filename">files</code> directory,
3992: e.g.:</p>
3993: <pre class="programlisting">
3994: FILESDIR=${.CURDIR}/../xemacs/files
3995: </pre>
3996: </div>
3997: </div>
1.41 asau 3998: <div class="chapter">
1.1 dsieger 3999: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4000: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4001: <div class="toc">
4002: <p><b>Table of Contents</b></p>
1.100 leot 4003: <dl class="toc">
1.6 rillig 4004: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4005: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4006: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4007: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4008: <dd><dl>
4009: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 4010: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
4011: <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>
4012: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4013: </dl></dd>
4014: </dl>
4015: </div>
4016: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4017: each of which forms a well-defined part of the pkgsrc system. Using
1.79 snj 4018: 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 4019: like pkgsrc requires some discipline to keep the code correct and
4020: understandable.</p>
4021: <p>The basic ingredients for <code class="filename">Makefile</code>
4022: programming are variables (which are actually macros) and shell
4023: commands. Among these shell commands may even be more complex ones
1.79 snj 4024: 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 4025: as intended it is necessary to quote all variables correctly when they
4026: are used.</p>
4027: <p>This chapter describes some patterns, that appear quite often in
4028: <code class="filename">Makefile</code>s, including the pitfalls that come along
4029: with them.</p>
1.41 asau 4030: <div class="sect1">
1.1 dsieger 4031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4032: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4033: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4034: <p>When you are creating a file as a
4035: target of a rule, always write the data to a temporary file first
4036: and finally rename that file. Otherwise there might occur an error
4037: in the middle of generating the file, and when the user runs
1.79 snj 4038: <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 4039: regenerated properly. Example:</p>
4040: <pre class="programlisting">
4041: wrong:
4042: @echo "line 1" > ${.TARGET}
4043: @echo "line 2" >> ${.TARGET}
4044: @false
4045:
4046: correct:
4047: @echo "line 1" > ${.TARGET}.tmp
4048: @echo "line 2" >> ${.TARGET}.tmp
4049: @false
4050: @mv ${.TARGET}.tmp ${.TARGET}
4051: </pre>
1.10 hubertf 4052: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4053: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4054: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4055: correct</strong></span> gives an error message twice, as expected.</p>
1.79 snj 4056: <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 4057: <code class="literal">${.TARGET}</code> in case of error, but this only
4058: happens when it is interrupted, for example by pressing
4059: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.79 snj 4060: 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 4061: </li></ul></div>
4062: </div>
1.41 asau 4063: <div class="sect1">
1.1 dsieger 4064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4065: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4066: <p><code class="filename">Makefile</code> variables contain strings that
4067: can be processed using the five operators ``='', ``+='', ``?='',
1.79 snj 4068: ``:='', 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 4069: page.</p>
4070: <p>When a variable's value is parsed from a
4071: <code class="filename">Makefile</code>, the hash character ``#'' and the
4072: backslash character ``\'' are handled specially. If a backslash is
4073: followed by a newline, any whitespace immediately in front of the
4074: backslash, the backslash, the newline, and any whitespace
4075: immediately behind the newline are replaced with a single space. A
4076: backslash character and an immediately following hash character are
4077: replaced with a single hash character. Otherwise, the backslash is
4078: passed as is. In a variable assignment, any hash character that is
4079: not preceded by a backslash starts a comment that continues upto the
4080: end of the logical line.</p>
1.108 rillig 4081: <p>The evaluation of variables either happens immediately or lazy.
4082: It happens immediately when the variable occurs
4083: on the right-hand side of the ``:='' or the ``!='' operator, in a
4084: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4085: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4086: <p>Some of the modifiers split the string into words and then
4087: operate on the words, others operate on the string as a whole. When
1.108 rillig 4088: 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 4089: <p>There are several types of variables that should be handled
4090: differently. Strings and two types of lists.</p>
1.41 asau 4091: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4092: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4093: characters. Nevertheless, you should restrict yourself to only
4094: using printable characters. Examples are
4095: <code class="varname">PREFIX</code> and
4096: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4097: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4098: are never exported to any shell command. Their elements are
4099: separated by whitespace. Therefore, the elements themselves cannot
4100: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4101: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4102: Examples are <code class="varname">DEPENDS</code> and
4103: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4104: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4105: may be exported to a shell command. Their elements can contain any
4106: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4107: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4108: <code class="varname">DISTFILES</code> and
4109: <code class="varname">MASTER_SITES</code>.</p></li>
4110: </ul></div>
1.41 asau 4111: <div class="sect2">
1.1 dsieger 4112: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4113: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4114: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4115: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4116: are reserved for use by the pkgsrc infrastructure. They shall
4117: not be used by package
4118: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4119: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4120: lowercase variable names for the iteration
4121: variables.</p></li>
1.23 wiz 4122: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4123: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4124: <code class="varname">DISTFILES</code>.</p></li>
4125: </ul></div>
4126: </div>
4127: </div>
1.41 asau 4128: <div class="sect1">
1.1 dsieger 4129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4130: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.41 asau 4131: <div class="sect2">
1.1 dsieger 4132: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4133: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4134: <p>When adding a string that possibly contains whitespace or quotes to
4135: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4136: modifier.</p>
4137: <p>When adding another list to a list (example 2), it must not be
4138: quoted, since its elements are already quoted.</p>
1.1 dsieger 4139: <pre class="programlisting">
1.108 rillig 4140: STRING= foo * bar `date`
4141: LIST= # empty
4142: ANOTHER_LIST= a=b c=d
4143:
4144: LIST+= ${STRING:Q} # 1
4145: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4146: </pre>
4147: </div>
1.41 asau 4148: <div class="sect2">
1.1 dsieger 4149: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4150: <a name="echo-literal"></a>12.3.2. Echoing a string exacty as-is</h3></div></div></div>
4151: <p>Echoing a string containing special characters needs special
4152: work.</p>
1.1 dsieger 4153: <pre class="programlisting">
4154: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4155: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4156:
4157: all:
4158: echo ${STRING} # 1
1.108 rillig 4159: echo ${STRING:Q} # 2
4160: printf '%s\n' ${STRING:Q}'' # 3
4161: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4162: </pre>
4163: <p>Example 1 leads to a syntax error in the shell, as the characters
4164: are just copied.</p>
4165: <p>Example 2 quotes the string so that the shell interprets it
4166: correctly. But the echo command may additionally interpret strings with a
4167: leading dash or those containing backslashes.</p>
4168: <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
4169: interprets the format string, but not the next argument.</p>
4170: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4171: need to be quoted because the quoting has already been done
4172: when adding elements to the list.</p>
1.1 dsieger 4173: </div>
1.41 asau 4174: <div class="sect2">
1.1 dsieger 4175: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4176: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4177: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4178: GNU-style configure script (especially those that call other configure
4179: scripts), it must not have leading or trailing whitespace, since
4180: otherwise the configure script gets confused. To trim leading and
4181: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4182: following example:</p>
1.1 dsieger 4183: <pre class="programlisting">
4184: CPPFLAGS= # empty
1.108 rillig 4185: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4186: CPPFLAGS+= ${MY_CPPFLAGS}
4187:
4188: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4189:
4190: all:
4191: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4192: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4193: </pre>
1.108 rillig 4194: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4195: trailing whitespace because the <code class="code">+=</code> operator always adds a
4196: space.</p>
4197: </div>
4198: <div class="sect2">
4199: <div class="titlepage"><div><div><h3 class="title">
4200: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4201: <p>When a possibly empty variable is used in a shell program, it may
4202: lead to a syntax error.</p>
4203: <pre class="programlisting">
4204: EGFILES= # empty
4205:
4206: install-examples: # produces a syntax error in the shell
4207: for egfile in ${EGFILES}; do \
4208: echo "Installing $$egfile"; \
4209: done
4210: </pre>
4211: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
4212: <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>.
4213: To fix this syntax error, use one of the snippets below.</p>
4214: <pre class="programlisting">
4215: EMPTY= # empty
4216:
4217: install-examples:
4218: for egfile in ${EGFILES} ""; do \
4219: [ -n "$$egfile" ] || continue; \
4220: echo "Installing $$egfile"; \
1.1 dsieger 4221: done
1.108 rillig 4222: </pre>
4223: <p>In this case, an empty string is appended to the iteration list (to
4224: prevent the syntax error) and filtered out later.</p>
4225: <pre class="programlisting">
4226: EGFILES= # empty
1.1 dsieger 4227:
1.108 rillig 4228: install-examples:
4229: .for egfile in ${EGFILES}
4230: echo "Installing ${egfile}"
1.1 dsieger 4231: .endfor
4232: </pre>
1.108 rillig 4233: <p>This variant only works when <code class="varname">EGFILES</code> does not
4234: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4235: simple whitespace.</p>
4236: <p>To have a shell command test whether a make variable is empty, use
4237: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4238: </div>
4239: </div>
4240: </div>
1.41 asau 4241: <div class="chapter">
1.1 dsieger 4242: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4243: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4244: <div class="toc">
4245: <p><b>Table of Contents</b></p>
1.100 leot 4246: <dl class="toc">
1.6 rillig 4247: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4248: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4249: <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 4250: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4251: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4252: <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 4253: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4254: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4255: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4256: </dl>
4257: </div>
4258: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4259: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4260: the package (relative to the <code class="filename">${PREFIX}</code>
4261: directory it's been installed in) plus some additional statements
1.79 snj 4262: - 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 4263: This chapter addresses some issues that need attention when
4264: dealing with the <code class="filename">PLIST</code> file (or files, see
4265: below!).</p>
1.41 asau 4266: <div class="sect1">
1.1 dsieger 4267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4268: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4269: <p>Be sure to add a RCS ID line as the first thing in any
4270: <code class="filename">PLIST</code> file you write:</p>
4271: <pre class="programlisting">
4272: @comment $NetBSD$
1.111 ! sevan 4273: </pre>
1.1 dsieger 4274: </div>
1.41 asau 4275: <div class="sect1">
1.1 dsieger 4276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4277: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4278: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4279: to output a PLIST that matches any new files since the package
1.10 hubertf 4280: 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 4281: more information on this target.</p>
4282: </div>
1.41 asau 4283: <div class="sect1">
1.1 dsieger 4284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4285: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4286: </h2></div></div></div>
4287: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4288: of AWK patterns and actions that are used to filter the output of
4289: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4290: scripting you like to it, but be careful with quoting.</p>
4291: <p>For example, to get all files inside the
4292: <code class="filename">libdata/foo</code> directory removed from the
4293: resulting PLIST:</p>
4294: <pre class="programlisting">
4295: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 ! sevan 4296: </pre>
1.1 dsieger 4297: </div>
1.41 asau 4298: <div class="sect1">
1.1 dsieger 4299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4300: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4301: <p>A number of variables are substituted automatically in
4302: PLISTs when a package is installed on a system. This includes the
4303: following variables:</p>
1.41 asau 4304: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4305: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4306: <dd>
4307: <p>Some packages like emacs and perl embed information
4308: about which architecture they were built on into the
4309: pathnames where they install their files. To handle this
4310: case, PLIST will be preprocessed before actually used, and
4311: the symbol
1.23 wiz 4312: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4313: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4314: same is done if the string
4315: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4316: PLIST somewhere - use this on packages that have GNU
4317: autoconf-created configure scripts.</p>
1.41 asau 4318: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4319: <h3 class="title">Legacy note</h3>
4320: <p>There used to be a symbol
1.23 wiz 4321: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4322: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4323: -m</strong></span>, but that's no longer supported and has
4324: been removed.</p>
4325: </div>
4326: </dd>
4327: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4328: <dd>
4329: <p>Some packages want to embed the OS name and version
4330: into some paths. To do this, use these variables in the
4331: <code class="filename">PLIST</code>:
4332: </p>
1.41 asau 4333: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4334: <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>
4335: <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>
4336: <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 4337: </ul></div>
4338: </dd>
4339: </dl></div>
1.88 tnn 4340: <p>For a list of values which are replaced by
4341: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4342: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4343: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4344: <p>If you want to change other variables not listed above, you
4345: can add variables and their expansions to this variable in the
1.10 hubertf 4346: 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 4347: <pre class="programlisting">
4348: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 ! sevan 4349: </pre>
1.23 wiz 4350: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4351: in the <code class="filename">PLIST</code> with
1.23 wiz 4352: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4353: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4354: the common case of conditionally including some
4355: <code class="filename">PLIST</code> entries. It can be done by adding
4356: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4357: setting the corresponding <code class="varname">PLIST.foo</code> variable
4358: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4359: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4360: in the <code class="filename">PLIST</code> with either
1.23 wiz 4361: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4362: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4363: For example, in <code class="filename">Makefile</code>:</p>
4364: <pre class="programlisting">
4365: PLIST_VARS+= foo
4366: .if <em class="replaceable"><code>condition</code></em>
4367: PLIST.foo= yes
4368: .else
1.111 ! sevan 4369: </pre>
1.18 snj 4370: <p>And then in <code class="filename">PLIST</code>:</p>
4371: <pre class="programlisting">
4372: @comment $NetBSD$
4373: bin/bar
4374: man/man1/bar.1
4375: ${PLIST.foo}bin/foo
4376: ${PLIST.foo}man/man1/foo.1
4377: ${PLIST.foo}share/bar/foo.data
1.111 ! sevan 4378: </pre>
1.1 dsieger 4379: </div>
1.41 asau 4380: <div class="sect1">
1.1 dsieger 4381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4382: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 4383: <p>Man pages should be installed in compressed form if
4384: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4385: and uncompressed otherwise. To handle this in the
1.23 wiz 4386: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4387: appended/removed automatically for man pages according to
4388: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4389: or not, see above for details. This modification of the
4390: <code class="filename">PLIST</code> file is done on a copy of it, not
4391: <code class="filename">PLIST</code> itself.</p>
4392: </div>
1.41 asau 4393: <div class="sect1">
1.1 dsieger 4394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4395: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4396: </h2></div></div></div>
4397: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4398: in generating the binary package, set the variable
4399: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.79 snj 4400: 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 4401: important. The default for <code class="varname">PLIST_SRC</code> is
4402: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4403: </div>
1.41 asau 4404: <div class="sect1">
1.1 dsieger 4405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4406: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4407: <p>Some packages decide to install a different set of files based on
4408: the operating system being used. These differences can be
4409: automatically handled by using the following files:</p>
1.41 asau 4410: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4411: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4412: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4413: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4414: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4415: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4416: </ul></div>
4417: </div>
1.41 asau 4418: <div class="sect1">
1.1 dsieger 4419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 4420: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4421: <p>Some packages decide to generate hard-to-guess file names
4422: during installation that are hard to wire down.</p>
4423: <p>In such cases, you can set the
4424: <code class="varname">GENERATE_PLIST</code> variable to shell code
4425: terminated (with a semicolon) that will output PLIST entries which
4426: will be appended to the PLIST</p>
4427: <p>You can find one example in editors/xemacs:</p>
4428: <pre class="programlisting">
1.111 ! sevan 4429: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
! 4430: </pre>
1.86 wiz 4431: <p>which will append something like
4432: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4433: <code class="filename">PLIST</code>.
4434: </p>
4435: </div>
4436: <div class="sect1">
4437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4438: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4439: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4440: multiple (and unrelated) packages install files. These
1.22 jakllsch 4441: directories were problematic because you had to add special
4442: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4443: centralized package handle them.</p>
1.22 jakllsch 4444: <p>In pkgsrc, it is now easy: Each package should create
4445: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4446: will remove any directories left empty after uninstalling a
4447: package.</p>
4448: <p>If a package needs an empty directory to work, create
4449: the directory during installation as usual, and also add an
4450: entry to the PLIST:
1.111 ! sevan 4451:
! 4452: </p>
1.1 dsieger 4453: <pre class="programlisting">
1.22 jakllsch 4454: @pkgdir path/to/empty/directory
1.111 ! sevan 4455: </pre>
1.22 jakllsch 4456: <p>
1.111 ! sevan 4457:
1.86 wiz 4458: or take a look at <code class="varname">MAKE_DIRS</code> and
4459: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4460: </p>
1.1 dsieger 4461: </div>
4462: </div>
1.41 asau 4463: <div class="chapter">
1.1 dsieger 4464: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4465: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4466: <div class="toc">
4467: <p><b>Table of Contents</b></p>
1.100 leot 4468: <dl class="toc">
1.6 rillig 4469: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 4470: <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 4471: <dd><dl>
1.6 rillig 4472: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 4473: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
4474: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4475: and
4476: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4477: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4478: </dl></dd>
1.23 wiz 4479: <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 4480: <dd><dl>
1.23 wiz 4481: <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 4482: <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 4483: </dl></dd>
4484: </dl>
4485: </div>
4486: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4487: are seen by a package's configure and build processes. This is implemented
4488: in a two step process:</p>
1.23 wiz 4489: <div class="orderedlist"><ol class="orderedlist" type="1">
4490: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4491: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4492: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4493: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4494: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4495: <code class="option">-L${LOCALBASE}/lib</code> into references to
4496: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4497: native compiler on some operating systems look like GCC, so that
4498: packages that expect GCC won't require modifications to build with
4499: those native compilers.</p></li>
4500: </ol></div>
4501: <p>This normalizes the environment in which a package is built so that the
4502: package may be built consistently despite what other software may be
4503: installed. Please note that the normal system header and library paths,
4504: e.g. <code class="filename">/usr/include</code>,
4505: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4506: designed to insulate the package build from non-system-supplied
4507: software.</p>
1.41 asau 4508: <div class="sect1">
1.1 dsieger 4509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4510: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4511: <p>The process of converting packages to use the buildlink3
1.23 wiz 4512: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4513: The things to keep in mind are:</p>
1.23 wiz 4514: <div class="orderedlist"><ol class="orderedlist" type="1">
4515: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4516: instead of the actual toolchain. Some packages are tricky,
4517: and the only way to know for sure is the check
4518: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4519: wrappers are being invoked.</p></li>
1.23 wiz 4520: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4521: the package Makefile, e.g. Java VMs, standalone shells,
4522: etc., because the code to symlink files into
4523: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4524: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4525: </p></li>
1.23 wiz 4526: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4527: <code class="filename">buildlink3.mk</code> files that you list in a
4528: package's Makefile are added as dependencies for that package.
4529: </p></li>
4530: </ol></div>
4531: <p>If a dependency on a particular package is required for its libraries and
4532: headers, then we replace:</p>
4533: <pre class="programlisting">
4534: DEPENDS+= foo>=1.1.0:../../category/foo
4535: </pre>
4536: <p>with</p>
4537: <pre class="programlisting">
4538: .include "../../category/foo/buildlink3.mk"
4539: </pre>
4540: <p>The buildlink3.mk files usually define the required dependencies.
4541: If you need a newer version of the dependency when using buildlink3.mk
4542: files, then you can define it in your Makefile; for example:</p>
4543: <pre class="programlisting">
4544: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4545: .include "../../category/foo/buildlink3.mk"
4546: </pre>
4547: <p>There are several <code class="filename">buildlink3.mk</code>
4548: files in <code class="filename">pkgsrc/mk</code>
4549: that handle special package issues:</p>
1.41 asau 4550: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4551: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4552: the native or a pkgsrc Berkeley DB implementation based on
4553: the values of <code class="varname">BDB_ACCEPTED</code> and
4554: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4555: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4556: comes with neither Curses nor NCurses, this will take care
1.79 snj 4557: 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 4558: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4559: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4560: adding a dependency on Heimdal or MIT-krb5 for packages that
4561: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4562: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4563: system-provided Motif installation or adds a dependency on
1.79 snj 4564: <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 4565: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 4566: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
4567: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 4568: which Motif version will be used.</p></li>
1.55 ryoon 4569: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4570: system-provided GNU readline or editline (libedit) installation,
1.79 snj 4571: 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>,
4572: <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 4573: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4574: If your package really needs GNU readline library, its Makefile
4575: should include <code class="filename">devel/readline/buildlink3.mk</code>
4576: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4577: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4578: variables that may be used by packages that use the
4579: Open Sound System (OSS) API.</p></li>
1.23 wiz 4580: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4581: any of the Postgres versions in the variable
4582: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4583: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4584: the file for more information.</p></li>
1.23 wiz 4585: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4586: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.79 snj 4587: 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 4588: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4589: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4590: library.</p></li>
4591: </ul></div>
4592: <p>The comments in those <code class="filename">buildlink3.mk</code>
4593: files provide a more complete
4594: description of how to use them properly.</p>
4595: </div>
1.41 asau 4596: <div class="sect1">
1.1 dsieger 4597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4598: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4599: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4600: included by Makefiles to indicate the need to compile and link
4601: against header files and libraries provided by the package. A
4602: <code class="filename">buildlink3.mk</code> file should always provide
4603: enough information to add the correct type of dependency
4604: relationship and include any other
4605: <code class="filename">buildlink3.mk</code> files that it needs to find
4606: headers and libraries that it needs in turn.</p>
4607: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.79 snj 4608: 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 4609: package is highly recommended. For most packages, the following
4610: command will generate a good starting point for
4611: <code class="filename">buildlink3.mk</code> files:</p>
4612: <pre class="screen">
4613: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4614: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4615: </pre>
1.41 asau 4616: <div class="sect2">
1.1 dsieger 4617: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4618: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4619: <p>The following real-life example
4620: <code class="filename">buildlink3.mk</code> is taken
4621: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4622: <pre class="programlisting">
1.18 snj 4623: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4624:
1.18 snj 4625: BUILDLINK_TREE+= tiff
1.1 dsieger 4626:
1.18 snj 4627: .if !defined(TIFF_BUILDLINK3_MK)
4628: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4629:
1.18 snj 4630: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4631: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4632: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4633:
4634: .include "../../devel/zlib/buildlink3.mk"
4635: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4636: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4637:
1.18 snj 4638: BUILDLINK_TREE+= -tiff
1.1 dsieger 4639: </pre>
4640: <p>The header and footer manipulate
1.18 snj 4641: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4642: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4643: the dependency tree.</p>
4644: <p>The main section is protected from multiple inclusion
1.1 dsieger 4645: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4646: added. Several important variables are set in the section:</p>
1.41 asau 4647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4648: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4649: is the actual dependency recorded in the installed
4650: package; this should always be set using
1.10 hubertf 4651: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4652: we're appending to any pre-existing list of values. This
4653: variable should be set to the first version of the
1.26 wiz 4654: package that had an backwards-incompatible API change.
1.1 dsieger 4655: </p></li>
1.23 wiz 4656: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4657: is the location of the <em class="replaceable"><code>pkg</code></em>
4658: pkgsrc directory.</p></li>
1.23 wiz 4659: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4660: (not shown above) controls whether we use
4661: <code class="varname">BUILD_DEPENDS</code> or
4662: <code class="varname">DEPENDS</code> to add the dependency on
4663: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4664: selected by setting
4665: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4666: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4667: used.</p></li>
1.23 wiz 4668: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4669: and
4670: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4671: (not shown above) are lists of subdirectories of
4672: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4673: to add to the header and library search paths. These
1.23 wiz 4674: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4675: respectively.</p></li>
1.23 wiz 4676: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4677: (not shown above) is the list of preprocessor flags to add
4678: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4679: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4680: should be avoided and instead be handled using
4681: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4682: above.</p></li>
4683: </ul></div>
4684: <p>The following variables are all optionally defined within
4685: this second section (protected against multiple inclusion) and
4686: control which package files are symlinked into
4687: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4688: transformed during the symlinking:</p>
1.41 asau 4689: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4690: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4691: (not shown above) is a shell glob pattern relative to
4692: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4693: to be symlinked into
4694: <code class="filename">${BUILDLINK_DIR}</code>,
4695: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4696: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4697: (not shown above) is a shell pipeline that
4698: outputs to stdout a list of files relative to
4699: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4700: The resulting files are to be symlinked
4701: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4702: this takes the <code class="filename">+CONTENTS</code> of a
4703: <em class="replaceable"><code>pkg</code></em> and filters it through
4704: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4705: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4706: (not shown above) is a filter command that filters
4707: <code class="filename">+CONTENTS</code> input into a list of files
4708: relative to
4709: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4710: on stdout. By default,
1.1 dsieger 4711: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4712: outputs the contents of the <code class="filename">include</code>
4713: and <code class="filename">lib</code> directories in the package
1.84 wiz 4714: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4715: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4716: (not shown above) is a list of sed arguments used to
4717: transform the name of the source filename into a
1.10 hubertf 4718: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4719: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4720: </ul></div>
1.18 snj 4721: <p>This section can additionally include any
1.1 dsieger 4722: <code class="filename">buildlink3.mk</code> needed for
4723: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4724: Including these <code class="filename">buildlink3.mk</code> files
4725: means that the headers and libraries for these
4726: dependencies are also symlinked into
4727: <code class="filename">${BUILDLINK_DIR}</code>
4728: whenever the <em class="replaceable"><code>pkg</code></em>
4729: <code class="filename">buildlink3.mk</code>
1.18 snj 4730: file is included. Dependencies are only added for directly
4731: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4732: <p>When providing a <code class="filename">buildlink3.mk</code> and
4733: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4734: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4735: header files are automatically exposed when the package is
4736: use.</p>
4737: <p>In particular, if only an executable
4738: (<code class="filename">bin/foo</code>) is linked against a library, that
4739: library does not need to be propagated in the
4740: <code class="filename">buildlink3.mk</code> file.</p>
4741: <p>The following steps should help you decide if a
4742: <code class="filename">buildlink3.mk</code> file needs to be included:
4743: </p>
4744: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4745: <li class="listitem"><p>Look at the installed header files: What
4746: headers do they include? The packages providing these files
4747: must be buildlinked.</p></li>
1.49 wiz 4748: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4749: libraries and look against what other libraries they link.
4750: Some of the packages providing these probably need to be
4751: buildlinked; however, it's not automatic, since e.g. GTK on
4752: some systems pulls in the X libraries, so they will show up in
4753: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4754: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4755: used as a hint.</p></li>
1.47 wiz 4756: </ul></div>
4757: <p>
4758: </p>
1.1 dsieger 4759: </div>
1.41 asau 4760: <div class="sect2">
1.1 dsieger 4761: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 4762: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 4763: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4764: and
4765: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4766: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4767: <p>These two variables differ in that one describes source
4768: compatibility (API) and the other binary compatibility (ABI).
4769: The difference is that a change in the API breaks compilation of
4770: programs while changes in the ABI stop compiled programs from
4771: running.</p>
4772: <p>Changes to the
1.27 wiz 4773: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4774: variable in a <code class="filename">buildlink3.mk</code> file happen
4775: very rarely. One possible reason is that all packages depending
4776: on this already need a newer version. In case it is bumped see
4777: the description below.</p>
4778: <p>The most common example of an ABI change is that the major
4779: version of a shared library is increased. In this case,
4780: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4781: should be adjusted to require at least the new package version.
4782: Then the packages that depend on this package need their
4783: <code class="varname">PKGREVISION</code>s increased and, if they have
4784: <code class="filename">buildlink3.mk</code> files, their
4785: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4786: adjusted, too. This is needed so pkgsrc will require the correct
4787: package dependency and not settle for an older one when building
4788: the source.</p>
1.108 rillig 4789: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.26 wiz 4790: more information about dependencies on other packages,
4791: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4792: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4793: <p>Please take careful consideration before adjusting
4794: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4795: or
4796: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4797: as we don't want to cause unneeded package deletions and
4798: rebuilds. In many cases, new versions of packages work just
4799: fine with older dependencies.</p>
4800: <p>Also it is not needed to set
1.26 wiz 4801: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4802: when it is identical to
1.1 dsieger 4803: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4804: </div>
4805: </div>
1.41 asau 4806: <div class="sect1">
1.1 dsieger 4807: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4808: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4809: <p>Some packages in pkgsrc install headers and libraries that
4810: coincide with headers and libraries present in the base system.
4811: Aside from a <code class="filename">buildlink3.mk</code> file, these
4812: packages should also include a <code class="filename">builtin.mk</code>
4813: file that includes the necessary checks to decide whether using
4814: the built-in software or the pkgsrc software is
4815: appropriate.</p>
4816: <p>The only requirements of a builtin.mk file for
4817: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4818: <div class="orderedlist"><ol class="orderedlist" type="1">
4819: <li class="listitem"><p>It should set
1.1 dsieger 4820: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4821: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4822: after it is included.</p></li>
1.23 wiz 4823: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4824: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4825: which is already set before the
4826: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4827: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4828: is <span class="emphasis"><em>very</em></span> important and takes careful
4829: attention to <code class="filename">Makefile</code> coding.</p></li>
4830: </ol></div>
1.41 asau 4831: <div class="sect2">
1.1 dsieger 4832: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4833: <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 4834: <p>The following is the recommended template for builtin.mk
4835: files:</p>
4836: <pre class="programlisting">
4837: .if !defined(IS_BUILTIN.foo)
4838: #
4839: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4840: # genuinely exists in the system or not.
4841: #
4842: IS_BUILTIN.foo?= no
4843:
4844: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4845: # version can be determined.
4846: #
4847: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4848: BUILTIN_PKG.foo?= foo-1.0
4849: . endif
4850: .endif # IS_BUILTIN.foo
4851:
4852: .if !defined(USE_BUILTIN.foo)
4853: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4854: . if defined(BUILTIN_PKG.foo)
4855: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4856: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4857: USE_BUILTIN.foo!= \
4858: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4859: && ${ECHO} "yes" || ${ECHO} "no"
4860: . endif
4861: . endfor
4862: . endif
4863: .endif # USE_BUILTIN.foo
4864:
4865: CHECK_BUILTIN.foo?= no
4866: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4867: #
4868: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4869: # "yes" or "no".
4870: #
4871: .endif # CHECK_BUILTIN.foo
4872: </pre>
4873: <p>The first section sets
4874: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4875: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4876: in the base system. This should not be a base system software
4877: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 4878: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 4879: included as part of the base system. This variable is only
4880: used internally within the <code class="filename">builtin.mk</code>
4881: file.</p>
4882: <p>The second section sets
4883: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4884: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4885: system if it exists (if
4886: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4887: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 4888: within the <code class="filename">builtin.mk</code> file.</p>
4889: <p>The third section sets
4890: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4891: and is <span class="emphasis"><em>required</em></span> in all
4892: <code class="filename">builtin.mk</code> files. The code in this
4893: section must make the determination whether the built-in
4894: software is adequate to satisfy the dependencies listed in
4895: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4896: This is typically done by comparing
4897: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4898: against each of the dependencies in
4899: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4900: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4901: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4902: end of the <code class="filename">builtin.mk</code> file. Note that
4903: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4904: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 4905: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4906: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 4907: that the built-in version of the software is similar enough to
4908: be used as a replacement.</p>
4909: <p>The last section is guarded by
4910: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4911: and includes code that uses the value of
4912: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4913: set in the previous section. This typically includes, e.g.,
4914: adding additional dependency restrictions and listing additional
4915: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4916: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
4917: </div>
1.41 asau 4918: <div class="sect2">
1.1 dsieger 4919: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4920: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 4921: <p>When building packages, it's possible to choose whether to set
4922: a global preference for using either the built-in (native)
4923: version or the pkgsrc version of software to satisfy a
4924: dependency. This is controlled by setting
4925: <code class="varname">PREFER_PKGSRC</code> and
4926: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 4927: 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 4928: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4929: use the pkgsrc versions of software, while
4930: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4931: built-in versions. Preferences are determined by the most
4932: specific instance of the package in either
4933: <code class="varname">PREFER_PKGSRC</code> or
4934: <code class="varname">PREFER_NATIVE</code>. If a package is specified
4935: in neither or in both variables, then
4936: <code class="varname">PREFER_PKGSRC</code> has precedence over
4937: <code class="varname">PREFER_NATIVE</code>. For example, to require
4938: using pkgsrc versions of software for all but the most basic
4939: bits on a NetBSD system, you can set:</p>
4940: <pre class="programlisting">
4941: PREFER_PKGSRC= yes
4942: PREFER_NATIVE= getopt skey tcp_wrappers
4943: </pre>
4944: <p>A package <span class="emphasis"><em>must</em></span> have a
4945: <code class="filename">builtin.mk</code>
4946: file to be listed in <code class="varname">PREFER_NATIVE</code>,
4947: otherwise it is simply ignored in that list.</p>
4948: </div>
4949: </div>
4950: </div>
1.41 asau 4951: <div class="chapter">
1.1 dsieger 4952: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4953: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 4954: <div class="toc">
4955: <p><b>Table of Contents</b></p>
1.100 leot 4956: <dl class="toc">
1.6 rillig 4957: <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 4958: <dd><dl>
1.6 rillig 4959: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
4960: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 4961: </dl></dd>
1.6 rillig 4962: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 4963: <dd><dl>
1.23 wiz 4964: <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 4965: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
4966: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
4967: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
4968: </dl></dd>
4969: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
4970: <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>
4971: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
4972: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
4973: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
4974: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
4975: <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 4976: </dl>
4977: </div>
4978: <p>This chapter describes the framework known as
4979: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 4980: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4981: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 4982: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 4983: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 4984: provided that packages are correctly designed.</p></li>
1.23 wiz 4985: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
4986: <li class="listitem"><p>Registration of system users and groups.</p></li>
4987: <li class="listitem"><p>Registration of system shells.</p></li>
4988: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 4989: </ul></div>
4990: <p>The following sections inspect each of the above points in detail.</p>
4991: <p>You may be thinking that many of the things described here could be
4992: easily done with simple code in the package's post-installation target
4993: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
4994: as the code in them is only executed when building from source. Machines
4995: using binary packages could not benefit from it at all (as the code itself
4996: could be unavailable). Therefore, the only way to achieve any of the items
4997: described above is by means of the installation scripts, which are
4998: automatically generated by pkginstall.</p>
1.41 asau 4999: <div class="sect1">
1.1 dsieger 5000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5001: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5002: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5003: of files and directories that belong to a package. The names used in it
5004: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5005: which means that it cannot register files outside this directory (absolute
5006: path names are not allowed). Despite this restriction, some packages need
5007: to install files outside this location; e.g., under
5008: <code class="filename">${VARBASE}</code> or
5009: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5010: is to create such files during installation time by using
5011: installation scripts.</p>
5012: <p>The generic installation scripts are shell scripts that can
5013: contain arbitrary code. The list of scripts to execute is taken from
5014: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5015: <code class="filename">INSTALL</code>. A similar variable exists for package
5016: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5017: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5018: commands, so they have the potential to create and manage files
5019: anywhere in the file system.</p>
5020: <p>Using these general installation files is not recommended, but
5021: may be needed in some special cases. One reason for avoiding them is
5022: that the user has to trust the packager that there is no unwanted or
5023: simply erroneous code included in the installation script. Also,
5024: previously there were many similar scripts for the same functionality,
5025: and fixing a common error involved finding and changing all of
5026: them.</p>
5027: <p>The pkginstall framework offers another, standardized way. It
5028: provides generic scripts to abstract the manipulation of such files
5029: and directories based on variables set in the package's
5030: <code class="filename">Makefile</code>. The rest of this section describes
5031: these variables.</p>
1.41 asau 5032: <div class="sect2">
1.1 dsieger 5033: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5034: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5035: <p>The following variables can be set to request the creation of
5036: directories anywhere in the file system:</p>
1.41 asau 5037: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5038: <li class="listitem">
5039: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5040: contain a list of directories that should be created and should attempt
5041: to be destroyed by the installation scripts. The difference between
5042: the two is that the latter prompts the administrator to remove any
5043: directories that may be left after deinstallation (because they were
1.108 rillig 5044: not empty), while the former does not. Example:</p>
5045: <pre class="programlisting">
5046: MAKE_DIRS+= ${VARBASE}/foo/private
5047: </pre>
5048: </li>
1.23 wiz 5049: <li class="listitem">
1.1 dsieger 5050: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5051: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5052: which directories should be created and should attempt to be destroyed
5053: by the installation scripts. Each tuple holds the following values,
5054: separated by spaces: the directory name, its owner, its group and its
5055: numerical mode. For example:</p>
5056: <pre class="programlisting">
1.108 rillig 5057: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5058: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5059: </pre>
5060: <p>The difference between the two is exactly the same as their
5061: non-<code class="varname">PERMS</code> counterparts.</p>
5062: </li>
5063: </ul></div>
5064: </div>
1.41 asau 5065: <div class="sect2">
1.1 dsieger 5066: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5067: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5068: <p>Creating non-empty files outside the installation prefix is tricky
5069: because the <code class="filename">PLIST</code> forces all files to be inside it.
5070: To overcome this problem, the only solution is to extract the file in the
5071: known place (i.e., inside the installation prefix) and copy it to the
5072: appropriate location during installation (done by the installation scripts
5073: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5074: file</em></span> in the following paragraphs, which describe the variables
5075: that can be used to automatically and consistently handle files outside the
5076: installation prefix:</p>
1.41 asau 5077: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5078: <li class="listitem">
1.1 dsieger 5079: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5080: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5081: During installation time, the master file is copied to the target one
5082: if and only if the latter does not exist. Upon deinstallation, the
5083: target file is removed provided that it was not modified by the
5084: installation.</p>
5085: <p>The difference between the two is that the latter prompts the
5086: administrator to remove any files that may be left after
5087: deinstallation (because they were not empty), while the former does
5088: not.</p>
5089: </li>
1.23 wiz 5090: <li class="listitem">
1.1 dsieger 5091: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5092: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5093: files as well as their target locations. For each of them, it also
5094: specifies their owner, their group and their numeric permissions, in
5095: this order. For example:</p>
5096: <pre class="programlisting">
1.108 rillig 5097: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5098: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5099: </pre>
5100: <p>The difference between the two is exactly the same as their
5101: non-<code class="varname">PERMS</code> counterparts.</p>
5102: </li>
5103: </ul></div>
5104: </div>
5105: </div>
1.41 asau 5106: <div class="sect1">
1.1 dsieger 5107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5108: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5109: <p>Configuration files are special in the sense that they are installed
5110: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5111: need special treatment during installation (most of which is automated by
5112: pkginstall). The main concept you must bear in mind is that files marked
5113: as configuration files are automatically copied to the right place (somewhere
5114: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5115: and only if</em></span> they didn't exist before. Similarly, they will not
5116: be removed if they have local modifications. This ensures that
5117: administrators never lose any custom changes they may have made.</p>
1.41 asau 5118: <div class="sect2">
1.1 dsieger 5119: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5120: <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 5121: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5122: specifies where configuration files shall be installed. Its contents are
5123: set based upon the following variables:</p>
1.41 asau 5124: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5125: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5126: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5127: be overridden by the user to point to his preferred location (e.g.,
5128: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5129: Packages must not use it directly.</p></li>
1.23 wiz 5130: <li class="listitem">
1.1 dsieger 5131: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5132: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5133: for the package being built shall be installed. The definition of this
5134: variable only makes sense in the package's
5135: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5136: <p>As an example, consider the Apache package,
1.79 snj 5137: <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 5138: configuration files under the
5139: <code class="filename">httpd/</code> subdirectory of
5140: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5141: Makefile.</p>
5142: </li>
1.23 wiz 5143: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5144: variable that holds this package's configuration directory (if
5145: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5146: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5147: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5148: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5149: directory where the configuration files for the package identified by
5150: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5151: </ul></div>
5152: <p>Based on the above variables, pkginstall determines the value of
5153: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5154: variable that can be used within a package to refer to its configuration
5155: directory. The algorithm used to set its value is basically the
5156: following:</p>
1.23 wiz 5157: <div class="orderedlist"><ol class="orderedlist" type="1">
5158: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5159: its value is used.</p></li>
1.23 wiz 5160: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5161: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5162: <code class="filename">Makefile</code>, the resulting value is
5163: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5164: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5165: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5166: </ol></div>
5167: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5168: 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
5169: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5170: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5171: </div>
1.41 asau 5172: <div class="sect2">
1.1 dsieger 5173: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5174: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5175: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5176: known place, you need to teach each package where it shall install its
5177: files. In some cases you will have to patch the package Makefiles to
5178: achieve it. If you are lucky, though, it may be as easy as passing an
5179: extra flag to the configuration script; this is the case of GNU Autoconf-
5180: generated files:</p>
5181: <pre class="programlisting">
5182: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5183: </pre>
5184: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5185: for</em></span> its configuration files, not where they will be originally
5186: installed (although the difference is never explicit,
5187: unfortunately).</p>
5188: </div>
1.41 asau 5189: <div class="sect2">
1.1 dsieger 5190: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5191: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5192: <p>As said before, pkginstall automatically handles configuration files.
5193: This means that <span class="strong"><strong>the packages themselves must not
5194: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5195: directly</strong></span>. Bad news is that many software installation scripts
5196: will, out of the box, mess with the contents of that directory. So what is
5197: the correct procedure to fix this issue?</p>
5198: <p>You must teach the package (usually by manually patching it) to
5199: install any configuration files under the examples hierarchy,
5200: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5201: <code class="filename">PLIST</code> registers them and the administrator always
5202: has the original copies available.</p>
5203: <p>Once the required configuration files are in place (i.e., under the
5204: examples hierarchy), the pkginstall framework can use them as master copies
5205: during the package installation to update what is in
5206: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5207: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5208: 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 5209: about their syntax and their purpose. Here is an example, taken from the
1.79 snj 5210: <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 5211: <pre class="programlisting">
5212: EGDIR= ${PREFIX}/share/doc/mutt/samples
5213: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5214: </pre>
5215: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5216: package and has no meaning outside it.</p>
5217: </div>
1.41 asau 5218: <div class="sect2">
1.1 dsieger 5219: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5220: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5221: <p>The automatic copying of config files can be toggled by setting the
5222: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5223: installation.</p>
5224: </div>
5225: </div>
1.41 asau 5226: <div class="sect1">
1.1 dsieger 5227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5228: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5229: <p>System startup scripts are special files because they must be
5230: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5231: 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 5232: can be used. However, pkginstall provides a special mechanism to handle
5233: these files.</p>
5234: <p>In order to provide system startup scripts, the package has
5235: to:</p>
1.23 wiz 5236: <div class="orderedlist"><ol class="orderedlist" type="1">
5237: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5238: the <code class="literal">.sh</code> suffix appended. Considering the
1.79 snj 5239: <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 5240: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5241: <li class="listitem">
1.1 dsieger 5242: <p>Tell pkginstall to handle it, appending the name of the script,
5243: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5244: Continuing the previous example:</p>
5245: <pre class="programlisting">
5246: RCD_SCRIPTS+= cupsd
5247: </pre>
5248: </li>
5249: </ol></div>
5250: <p>Once this is done, pkginstall will do the following steps for each
5251: script in an automated fashion:</p>
1.23 wiz 5252: <div class="orderedlist"><ol class="orderedlist" type="1">
5253: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5254: substitutions described in the <code class="filename">FILES_SUBST</code>
5255: variable.</p></li>
1.23 wiz 5256: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5257: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5258: that this master file must be explicitly registered in the
5259: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5260: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5261: from the examples hierarchy into the system-wide startup scripts
5262: directory.</p></li>
5263: </ol></div>
1.41 asau 5264: <div class="sect2">
1.1 dsieger 5265: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5266: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5267: <p>The automatic copying of config files can be toggled by setting the
5268: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5269: installation. Note that the scripts will be always copied inside the
5270: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5271: matter what the value of this variable is.</p>
5272: </div>
5273: </div>
1.41 asau 5274: <div class="sect1">
1.1 dsieger 5275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5276: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5277: <p>If a package needs to create special users and/or groups during
5278: installation, it can do so by using the pkginstall framework.</p>
5279: <p>Users can be created by adding entries to the
5280: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5281: syntax:</p>
5282: <pre class="programlisting">
5283: user:group
5284: </pre>
5285: <p>Further specification of user details may be done by setting
5286: per-user variables.
5287: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5288: numeric UID for the user.
5289: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5290: user's description or comment.
5291: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5292: user's home directory, and defaults to
5293: <code class="filename">/nonexistent</code> if not specified.
5294: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5295: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5296: not specified.</p>
5297: <p>Similarly, groups can be created by adding entries to the
5298: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5299: <pre class="programlisting">
5300: group
5301: </pre>
5302: <p>The numeric GID of the group may be set by defining
5303: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5304: <p>If a package needs to create the users and groups at an earlier
5305: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5306: either <code class="literal">configure</code> or <code class="literal">build</code> to
5307: indicate the phase before which the users and groups are created. In
5308: this case, the numeric UIDs and GIDs of the created users and groups
5309: are automatically hardcoded into the final installation scripts.</p>
5310: </div>
1.41 asau 5311: <div class="sect1">
1.1 dsieger 5312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5313: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5314: <p>Packages that install system shells should register them in the shell
5315: database, <code class="filename">/etc/shells</code>, to make things easier to the
5316: administrator. This must be done from the installation scripts to keep
5317: binary packages working on any system. pkginstall provides an easy way to
5318: accomplish this task.</p>
5319: <p>When a package provides a shell interpreter, it has to set the
5320: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5321: add some hooks to the installation scripts to handle it. Consider the
1.79 snj 5322: 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 5323: <pre class="programlisting">
5324: PKG_SHELL= ${PREFIX}/bin/zsh
5325: </pre>
1.41 asau 5326: <div class="sect2">
1.1 dsieger 5327: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5328: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5329: <p>The automatic registration of shell interpreters can be disabled by
5330: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5331: environment variable to <code class="literal">NO</code>.</p>
5332: </div>
5333: </div>
1.41 asau 5334: <div class="sect1">
1.1 dsieger 5335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5336: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5337: <p>Packages that install X11 fonts should update the database files
5338: that index the fonts within each fonts directory. This can easily be
5339: accomplished within the pkginstall framework.</p>
5340: <p>When a package installs X11 fonts, it must list the directories in
5341: which fonts are installed in the
5342: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5343: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5344: <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 5345: installation scripts to run the appropriate commands to update the fonts
5346: database files within each of those directories. For convenience, if the
5347: directory path is relative, it is taken to be relative to the package's
1.79 snj 5348: 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 5349: <pre class="programlisting">
1.67 wiz 5350: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5351: </pre>
1.41 asau 5352: <div class="sect2">
1.1 dsieger 5353: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5354: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5355: <p>The automatic update of fonts databases can be disabled by
5356: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5357: environment variable to <code class="literal">NO</code>.</p>
5358: </div>
5359: </div>
5360: </div>
1.41 asau 5361: <div class="chapter">
1.1 dsieger 5362: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5363: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5364: <div class="toc">
5365: <p><b>Table of Contents</b></p>
1.100 leot 5366: <dl class="toc">
1.6 rillig 5367: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5368: <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 5369: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5370: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5371: </dl>
5372: </div>
5373: <p>Many packages have the ability to be built to support different
5374: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5375: in pkgsrc that provides generic handling of those options that
5376: determine different ways in which the packages can be built. It's
5377: possible for the user to specify exactly which sets of options will be
5378: built into a package or to allow a set of global default options
5379: apply.</p>
1.7 rillig 5380: <p>There are two broad classes of behaviors that one might want to
5381: control via options. One is whether some particular feature is
5382: enabled in a program that will be built anyway, often by including or
5383: not including a dependency on some other package. The other is
5384: whether or not an additional program will be built as part of the
5385: package. Generally, it is better to make a split package for such
5386: additional programs instead of using options, because it enables
5387: binary packages to be built which can then be added separately. For
5388: example, the foo package might have minimal dependencies (those
5389: packages without which foo doesn't make sense), and then the foo-gfoo
5390: package might include the GTK frontend program gfoo. This is better
5391: than including a gtk option to foo that adds gfoo, because either that
5392: option is default, in which case binary users can't get foo without
5393: gfoo, or not default, in which case they can't get gfoo. With split
5394: packages, they can install foo without having GTK, and later decide to
5395: install gfoo (pulling in GTK at that time). This is an advantage to
5396: source users too, avoiding the need for rebuilds.</p>
5397: <p>Plugins with widely varying dependencies should usually be split
5398: instead of options.</p>
5399: <p>It is often more work to maintain split packages, especially if
5400: the upstream package does not support this. The decision of split
5401: vs. option should be made based on the likelihood that users will want
5402: or object to the various pieces, the size of the dependencies that are
5403: included, and the amount of work.</p>
5404: <p>A further consideration is licensing. Non-free parts, or parts
5405: that depend on non-free dependencies (especially plugins) should
5406: almost always be split if feasible.</p>
1.41 asau 5407: <div class="sect1">
1.1 dsieger 5408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5409: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 5410: <p>Global default options are listed in
5411: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5412: that should be built into every package if that option is supported.
1.10 hubertf 5413: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5414: </div>
1.41 asau 5415: <div class="sect1">
1.1 dsieger 5416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5417: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5418: </h2></div></div></div>
5419: <p>The following example shows how
5420: <code class="filename">bsd.options.mk</code> should be used
5421: by the hypothetical ``wibble'' package, either in the package
5422: <code class="filename">Makefile</code>, or in a file,
5423: e.g. <code class="filename">options.mk</code>, that is included by the
5424: main package <code class="filename">Makefile</code>.</p>
5425: <pre class="programlisting">
5426: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5427: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5428: PKG_OPTIONS_OPTIONAL_GROUPS= database
5429: PKG_OPTIONS_GROUP.database= mysql pgsql
5430: PKG_SUGGESTED_OPTIONS= wibble-foo
5431: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5432: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5433:
5434: .include "../../mk/bsd.prefs.mk"
5435:
5436: # this package was previously named wibble2
5437: .if defined(PKG_OPTIONS.wibble2)
5438: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5439: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5440: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5441: .endif
5442:
5443: .include "../../mk/bsd.options.mk"
5444:
5445: # Package-specific option-handling
5446:
5447: ###
5448: ### FOO support
5449: ###
5450: .if !empty(PKG_OPTIONS:Mwibble-foo)
5451: CONFIGURE_ARGS+= --enable-foo
5452: .endif
5453:
5454: ###
5455: ### LDAP support
5456: ###
5457: .if !empty(PKG_OPTIONS:Mldap)
5458: . include "../../databases/openldap-client/buildlink3.mk"
5459: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5460: .endif
5461:
5462: ###
5463: ### database support
5464: ###
5465: .if !empty(PKG_OPTIONS:Mmysql)
5466: . include "../../mk/mysql.buildlink3.mk"
5467: .endif
5468: .if !empty(PKG_OPTIONS:Mpgsql)
5469: . include "../../mk/pgsql.buildlink3.mk"
5470: .endif
5471: </pre>
5472: <p>The first section contains the information about which build
5473: options are supported by the package, and any default options settings
5474: if needed.</p>
1.23 wiz 5475: <div class="orderedlist"><ol class="orderedlist" type="1">
5476: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.79 snj 5477: <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 5478: options. It should be set to
5479: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5480: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5481: at the point where the options are processed.</p></li>
1.23 wiz 5482: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5483: build options supported by the package.</p></li>
1.23 wiz 5484: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5485: list of names of groups of mutually exclusive options. The options in
5486: each group are listed in
5487: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5488: The most specific setting of any option from the group takes
5489: precedence over all other options in the group. Options from the
5490: groups will be automatically added to
5491: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5492: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5493: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5494: packages will fail if no option from the group is
5495: selected.</p></li>
1.23 wiz 5496: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5497: of names of sets of options. At least one option from each set must
5498: be selected. The options in each set are listed in
5499: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5500: Options from the sets will be automatically added to
5501: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5502: fail if no option from the set is selected.</p></li>
1.23 wiz 5503: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5504: build options which are enabled by default.</p></li>
1.23 wiz 5505: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5506: of
1.23 wiz 5507: <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 5508: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5509: their option counterparts. Pairs should be added with
1.23 wiz 5510: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5511: warning will be issued if the user uses a legacy
5512: variable.</p></li>
1.23 wiz 5513: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5514: of
1.23 wiz 5515: <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 5516: pairs that map options that have been renamed to their new
1.23 wiz 5517: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5518: the listing of global legacy options. A warning will be issued if
5519: the user uses a legacy option.</p></li>
1.23 wiz 5520: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5521: options implied by deprecated variables used. This can be used for
5522: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5523: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5524: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5525: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5526: a list of warnings about deprecated variables or options used, and
5527: what to use instead.</p></li>
5528: </ol></div>
5529: <p>A package should never modify
5530: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5531: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5532: To suggest a default set of options, use
5533: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5534: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5535: including <code class="filename">bsd.options.mk</code>. If none of
5536: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5537: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5538: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5539: happen with platform-specific options if none of them is supported on
5540: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5541: empty list and the package is otherwise treated as not using the
5542: options framework.</p>
5543: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5544: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5545: build options, properly filtered to remove unsupported and duplicate
5546: options.</p>
5547: <p>The remaining sections contain the logic that is specific to
5548: each option. The correct way to check for an option is to check
5549: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5550: <pre class="programlisting">
5551: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5552: </pre>
5553: </div>
1.41 asau 5554: <div class="sect1">
1.1 dsieger 5555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5556: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 5557: <p>Options that enable similar features in different packages (like
5558: optional support for a library) should use a common name in all
5559: packages that support it (like the name of the library). If another
5560: package already has an option with the same meaning, use the same
5561: name.</p>
5562: <p>Options that enable features specific to one package, where it's
5563: unlikely that another (unrelated) package has the same (or a similar)
5564: optional feature, should use a name prefixed with
5565: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5566: <p>If a group of related packages share an optional feature
5567: specific to that group, prefix it with the name of the
1.23 wiz 5568: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5569: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5570: <p>For new options, add a line to
5571: <code class="filename">mk/defaults/options.description</code>. Lines have two
5572: fields, separated by tab. The first field is the option name, the
5573: second its description. The description should be a whole sentence
5574: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5575: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5576: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5577: </div>
1.41 asau 5578: <div class="sect1">
1.7 rillig 5579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5580: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5581: <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 5582: different dependencies based on the options with which the package was
5583: built. For querying these options, the file
5584: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5585: typical example looks like this:</p>
5586: <pre class="programlisting">
5587: pkgbase := libpurple
5588: .include "../../mk/pkg-build-options.mk"
5589:
5590: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5591: ...
5592: .endif
5593: </pre>
5594: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5595: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5596: options of the libpurple package, which can then be queried like
5597: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5598: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5599: details.</p>
5600: </div>
1.1 dsieger 5601: </div>
1.41 asau 5602: <div class="chapter">
1.1 dsieger 5603: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5604: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 5605: <div class="toc">
5606: <p><b>Table of Contents</b></p>
1.100 leot 5607: <dl class="toc">
1.6 rillig 5608: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
5609: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
5610: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
5611: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 5612: <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 5613: <dd><dl>
5614: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
5615: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
5616: </dl></dd>
1.23 wiz 5617: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5618: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5619: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5620: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5621: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5622: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5623: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5624: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5625: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5626: <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 5627: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
5628: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 5629: </dl>
5630: </div>
1.41 asau 5631: <div class="sect1">
1.1 dsieger 5632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5633: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 5634: <p>This chapter gives a detailed description on how a package is
5635: built. Building a package is separated into different
5636: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5637: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5638: described in the following sections. Each phase is split into
1.1 dsieger 5639: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5640: containing phase, prefixed by one of <code class="varname">pre-</code>,
5641: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5642: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5643: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5644: <p>Never override the regular targets (like
5645: <code class="varname">fetch</code>), if you have to, override the
5646: <code class="varname">do-*</code> ones instead.</p>
5647: <p>The basic steps for building a program are always the same. First
5648: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5649: the local system and then extracted. After any pkgsrc-specific patches
5650: to compile properly are applied, the software can be configured, then
5651: built (usually by compiling), and finally the generated binaries, etc.
5652: can be put into place on the system.</p>
5653: <p>To get more details about what is happening at each step,
5654: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5655: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5656: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5657: </div>
1.41 asau 5658: <div class="sect1">
1.1 dsieger 5659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5660: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 5661: <p>Before outlining the process performed by the NetBSD package system in
5662: the next section, here's a brief discussion on where programs are
5663: installed, and which variables influence this.</p>
5664: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5665: where all files of the final program shall be installed. It is
5666: usually set to <code class="varname">LOCALBASE</code>
5667: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5668: for pkgs in the <code class="filename">cross</code> category. The value of
5669: <code class="varname">PREFIX</code> needs to be put
5670: into the various places in the program's source where paths to
1.108 rillig 5671: 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 5672: <p>When choosing which of these variables to use,
5673: follow the following rules:</p>
1.41 asau 5674: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5675: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5676: where the current pkg will be installed. When referring to a
5677: pkg's own installation path, use
1.23 wiz 5678: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5679: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5680: are installed. If you need to construct a -I or -L argument
5681: to the compiler to find includes and libraries installed by
1.23 wiz 5682: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5683: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5684: installed all packages in <code class="filename">/usr/local</code>. As
5685: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5686: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5687: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5688: distribution (from xsrc, etc.) is installed. When looking for
5689: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5690: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5691: <li class="listitem"><p>X11-based packages using imake must set
5692: <code class="varname">USE_IMAKE</code> to be installed correctly under
5693: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5694: <li class="listitem">
1.99 sevan 5695: <p>To determine the prefix of an
1.1 dsieger 5696: installed package, the <code class="varname">EVAL_PREFIX</code>
5697: definition can be used. It takes pairs in the format
1.79 snj 5698: <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 5699: variable <code class="varname">DIRNAME</code> will be set to the prefix
5700: of the installed package <package>, or
1.99 sevan 5701: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> if the package is not
1.1 dsieger 5702: installed.</p>
5703: <p>This is best illustrated by example.</p>
5704: <p>The following lines are taken from
5705: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
5706: <pre class="programlisting">
5707: EVAL_PREFIX+= GTKDIR=gtk+
5708: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
5709: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
5710: CONFIGURE_ARGS+= --enable-multibyte
5711: </pre>
5712: <p>Specific defaults can be defined for the packages
5713: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
5714: definition of the form:</p>
5715: <pre class="programlisting">
5716: GTKDIR_DEFAULT= ${LOCALBASE}
5717: </pre>
5718: <p>where <code class="varname">GTKDIR</code> corresponds
5719: to the first definition in
5720: the <code class="varname">EVAL_PREFIX</code> pair.</p>
5721: </li>
1.23 wiz 5722: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.79 snj 5723: 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 5724: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5725: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5726: </ul></div>
5727: </div>
1.41 asau 5728: <div class="sect1">
1.1 dsieger 5729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5730: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5731: <p>When building a package, various directories are used to store
1.1 dsieger 5732: source files, temporary files, pkgsrc-internal files, and so on. These
5733: directories are explained here.</p>
5734: <p>Some of the directory variables contain relative pathnames. There
5735: are two common base directories for these relative directories:
5736: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5737: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5738: inside the package itself.</p>
1.41 asau 5739: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5740: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5741: <dd><p>This is an absolute pathname that points to the pkgsrc
5742: root directory. Generally, you don't need
5743: it.</p></dd>
5744: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5745: <dd><p>This is an absolute pathname that points to the
5746: current package.</p></dd>
5747: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5748: <dd><p>This is a pathname relative to
5749: <code class="varname">PKGSRCDIR</code> that points to the current
5750: package.</p></dd>
5751: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5752: <dd><p>This is an absolute pathname pointing to the directory
5753: where all work takes place. The distfiles are extracted to this
5754: directory. It also contains temporary directories and log files used by
5755: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5756: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5757: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5758: <dd><p>This is an absolute pathname pointing to the directory
5759: where the distfiles are extracted. It is usually a direct subdirectory
5760: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5761: that isn't hidden. This variable may be changed by a package
5762: <code class="filename">Makefile</code>.</p></dd>
5763: </dl></div>
1.14 jmcneill 5764: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5765: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5766: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5767: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5768: If users would like to have their pkgsrc trees behave in a
5769: read-only manner, then the value of
5770: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5771: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5772: </div>
1.41 asau 5773: <div class="sect1">
1.1 dsieger 5774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5775: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 5776: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5777: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5778: phase. This will automatically run all phases that are required for this
5779: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5780: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5781: the package will be built, but not installed.</p>
5782: </div>
1.41 asau 5783: <div class="sect1">
1.1 dsieger 5784: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5785: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5786: <p>The first step in building a package is to fetch the
5787: distribution files (distfiles) from the sites that are providing
5788: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5789: phase.</p>
1.41 asau 5790: <div class="sect2">
1.1 dsieger 5791: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5792: <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 5793: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5794: defines all URLs from where the distfile, whose name is
5795: derived from the <code class="varname">DISTNAME</code> variable, is
5796: fetched. The more complicated cases are described
5797: below.</p>
5798: <p>The variable <code class="varname">DISTFILES</code> specifies
5799: the list of distfiles that have to be fetched. Its value
1.66 asau 5800: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5801: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5802: so that most packages don't need to define it at all.
5803: <code class="varname">EXTRACT_SUFX</code> is
5804: <code class="literal">.tar.gz</code> by default, but can be changed
5805: freely. Note that if your package requires additional
5806: distfiles to the default one, you cannot just append the
5807: additional filenames using the <code class="literal">+=</code>
5808: operator, but you have write for example:</p>
5809: <pre class="programlisting">
1.66 asau 5810: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5811: </pre>
5812: <p>Each distfile is fetched from a list of sites, usually
5813: <code class="varname">MASTER_SITES</code>. If the package has multiple
5814: <code class="varname">DISTFILES</code> or multiple
5815: <code class="varname">PATCHFILES</code> from different sites, you can
5816: set
5817: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5818: to the list of URLs where the file
5819: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5820: (including the suffix) can be found.</p>
5821: <pre class="programlisting">
5822: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5823: DISTFILES+= foo-file.tar.gz
5824: SITES.foo-file.tar.gz= \
5825: http://www.somewhere.com/somehow/ \
5826: http://www.somewhereelse.com/mirror/somehow/
5827: </pre>
5828: <p>When actually fetching the distfiles, each item from
5829: <code class="varname">MASTER_SITES</code> or
5830: <code class="varname">SITES.*</code> gets the name of each distfile
5831: appended to it, without an intermediate slash. Therefore,
5832: all site values have to end with a slash or other separator
5833: character. This allows for example to set
5834: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5835: that gets the name of the distfile as a parameter. In this
5836: case, the definition would look like:</p>
5837: <pre class="programlisting">
5838: MASTER_SITES= http://www.example.com/download.cgi?file=
5839: </pre>
1.22 jakllsch 5840: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5841: In that case the URL is taken as is, fetched and the result
5842: stored under the name of the distfile. You can use this style
5843: for the case when the download URL style does not match the
5844: above common case. For example, if permanent download URL is a
5845: redirector to the real download URL, or the download file name
5846: is offered by an HTTP Content-Disposition header. In the
5847: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5848: created instead of the default
5849: <code class="filename">v1.0.0.tar.gz</code>.</p>
5850: <pre class="programlisting">
5851: DISTNAME= foo-1.0.0
5852: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5853: </pre>
1.1 dsieger 5854: <p>There are some predefined values for
5855: <code class="varname">MASTER_SITES</code>, which can be used in
5856: packages. The names of the variables should speak for
5857: themselves.</p>
5858: <pre class="programlisting">
5859: ${MASTER_SITE_APACHE}
5860: ${MASTER_SITE_BACKUP}
5861: ${MASTER_SITE_CYGWIN}
5862: ${MASTER_SITE_DEBIAN}
5863: ${MASTER_SITE_FREEBSD}
5864: ${MASTER_SITE_FREEBSD_LOCAL}
5865: ${MASTER_SITE_GENTOO}
5866: ${MASTER_SITE_GNOME}
5867: ${MASTER_SITE_GNU}
5868: ${MASTER_SITE_GNUSTEP}
1.66 asau 5869: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 5870: ${MASTER_SITE_IFARCHIVE}
5871: ${MASTER_SITE_KDE}
5872: ${MASTER_SITE_MOZILLA}
1.66 asau 5873: ${MASTER_SITE_MOZILLA_ALL}
5874: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 5875: ${MASTER_SITE_MYSQL}
1.66 asau 5876: ${MASTER_SITE_NETLIB}
1.1 dsieger 5877: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 5878: ${MASTER_SITE_OSDN}
1.1 dsieger 5879: ${MASTER_SITE_PERL_CPAN}
5880: ${MASTER_SITE_PGSQL}
1.66 asau 5881: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 5882: ${MASTER_SITE_R_CRAN}
5883: ${MASTER_SITE_SOURCEFORGE}
5884: ${MASTER_SITE_SUNSITE}
5885: ${MASTER_SITE_SUSE}
5886: ${MASTER_SITE_TEX_CTAN}
5887: ${MASTER_SITE_XCONTRIB}
5888: ${MASTER_SITE_XEMACS}
1.66 asau 5889: ${MASTER_SITE_XORG}
1.1 dsieger 5890: </pre>
5891: <p>Some explanations for the less self-explaining ones:
5892: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 5893: 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 5894: 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 5895: <p>If you choose one of these predefined sites, you may
5896: want to specify a subdirectory of that site. Since these
5897: macros may expand to more than one actual site, you
5898: <span class="emphasis"><em>must</em></span> use the following construct to
5899: specify a subdirectory:</p>
5900: <pre class="programlisting">
5901: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5902: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5903: </pre>
5904: <p>Note the trailing slash after the subdirectory
5905: name.</p>
5906: </div>
1.41 asau 5907: <div class="sect2">
1.1 dsieger 5908: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5909: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 5910: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5911: all the distfiles exist in a local directory
5912: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
5913: user). If the files do not exist, they are fetched using
5914: commands of the form</p>
5915: <pre class="programlisting">
5916: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5917: </pre>
5918: <p>where <code class="literal">${site}</code> varies through
5919: several possibilities in turn: first,
5920: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
5921: sites specified in either <code class="varname">SITES.file</code> if
5922: defined, else <code class="varname">MASTER_SITES</code> or
5923: <code class="varname">PATCH_SITES</code>, as applies, then finally the
5924: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
5925: all except the first and the last can be optionally sorted
5926: by the user, via setting either
5927: <code class="varname">MASTER_SORT_RANDOM</code>, and
5928: <code class="varname">MASTER_SORT_AWK</code> or
5929: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 5930: <p> The specific command and arguments used depend on the
5931: <code class="varname">FETCH_USING</code> parameter. The example above is
5932: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 5933: <p>The distfiles mirror run by the NetBSD Foundation uses the
5934: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
5935: distfiles, if they are freely distributable. Packages setting
5936: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 5937: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 5938: mirrored.</p>
5939: </div>
5940: </div>
1.41 asau 5941: <div class="sect1">
1.1 dsieger 5942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5943: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 5944: <p>After the distfile(s) are fetched, their checksum is
5945: generated and compared with the checksums stored in the
5946: distinfo file. If the checksums don't match, the build is
5947: aborted. This is to ensure the same distfile is used for
5948: building, and that the distfile wasn't changed, e.g. by some
5949: malign force, deliberately changed distfiles on the master
5950: distribution site or network lossage.</p>
5951: </div>
1.41 asau 5952: <div class="sect1">
1.1 dsieger 5953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5954: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 5955: <p>When the distfiles are present on the local system, they
5956: need to be extracted, as they usually come in the form of some
5957: compressed archive format.</p>
5958: <p>By default, all <code class="varname">DISTFILES</code> are
5959: extracted. If you only need some of them, you can set the
5960: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
5961: files.</p>
5962: <p>Extracting the files is usually done by a little
5963: program, <code class="filename">mk/extract/extract</code>, which
5964: already knows how to extract various archive formats, so most
5965: likely you will not need to change anything here. But if you
5966: need, the following variables may help you:</p>
1.41 asau 5967: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5968: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
5969: <dd><p>Use these variables to override the default
5970: options for an extract command, which are defined in
5971: <code class="filename">mk/extract/extract</code>.</p></dd>
5972: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
5973: <dd><p>This variable can be set to
1.14 jmcneill 5974: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
5975: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 5976: absolute pathname pointing to the command with which tar
1.14 jmcneill 5977: archives should be extracted. It is preferred to choose bsdtar over gtar
5978: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 5979: </dl></div>
5980: <p>If the <code class="filename">extract</code> program doesn't
5981: serve your needs, you can also override the
5982: <code class="varname">EXTRACT_CMD</code> variable, which holds the
5983: command used for extracting the files. This command is
5984: executed in the <code class="filename">${WRKSRC}</code>
5985: directory. During execution of this command, the shell
5986: variable <code class="varname">extract_file</code> holds the absolute
5987: pathname of the file that is going to be extracted.</p>
5988: <p>And if that still does not suffice, you can override the
5989: <code class="varname">do-extract</code> target in the package
5990: Makefile.</p>
5991: </div>
1.41 asau 5992: <div class="sect1">
1.1 dsieger 5993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5994: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 5995: <p>After extraction, all the patches named by the
5996: <code class="varname">PATCHFILES</code>, those present in the patches
5997: subdirectory of the package as well as in
5998: $LOCALPATCHES/$PKGPATH (e.g.
5999: <code class="filename">/usr/local/patches/graphics/png</code>) are
6000: applied. Patchfiles ending in <code class="filename">.Z</code> or
6001: <code class="filename">.gz</code> are uncompressed before they are
6002: applied, files ending in <code class="filename">.orig</code> or
6003: <code class="filename">.rej</code> are ignored. Any special options to
1.79 snj 6004: <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 6005: <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 6006: <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 6007: it fail if the patches apply with some lines of fuzz. Please
6008: fix (regen) the patches so that they apply cleanly. The
6009: rationale behind this is that patches that don't apply cleanly
6010: may end up being applied in the wrong place, and cause severe
6011: harm there.</p>
6012: </div>
1.41 asau 6013: <div class="sect1">
1.1 dsieger 6014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6015: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6016: <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 6017: </p>
6018: </div>
1.41 asau 6019: <div class="sect1">
1.1 dsieger 6020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6021: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6022: <p>This phase creates wrapper programs for the compilers and
6023: linkers. The following variables can be used to tweak the
6024: wrappers.</p>
1.41 asau 6025: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6026: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6027: <dd><p>The command used to print progress
6028: messages. Does nothing by default. Set to
6029: <code class="literal">${ECHO}</code> to see the progress
6030: messages.</p></dd>
6031: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6032: <dd><p>This variable can be set to
6033: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6034: depending on whether you want additional information in the
6035: wrapper log file.</p></dd>
6036: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6037: <dd><p>This variable can be set to
6038: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6039: on whether the wrapper should use its cache, which will
6040: improve the speed. The default value is
6041: <code class="literal">yes</code>, but is forced to
6042: <code class="literal">no</code> if the platform does not support
6043: it.</p></dd>
6044: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6045: <dd><p>A list of reordering commands. A reordering
6046: command has the form
6047: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6048: It ensures that that
6049: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6050: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6051: </p></dd>
6052: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6053: <dd><p>A list of transformation commands. [TODO:
6054: investigate further]</p></dd>
6055: </dl></div>
6056: </div>
1.41 asau 6057: <div class="sect1">
1.1 dsieger 6058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6059: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6060: <p>Most pieces of software need information on the header
6061: files, system calls, and library routines which are available
6062: on the platform they run on. The process of determining this
6063: information is known as configuration, and is usually
6064: automated. In most cases, a script is supplied with the
6065: distfiles, and its invocation results in generation of header
6066: files, Makefiles, etc.</p>
6067: <p>If the package contains a configure script, this can be
6068: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6069: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6070: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6071: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6072: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6073: <pre class="programlisting">
6074: .for d in ${CONFIGURE_DIRS}
6075: cd ${WRKSRC} \
6076: && cd ${d} \
6077: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6078: .endfor
6079: </pre>
6080: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6081: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6082: <code class="varname">WRKSRC</code>. In each of these directories, the
6083: configure script is run with the environment
6084: <code class="varname">CONFIGURE_ENV</code> and arguments
6085: <code class="varname">CONFIGURE_ARGS</code>. The variables
6086: <code class="varname">CONFIGURE_ENV</code>,
6087: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6088: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6089: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6090: package.</p>
1.37 wiz 6091: <p>If the program uses the Perl way of configuration (mainly Perl
6092: modules, but not only), i.e. a file called
6093: <code class="filename">Makefile.PL</code>, it should include
6094: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6095: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6096: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6097: <p>If the program uses an <code class="filename">Imakefile</code>
6098: for configuration, the appropriate steps can be invoked by
6099: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6100: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6101: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6102: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6103: <p>If the program uses <code class="filename">cmake</code>
6104: for configuration, the appropriate steps can be invoked by
1.23 wiz 6105: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6106: You can add variables to cmake's environment by adding them to the
6107: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6108: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6109: The top directory argument is given by the
6110: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6111: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6112: <p>If there is no configure step at all, set
1.23 wiz 6113: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6114: </div>
1.41 asau 6115: <div class="sect1">
1.1 dsieger 6116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6117: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6118: <p>For building a package, a rough equivalent of the
6119: following code is executed.</p>
6120: <pre class="programlisting">
6121: .for d in ${BUILD_DIRS}
6122: cd ${WRKSRC} \
6123: && cd ${d} \
6124: && env ${MAKE_ENV} \
6125: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6126: -f ${MAKE_FILE} \
6127: ${BUILD_TARGET}
6128: .endfor
6129: </pre>
6130: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6131: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6132: <code class="varname">WRKSRC</code>. In each of these directories,
6133: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6134: <code class="varname">MAKE_ENV</code> and arguments
6135: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6136: <code class="varname">MAKE_ENV</code>,
6137: <code class="varname">BUILD_MAKE_FLAGS</code>,
6138: <code class="varname">MAKE_FILE</code> and
6139: <code class="varname">BUILD_TARGET</code> may all be changed by the
6140: package.</p>
6141: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6142: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6143: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6144: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6145: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6146: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6147: <p>If there is no build step at all, set
1.23 wiz 6148: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 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.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6153: <p>[TODO]</p>
6154: </div>
1.41 asau 6155: <div class="sect1">
1.1 dsieger 6156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6157: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6158: <p>Once the build stage has completed, the final step is to
6159: install the software in public directories, so users can
6160: access the programs and files.</p>
6161: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6162: equivalent of the following code is executed. Additionally,
6163: before and after this code, much magic is performed to do
6164: consistency checks, registering the package, and so on.</p>
6165: <pre class="programlisting">
6166: .for d in ${INSTALL_DIRS}
6167: cd ${WRKSRC} \
6168: && cd ${d} \
6169: && env ${MAKE_ENV} \
6170: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6171: -f ${MAKE_FILE} \
6172: ${INSTALL_TARGET}
6173: .endfor
6174: </pre>
6175: <p>The variable's meanings are analogous to the ones in the
6176: <span class="emphasis"><em>build</em></span> phase.
6177: <code class="varname">INSTALL_DIRS</code> defaults to
6178: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6179: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6180: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6181: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6182: defined.</p>
6183: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6184: variables are useful. They are all variations of the
1.79 snj 6185: <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 6186: permissions preset. <code class="varname">INSTALL</code> is the plain
6187: install command. The specialized variants, together with their
6188: intended use, are:</p>
1.41 asau 6189: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6190: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6191: <dd><p>directories that contain
6192: binaries</p></dd>
6193: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6194: <dd><p>directories that contain
6195: scripts</p></dd>
6196: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6197: <dd><p>directories that contain shared and static
6198: libraries</p></dd>
6199: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6200: <dd><p>directories that contain data
6201: files</p></dd>
6202: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6203: <dd><p>directories that contain man
6204: pages</p></dd>
1.100 leot 6205: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6206: <dd><p>directories that contain data files for games
6207: </p></dd>
1.1 dsieger 6208: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6209: <dd><p>binaries that can be stripped from debugging
6210: symbols</p></dd>
6211: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6212: <dd><p>binaries that cannot be
6213: stripped</p></dd>
6214: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6215: <dd><p>game
6216: binaries</p></dd>
6217: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6218: <dd><p>shared and static
6219: libraries</p></dd>
6220: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6221: <dd><p>data files</p></dd>
6222: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6223: <dd><p>data files for
6224: games</p></dd>
6225: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6226: <dd><p>man pages</p></dd>
6227: </dl></div>
6228: <p>Some other variables are:</p>
1.41 asau 6229: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6230: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
6231: <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>
6232: when installing binaries. Any debugging sections and symbols present in
6233: binaries will be preserved.
6234: </p></dd>
1.1 dsieger 6235: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6236: <dd><p>A list of directories relative to
6237: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6238: beginning of the <span class="emphasis"><em>install</em></span> phase.
6239: The package is supposed to create all needed directories itself
6240: before installing files to it and list all other directories here.
6241: </p></dd>
6242: </dl></div>
6243: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6244: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6245: mostly relevant for packages in the <code class="filename">regress</code>
6246: category.</p>
6247: </div>
1.41 asau 6248: <div class="sect1">
1.1 dsieger 6249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6250: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6251: <p>Once the install stage has completed, a binary package of
6252: the installed files can be built. These binary packages can be
6253: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6254: the <span class="command"><strong>make bin-install</strong></span> or by using
6255: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6256: <p>By default, the binary packages are created in
6257: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6258: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6259: one for each category in the <code class="varname">CATEGORIES</code>
6260: variable. <code class="varname">PACKAGES</code> defaults to
6261: <code class="filename">pkgsrc/packages</code>.</p>
6262: </div>
1.41 asau 6263: <div class="sect1">
1.1 dsieger 6264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6265: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6266: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6267: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6268: to clean the work directories of all dependencies too, use
1.10 hubertf 6269: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6270: </div>
1.41 asau 6271: <div class="sect1">
1.1 dsieger 6272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6273: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6274: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6275: <dt><span class="term">pre/post-*</span></dt>
6276: <dd><p>For any of the main targets described in the
6277: previous section, two auxiliary targets exist with
1.23 wiz 6278: <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 6279: prefix for the main target's name. These targets are
6280: invoked before and after the main target is called,
6281: allowing extra configuration or installation steps be
6282: performed from a package's Makefile, for example, which
6283: a program's configure script or install target
6284: omitted.</p></dd>
6285: <dt><span class="term">do-*</span></dt>
6286: <dd><p>Should one of the main targets do the wrong thing,
6287: and should there be no variable to fix this, you can
6288: redefine it with the do-* target. (Note that redefining
6289: the target itself instead of the do-* target is a bad
6290: idea, as the pre-* and post-* targets won't be called
6291: anymore, etc.) You will not usually need to do
6292: this.</p></dd>
6293: <dt><span class="term">reinstall</span></dt>
6294: <dd>
1.10 hubertf 6295: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6296: you noticed some file was not installed properly, you
6297: can repeat the installation with this target, which will
1.23 wiz 6298: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6299: <p>This is the default value of
6300: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6301: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6302: package</strong></span>, where the defaults are
1.23 wiz 6303: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6304: respectively.</p>
6305: </dd>
6306: <dt><span class="term">deinstall</span></dt>
6307: <dd>
1.79 snj 6308: <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 6309: current directory, effectively de-installing the
6310: package. The following variables can be used to tune the
6311: behaviour:</p>
1.41 asau 6312: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6313: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.79 snj 6314: <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 6315: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6316: <dd><p>Remove all packages that require (depend on)
6317: the given package. This can be used to remove any
6318: packages that may have been pulled in by a given
1.10 hubertf 6319: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6320: DEINSTALLDEPENDS=1</strong></span> is done in
6321: <code class="filename">pkgsrc/x11/kde</code>, this is
6322: likely to remove whole KDE. Works by adding
1.79 snj 6323: <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 6324: command line.</p></dd>
6325: </dl></div>
6326: </dd>
6327: <dt><span class="term">bin-install</span></dt>
6328: <dd><p>Install a binary package from local disk and via FTP
6329: from a list of sites (see the
6330: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6331: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6332: available anywhere. The arguments given to
1.10 hubertf 6333: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6334: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6335: operation, etc.</p></dd>
1.95 wiz 6336: <dt><span class="term">install-clean</span></dt>
6337: <dd><p>This target removes the state files for the "install" and later
6338: phases so that the "install" target may be re-invoked. This can be
6339: used after editing the PLIST to install the package without
6340: rebuilding it.</p></dd>
6341: <dt><span class="term">build-clean</span></dt>
6342: <dd><p>This target removes the state files for the "build" and later
6343: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6344: <dt><span class="term">update</span></dt>
6345: <dd>
6346: <p>This target causes the current package to be
6347: updated to the latest version. The package and all
6348: depending packages first get de-installed, then current
6349: versions of the corresponding packages get compiled and
6350: installed. This is similar to manually noting which
6351: packages are currently installed, then performing a
1.10 hubertf 6352: series of <span class="command"><strong>make deinstall</strong></span> and
6353: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6354: <code class="varname">UPDATE_TARGET</code> is set to) for these
6355: packages.</p>
1.23 wiz 6356: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6357: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6358: update</strong></span> was interrupted for some reason.
6359: However, in this case, make sure you don't call
1.10 hubertf 6360: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6361: list of dependent packages in <code class="varname">WRKDIR</code>.
6362: Otherwise, you lose the ability to automatically update
6363: the current package along with the dependent packages
6364: you have installed.</p>
1.10 hubertf 6365: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6366: update</strong></span> will only work as long as the package
6367: tree remains unchanged. If the source code for one of
6368: the packages to be updated has been changed, resuming
1.10 hubertf 6369: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6370: fail!</p>
6371: <p>The following variables can be used either on the
1.10 hubertf 6372: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6373: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6374: update</strong></span>:</p>
1.41 asau 6375: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6376: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6377: <dd><p>Install target to recursively use for the
6378: updated package and the dependent packages.
6379: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6380: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6381: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6382: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6383: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6384: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6385: endless loop!</p></dd>
6386: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6387: <dd><p>Don't clean up after updating. Useful if
6388: you want to leave the work sources of the updated
6389: packages around for inspection or other purposes.
6390: Be sure you eventually clean up the source tree
1.23 wiz 6391: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6392: or you may run into troubles with old source code
6393: still lying around on your next
1.10 hubertf 6394: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6395: update</strong></span>.</p></dd>
6396: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6397: <dd><p>Deinstall each package before installing
6398: (making <code class="varname">DEPENDS_TARGET</code>). This
6399: may be necessary if the
1.23 wiz 6400: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6401: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6402: update</strong></span>.</p></dd>
6403: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6404: <dd><p>Allows you to disable recursion and hardcode
6405: the target for packages. The default is
1.23 wiz 6406: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6407: facilitating a recursive update of prerequisite
6408: packages. Only set
6409: <code class="varname">DEPENDS_TARGET</code> if you want to
6410: disable recursive updates. Use
6411: <code class="varname">UPDATE_TARGET</code> instead to just
6412: set a specific target for each package to be
1.10 hubertf 6413: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6414: (see above).</p></dd>
6415: </dl></div>
6416: </dd>
6417: <dt><span class="term">clean-update</span></dt>
6418: <dd>
6419: <p>Clean the source tree for all packages that would
1.10 hubertf 6420: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6421: from the current directory. This target should not be
6422: used if the current package (or any of its depending
6423: packages) have already been de-installed (e.g., after
1.10 hubertf 6424: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6425: some packages you intended to update. As a rule of
6426: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6427: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6428: and only if you have a dirty package tree (e.g., if you
6429: used <code class="varname">NOCLEAN</code>).</p>
6430: <p>If you are unsure about whether your tree is
1.10 hubertf 6431: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6432: clean</strong></span> at the top of the tree, or use the
6433: following sequence of commands from the directory of the
6434: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6435: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6436: time, otherwise you lose all the packages you wanted to
6437: update!):</p>
6438: <pre class="screen">
6439: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6440: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6441: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6442: </pre>
6443: <p>The following variables can be used either on the
1.10 hubertf 6444: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6445: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6446: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6447: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6448: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6449: reconstruct the list of directories to update for
1.10 hubertf 6450: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6451: update</strong></span> successfully installed all
6452: packages you wanted to update. Normally, this is
1.10 hubertf 6453: done automatically on <span class="command"><strong>make
1.1 dsieger 6454: update</strong></span>, but may have been suppressed by
6455: the <code class="varname">NOCLEAN</code> variable (see
6456: above).</p></dd>
6457: </dl></div>
6458: </dd>
6459: <dt><span class="term">replace</span></dt>
6460: <dd>
6461: <p>Update the installation of the current package. This
6462: differs from update in that it does not replace dependent
1.79 snj 6463: 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 6464: target to work.</p>
6465: <p><span class="emphasis"><em>Be careful when using this
6466: target!</em></span> There are no guarantees that dependent
6467: packages will still work, in particular they will most
1.10 hubertf 6468: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6469: library package whose shared library major version changed
6470: between your installed version and the new one. For this
6471: reason, this target is not officially supported and only
6472: recommended for advanced users.</p>
6473: </dd>
6474: <dt><span class="term">info</span></dt>
1.79 snj 6475: <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 6476: package. You can use this to check which version of a
6477: package is installed.</p></dd>
6478: <dt><span class="term">index</span></dt>
6479: <dd>
6480: <p>This is a top-level command, i.e. it should be used in
6481: the <code class="filename">pkgsrc</code> directory. It creates a
6482: database of all packages in the local pkgsrc tree, including
6483: dependencies, comment, maintainer, and some other useful
6484: information. Individual entries are created by running
1.10 hubertf 6485: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6486: directories. This index file is saved as
6487: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6488: verbose format by running <span class="command"><strong>make
1.1 dsieger 6489: print-index</strong></span>. You can search in it with
1.10 hubertf 6490: <span class="command"><strong>make search
1.1 dsieger 6491: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6492: extract a list of all packages that depend on a particular
1.10 hubertf 6493: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6494: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6495: <p>Running this command takes a very long time, some
6496: hours even on fast machines!</p>
6497: </dd>
6498: <dt><span class="term">readme</span></dt>
6499: <dd>
6500: <p>This target generates a
6501: <code class="filename">README.html</code> file, which can be
1.79 snj 6502: 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 6503: contain references to any packages which are in the
6504: <code class="varname">PACKAGES</code> directory on the local
6505: host. The generated files can be made to refer to URLs
6506: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6507: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6508: wanted to generate <code class="filename">README.html</code>
6509: files which pointed to binary packages on the local
6510: machine, in the directory
6511: <code class="filename">/usr/packages</code>, set
6512: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6513: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6514: <code class="varname">${PACKAGES}</code> directory and its
6515: subdirectories will be searched for all the binary
6516: packages.</p>
6517: <p>The target can be run at the toplevel or in category
6518: directories, in which case it descends recursively.</p>
6519: </dd>
6520: <dt><span class="term">readme-all</span></dt>
6521: <dd><p>This is a top-level command, run it in
6522: <code class="filename">pkgsrc</code>. Use this target to create a
6523: file <code class="filename">README-all.html</code> which contains a
6524: list of all packages currently available in the NetBSD
6525: Packages Collection, together with the category they belong
6526: to and a short description. This file is compiled from the
6527: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6528: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6529: readme</strong></span>.</p></dd>
6530: <dt><span class="term">cdrom-readme</span></dt>
6531: <dd><p>This is very much the same as the
1.23 wiz 6532: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6533: used when generating a pkgsrc tree to be written to a
6534: CD-ROM. This target also produces
6535: <code class="filename">README.html</code> files, and can be made
6536: to refer to URLs based on
6537: <code class="varname">CDROM_PKG_URL_HOST</code> and
6538: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6539: <dt><span class="term">show-distfiles</span></dt>
6540: <dd><p>This target shows which distfiles and patchfiles
6541: are needed to build the package
6542: (<code class="varname">ALLFILES</code>, which contains all
6543: <code class="varname">DISTFILES</code> and
6544: <code class="varname">PATCHFILES</code>, but not
6545: <code class="filename">patches/*</code>).</p></dd>
6546: <dt><span class="term">show-downlevel</span></dt>
6547: <dd><p>This target shows nothing if the package is not
6548: installed. If a version of this package is installed,
6549: but is not the version provided in this version of
6550: pkgsrc, then a warning message is displayed. This target
6551: can be used to show which of your installed packages are
6552: downlevel, and so the old versions can be deleted, and
6553: the current ones added.</p></dd>
6554: <dt><span class="term">show-pkgsrc-dir</span></dt>
6555: <dd><p>This target shows the directory in the pkgsrc
6556: hierarchy from which the package can be built and
6557: installed. This may not be the same directory as the one
6558: from which the package was installed. This target is
6559: intended to be used by people who may wish to upgrade
6560: many packages on a single host, and can be invoked from
6561: the top-level pkgsrc Makefile by using the
1.23 wiz 6562: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6563: <dt><span class="term">show-installed-depends</span></dt>
6564: <dd><p>This target shows which installed packages match
6565: the current package's <code class="varname">DEPENDS</code>. Useful
6566: if out of date dependencies are causing build
6567: problems.</p></dd>
1.95 wiz 6568: <dt><span class="term">print-build-depends-list</span></dt>
6569: <dd><p>This target shows the list of packages that the current package
6570: depends on for building.</p></dd>
6571: <dt><span class="term">print-run-depends-list</span></dt>
6572: <dd><p>This target shows the list of packages that the current package
6573: depends on for running.</p></dd>
1.1 dsieger 6574: <dt><span class="term">check-shlibs</span></dt>
6575: <dd><p>After a package is installed, check all its
6576: binaries and (on ELF platforms) shared libraries to see
6577: if they find the shared libs they need. Run by default
1.10 hubertf 6578: 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 6579: <dt><span class="term">print-PLIST</span></dt>
6580: <dd>
1.23 wiz 6581: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6582: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6583: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6584: -newer work/.extract_done</strong></span>. An attempt is made
6585: to care for shared libs etc., but it is
6586: <span class="emphasis"><em>strongly</em></span> recommended to review the
6587: result before putting it into
6588: <code class="filename">PLIST</code>. On upgrades, it's useful to
6589: diff the output of this command against an already
6590: existing <code class="filename">PLIST</code> file.</p>
1.79 snj 6591: <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 6592: other methods that don't update file access times, be
6593: sure to add these files manually to your
1.23 wiz 6594: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6595: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6596: them!</p>
1.23 wiz 6597: <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 6598: information on this target.</p>
6599: </dd>
6600: <dt><span class="term">bulk-package</span></dt>
6601: <dd>
6602: <p>Used to do bulk builds. If an appropriate binary
6603: package already exists, no action is taken. If not, this
6604: target will compile, install and package it (and its
6605: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 6606: 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
6607: builds)</i></a>).
1.1 dsieger 6608: After creating the binary package, the sources, the
6609: just-installed package and its required packages are
6610: removed, preserving free disk space.</p>
6611: <p><span class="emphasis"><em>Beware that this target may deinstall
6612: all packages installed on a system!</em></span></p>
6613: </dd>
6614: <dt><span class="term">bulk-install</span></dt>
6615: <dd>
6616: <p>Used during bulk-installs to install required
6617: packages. If an up-to-date binary package is available,
1.79 snj 6618: 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 6619: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6620: but the installed binary won't be removed.</p>
6621: <p>A binary package is considered
1.23 wiz 6622: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.79 snj 6623: <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 6624: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6625: <li class="listitem"><p>None of the package's files
1.1 dsieger 6626: (<code class="filename">Makefile</code>, ...) were modified
6627: since it was built.</p></li>
1.23 wiz 6628: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6629: packages were modified since it was built.</p></li>
6630: </ul></div>
6631: <p><span class="emphasis"><em>Beware that this target may deinstall
6632: all packages installed on a system!</em></span></p>
6633: </dd>
6634: </dl></div>
6635: </div>
6636: </div>
1.41 asau 6637: <div class="chapter">
1.1 dsieger 6638: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6639: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6640: <div class="toc">
6641: <p><b>Table of Contents</b></p>
1.100 leot 6642: <dl class="toc">
1.6 rillig 6643: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
6644: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
6645: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6646: </dl>
6647: </div>
6648: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6649: by pkgsrc and also for individual packages to define what commands
6650: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
6651: or for later run-time of an installed packaged (such as
6652: <code class="varname">DEPENDS</code>).
6653: If the native system provides an adequate tool, then in many cases, a pkgsrc
6654: package will not be used.</p>
6655: <p>When building a package, the replacement tools are
6656: made available in a directory (as symlinks or wrapper scripts)
6657: that is early in the executable search path. Just like the buildlink
6658: system, this helps with consistent builds.</p>
6659: <p>A tool may be needed to help build a specific package. For example,
6660: perl, GNU make (gmake) or yacc may be needed.</p>
6661: <p>Also a tool may be needed, for example, because the native system's supplied
6662: tool may be inefficient for building a package with pkgsrc.
6663: For example, a package may need GNU awk, bison (instead of
6664: yacc) or a better sed.</p>
6665: <p>The tools used by a package can be listed by running
1.10 hubertf 6666: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6667: <div class="sect1">
1.1 dsieger 6668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6669: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6670: <p>The default set of tools used by pkgsrc is defined in
6671: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6672: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6673: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6674: These can be seen by running:
1.10 hubertf 6675: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6676: <p>If a package needs a specific program to build
6677: then the <code class="varname">USE_TOOLS</code> variable can be used
6678: to define the tools needed.</p>
6679: </div>
1.41 asau 6680: <div class="sect1">
1.1 dsieger 6681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6682: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6683: <p>In the following examples, the :run means that it is needed at
6684: run-time (and becomes a DEPENDS).
1.1 dsieger 6685: The default is a build dependency which can be set with
6686: :build. (So in this example, it is the same as gmake:build
6687: and pkg-config:build.)</p>
6688: <pre class="programlisting">
6689: USE_TOOLS+= gmake perl:run pkg-config
6690: </pre>
6691: <p>When using the tools framework, a
6692: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6693: which contains the full path to the appropriate tool. For example,
1.23 wiz 6694: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6695: on Linux systems.</p>
6696: <p>If you always need a pkgsrc version of the
6697: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6698: </p>
6699: </div>
1.41 asau 6700: <div class="sect1">
1.1 dsieger 6701: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6702: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6703: <p>When improving or porting pkgsrc to a new platform, have a look
6704: at (or create) the corresponding platform specific make file fragment under
6705: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6706: the name of the common tools. For example:</p>
6707: <pre class="programlisting">
6708: .if exists(/usr/bin/bzcat)
6709: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6710: .elif exists(/usr/bin/bzip2)
6711: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6712: .endif
6713:
6714: TOOLS_PLATFORM.true?= true # shell builtin
6715: </pre>
6716: </div>
6717: </div>
1.41 asau 6718: <div class="chapter">
1.1 dsieger 6719: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6720: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 6721: <div class="toc">
6722: <p><b>Table of Contents</b></p>
1.100 leot 6723: <dl class="toc">
1.6 rillig 6724: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 6725: <dd><dl>
1.108 rillig 6726: <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>
6727: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
6728: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
6729: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
6730: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
6731: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
6732: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
6733: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
6734: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
6735: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6736: <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 6737: </dl></dd>
1.108 rillig 6738: <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 6739: <dd><dl>
6740: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6741: <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 6742: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 6743: </dl></dd>
1.108 rillig 6744: <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 6745: <dd><dl>
6746: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
6747: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6748: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
6749: </dl></dd>
6750: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
6751: <dd><dl>
6752: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
6753: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
6754: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 6755: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
6756: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 6757: </dl></dd>
1.108 rillig 6758: <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 6759: <dd><dl>
6760: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
6761: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 6762: <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 6763: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
6764: </dl></dd>
1.108 rillig 6765: <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 6766: <dd><dl>
6767: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
6768: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
6769: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
6770: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
6771: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6772: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
6773: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
6774: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 6775: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 6776: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 6777: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
6778: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
6779: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
6780: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
6781: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
6782: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
6783: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
6784: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 6785: emulation</a></span></dt>
1.6 rillig 6786: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
6787: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6788: </dl></dd>
1.6 rillig 6789: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6790: </dl>
6791: </div>
1.41 asau 6792: <div class="sect1">
1.1 dsieger 6793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6794: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 6795: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6796: different platforms. As a result, it is important to ensure,
6797: where possible, that packages in pkgsrc are portable. This
6798: chapter mentions some particular details you should pay
6799: attention to while working on pkgsrc.</p>
1.41 asau 6800: <div class="sect2">
1.1 dsieger 6801: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6802: <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 6803: </h3></div></div></div>
6804: <p>The pkgsrc user can configure pkgsrc by overriding several
6805: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6806: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6807: want to use those variables in the preprocessor directives of
1.79 snj 6808: <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 6809: <code class="literal">.for</code>), you need to include the file
6810: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6811: loads the user preferences.</p>
6812: <p>But note that some variables may not be completely defined
6813: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6814: included, as they may contain references to variables that are
1.108 rillig 6815: not yet defined. In shell commands (the lines in
6816: <code class="filename">Makefile</code> that are indented with a tab) this
6817: is no problem, since variables are only expanded when they are
6818: used. But in the preprocessor directives mentioned above and in
6819: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6820: dependencies</code>) the variables are expanded at load
6821: time.</p>
1.41 asau 6822: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6823: <h3 class="title">Note</h3>
1.108 rillig 6824: <p>To check whether a variable can be used at load time,
6825: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6826: </div>
6827: </div>
1.41 asau 6828: <div class="sect2">
1.1 dsieger 6829: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6830: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6831: <p>Occasionally, packages require interaction from the user,
6832: and this can be in a number of ways:</p>
1.41 asau 6833: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6834: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 6835: interaction such as entering username/password or accepting a
6836: license on a web page.</p></li>
1.23 wiz 6837: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 6838: passwords.</p></li>
1.23 wiz 6839: <li class="listitem"><p>help to configure the package before it is built</p></li>
6840: <li class="listitem"><p>help during the build process</p></li>
6841: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 6842: </ul></div>
1.108 rillig 6843: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6844: variable to define which stages need interaction. This should be
6845: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 6846: <pre class="programlisting">
6847: INTERACTIVE_STAGE= configure install
1.111 ! sevan 6848: </pre>
1.1 dsieger 6849: <p>The user can then decide to skip this package by setting the
1.108 rillig 6850: <code class="varname">BATCH</code> variable. Packages that require interaction
6851: are also excluded from bulk builds.</p>
1.1 dsieger 6852: </div>
1.41 asau 6853: <div class="sect2">
1.1 dsieger 6854: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6855: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.111 ! sevan 6856: <p>Authors of software can choose the licence under which software
! 6857: can be copied. The Free Software Foundation has declared some
! 6858: licenses "Free", and the Open Source Initiative has a definition of
! 6859: "Open Source".</p>
! 6860: <p>By default, pkgsrc allows packages with Free or Open Source
! 6861: licenses to be built. To allow packages with other licenses to be
! 6862: built as well, the pkgsrc user needs to add these licenses to the
! 6863: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
! 6864: that this variable only affects which packages may be
! 6865: <span class="emphasis"><em>built</em></span>, while the license terms often also
! 6866: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 6867: <p>One might want to only install packages with a BSD license,
1.108 rillig 6868: or the GPL, and not the other. The free licenses are added to the
1.111 ! sevan 6869: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 6870: user can override the default by setting the
6871: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 ! sevan 6872: of "+=". The licenses accepted by default are defined in the
! 6873: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
! 6874: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 6875: <p>The license tag mechanism is intended to address
6876: copyright-related issues surrounding building, installing and
6877: using a package, and not to address redistribution issues (see
6878: <code class="varname">RESTRICTED</code> and
1.111 ! sevan 6879: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 6880: Packages with redistribution restrictions should set these
6881: tags.</p>
1.1 dsieger 6882: <p>Denoting that a package may be copied according to a
6883: particular license is done by placing the license in
6884: <code class="filename">pkgsrc/licenses</code> and setting the
6885: <code class="varname">LICENSE</code> variable to a string identifying the
1.79 snj 6886: 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 6887: <pre class="programlisting">
6888: LICENSE= xv-license
1.111 ! sevan 6889: </pre>
1.1 dsieger 6890: <p>When trying to build, the user will get a notice that the
6891: package is covered by a license which has not been placed in the
6892: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
6893: <pre class="programlisting">
6894: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6895: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6896: ===> To view the license, enter "/usr/bin/make show-license".
6897: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6898: ===> ACCEPTABLE_LICENSES+=xv-license
6899: *** Error code 1
1.111 ! sevan 6900: </pre>
1.10 hubertf 6901: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 6902: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 6903: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 6904: convey to pkgsrc that it should not in the future fail because of
6905: that license:</p>
6906: <pre class="programlisting">
6907: ACCEPTABLE_LICENSES+=xv-license
1.111 ! sevan 6908: </pre>
! 6909: <p>The use of <code class="varname">LICENSE=shareware</code>,
! 6910: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
! 6911: is deprecated because it does not crisply refer to a particular
! 6912: license text. Another problem with such usage is that it does not
! 6913: enable a user to tell pkgsrc to proceed for a single package
! 6914: without also telling pkgsrc to proceed for all packages with that
! 6915: tag.</p>
! 6916: <div class="sect3">
! 6917: <div class="titlepage"><div><div><h4 class="title">
! 6918: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 6919: <p>When adding a package with a new license, the following steps
6920: are required:</p>
6921: <div class="orderedlist"><ol class="orderedlist" type="1">
6922: <li class="listitem">
1.111 ! sevan 6923: <p>Check whether the license qualifies as Free or Open
! 6924: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
! 6925: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
! 6926: Open Source Initiative</a>. If this is the case, the filename in
! 6927: <code class="filename">pkgsrc/licenses/</code> does not need the
! 6928: <code class="filename">-license</code> suffix, and the license name should be
! 6929: added to:</p>
1.48 rodent 6930: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6931: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
6932: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
6933: </ul></div>
6934: </li>
6935: <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>
6936: </ol></div>
1.111 ! sevan 6937: </div>
! 6938: <div class="sect3">
! 6939: <div class="titlepage"><div><div><h4 class="title">
! 6940: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 6941: <p>When the license changes (in a way other than formatting),
1.111 ! sevan 6942: make sure that the new license has a different name (e.g.,
1.1 dsieger 6943: append the version number if it exists, or the date). Just
6944: because a user told pkgsrc to build programs under a previous
6945: version of a license does not mean that pkgsrc should build
6946: programs under the new licenses. The higher-level point is that
6947: pkgsrc does not evaluate licenses for reasonableness; the only
6948: test is a mechanistic test of whether a particular text has been
1.111 ! sevan 6949: approved by either of two bodies (FSF or OSI).</p>
! 6950: </div>
1.1 dsieger 6951: </div>
1.41 asau 6952: <div class="sect2">
1.1 dsieger 6953: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6954: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 6955: <p>Some licenses restrict how software may be re-distributed.
1.111 ! sevan 6956: By declaring the restrictions, package tools can
1.1 dsieger 6957: automatically refrain from e.g. placing binary packages on FTP
6958: sites.</p>
1.111 ! sevan 6959: <p>There are four possible restrictions, which are
1.1 dsieger 6960: the cross product of sources (distfiles) and binaries not being
6961: placed on FTP sites and CD-ROMs. Because this is rarely the exact
6962: language in any license, and because non-Free licenses tend to be
6963: different from each other, pkgsrc adopts a definition of FTP and
1.111 ! sevan 6964: CD-ROM.
! 6965:
! 6966: "FTP" means making the source or binary file available over the
! 6967: Internet at no charge.
! 6968:
! 6969: "CD-ROM" means making the source or binary available on some kind of
! 6970: media, together with other source and binary packages, which is sold
! 6971: for a distribution charge.
1.1 dsieger 6972: </p>
6973: <p>In order to encode these restrictions, the package system
6974: defines five make variables that can be set to note these
6975: restrictions:</p>
1.41 asau 6976: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6977: <li class="listitem">
1.1 dsieger 6978: <p><code class="varname">RESTRICTED</code></p>
6979: <p>This variable should be set whenever a restriction
6980: exists (regardless of its kind). Set this variable to a
6981: string containing the reason for the restriction. It should
6982: be understood that those wanting to understand the restriction
6983: will have to read the license, and perhaps seek advice of
6984: counsel.</p>
6985: </li>
1.23 wiz 6986: <li class="listitem">
1.1 dsieger 6987: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
6988: <p>Binaries may not be placed on CD-ROM containing other
6989: binary packages, for which a distribution charge may be made.
6990: In this case, set this variable to
6991: <code class="varname">${RESTRICTED}</code>.</p>
6992: </li>
1.23 wiz 6993: <li class="listitem">
1.1 dsieger 6994: <p><code class="varname">NO_BIN_ON_FTP</code></p>
6995: <p>Binaries may not made available on the Internet without
6996: charge. In this case, set this variable to
6997: <code class="varname">${RESTRICTED}</code>. If this variable is set,
6998: binary packages will not be included on ftp.NetBSD.org.</p>
6999: </li>
1.23 wiz 7000: <li class="listitem">
1.1 dsieger 7001: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7002: <p>Distfiles may not be placed on CD-ROM, together with
7003: other distfiles, for which a fee may be charged. In this
7004: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7005: </p>
7006: </li>
1.23 wiz 7007: <li class="listitem">
1.1 dsieger 7008: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7009: <p>Distfiles may not made available via FTP at no charge.
7010: In this case, set this variable to
7011: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7012: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7013: </li>
7014: </ul></div>
1.111 ! sevan 7015: <p>Please note that packages will be removed from pkgsrc when the
! 7016: distfiles are not distributable and cannot be obtained for a period
! 7017: of one full quarter branch. Packages with manual/interactive fetch
! 7018: must have a maintainer and it is his/her responsibility to ensure
! 7019: this.</p>
1.1 dsieger 7020: </div>
1.41 asau 7021: <div class="sect2">
1.1 dsieger 7022: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7023: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7024: <p>Your package may depend on some other package being present
7025: - and there are various ways of expressing this dependency.
7026: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7027: <code class="varname">DEPENDS</code> definitions, the
7028: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7029: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7030: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7031: 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 7032: <p>The basic difference between the two variables is as
7033: follows: The <code class="varname">DEPENDS</code> definition registers
7034: that pre-requisite in the binary package so it will be pulled in
7035: when the binary package is later installed, whilst the
7036: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7037: dependency that is only needed for building the package.</p>
7038: <p>This means that if you only need a package present whilst
7039: you are building, it should be noted as a
7040: <code class="varname">BUILD_DEPENDS</code>.</p>
7041: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7042: <code class="varname">DEPENDS</code> definition is:</p>
7043: <pre class="programlisting">
7044: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 ! sevan 7045: </pre>
1.23 wiz 7046: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7047: may include any of the wildcard version numbers recognized by
1.79 snj 7048: <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 7049: <div class="orderedlist"><ol class="orderedlist" type="1">
7050: <li class="listitem">
1.1 dsieger 7051: <p>If your package needs another package's binaries or
1.54 wiz 7052: libraries to build and run, and if that package has a
1.1 dsieger 7053: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7054: <pre class="programlisting">
7055: .include "../../graphics/jpeg/buildlink3.mk"
1.111 ! sevan 7056: </pre>
1.1 dsieger 7057: </li>
1.23 wiz 7058: <li class="listitem">
1.54 wiz 7059: <p>If your package needs another package's binaries or
7060: libraries only for building, and if that package has a
7061: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7062: <pre class="programlisting">
7063: .include "../../graphics/jpeg/buildlink3.mk"
1.111 ! sevan 7064: </pre>
1.54 wiz 7065: <p>but set
7066: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7067: to make it a build dependency only. This case is rather
7068: rare.</p>
7069: </li>
7070: <li class="listitem">
1.25 spz 7071: <p>If your package needs binaries from another package to build,
7072: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7073: <pre class="programlisting">
1.25 spz 7074: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.111 ! sevan 7075: </pre>
1.1 dsieger 7076: </li>
1.25 spz 7077: <li class="listitem"><p>If your package needs a library with which to link and
7078: there is no <code class="filename">buildlink3.mk</code> file
7079: available, create one. Using
7080: <code class="varname">DEPENDS</code> won't be sufficient because the
7081: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7082: <li class="listitem">
1.25 spz 7083: <p>If your package needs some executable to be able to run
7084: correctly and if there's no
7085: <code class="filename">buildlink3.mk</code> file, this is specified
7086: using the <code class="varname">DEPENDS</code> variable. The
1.79 snj 7087: <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 7088: be able to execute the latex binary from the teTeX package
7089: when it runs, and that is specified:</p>
1.1 dsieger 7090: <pre class="programlisting">
1.25 spz 7091: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.111 ! sevan 7092: </pre>
1.25 spz 7093: </li>
7094: <li class="listitem">
7095: <p>You can use wildcards in package dependencies. Note that
7096: such wildcard dependencies are retained when creating binary
7097: packages. The dependency is checked when installing the binary
7098: package and any package which matches the pattern will be
7099: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7100: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7101: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7102: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7103: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7104: <p>Wildcards can also be used to specify that a package
7105: will only build against a certain minimum version of a
7106: pre-requisite:</p>
7107: <pre class="programlisting">
1.25 spz 7108: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 ! sevan 7109: </pre>
1.25 spz 7110: <p>This means that the package will build using version 6.0
7111: of ImageMagick or newer. Such a dependency may be warranted
7112: if, for example, the command line options of an executable
7113: have changed.</p>
7114: <p>If you need to depend on minimum versions of libraries,
7115: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7116: <p>For security fixes, please update the package
1.108 rillig 7117: 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 7118: information.</p>
7119: </li>
7120: </ol></div>
7121: <p>If your package needs files from another package to build,
7122: add the relevant distribution files to
7123: <code class="varname">DISTFILES</code>, so they will be extracted
1.79 snj 7124: 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 7125: (It relies on the jpeg sources being present in source form
7126: during the build.)</p>
7127: </div>
1.41 asau 7128: <div class="sect2">
1.1 dsieger 7129: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7130: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7131: <p>Your package may conflict with other packages a user might
7132: already have installed on his system, e.g. if your package
7133: installs the same set of files as another package in the pkgsrc
1.80 wiz 7134: tree or has the same <code class="varname">PKGNAME</code>.</p>
7135: <p>These cases are handled automatically by the packaging tools
7136: at package installation time and do not need to be handled
7137: manually.</p>
7138: <p>In case the conflicts can not be recognized automatically
7139: (e.g., packages using the same config file location but no other
7140: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7141: space-separated list of packages (including version string) your
7142: package conflicts with.</p>
1.80 wiz 7143: <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>
7144: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7145: use the same config file, you would set in
7146: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7147: <pre class="programlisting">
1.80 wiz 7148: CONFLICTS= baz-[0-9]*
1.111 ! sevan 7149: </pre>
1.80 wiz 7150: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7151: <pre class="programlisting">
1.80 wiz 7152: CONFLICTS= bar-[0-9]*
1.111 ! sevan 7153: </pre>
1.1 dsieger 7154: </div>
1.41 asau 7155: <div class="sect2">
1.1 dsieger 7156: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7157: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7158: <p>There are several reasons why a package might be
7159: instructed to not build under certain circumstances. If the
7160: package builds and runs on most platforms, the exceptions
1.83 dholland 7161: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7162: the package builds and runs on a small handful of platforms,
7163: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7164: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7165: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7166: (OS-version-platform) that can use glob-style
7167: wildcards.</p>
7168: <p>If a package is not appropriate for some platforms (as
7169: oopposed to merely broken), a different set of variables should be
7170: used as this affects failure reporting and statistics.
7171: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7172: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7173: the package is appropriate for only a small handful of platforms
7174: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7175: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7176: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7177: (OS-version-platform) that can use glob-style
7178: wildcards.</p>
7179: <p>Some packages are tightly bound to a specific version of an
1.79 snj 7180: 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 7181: backwards compatible with other versions of the OS, and should be
7182: uploaded to a version specific directory on the FTP server. Mark
7183: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7184: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7185: the package system internals, but may be used in the
7186: future.</p>
7187: <p>If the package should be skipped (for example, because it
7188: provides functionality already provided by the system), set
7189: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7190: the package should fail because some preconditions are not met,
7191: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7192: message.</p>
7193: </div>
1.41 asau 7194: <div class="sect2">
1.1 dsieger 7195: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7196: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7197: <p>To ensure that a package may not be deleted, once it has been
7198: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7199: be set in the package Makefile. This will be carried into any
7200: binary package that is made from this pkgsrc entry. A
1.23 wiz 7201: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.79 snj 7202: 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 7203: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7204: </div>
1.41 asau 7205: <div class="sect2">
1.1 dsieger 7206: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7207: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7208: <p>When a vulnerability is found, this should be noted in
7209: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7210: and after committing that file, ask pkgsrc-security@NetBSD.org to
7211: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7212: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7213: <code class="varname">PKGREVISION</code> should be increased (this is of
7214: course not necessary if the problem is fixed by using a newer
7215: release of the software), and the pattern in the
7216: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7217: <p>Also, if the fix should be applied to the stable pkgsrc
7218: branch, be sure to submit a pullup request!</p>
7219: <p>Binary packages already on ftp.NetBSD.org will be handled
7220: semi-automatically by a weekly cron job.</p>
7221: </div>
1.41 asau 7222: <div class="sect2">
1.1 dsieger 7223: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7224: <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 7225: <p>When making fixes to an existing package it can be useful
7226: to change the version number in <code class="varname">PKGNAME</code>. To
7227: avoid conflicting with future versions by the original author, a
1.23 wiz 7228: <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 7229: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7230: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7231: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7232: <pre class="programlisting">
7233: DISTNAME= foo-17.42
7234: PKGREVISION= 9
1.111 ! sevan 7235: </pre>
1.1 dsieger 7236: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7237: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7238: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7239: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7240: <code class="varname">PKGNAME_NOREV</code>.</p>
7241: <p>When a new release of the package is released, the
7242: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7243: minor release of the above package, things should be like:</p>
7244: <pre class="programlisting">
7245: DISTNAME= foo-17.43
1.111 ! sevan 7246: </pre>
1.1 dsieger 7247: <p><code class="varname">PKGREVISION</code> should be incremented for any
7248: non-trivial change in the resulting binary package. Without a
7249: <code class="varname">PKGREVISION</code> bump, someone with the previous
7250: version installed has no way of knowing that their package is out
7251: of date. Thus, changes without increasing
7252: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7253: trivial that no reasonable person would want to upgrade", and this
7254: is the rough test for when increasing
7255: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7256: changes that do not merit increasing
7257: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7258: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7259: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7260: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7261: or comments in Makefile.</p></li>
1.23 wiz 7262: <li class="listitem"><p>
1.1 dsieger 7263: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7264: <li class="listitem"><p>
1.1 dsieger 7265: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7266: <li class="listitem"><p>
1.1 dsieger 7267: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7268: </ul></div>
7269: <p>Examples of changes that do merit an increase to
7270: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7271: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7272: <li class="listitem"><p>
1.1 dsieger 7273: Security fixes</p></li>
1.23 wiz 7274: <li class="listitem"><p>
1.1 dsieger 7275: Changes or additions to a patch file</p></li>
1.23 wiz 7276: <li class="listitem"><p>
1.1 dsieger 7277: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 7278: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 7279: </ul></div>
7280: <p>PKGREVISION must also be incremented when dependencies have ABI
7281: changes.</p>
7282: </div>
1.41 asau 7283: <div class="sect2">
1.1 dsieger 7284: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7285: <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 7286: <p>When you want to replace the same text in multiple files
7287: or when the replacement text varies, patches alone cannot help.
7288: This is where the SUBST framework comes in. It provides an
7289: easy-to-use interface for replacing text in files.
7290: Example:</p>
7291: <pre class="programlisting">
7292: SUBST_CLASSES+= fix-paths
7293: SUBST_STAGE.fix-paths= pre-configure
7294: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7295: SUBST_FILES.fix-paths= src/*.c
7296: SUBST_FILES.fix-paths+= scripts/*.sh
7297: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7298: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 ! sevan 7299: </pre>
1.1 dsieger 7300: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7301: that are used to identify the different SUBST blocks that are
7302: defined. The SUBST framework is heavily used by pkgsrc, so it is
7303: important to always use the <code class="literal">+=</code> operator with
7304: this variable. Otherwise some substitutions may be
7305: skipped.</p>
7306: <p>The remaining variables of each SUBST block are
7307: parameterized with the identifier from the first line
7308: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7309: parameters to a function call.</p>
7310: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7311: which the replacement will take place. All combinations of
7312: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7313: <code class="literal">post-</code> together with a phase name are
7314: possible, though only few are actually used. Most commonly used
7315: are <code class="literal">post-patch</code> and
7316: <code class="literal">pre-configure</code>. Of these two,
7317: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7318: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7319: have the state after applying the patches but before making any
7320: other changes. This is especially useful when you are debugging
7321: a package in order to create new patches for it. Similarly,
7322: <code class="literal">post-build</code> is preferred over
7323: <code class="literal">pre-install</code>, because the install phase should
7324: generally be kept as simple as possible. When you use
7325: <code class="literal">post-build</code>, you have the same files in the
7326: working directory that will be installed later, so you can check
7327: if the substitution has succeeded.</p>
7328: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7329: that is printed just before the substitution is done.</p>
7330: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7331: globbing patterns that specifies the files in which the
7332: substitution will take place. The patterns are interpreted
7333: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7334: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.79 snj 7335: <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 7336: command should be prefixed with <code class="literal">-e</code>, so that
7337: all SUBST blocks look uniform.</p>
7338: <p>There are some more variables, but they are so seldomly
7339: used that they are only documented in the
7340: <code class="filename">mk/subst.mk</code> file.</p>
7341: </div>
7342: </div>
1.41 asau 7343: <div class="sect1">
1.1 dsieger 7344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7345: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7346: <div class="sect2">
1.1 dsieger 7347: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7348: <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 7349: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7350: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7351: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7352: with the name of each file to download as an argument, expecting
7353: it to output the URL of the directory from which to download
1.79 snj 7354: 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 7355: example of this usage.</p>
7356: <p>If the download can't be automated, because the user must
7357: submit personal information to apply for a password, or must pay
7358: for the source, or whatever, you can set
7359: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7360: displayed to the user before aborting the build. Example:</p>
7361: <pre class="programlisting">
7362: FETCH_MESSAGE= "Please download the files"
7363: FETCH_MESSAGE+= " "${DISTFILES:Q}
7364: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 ! sevan 7365: </pre>
1.1 dsieger 7366: </div>
1.41 asau 7367: <div class="sect2">
1.1 dsieger 7368: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7369: <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 7370: <p>Sometimes authors of a software package make some
7371: modifications after the software was released, and they put up a
7372: new distfile without changing the package's version number. If a
7373: package is already in pkgsrc at that time, the checksum will
7374: no longer match. The contents of the new distfile should be
7375: compared against the old one before changing anything, to make
7376: sure the distfile was really updated on purpose, and that
7377: no trojan horse or so crept in.
7378: Please mention that the distfiles were compared and what was found
1.53 rodent 7379: in your commit message.</p>
1.109 wiz 7380: <p>Then, the correct way to work around this is to set
7381: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7382: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7383: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7384: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7385: <code class="varname">PATCHFILES</code> for this package will be put in that
1.109 wiz 7386: 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 7387: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7388: including the <code class="filename">nbX</code> suffix) or a date stamp can
7389: be appended, like
7390: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53 rodent 7391: <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>
7392: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7393: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7394: path in the filenames.
1.53 rodent 7395: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7396: Furthermore, a mail to the package's authors seems appropriate
7397: telling them that changing distfiles after releases without
7398: changing the file names is not good practice.</p>
7399: </div>
1.88 tnn 7400: <div class="sect2">
7401: <div class="titlepage"><div><div><h3 class="title">
7402: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 7403: <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:
7404: </p>
1.88 tnn 7405: <div class="sect3">
7406: <div class="titlepage"><div><div><h4 class="title">
7407: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
7408: <p>
7409: 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.
7410: </p>
7411: <pre class="programlisting">
7412: DISTNAME= exampleproject-1.0
1.90 tnn 7413: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7414: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7415: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7416: EXTRACT_SUFX= .zip
7417: </pre>
7418: </div>
7419: <div class="sect3">
7420: <div class="titlepage"><div><div><h4 class="title">
7421: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
7422: <p>
7423: 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.
7424: </p>
7425: <pre class="programlisting">
7426: DISTNAME= example-1.0
1.107 jnemeth 7427: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7428: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7429: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 ! sevan 7430: </pre>
1.88 tnn 7431: </div>
7432: <div class="sect3">
7433: <div class="titlepage"><div><div><h4 class="title">
7434: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
7435: <p>
7436: 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.
7437: </p>
7438: <pre class="programlisting">
7439: DISTNAME= offensive-1.6
1.90 tnn 7440: PKGNAME= ${DISTNAME:S/offensive/proper/}
7441: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7442: GITHUB_PROJECT= exampleproject
7443: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7444: EXTRACT_SUFX= .zip
1.111 ! sevan 7445: </pre>
1.88 tnn 7446: </div>
7447: </div>
1.1 dsieger 7448: </div>
1.41 asau 7449: <div class="sect1">
1.1 dsieger 7450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7451: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7452: <div class="sect2">
1.1 dsieger 7453: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7454: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7455: <p>pkgsrc supports many different machines, with different
7456: object formats like a.out and ELF, and varying abilities to do
7457: shared library and dynamic loading at all. To accompany this,
7458: varying commands and options have to be passed to the
7459: compiler, linker, etc. to get the Right Thing, which can be
7460: pretty annoying especially if you don't have all the machines
7461: at your hand to test things. The
1.79 snj 7462: <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 7463: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7464: both static and dynamic libraries from a set of source files,
7465: thus being platform-independent.</p>
7466: <p>Here's how to use libtool in a package in seven simple
7467: steps:</p>
1.23 wiz 7468: <div class="orderedlist"><ol class="orderedlist" type="1">
7469: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7470: Makefile.</p></li>
1.23 wiz 7471: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7472: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7473: add it to the definition of <code class="varname">CC</code>, if only
7474: libraries are being built in a given Makefile. This one command
7475: will build both PIC and non-PIC library objects, so you need not
7476: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7477: <li class="listitem">
1.1 dsieger 7478: <p>For the linking of the library, remove any
1.23 wiz 7479: <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
7480: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7481: <pre class="programlisting">
7482: ${LIBTOOL} --mode=link \
7483: ${CC} -o ${.TARGET:.a=.la} \
7484: ${OBJS:.o=.lo} \
7485: -rpath ${PREFIX}/lib \
7486: -version-info major:minor
1.111 ! sevan 7487: </pre>
1.1 dsieger 7488: <p>Note that the library is changed to have a
7489: <code class="filename">.la</code> extension, and the objects are
7490: changed to have a <code class="filename">.lo</code>
7491: extension. Change <code class="varname">OBJS</code> as
7492: necessary. This automatically creates all of the
7493: <code class="filename">.a</code>,
7494: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7495: necessary) in the build directory. Be sure to include
1.23 wiz 7496: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7497: minor are zero, as libtool will otherwise strip off the
7498: shared library version.</p>
7499: <p>From the libtool manual:</p>
7500: <pre class="programlisting">
7501: So, libtool library versions are described by three integers:
7502:
7503: CURRENT
7504: The most recent interface number that this library implements.
7505:
7506: REVISION
7507: The implementation number of the CURRENT interface.
7508:
7509: AGE
7510: The difference between the newest and oldest interfaces that
7511: this library implements. In other words, the library implements
7512: all the interface numbers in the range from number `CURRENT -
7513: AGE' to `CURRENT'.
7514:
7515: If two libraries have identical CURRENT and AGE numbers, then the
7516: dynamic linker chooses the library with the greater REVISION number.
1.111 ! sevan 7517: </pre>
1.23 wiz 7518: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7519: different results for a.out and ELF (excluding symlinks)
7520: in only one case. An ELF library of the form
1.23 wiz 7521: <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 7522: will have a symlink of
1.23 wiz 7523: <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 7524: on an a.out platform. This is handled
7525: automatically.</p>
1.23 wiz 7526: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7527: directory of the library being built.</p>
7528: <p>In the <code class="filename">PLIST</code>, include only the
7529: <code class="filename">.la</code> file, the other files will be
7530: added automatically.</p>
7531: </li>
1.23 wiz 7532: <li class="listitem">
1.1 dsieger 7533: <p>When linking shared object (<code class="filename">.so</code>)
1.79 snj 7534: 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 7535: shared libraries, use <span class="quote">“<span class="quote">-module
7536: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7537: tacked on.</p>
7538: <p>The <code class="filename">PLIST</code> file gets the
7539: <code class="filename">foo.so</code> entry.</p>
7540: </li>
1.23 wiz 7541: <li class="listitem">
1.1 dsieger 7542: <p>When linking programs that depend on these libraries
7543: <span class="emphasis"><em>before</em></span> they are installed, preface
1.79 snj 7544: 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 7545: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7546: libraries (static or shared), but please be aware that
7547: libtool will not allow you to specify a relative path in
1.23 wiz 7548: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7549: expects you to change that argument to be the
7550: <code class="filename">.la</code> file. e.g.</p>
7551: <pre class="programlisting">
7552: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 ! sevan 7553: </pre>
1.1 dsieger 7554: <p>should be changed to:</p>
7555: <pre class="programlisting">
7556: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 ! sevan 7557: </pre>
1.1 dsieger 7558: <p>and it will do the right thing with the libraries.</p>
7559: </li>
1.23 wiz 7560: <li class="listitem">
1.79 snj 7561: <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>
7562: 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 7563: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7564: <code class="filename">.la</code>. e.g.</p>
7565: <pre class="programlisting">
1.22 jakllsch 7566: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 ! sevan 7567: </pre>
1.1 dsieger 7568: <p>This will install the static <code class="filename">.a</code>,
7569: shared library, any needed symlinks, and run
1.79 snj 7570: <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 7571: </li>
1.23 wiz 7572: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7573: the <code class="filename">.la</code>
7574: file (this is a change from previous behaviour).</p></li>
7575: </ol></div>
7576: </div>
1.41 asau 7577: <div class="sect2">
1.1 dsieger 7578: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7579: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7580: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7581: package Makefile. This will override the package's own libtool
7582: in most cases. For older libtool using packages, libtool is
7583: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7584: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7585: configure; find work*/ -name libtool</strong></span>.</p>
7586: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7587: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7588: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7589: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7590: package's libtool script(s), set it as appropriate.</p>
7591: <p>If you do not need <code class="filename">*.a</code> static
7592: libraries built and installed, then use
7593: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7594: <p>If your package makes use of the platform-independent library
7595: for loading dynamic shared objects, that comes with libtool
7596: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7597: <p>Some packages use libtool incorrectly so that the package
7598: may not work or build in some circumstances. Some of the more
7599: common errors are:</p>
1.41 asau 7600: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7601: <li class="listitem">
1.1 dsieger 7602: <p>The inclusion of a shared object (-module) as a dependent library in an
7603: executable or library. This in itself isn't a problem if one of two things
7604: has been done:</p>
1.23 wiz 7605: <div class="orderedlist"><ol class="orderedlist" type="1">
7606: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7607: <code class="filename">libfoo.la</code>, not
7608: <code class="filename">foo.la</code></p></li>
1.23 wiz 7609: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7610: </ol></div>
7611: </li>
1.23 wiz 7612: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7613: The function lt_dlinit() should be called and the macro
7614: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7615: executables.</p></li>
7616: </ul></div>
7617: </div>
1.41 asau 7618: <div class="sect2">
1.1 dsieger 7619: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7620: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7621: <p>If a package needs GNU autoconf or automake to be executed
7622: to regenerate the configure script and Makefile.in makefile
7623: templates, then they should be executed in a pre-configure
7624: target.</p>
7625: <p>For packages that need only autoconf:</p>
7626: <pre class="programlisting">
7627: AUTOCONF_REQD= 2.50 # if default version is not good enough
7628: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7629: ...
7630:
7631: pre-configure:
7632: cd ${WRKSRC} && autoconf
7633:
7634: ...
1.111 ! sevan 7635: </pre>
1.1 dsieger 7636: <p>and for packages that need automake and autoconf:</p>
7637: <pre class="programlisting">
7638: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7639: USE_TOOLS+= automake # use "automake14" for automake-1.4
7640: ...
7641:
7642: pre-configure:
7643: set -e; cd ${WRKSRC}; \
7644: aclocal; autoheader; automake -a --foreign -i; autoconf
7645:
7646: ...
1.111 ! sevan 7647: </pre>
1.1 dsieger 7648: <p>Packages which use GNU Automake will almost certainly
7649: require GNU Make.</p>
7650: <p>There are times when the configure process makes
7651: additional changes to the generated files, which then causes
7652: the build process to try to re-execute the automake sequence.
7653: This is prevented by touching various files in the configure
7654: stage. If this causes problems with your package you can set
7655: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7656: Makefile.</p>
7657: </div>
7658: </div>
1.41 asau 7659: <div class="sect1">
1.1 dsieger 7660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7661: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 7662: <div class="sect2">
1.1 dsieger 7663: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7664: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7665: <p>Compilers for the C, C++, and Fortran languages comes with
7666: the NetBSD base system. By default, pkgsrc assumes that a package
7667: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 7668: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7669: <p>To declare which language's compiler a package needs, set
7670: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7671: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7672: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7673: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7674: written in C++, usually need a C compiler for the configure
7675: phase.</p>
7676: </div>
1.41 asau 7677: <div class="sect2">
1.1 dsieger 7678: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7679: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 7680: <p>If a program is written in Java, use the Java framework in
7681: pkgsrc. The package must include
7682: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7683: provides the following variables:</p>
1.41 asau 7684: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7685: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7686: dependency on the JDK is added. If
1.23 wiz 7687: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7688: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7689: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7690: JDK.</p></li>
1.23 wiz 7691: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7692: a package needs a Java2 implementation. The supported values
1.23 wiz 7693: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7694: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7695: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7696: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7697: above. This variable is not set by default.</p></li>
1.24 wiz 7698: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7699: automatically set to the runtime location of the used Java
7700: implementation dependency. It may be used to set
7701: <code class="varname">JAVA_HOME</code> to a good value if the program
7702: needs this variable to be defined.
7703: </p></li>
1.1 dsieger 7704: </ul></div>
7705: </div>
1.41 asau 7706: <div class="sect2">
1.1 dsieger 7707: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7708: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7709: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7710: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7711: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7712: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7713: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7714: that you want adjusted. Every occurrence of
7715: <code class="filename">*/bin/perl</code> in a she-bang line will be
7716: replaced with the full path to the perl executable.</p>
1.1 dsieger 7717: <p>If a particular version of perl is needed, set the
7718: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7719: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 7720: <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 7721: about handling perl modules.</p>
7722: </div>
1.41 asau 7723: <div class="sect2">
1.1 dsieger 7724: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 7725: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
7726: <p><code class="varname">REPLACE_SH</code>,
7727: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7728: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7729: hash bangs in files. Please use the appropriate one, prefering
7730: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7731: Each should contain a list of scripts, relative to
7732: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7733: occurrence of the matching shell in a she-bang line will be
7734: replaced with the full path to the shell executable.
1.40 wiz 7735: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7736: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7737: </div>
1.41 asau 7738: <div class="sect2">
1.40 wiz 7739: <div class="titlepage"><div><div><h3 class="title">
7740: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7741: <p>Currently, there is no special handling for other languages
7742: in pkgsrc. If a compiler package provides a
7743: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7744: just add a (build) dependency on the appropriate compiler
7745: package.</p>
7746: </div>
7747: </div>
1.41 asau 7748: <div class="sect1">
1.1 dsieger 7749: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7750: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7751: <p>The most common failures when building a package are that
7752: some platforms do not provide certain header files, functions or
7753: libraries, or they provide the functions in a library that the
7754: original package author didn't know. To work around this, you
7755: can rewrite the source code in most cases so that it does not
7756: use the missing functions or provides a replacement function.</p>
1.41 asau 7757: <div class="sect2">
1.1 dsieger 7758: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7759: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7760: <p>If a package already comes with a GNU configure script, the
7761: preferred way to fix the build failure is to change the
7762: configure script, not the code. In the other cases, you can
7763: utilize the C preprocessor, which defines certain macros
7764: depending on the operating system and hardware architecture it
7765: compiles for. These macros can be queried using for example
7766: <code class="varname">#if defined(__i386)</code>. Almost every operating
7767: system, hardware architecture and compiler has its own macro.
7768: For example, if the macros <code class="varname">__GNUC__</code>,
7769: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7770: are all defined, you know that you are using NetBSD on an i386
7771: compatible CPU, and your compiler is GCC.</p>
7772: <p>The list of the following macros for hardware and
7773: operating system depends on the compiler that is used. For
7774: example, if you want to conditionally compile code on Solaris,
7775: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7776: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7777: <div class="sect3">
1.1 dsieger 7778: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7779: <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 7780: <p>To distinguish between 4.4 BSD-derived systems and the
7781: rest of the world, you should use the following code.</p>
7782: <pre class="programlisting">
7783: #include <sys/param.h>
7784: #if (defined(BSD) && BSD >= 199306)
7785: /* BSD-specific code goes here */
7786: #else
7787: /* non-BSD-specific code goes here */
7788: #endif
7789: </pre>
7790: <p>If this distinction is not fine enough, you can also test
7791: for the following macros.</p>
7792: <pre class="programlisting">
1.45 obache 7793: Cygwin __CYGWIN__
7794: DragonFly __DragonFly__
1.1 dsieger 7795: FreeBSD __FreeBSD__
1.45 obache 7796: Haiku __HAIKU__
1.1 dsieger 7797: Interix __INTERIX
7798: IRIX __sgi (TODO: get a definite source for this)
7799: Linux linux, __linux, __linux__
1.83 dholland 7800: Mac OS X __APPLE__
1.45 obache 7801: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7802: Minix3 __minix
1.1 dsieger 7803: NetBSD __NetBSD__
7804: OpenBSD __OpenBSD__
7805: Solaris sun, __sun
7806: </pre>
7807: </div>
1.41 asau 7808: <div class="sect3">
1.1 dsieger 7809: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7810: <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 7811: <pre class="programlisting">
7812: i386 i386, __i386, __i386__
7813: MIPS __mips
7814: SPARC sparc, __sparc
7815: </pre>
7816: </div>
1.41 asau 7817: <div class="sect3">
1.1 dsieger 7818: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7819: <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 7820: <pre class="programlisting">
7821: GCC __GNUC__ (major version), __GNUC_MINOR__
7822: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7823: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7824: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7825: </pre>
7826: </div>
7827: </div>
1.41 asau 7828: <div class="sect2">
1.1 dsieger 7829: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7830: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 7831: <p>Some source files trigger bugs in the compiler, based on
7832: combinations of compiler version and architecture and almost
7833: always relation to optimisation being enabled. Common symptoms
7834: are gcc internal errors or never finishing compiling a
7835: file.</p>
7836: <p>Typically, a workaround involves testing the
7837: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7838: optimisation for that combination of file,
1.87 tnn 7839: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7840: <p>This used to be a big problem in the past, but is rarely
7841: needed now as compiler technology has matured. If you still need
7842: to add a compiler specific workaround, please do so in the file
7843: <code class="filename">hacks.mk</code> and describe the symptom and
7844: compiler version as detailed as possible.</p>
1.1 dsieger 7845: </div>
1.41 asau 7846: <div class="sect2">
1.1 dsieger 7847: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 7848: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
7849: </h3></div></div></div>
1.1 dsieger 7850: <p>This error message often means that a package did not
7851: link to a shared library it needs. The following functions are
7852: known to cause this error message over and over.</p>
7853: <div class="informaltable">
1.106 tnn 7854: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 7855: <colgroup>
7856: <col>
7857: <col>
7858: <col>
7859: </colgroup>
7860: <thead><tr>
7861: <th>Function</th>
7862: <th>Library</th>
7863: <th>Affected platforms</th>
7864: </tr></thead>
7865: <tbody>
7866: <tr>
7867: <td>accept, bind, connect</td>
7868: <td>-lsocket</td>
7869: <td>Solaris</td>
7870: </tr>
7871: <tr>
7872: <td>crypt</td>
7873: <td>-lcrypt</td>
7874: <td>DragonFly, NetBSD</td>
7875: </tr>
7876: <tr>
7877: <td>dlopen, dlsym</td>
7878: <td>-ldl</td>
7879: <td>Linux</td>
7880: </tr>
7881: <tr>
7882: <td>gethost*</td>
7883: <td>-lnsl</td>
7884: <td>Solaris</td>
7885: </tr>
7886: <tr>
7887: <td>inet_aton</td>
7888: <td>-lresolv</td>
7889: <td>Solaris</td>
7890: </tr>
7891: <tr>
7892: <td>nanosleep, sem_*, timer_*</td>
7893: <td>-lrt</td>
7894: <td>Solaris</td>
7895: </tr>
7896: <tr>
7897: <td>openpty</td>
7898: <td>-lutil</td>
7899: <td>Linux</td>
7900: </tr>
7901: </tbody>
7902: </table>
7903: </div>
7904: <p>To fix these linker errors, it is often sufficient to say
7905: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
7906: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 7907: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 7908: bmake</strong></span>.</p>
1.41 asau 7909: <div class="sect3">
1.1 dsieger 7910: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7911: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 7912: <p>When you are using the SunPro compiler, there is another
7913: possibility. That compiler cannot handle the following code:</p>
7914: <pre class="programlisting">
7915: extern int extern_func(int);
7916:
7917: static inline int
7918: inline_func(int x)
7919: {
7920: return extern_func(x);
7921: }
7922:
7923: int main(void)
7924: {
7925: return 0;
7926: }
7927: </pre>
7928: <p>It generates the code for <code class="function">inline_func</code> even if
7929: that function is never used. This code then refers to
7930: <code class="function">extern_func</code>, which can usually not be resolved. To
7931: solve this problem you can try to tell the package to disable inlining
7932: of functions.</p>
7933: </div>
7934: </div>
1.41 asau 7935: <div class="sect2">
1.1 dsieger 7936: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7937: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 7938: <p>Sometimes packages fail to build because the compiler runs
7939: into an operating system specific soft limit. With the
7940: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 7941: to unlimit the resources. Currently, the allowed values are any combination of
7942: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
7943: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 7944: Setting this variable is similar to running the shell builtin
1.10 hubertf 7945: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 7946: segment size or maximum stack size of a process, respectively, to
7947: their hard limits.</p>
7948: </div>
7949: </div>
1.41 asau 7950: <div class="sect1">
1.1 dsieger 7951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7952: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 7953: <div class="sect2">
1.1 dsieger 7954: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7955: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 7956: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 7957: with some operating systems cannot create more than one
7958: directory at a time. As such, you should call
7959: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
7960: <pre class="programlisting">
7961: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7962: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 ! sevan 7963: </pre>
1.23 wiz 7964: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
7965: dir2</code></span>”</span> to the
1.1 dsieger 7966: <code class="varname">INSTALLATION_DIRS</code> variable, which will
7967: automatically do the right thing.</p>
7968: </div>
1.41 asau 7969: <div class="sect2">
1.1 dsieger 7970: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7971: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 7972: <p>In general, documentation should be installed into
7973: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7974: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
7975: includes the version number of the package).</p>
7976: <p>Many modern packages using GNU autoconf allow to set the
7977: directory where HTML documentation is installed with the
1.23 wiz 7978: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 7979: is needed because otherwise the documentation ends up in
7980: <code class="filename">${PREFIX}/share/doc/html</code> or other
7981: places.</p>
7982: <p>An exception to the above is that library API documentation
1.79 snj 7983: 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 7984: browsers (devhelp) should be left at their default location, which
7985: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
7986: documentation can be recognized from files ending in
7987: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
7988: (It is also acceptable to install such files in
7989: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7990: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
7991: <code class="filename">.devhelp*</code> file must be directly in that
7992: directory then, no additional subdirectory level is allowed in
7993: this case. This is usually achieved by using
1.23 wiz 7994: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 7995: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
7996: though.)</p>
7997: </div>
1.41 asau 7998: <div class="sect2">
1.1 dsieger 7999: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8000: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8001: <p>Certain packages, most of them in the games category, install
8002: a score file that allows all users on the system to record their
8003: highscores. In order for this to work, the binaries need to be
8004: installed setgid and the score files owned by the appropriate
1.35 wiz 8005: group and/or owner (traditionally the "games" user/group). Set
8006: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8007: following variables, documented in more detail in
8008: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8009: behaviour: <code class="varname">GAMEDATAMODE</code>,
8010: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8011: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8012: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8013: <code class="varname">GAMEDATA_PERMS</code> and
8014: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8015: <p>An example that illustrates some of the variables described above is
8016: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8017: used to properly set directory permissions of the directory where the
8018: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8019: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8020: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8021: binary:</p>
8022: <pre class="programlisting">
8023: USE_GAMESGROUP= yes
8024:
8025: BUILD_DEFS+= VARBASE
8026:
8027: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8028: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8029: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 ! sevan 8030: </pre>
1.100 leot 8031: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8032: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8033: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8034: needed to be accessed by setgid games and
8035: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8036: <p>A package should therefore never hard code file ownership or
1.100 leot 8037: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8038: or alternatively on <code class="varname">INSTALL_GAME</code>,
8039: <code class="varname">INSTALL_GAME_DATA</code> and
8040: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8041: </div>
1.41 asau 8042: <div class="sect2">
1.1 dsieger 8043: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8044: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8045: <p><code class="varname">DESTDIR</code> support means that a package
8046: installs into a staging directory, not the final location of the
8047: files. Then a binary package is created which can be used for
8048: installation as usual. There are two ways: Either the package must
1.23 wiz 8049: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8050: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8051: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8052: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 8053: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8054: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8055: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8056: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8057: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8058: the inclusion.</p></li>
1.23 wiz 8059: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8060: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8061: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8062: automatically. Many manual rules and pre/post-install often are
8063: incorrect; fix them.</p></li>
1.23 wiz 8064: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8065: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8066: <li class="listitem"><p>In general, packages should support
1.4 rillig 8067: <code class="varname">UNPRIVILEGED</code> to be able to use
8068: DESTDIR.</p></li>
8069: </ul></div>
8070: </div>
1.41 asau 8071: <div class="sect2">
1.4 rillig 8072: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8073: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8074: <p>Your package may also contain scripts with hardcoded paths to
8075: other interpreters besides (or as well as) perl. To correct the
8076: full pathname to the script interpreter, you need to set the
8077: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8078: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8079: <pre class="programlisting">
8080: REPLACE_INTERPRETER+= tcl
8081: REPLACE.tcl.old= .*/bin/tclsh
8082: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8083: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8084: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 ! sevan 8085: </pre>
1.41 asau 8086: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8087: <h3 class="title">Note</h3>
8088: <p>Before March 2006, these variables were called
8089: <code class="varname">_REPLACE.*</code> and
8090: <code class="varname">_REPLACE_FILES.*</code>.</p>
8091: </div>
8092: </div>
1.41 asau 8093: <div class="sect2">
1.1 dsieger 8094: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8095: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8096: <p>Makefiles of packages providing perl5 modules should include
8097: the Makefile fragment
8098: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8099: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8100: configuration for such modules as well as various hooks to tune
8101: this configuration. See comments in this file for
8102: details.</p>
8103: <p>Perl5 modules will install into different places depending
8104: on the version of perl used during the build process. To
8105: address this, pkgsrc will append lines to the
8106: <code class="filename">PLIST</code> corresponding to the files listed in
8107: the installed <code class="filename">.packlist</code> file generated by
8108: most perl5 modules. This is invoked by defining
8109: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8110: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8111: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8112: e.g.:</p>
1.1 dsieger 8113: <pre class="programlisting">
1.47 wiz 8114: PERL5_PACKLIST= auto/Pg/.packlist
1.111 ! sevan 8115: </pre>
1.47 wiz 8116: <p>The perl5 config variables
8117: <code class="varname">installarchlib</code>,
8118: <code class="varname">installscript</code>,
8119: <code class="varname">installvendorbin</code>,
8120: <code class="varname">installvendorscript</code>,
8121: <code class="varname">installvendorarch</code>,
8122: <code class="varname">installvendorlib</code>,
8123: <code class="varname">installvendorman1dir</code>, and
8124: <code class="varname">installvendorman3dir</code> represent those
8125: locations in which components of perl5 modules may be installed,
8126: provided as variable with uppercase and prefixed with
8127: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8128: and may be used by perl5 packages that don't have a packlist.
8129: These variables are also substituted for in the
8130: <code class="filename">PLIST</code> as uppercase prefixed with
8131: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8132: </div>
1.41 asau 8133: <div class="sect2">
1.1 dsieger 8134: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8135: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8136: <p>Some packages install info files or use the
1.23 wiz 8137: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8138: commands. <code class="varname">INFO_FILES</code> should be defined in
8139: the package Makefile so that <code class="filename">INSTALL</code> and
8140: <code class="filename">DEINSTALL</code> scripts will be generated to
8141: handle registration of the info files in the Info directory
1.23 wiz 8142: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8143: files registration is either provided by the system, or by a
8144: special purpose package automatically added as dependency if
8145: needed.</p>
8146: <p><code class="varname">PKGINFODIR</code> is the directory under
8147: <code class="filename">${PREFIX}</code> where info files are primarily
8148: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8149: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8150: <p>The info files for the package should be listed in the
8151: package <code class="filename">PLIST</code>; however any split info files
8152: need not be listed.</p>
1.23 wiz 8153: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8154: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8155: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8156: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8157: should be noted with the <code class="varname">TEXINFO_REQD</code>
8158: variable in the package <code class="filename">Makefile</code>. By
8159: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8160: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8161: does not match the required minimum, a build dependency on the
1.79 snj 8162: <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 8163: be added automatically.</p>
8164: <p>The build and installation process of the software provided
8165: by the package should not use the
1.10 hubertf 8166: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8167: info files is the task of the package
8168: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8169: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8170: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8171: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8172: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8173: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8174: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8175: no effect except the logging of a message. The script overriding
1.10 hubertf 8176: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8177: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8178: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8179: </div>
1.41 asau 8180: <div class="sect2">
1.1 dsieger 8181: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8182: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8183: <p>All packages that install manual pages should install them
8184: into the same directory, so that there is one common place to look
8185: for them. In pkgsrc, this place is
8186: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8187: should be used in packages. The default for
8188: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8189: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8190: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8191: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8192: <h3 class="title">Note</h3>
8193: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8194: is far from complete.</p>
8195: </div>
8196: <p>The <code class="filename">PLIST</code> files can just use
8197: <code class="filename">man/</code> as the top level directory for the man
8198: page file entries, and the pkgsrc framework will convert as
8199: needed. In all other places, the correct
8200: <code class="varname">PKGMANDIR</code> must be used.</p>
8201: <p>Packages that are
8202: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8203: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8204: <code class="filename">./configure</code>
8205: --mandir switch to set where the man pages should be installed.
8206: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8207: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8208: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8209: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8210: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8211: Or if the <code class="filename">./configure</code> script uses
8212: a non-standard use of --mandir, you can set
8213: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8214: <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 8215: information on installation of compressed manual pages.</p>
8216: </div>
1.41 asau 8217: <div class="sect2">
1.1 dsieger 8218: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8219: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8220: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8221: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8222: you need to take some extra steps to make sure they get registered
8223: in the database:</p>
1.23 wiz 8224: <div class="orderedlist"><ol class="orderedlist" type="1">
8225: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8226: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8227: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8228: deinstallation time, and tells the package where to install
1.7 rillig 8229: GConf data files using some standard configure arguments. It
1.1 dsieger 8230: also disallows any access to the database directly from the
8231: package.</p></li>
1.23 wiz 8232: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8233: <code class="filename">.schemas</code> files under
8234: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8235: installed under <code class="filename">${PREFIX}/etc</code>, you will
8236: need to manually patch the package.</p></li>
1.23 wiz 8237: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8238: directory, as they will be handled automatically. See
1.84 wiz 8239: <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 8240: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8241: your <code class="filename">Makefile</code> with a list of all
8242: <code class="filename">.schemas</code> files installed by the package, if
8243: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8244: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8245: your <code class="filename">Makefile</code> with a
8246: list of all <code class="filename">.entries</code> files installed by the
8247: package, if any. Names must not contain any directories in
8248: them.</p></li>
8249: </ol></div>
8250: </div>
1.41 asau 8251: <div class="sect2">
1.1 dsieger 8252: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8253: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8254: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8255: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8256: get registered in the database:</p>
1.23 wiz 8257: <div class="orderedlist"><ol class="orderedlist" type="1">
8258: <li class="listitem"><p>Include
1.18 snj 8259: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8260: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8261: takes care of rebuilding the scrollkeeper database at
8262: installation and deinstallation time, and disallows any access
8263: to it directly from the package.</p></li>
1.23 wiz 8264: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8265: <code class="filename">libdata/scrollkeeper</code> directory, as they
8266: will be handled automatically.</p></li>
1.23 wiz 8267: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8268: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8269: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8270: </ol></div>
8271: </div>
1.41 asau 8272: <div class="sect2">
1.1 dsieger 8273: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8274: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8275: <p>If a package installs font files, you will need to rebuild
8276: the fonts database in the directory where they get installed at
8277: installation and deinstallation time. This can be automatically
8278: done by using the pkginstall framework.</p>
8279: <p>You can list the directories where fonts are installed in the
8280: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8281: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8282: <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 8283: Also make sure that the database file
8284: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8285: <p>Note that you should not create new directories for fonts;
8286: instead use the standard ones to avoid that the user needs to
8287: manually configure his X server to find them.</p>
8288: </div>
1.41 asau 8289: <div class="sect2">
1.1 dsieger 8290: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8291: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8292: <p>If a package installs GTK2 immodules or loaders, you need to
8293: take some extra steps to get them registered in the GTK2 database
8294: properly:</p>
1.23 wiz 8295: <div class="orderedlist"><ol class="orderedlist" type="1">
8296: <li class="listitem"><p>Include
1.1 dsieger 8297: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8298: <code class="filename">buildlink3.mk</code> file. This takes care of
8299: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8300: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8301: your package installs GTK2 immodules.</p></li>
1.23 wiz 8302: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8303: GTK2 loaders.</p></li>
1.23 wiz 8304: <li class="listitem">
1.1 dsieger 8305: <p>Patch the package to not touch any of the GTK2
8306: databases directly. These are:</p>
1.41 asau 8307: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8308: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8309: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8310: </ul></div>
8311: </li>
1.23 wiz 8312: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8313: any entries under the <code class="filename">libdata/gtk-2.0</code>
8314: directory, as they will be handled automatically.</p></li>
8315: </ol></div>
8316: </div>
1.41 asau 8317: <div class="sect2">
1.1 dsieger 8318: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8319: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8320: <p>If a package installs SGML or XML data files that need to be
8321: registered in system-wide catalogs (like DTDs, sub-catalogs,
8322: etc.), you need to take some extra steps:</p>
1.23 wiz 8323: <div class="orderedlist"><ol class="orderedlist" type="1">
8324: <li class="listitem"><p>Include
1.1 dsieger 8325: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8326: your <code class="filename">Makefile</code>, which takes care of
8327: registering those files in system-wide catalogs at
8328: installation and deinstallation time.</p></li>
1.23 wiz 8329: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8330: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8331: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8332: any XML catalogs installed by the package.</p></li>
1.23 wiz 8333: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8334: to be added to the SGML catalog. These come in groups of
8335: three strings; see xmlcatmgr(1) for more information
8336: (specifically, arguments recognized by the 'add' action).
8337: Note that you will normally not use this variable.</p></li>
1.23 wiz 8338: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8339: to be added to the XML catalog. These come in groups of three
8340: strings; see xmlcatmgr(1) for more information (specifically,
8341: arguments recognized by the 'add' action). Note that you will
8342: normally not use this variable.</p></li>
8343: </ol></div>
8344: </div>
1.41 asau 8345: <div class="sect2">
1.1 dsieger 8346: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8347: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8348: <p>If a package provides extensions to the MIME database by
8349: installing <code class="filename">.xml</code> files inside
8350: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8351: need to take some extra steps to ensure that the database is kept
8352: consistent with respect to these new files:</p>
1.23 wiz 8353: <div class="orderedlist"><ol class="orderedlist" type="1">
8354: <li class="listitem"><p>Include
1.1 dsieger 8355: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8356: (avoid using the <code class="filename">buildlink3.mk</code> file from
8357: this same directory, which is reserved for inclusion from
8358: other <code class="filename">buildlink3.mk</code> files). It takes
8359: care of rebuilding the MIME database at installation and
8360: deinstallation time, and disallows any access to it directly
8361: from the package.</p></li>
1.23 wiz 8362: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8363: <code class="filename">share/mime</code> directory,
8364: <span class="emphasis"><em>except</em></span> for files saved under
8365: <code class="filename">share/mime/packages</code>. The former are
8366: handled automatically by
8367: the update-mime-database program, but the latter are
8368: package-dependent and must be removed by the package that
8369: installed them in the first place.</p></li>
1.23 wiz 8370: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8371: from the PLIST. They will be handled by the shared-mime-info
8372: package.</p></li>
8373: </ol></div>
8374: </div>
1.41 asau 8375: <div class="sect2">
1.1 dsieger 8376: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8377: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8378: <p>If a package uses intltool during its build, add
8379: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8380: which forces it to use the intltool package provided by pkgsrc,
8381: instead of the one bundled with the distribution file.</p>
8382: <p>This tracks intltool's build-time dependencies and uses the
8383: latest available version; this way, the package benefits of any
8384: bug fixes that may have appeared since it was released.</p>
8385: </div>
1.41 asau 8386: <div class="sect2">
1.1 dsieger 8387: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8388: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8389: <p>If a package contains a rc.d script, it won't be copied into
8390: the startup directory by default, but you can enable it, by adding
8391: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8392: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8393: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8394: it will automatically remove the scripts when the package is
8395: deinstalled.</p>
8396: </div>
1.41 asau 8397: <div class="sect2">
1.1 dsieger 8398: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8399: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8400: <p>If a package installs TeX packages into the texmf tree,
8401: the <code class="filename">ls-R</code> database of the tree needs to be
8402: updated.</p>
1.41 asau 8403: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8404: <h3 class="title">Note</h3>
1.22 jakllsch 8405: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8406: packages should install files
1.22 jakllsch 8407: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8408: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8409: </div>
1.23 wiz 8410: <div class="orderedlist"><ol class="orderedlist" type="1">
8411: <li class="listitem"><p>Include
1.22 jakllsch 8412: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8413: takes care of rebuilding the <code class="filename">ls-R</code>
8414: database at installation and deinstallation time.</p></li>
1.23 wiz 8415: <li class="listitem">
1.1 dsieger 8416: <p>If your package installs files into a texmf
8417: tree other than the one
1.22 jakllsch 8418: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8419: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8420: trees that need database update.</p>
8421: <p>If your package also installs font map files that need
1.10 hubertf 8422: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8423: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8424: set <code class="varname">TEX_MAP_FILES</code> and/or
8425: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8426: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8427: be run automatically at installation/deinstallation to
8428: enable/disable font map files for TeX output
8429: drivers.</p>
8430: </li>
1.23 wiz 8431: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8432: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8433: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8434: </ol></div>
8435: </div>
1.41 asau 8436: <div class="sect2">
1.1 dsieger 8437: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8438: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 8439: emulation</h3></div></div></div>
8440: <p>There are some packages that provide libraries and
8441: executables for running binaries from a one operating system
8442: on a different one (if the latter supports it). One example
8443: is running Linux binaries on NetBSD.</p>
1.79 snj 8444: <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 8445: helps in extracting and packaging Linux rpm packages.</p>
8446: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8447: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8448: if all libraries for each installed executable can be found by
8449: the dynamic linker. Since the standard dynamic linker is run,
8450: this fails for emulation packages, because the libraries used
8451: by the emulation are not in the standard directories.</p>
8452: </div>
1.41 asau 8453: <div class="sect2">
1.1 dsieger 8454: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8455: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8456: <p>If a package installs images under the
8457: <code class="filename">share/icons/hicolor</code> and/or updates the
8458: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8459: database, you need to take some extra steps to make sure that the
8460: shared theme directory is handled appropriately and that the cache
8461: database is rebuilt:</p>
1.23 wiz 8462: <div class="orderedlist"><ol class="orderedlist" type="1">
8463: <li class="listitem"><p>Include
1.1 dsieger 8464: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8465: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8466: entry that refers to the theme cache.</p></li>
1.23 wiz 8467: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8468: directories from the <code class="filename">share/icons/hicolor</code>
8469: hierarchy because they will be handled automatically.</p></li>
8470: </ol></div>
8471: <p>The best way to verify that the PLIST is correct with
8472: respect to the last two points is to regenerate it using
1.10 hubertf 8473: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8474: </div>
1.41 asau 8475: <div class="sect2">
1.1 dsieger 8476: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8477: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8478: <p>If a package installs <code class="filename">.desktop</code> files
8479: under <code class="filename">share/applications</code> and these include
1.53 rodent 8480: MIME information (MimeType key), you need to take extra steps to
8481: ensure that they are registered into the MIME database:</p>
1.23 wiz 8482: <div class="orderedlist"><ol class="orderedlist" type="1">
8483: <li class="listitem"><p>Include
1.1 dsieger 8484: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8485: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8486: <code class="filename">share/applications/mimeinfo.cache</code> file.
8487: It will be handled automatically.</p></li>
8488: </ol></div>
8489: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8490: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8491: print-PLIST</strong></span>.</p>
8492: </div>
8493: </div>
1.41 asau 8494: <div class="sect1">
1.1 dsieger 8495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8496: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8497: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8498: immediately. In this case, one can plainly mark a package as broken. For
8499: this, one just sets the variable <code class="varname">BROKEN</code> to the
8500: reason why the package is broken (similar to the
8501: <code class="varname">RESTRICTED</code> variable). A user trying to build
8502: the package will immediately be shown this message, and the build
8503: will not be even tried.</p>
8504: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8505: intervals.</p>
8506: </div>
8507: </div>
1.41 asau 8508: <div class="chapter">
1.1 dsieger 8509: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8510: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 8511: <p>To check out all the gotchas when building a package, here are
8512: the steps that I do in order to get a package working. Please note
8513: this is basically the same as what was explained in the previous
8514: sections, only with some debugging aids.</p>
1.41 asau 8515: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8516: <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>
8517: <li class="listitem">
1.79 snj 8518: <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 8519: create a directory for a new package, change into it, then run
1.10 hubertf 8520: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8521: <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>
8522: <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>
8523: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8524: </li>
1.23 wiz 8525: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8526: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8527: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8528: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8529: configure step to the package's
8530: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8531: <li class="listitem">
1.1 dsieger 8532: <p>Make the package compile, doing multiple rounds of</p>
8533: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8534: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8535: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8536: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8537: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8538: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8539: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8540: <p>Doing this step as non-root user will ensure that no files
8541: are modified that shouldn't be, especially during the build
1.10 hubertf 8542: phase. <span class="command"><strong>mkpatches</strong></span>,
8543: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.79 snj 8544: 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 8545: package.</p>
8546: </li>
1.23 wiz 8547: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
8548: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
8549: <li class="listitem">
1.1 dsieger 8550: <p>Generate a <code class="filename">PLIST</code>:</p>
8551: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8552: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8553: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8554: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8555: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8556: <p>You usually need to be <code class="username">root</code> to do
8557: this. Look if there are any files left:</p>
8558: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8559: <p>If this reveals any files that are missing in
8560: <code class="filename">PLIST</code>, add them.</p>
8561: </li>
1.23 wiz 8562: <li class="listitem">
1.1 dsieger 8563: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8564: package again and make a binary package:</p>
8565: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8566: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8567: </li>
1.23 wiz 8568: <li class="listitem">
1.1 dsieger 8569: <p>Delete the installed package:</p>
8570: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8571: </li>
1.23 wiz 8572: <li class="listitem">
1.10 hubertf 8573: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8574: command, which shouldn't find anything now:</p>
8575: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8576: </li>
1.23 wiz 8577: <li class="listitem">
1.1 dsieger 8578: <p>Reinstall the binary package:</p>
8579: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8580: </li>
1.23 wiz 8581: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8582: <li class="listitem">
1.79 snj 8583: <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 8584: reports:</p>
8585: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8586: </li>
1.23 wiz 8587: <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 8588: </ul></div>
8589: </div>
1.41 asau 8590: <div class="chapter">
1.1 dsieger 8591: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8592: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8593: <div class="toc">
8594: <p><b>Table of Contents</b></p>
1.100 leot 8595: <dl class="toc">
1.6 rillig 8596: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
8597: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8598: <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 8599: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 8600: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 8601: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
8602: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8603: </dl>
8604: </div>
1.41 asau 8605: <div class="sect1">
1.1 dsieger 8606: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8607: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8608: <p>Our policy is that we accept binaries only from pkgsrc
8609: developers to guarantee that the packages don't contain any
8610: trojan horses etc. This is not to annoy anyone but rather to
8611: protect our users! You're still free to put up your home-made
8612: binary packages and tell the world where to get them. NetBSD
8613: developers doing bulk builds and wanting to upload them please
1.66 asau 8614: 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
8615: builds)</i></a>.</p>
1.1 dsieger 8616: </div>
1.41 asau 8617: <div class="sect1">
1.1 dsieger 8618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8619: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8620: <p>First, check that your package is complete, compiles and
1.10 hubertf 8621: 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 8622: 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 8623: archive that contains all files that make up the package.
8624: Finally, send this package to the pkgsrc bug tracking system,
1.79 snj 8625: 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 8626: that, go to the web page
1.10 hubertf 8627: <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 8628: which contains some instructions and a link to a form where you
8629: can submit packages. The
1.79 snj 8630: <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 8631: also available as a substitute for either of the above two tools.
8632: </p>
1.1 dsieger 8633: <p>In the form of the problem report, the category should be
1.23 wiz 8634: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8635: and version number, and the description field should contain a
8636: short description of your package (contents of the COMMENT
8637: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8638: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8639: <p>If you want to submit several packages, please send a
8640: separate PR for each one, it's easier for us to track things
8641: that way.</p>
8642: <p>Alternatively, you can also import new packages into
1.23 wiz 8643: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8644: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8645: for details.</p>
8646: </div>
1.41 asau 8647: <div class="sect1">
1.1 dsieger 8648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8649: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8650: <p>Please note all package additions, updates, moves, and
8651: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8652: important to keep this file up to date and conforming to the
8653: existing format, because it will be used by scripts to
1.10 hubertf 8654: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8655: sites. Additionally, check the
8656: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
8657: for the package you updated or removed, in case it was mentioned
8658: there.</p>
8659: <p>When the <code class="varname">PKGREVISION</code> of a package is
8660: bumped, the change should appear in
8661: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
8662: related or otherwise relevant. Mass bumps that result from a
8663: dependency being updated should not be mentioned. In all other
8664: cases it's the developer's decision.</p>
8665: <p>There is a make target that helps in creating proper
1.10 hubertf 8666: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 8667: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8668: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
8669: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
8670: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 8671: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8672: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 8673: For new packages, or package moves or removals, set the
8674: <code class="varname">CTYPE</code> variable on the command line to "Added",
8675: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 8676: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 8677: not the same as your NetBSD login name. The target also automatically
8678: removes possibly existing entries for the package in the
8679: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 8680: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 8681: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
8682: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8683: makes the cvs commands use the main repository.
8684: </p>
1.1 dsieger 8685: </div>
1.41 asau 8686: <div class="sect1">
1.1 dsieger 8687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 8688: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 8689: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 8690: access to the pkgsrc repository.</p>
8691: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8692: Start by adding the directory and then files in the directory. Don't
8693: forget to add the new package to the category's
8694: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8695: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8696: <pre class="programlisting">
8697: <code class="prompt">$</code> cd .../pkgsrc/category
8698: <code class="prompt">$</code> cvs add pkgname
8699: <code class="prompt">$</code> cd pkgname
8700: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8701: <code class="prompt">$</code> cvs add patches/p*
8702: <code class="prompt">$</code> cvs status | less
1.34 wiz 8703: <code class="prompt">$</code> cvs commit
1.33 wiz 8704: <code class="prompt">$</code> cd ..
8705: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 8706: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 8707: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 8708: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 8709: </pre>
1.1 dsieger 8710: <p>The commit message of the initial import should include part of the
8711: <code class="filename">DESCR</code> file, so people reading the mailing lists know
8712: what the package is/does.</p>
1.33 wiz 8713: <p>Also mention the new package in
8714: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8715: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8716: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 8717: </div>
1.41 asau 8718: <div class="sect1">
1.1 dsieger 8719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8720: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 8721: <p>Please always put a concise, appropriate and relevant summary of the
8722: changes between old and new versions into the commit log when updating
8723: a package. There are various reasons for this:</p>
1.41 asau 8724: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8725: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 8726: or its information may be overwritten by newer information.</p></li>
1.23 wiz 8727: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8728: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 8729: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8730: repository is very useful for people who read the pkgsrc-changes mailing
8731: list, so that they can make tactical decisions about when to upgrade
8732: the package.</p></li>
8733: </ul></div>
8734: <p>Please also recognize that, just because a new version of a package
8735: has been released, it should not automatically be upgraded in the CVS
8736: repository. We prefer to be conservative in the packages that are
8737: included in pkgsrc - development or beta packages are not really the
8738: best thing for most places in which pkgsrc is used. Please use your
8739: judgement about what should go into pkgsrc, and bear in mind that
8740: stability is to be preferred above new and possibly untested features.</p>
8741: </div>
1.41 asau 8742: <div class="sect1">
1.1 dsieger 8743: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 8744: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
8745: <p>Renaming packages is not recommended.</p>
8746: <p>When renaming packages, be sure to fix any references to old name
8747: in other Makefiles, options, buildlink files, etc.</p>
8748: <p>Also When renaming a package, please define
8749: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8750: pattern(s) of the previous package name.
8751: This may be repeated for multiple renames.
8752: The new package would be an exact replacement.
8753: </p>
1.23 wiz 8754: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 8755: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8756: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8757: not be an exact replacement but is a suggestion for the replaced
8758: functionality.</p>
8759: </div>
1.41 asau 8760: <div class="sect1">
1.20 snj 8761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8762: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
8763: <p>It is preferred that packages are not renamed or moved, but if needed
8764: please follow these steps.
8765: </p>
1.23 wiz 8766: <div class="orderedlist"><ol class="orderedlist" type="1">
8767: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8768: <li class="listitem">
1.1 dsieger 8769: <p>Remove all CVS dirs.</p>
8770: <p>Alternatively to the first two steps you can also do:</p>
8771: <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>
8772: <p>and use that for further work.</p>
8773: </li>
1.23 wiz 8774: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8775: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8776: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8777: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 8778: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8779: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8780: for doing an update using pkgsrc building; for example, it can
1.79 snj 8781: 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 8782: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8783: new <code class="varname">PKGPATH</code> for that moved package. Note that
8784: it may have multiple matches, so the tool should also check on the
8785: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8786: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8787: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 8788: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 8789: place.</p></li>
1.23 wiz 8790: <li class="listitem">
1.1 dsieger 8791: <p>Check if any package depends on it:
8792: </p>
8793: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8794: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8795: </li>
1.23 wiz 8796: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8797: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8798: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8799: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8800: <li class="listitem">
1.1 dsieger 8801: <p>Commit the changed and removed files:</p>
8802: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
8803: <p>(and any packages from step 5, of course).</p>
8804: </li>
8805: </ol></div>
8806: </div>
8807: </div>
1.41 asau 8808: <div class="chapter">
1.1 dsieger 8809: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8810: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 8811: <p>This section contains the answers to questions that may
8812: arise when you are writing a package. If you don't find your
8813: question answered here, first have a look in the other chapters,
8814: and if you still don't have the answer, ask on the
8815: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 8816: <div class="qandaset">
1.111 ! sevan 8817: <a name="idp140663383225904"></a><dl>
1.6 rillig 8818: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 8819: MAKEFLAGS, .MAKEFLAGS and
8820: MAKE_FLAGS?</a>
8821: </dt>
1.6 rillig 8822: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 8823: MAKE, GMAKE and
8824: MAKE_PROGRAM?</a>
8825: </dt>
1.6 rillig 8826: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 8827: CC, PKG_CC and
8828: PKGSRC_COMPILER?</a>
8829: </dt>
1.6 rillig 8830: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 8831: BUILDLINK_LDFLAGS,
8832: BUILDLINK_LDADD and
8833: BUILDLINK_LIBS?</a>
8834: </dt>
1.6 rillig 8835: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 8836: VARNAME=BUILDLINK_PREFIX.foo
8837: say it's empty?</a>
8838: </dt>
1.6 rillig 8839: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 8840: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
8841: don't understand the := inside
8842: it.</a>
8843: </dt>
1.6 rillig 8844: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 8845: developers?</a>
8846: </dt>
1.6 rillig 8847: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 8848: documentation?</a>
8849: </dt>
1.6 rillig 8850: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 8851: do?</a>
8852: </dt>
8853: </dl>
1.41 asau 8854: <table border="0" style="width: 100%;">
8855: <colgroup>
1.1 dsieger 8856: <col align="left" width="1%">
1.23 wiz 8857: <col>
1.41 asau 8858: </colgroup>
1.1 dsieger 8859: <tbody>
1.41 asau 8860: <tr class="question">
1.1 dsieger 8861: <td align="left" valign="top">
1.111 ! sevan 8862: <a name="devfaq.makeflags"></a><a name="idp140663383226608"></a><p><b>22.1.</b></p>
1.1 dsieger 8863: </td>
8864: <td align="left" valign="top"><p>What is the difference between
8865: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
8866: <code class="varname">MAKE_FLAGS</code>?</p></td>
8867: </tr>
8868: <tr class="answer">
8869: <td align="left" valign="top"></td>
8870: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.79 snj 8871: 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 8872: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
8873: the <code class="varname">MAKE_PROGRAM</code> when building the
8874: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
8875: </tr>
1.41 asau 8876: <tr class="question">
1.1 dsieger 8877: <td align="left" valign="top">
1.111 ! sevan 8878: <a name="devfaq.make"></a><a name="idp140663383231072"></a><p><b>22.2.</b></p>
1.1 dsieger 8879: </td>
8880: <td align="left" valign="top"><p>What is the difference between
8881: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
8882: <code class="varname">MAKE_PROGRAM</code>?</p></td>
8883: </tr>
8884: <tr class="answer">
8885: <td align="left" valign="top"></td>
8886: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.79 snj 8887: <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 8888: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
8889: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
8890: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
8891: Make program that is used for building the
8892: package.</p></td>
8893: </tr>
1.41 asau 8894: <tr class="question">
1.1 dsieger 8895: <td align="left" valign="top">
1.111 ! sevan 8896: <a name="devfaq.cc"></a><a name="idp140663383236080"></a><p><b>22.3.</b></p>
1.1 dsieger 8897: </td>
8898: <td align="left" valign="top"><p>What is the difference between
8899: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
8900: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
8901: </tr>
8902: <tr class="answer">
8903: <td align="left" valign="top"></td>
8904: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
8905: compiler, which can be configured by the pkgsrc user.
8906: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
8907: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
8908: path to a compiler, but the type of compiler that should be
8909: used. See <code class="filename">mk/compiler.mk</code> for more
8910: information about the latter variable.</p></td>
8911: </tr>
1.41 asau 8912: <tr class="question">
1.1 dsieger 8913: <td align="left" valign="top">
1.111 ! sevan 8914: <a name="devfaq.bl3flags"></a><a name="idp140663383240992"></a><p><b>22.4.</b></p>
1.1 dsieger 8915: </td>
8916: <td align="left" valign="top"><p>What is the difference between
8917: <code class="varname">BUILDLINK_LDFLAGS</code>,
8918: <code class="varname">BUILDLINK_LDADD</code> and
8919: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
8920: </tr>
8921: <tr class="answer">
8922: <td align="left" valign="top"></td>
8923: <td align="left" valign="top"><p>[FIXME]</p></td>
8924: </tr>
1.41 asau 8925: <tr class="question">
1.1 dsieger 8926: <td align="left" valign="top">
1.111 ! sevan 8927: <a name="devfaq.bl3prefix"></a><a name="idp140663383243616"></a><p><b>22.5.</b></p>
1.1 dsieger 8928: </td>
1.10 hubertf 8929: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 8930: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
8931: say it's empty?</p></td>
8932: </tr>
8933: <tr class="answer">
8934: <td align="left" valign="top"></td>
8935: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 8936: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
8937: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 8938: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 8939: command.</p></td>
8940: </tr>
1.41 asau 8941: <tr class="question">
1.1 dsieger 8942: <td align="left" valign="top">
1.111 ! sevan 8943: <a name="devfaq.master_sites"></a><a name="idp140663383247488"></a><p><b>22.6.</b></p>
1.1 dsieger 8944: </td>
8945: <td align="left" valign="top"><p>What does
1.108 rillig 8946: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
8947: don't understand the <code class="code">:=</code> inside
1.1 dsieger 8948: it.</p></td>
8949: </tr>
8950: <tr class="answer">
8951: <td align="left" valign="top"></td>
1.108 rillig 8952: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
8953: assignment operator, although it looks like it.
1.1 dsieger 8954: Instead, it is a degenerate form of
1.108 rillig 8955: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
8956: 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
8957: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 8958: case of <code class="varname">MASTER_SITE_*</code>,
8959: <em class="replaceable"><code>old_string</code></em> is the empty string and
8960: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 8961: <code class="code">package/</code>. That's where the
8962: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 8963: together.</p></td>
8964: </tr>
1.41 asau 8965: <tr class="question">
1.1 dsieger 8966: <td align="left" valign="top">
1.111 ! sevan 8967: <a name="devfaq.mailinglists"></a><a name="idp140663383255152"></a><p><b>22.7.</b></p>
1.1 dsieger 8968: </td>
8969: <td align="left" valign="top"><p>Which mailing lists are there for package
8970: developers?</p></td>
8971: </tr>
8972: <tr class="answer">
8973: <td align="left" valign="top"></td>
1.41 asau 8974: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 8975: <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 8976: <dd><p>This is a list for technical discussions related
8977: to pkgsrc development, e.g. soliciting feedback for changes to
8978: pkgsrc infrastructure, proposed new features, questions related
8979: to porting pkgsrc to a new platform, advice for maintaining a
8980: package, patches that affect many packages, help requests moved
8981: from pkgsrc-users when an infrastructure bug is found,
8982: etc.</p></dd>
1.10 hubertf 8983: <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 8984: <dd><p>All bug reports in category "pkg" sent with
1.79 snj 8985: <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 8986: directly; use one of the other mailing
8987: lists.</p></dd>
8988: </dl></div></td>
8989: </tr>
1.41 asau 8990: <tr class="question">
1.1 dsieger 8991: <td align="left" valign="top">
1.111 ! sevan 8992: <a name="devfaq.documentation"></a><a name="idp140663383260064"></a><p><b>22.8.</b></p>
1.1 dsieger 8993: </td>
8994: <td align="left" valign="top"><p>Where is the pkgsrc
8995: documentation?</p></td>
8996: </tr>
8997: <tr class="answer">
8998: <td align="left" valign="top"></td>
8999: <td align="left" valign="top">
9000: <p>There are many places where you can find
9001: documentation about pkgsrc:</p>
1.41 asau 9002: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9003: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9004: of chapters that explain large parts of pkgsrc, but some
9005: chapters tend to be outdated. Which ones they are is hard to
9006: say.</p></li>
1.23 wiz 9007: <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 9008: about certain features, announcements of new parts of the pkgsrc
9009: infrastructure and sometimes even announcements that a certain
9010: feature has been marked as obsolete. The benefit here is that
9011: each message has a date appended to it.</p></li>
1.23 wiz 9012: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9013: <code class="filename">mk/</code> directory start with a comment that
9014: describes the purpose of the file and how it can be used by the
9015: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9016: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9017: help</strong></span>.</p></li>
1.23 wiz 9018: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9019: information, but they tend to be highly abbreviated, especially
9020: for actions that occur often. Some contain a detailed
9021: description of what has changed, but they are geared towards the
9022: other pkgsrc developers, not towards an average pkgsrc user.
9023: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9024: don't know what has been before, these messages may not be worth
9025: too much to you.</p></li>
1.23 wiz 9026: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9027: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9028: mind of the developer who wrote the code. To get this
1.10 hubertf 9029: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9030: to see who has written it and ask on the
9031: <code class="literal">tech-pkg</code> mailing list, so that others can
9032: find your questions later (see above). To be sure that the
9033: developer in charge reads the mail, you may CC him or
9034: her.</p></li>
9035: </ul></div>
9036: </td>
9037: </tr>
1.41 asau 9038: <tr class="question">
1.1 dsieger 9039: <td align="left" valign="top">
1.111 ! sevan 9040: <a name="devfaq.too-much-time"></a><a name="idp140663383268864"></a><p><b>22.9.</b></p>
1.1 dsieger 9041: </td>
9042: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9043: do?</p></td>
9044: </tr>
9045: <tr class="answer">
9046: <td align="left" valign="top"></td>
9047: <td align="left" valign="top">
9048: <p>This is not really an FAQ yet, but here's the answer
9049: anyway.</p>
1.41 asau 9050: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9051: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.79 snj 9052: <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 9053: will tell you about newer versions of installed packages that are
9054: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9055: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9056: — it contains a list of suggested new packages and a list of
1.1 dsieger 9057: cleanups and enhancements for pkgsrc that would be nice to
9058: have.</p></li>
1.23 wiz 9059: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9060: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9061: mailing list.</p></li>
9062: </ul></div>
9063: </td>
9064: </tr>
9065: </tbody>
9066: </table>
9067: </div>
9068: </div>
1.41 asau 9069: <div class="chapter">
1.1 dsieger 9070: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9071: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9072: <div class="toc">
9073: <p><b>Table of Contents</b></p>
1.100 leot 9074: <dl class="toc">
1.6 rillig 9075: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9076: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9077: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9078: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9079: </dl>
9080: </div>
1.10 hubertf 9081: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9082: site</a>:</p>
9083: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9084: environment, an intuitive and attractive desktop for users, and the
9085: GNOME development platform, an extensive framework for building
9086: applications that integrate into the rest of the desktop.</p></blockquote></div>
9087: <p>pkgsrc provides a seamless way to automatically build and install
9088: a complete GNOME environment <span class="emphasis"><em>under many different
9089: platforms</em></span>. We can say with confidence that pkgsrc is one of
9090: the most advanced build and packaging systems for GNOME due to its
9091: included technologies buildlink3, the wrappers and tools framework and
9092: automatic configuration file management. Lots of efforts are put into
9093: achieving a completely clean deinstallation of installed software
9094: components.</p>
1.10 hubertf 9095: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9096: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9097: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9098: pkgsrc as its preferred packaging system, contributing lots of
9099: portability fixes to make GNOME build and install under it.</p>
9100: <p>This chapter is aimed at pkgsrc developers and other people
9101: interested in helping our GNOME porting and packaging efforts. It
9102: provides instructions on how to manage the existing packages and some
9103: important information regarding their internals.</p>
1.41 asau 9104: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9105: <h3 class="title">We need your help!</h3>
9106: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9107: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9108: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9109: work</a> list! There is still a long way to go to get a
9110: fully-functional GNOME desktop under NetBSD and we need your help to
9111: achieve it!</p>
9112: </div>
1.41 asau 9113: <div class="sect1">
1.1 dsieger 9114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9115: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9116: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9117: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 9118: <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 9119: the core GNOME desktop environment. It only includes the necessary
9120: bits to get it to boot correctly, although it may lack important
9121: functionality for daily operation. The idea behind this package is
9122: to let end users build their own configurations on top of this one,
9123: first installing this meta package to achieve a functional setup and
9124: then adding individual applications.</p></li>
1.79 snj 9125: <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 9126: complete installation of the GNOME platform and desktop as defined
9127: by the GNOME project; this is based on the components distributed in
9128: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9129: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9130: official FTP server. Developer-only tools found in those
9131: directories are not installed unless required by some other
9132: component to work properly. Similarly, packages from the bindings
9133: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9134: in unless required as a dependency for an end-user component. This
1.79 snj 9135: 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>
9136: <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 9137: Installs all the tools required to build a GNOME component when
9138: fetched from the CVS repository. These are required to let the
1.10 hubertf 9139: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9140: </ul></div>
9141: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9142: sorted in a way that eases updates: a package may depend on other
9143: packages listed before it but not on any listed after it. It is very
9144: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9145: change it to alphabetical sorting!</em></span></p>
9146: </div>
1.41 asau 9147: <div class="sect1">
1.1 dsieger 9148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9149: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9150: <p>Almost all GNOME applications are written in C and use a common
9151: set of tools as their build system. Things get different with the new
9152: bindings to other languages (such as Python), but the following will
9153: give you a general idea on the minimum required tools:</p>
1.41 asau 9154: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9155: <li class="listitem">
1.1 dsieger 9156: <p>Almost all GNOME applications use the GNU Autotools as their
9157: build system. As a general rule you will need to tell this to your
9158: package:</p>
9159: <pre class="programlisting">
9160: GNU_CONFIGURE=yes
9161: USE_LIBTOOL=yes
9162: USE_TOOLS+=gmake
9163: </pre>
9164: </li>
1.23 wiz 9165: <li class="listitem">
1.1 dsieger 9166: <p>If the package uses pkg-config to detect dependencies, add this
9167: tool to the list of required utilities:</p>
1.111 ! sevan 9168: <pre class="programlisting">
! 9169: USE_TOOLS+=pkg-config
! 9170: </pre>
1.79 snj 9171: <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 9172: the end of the build process to ensure that you did not miss to
9173: specify any dependency in your package and that the version
9174: requirements are all correct.</p>
9175: </li>
1.23 wiz 9176: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9177: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9178: to handle dependencies and to force the package to use the latest
9179: available version.</p></li>
1.23 wiz 9180: <li class="listitem">
1.1 dsieger 9181: <p>If the package uses gtk-doc (a documentation generation
9182: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9183: tool is rather big and the distfile should come with pregenerated
9184: documentation anyway; if it does not, it is a bug that you ought to
9185: report. For such packages you should disable gtk-doc (unless it is
9186: the default):</p>
1.111 ! sevan 9187: <pre class="programlisting">
! 9188: CONFIGURE_ARGS+=--disable-gtk-doc
! 9189: </pre>
1.1 dsieger 9190: <p>The default location of installed HTML files
9191: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9192: and should not be changed unless the package insists on installing
9193: them somewhere else. Otherwise programs as
1.10 hubertf 9194: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9195: do that with an entry similar to:</p>
1.111 ! sevan 9196: <pre class="programlisting">
! 9197: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
! 9198: </pre>
1.1 dsieger 9199: </li>
9200: </ul></div>
9201: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9202: files under the installation prefix to maintain databases. In this
9203: context, shared means that those exact same directories and files are
9204: used among several different packages, leading to conflicts in the
9205: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9206: handle the most common cases, so you have to forget about using
9207: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9208: omitting shared files from them. If you find yourself doing those,
9209: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9210: <p>The following table lists the common situations that result in
9211: using shared directories or files. For each of them, the appropriate
9212: solution is given. After applying the solution be sure to
9213: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9214: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9215: <div class="table">
1.6 rillig 9216: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9217: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9218: <colgroup>
9219: <col>
9220: <col>
9221: </colgroup>
9222: <thead><tr>
9223: <th>If the package...</th>
9224: <th>Then...</th>
9225: </tr></thead>
9226: <tbody>
9227: <tr>
9228: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9229: <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 9230: </tr>
9231: <tr>
9232: <td>Installs icons under the
9233: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9234: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9235: <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 9236: </tr>
9237: <tr>
9238: <td>Installs files under
9239: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9240: <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 9241: </tr>
9242: <tr>
9243: <td>Installs <code class="filename">.desktop</code> files under
9244: <code class="filename">share/applications</code> and these include MIME
9245: information.</td>
1.10 hubertf 9246: <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 9247: </tr>
9248: </tbody>
9249: </table></div>
9250: </div>
9251: <br class="table-break">
9252: </div>
1.41 asau 9253: <div class="sect1">
1.1 dsieger 9254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9255: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9256: <p>When seeing GNOME as a whole, there are two kinds of
9257: updates:</p>
1.41 asau 9258: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9259: <dt><span class="term">Major update</span></dt>
9260: <dd>
9261: <p>Given that there is still a very long way for GNOME 3 (if it
9262: ever appears), we consider a major update one that goes from a
9263: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9264: where <code class="literal">Y</code> is even and greater than
9265: <code class="literal">X</code>. These are hard to achieve because they
9266: introduce lots of changes in the components' code and almost all
9267: GNOME distfiles are updated to newer versions. Some of them can
9268: even break API and ABI compatibility with the previous major
9269: version series. As a result, the update needs to be done all at
9270: once to minimize breakage.</p>
9271: <p>A major update typically consists of around 80 package
9272: updates and the addition of some new ones.</p>
9273: </dd>
9274: <dt><span class="term">Minor update</span></dt>
9275: <dd>
9276: <p>We consider a minor update one that goes from a
9277: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9278: one where <code class="literal">Y</code> is greater than
9279: <code class="literal">X</code>. These are easy to achieve because they do
9280: not update all GNOME components, can be done in an incremental way
9281: and do not break API nor ABI compatibility.</p>
9282: <p>A minor update typically consists of around 50 package
9283: updates, although the numbers here may vary a lot.</p>
9284: </dd>
9285: </dl></div>
9286: <p>In order to update the GNOME components in pkgsrc to a new stable
9287: release (either major or minor), the following steps should be
9288: followed:</p>
1.23 wiz 9289: <div class="orderedlist"><ol class="orderedlist" type="1">
9290: <li class="listitem">
1.1 dsieger 9291: <p>Get a list of all the tarballs that form the new release by
9292: using the following commands. These will leave the full list of the
1.18 snj 9293: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9294: file:</p>
9295: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9296: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9297: awk '{ print $9 }' >list.txt</code></strong>
9298: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9299: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9300: awk '{ print $9 }' >>list.txt</code></strong></pre>
9301: </li>
1.23 wiz 9302: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9303: bump their version to the release you are updating them to. The
9304: three meta packages should be always consistent with versioning.
9305: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9306: in them.</p></li>
1.23 wiz 9307: <li class="listitem">
1.1 dsieger 9308: <p>For each meta package, update all its
9309: <code class="varname">DEPENDS</code> lines to match the latest versions as
9310: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9311: newer version (even if found in the FTP) because the meta packages
9312: are supposed to list the exact versions that form a specific GNOME
9313: release. Exceptions are permitted here if a newer version solves a
9314: serious issue in the overall desktop experience; these typically
9315: come in the form of a revision bump in pkgsrc, not in newer versions
9316: from the developers.</p>
9317: <p>Packages not listed in the <code class="filename">list.txt</code> file
9318: should be updated to the latest version available (if found in
9319: pkgsrc). This is the case, for example, of the dependencies on the
1.79 snj 9320: 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 9321: </li>
1.23 wiz 9322: <li class="listitem">
1.1 dsieger 9323: <p>Generate a patch from the modified meta packages and extract the
9324: list of "new" lines. This will provide you an outline on what
9325: packages need to be updated in pkgsrc and in what order:</p>
9326: <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>
9327: </li>
1.23 wiz 9328: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9329: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9330: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9331: of <code class="filename">todo.txt</code> and update the packages listed in
9332: it in order. For major desktop updates none of these should be
9333: committed until the entire set is completed because there are chances
9334: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9335: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9336: the tree one by one with appropriate log messages. At the end,
9337: commit the three meta package updates and all the corresponding
9338: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9339: <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>
9340: </ol></div>
9341: </div>
1.41 asau 9342: <div class="sect1">
1.1 dsieger 9343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9344: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9345: <p>GNOME is a very big component in pkgsrc which approaches 100
9346: packages. Please, it is very important that you always, always,
9347: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9348: 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 9349: their attention on portability issues and to ensure that future versions
9350: can be built out-of-the box on NetBSD. The less custom patches in
9351: pkgsrc, the easier further updates are. Those developers in charge of
9352: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9353: <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 9354: Bugzilla</a>. Not all components use these to track bugs, but most
9355: of them do. Do not be short on your reports: always provide detailed
9356: explanations of the current failure, how it can be improved to achieve
9357: maximum portability and, if at all possible, provide a patch against CVS
9358: head. The more verbose you are, the higher chances of your patch being
9359: accepted.</p>
9360: <p>Also, please avoid using preprocessor magic to fix portability
9361: issues. While the FreeBSD GNOME people are doing a great job in porting
9362: GNOME to their operating system, the official GNOME sources are now
9363: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9364: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 9365: 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 9366: details.</p>
9367: </div>
9368: </div>
9369: </div>
1.41 asau 9370: <div class="part">
1.1 dsieger 9371: <div class="titlepage"><div><div><h1 class="title">
9372: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9373: <div class="partintro">
1.1 dsieger 9374: <div></div>
9375: <p>This part of the guide deals with everything
9376: from the infrastructure that is behind the interfaces described
9377: in the developer's guide. A casual package maintainer should not
9378: need anything from this part.</p>
9379: <div class="toc">
9380: <p><b>Table of Contents</b></p>
1.100 leot 9381: <dl class="toc">
1.6 rillig 9382: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9383: <dd><dl>
1.6 rillig 9384: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9385: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9386: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9387: <dd><dl>
1.6 rillig 9388: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9389: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9390: </dl></dd>
1.6 rillig 9391: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9392: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9393: <dd><dl>
1.6 rillig 9394: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9395: <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 9396: </dl></dd>
1.6 rillig 9397: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9398: <dd><dl>
1.23 wiz 9399: <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>
9400: <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 9401: </dl></dd>
9402: </dl></dd>
1.6 rillig 9403: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 9404: <dd><dl>
1.108 rillig 9405: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9406: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9407: <dd><dl>
1.108 rillig 9408: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9409: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9410: </dl></dd>
9411: </dl></dd>
1.6 rillig 9412: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 9413: <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 9414: </dl>
9415: </div>
9416: </div>
1.41 asau 9417: <div class="chapter">
1.1 dsieger 9418: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9419: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9420: <div class="toc">
9421: <p><b>Table of Contents</b></p>
1.100 leot 9422: <dl class="toc">
1.6 rillig 9423: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9424: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9425: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9426: <dd><dl>
1.6 rillig 9427: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9428: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9429: </dl></dd>
1.6 rillig 9430: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9431: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9432: <dd><dl>
1.6 rillig 9433: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9434: <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 9435: </dl></dd>
1.6 rillig 9436: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9437: <dd><dl>
1.23 wiz 9438: <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>
9439: <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 9440: </dl></dd>
9441: </dl>
9442: </div>
9443: <p>The pkgsrc infrastructure consists of many small Makefile
9444: fragments. Each such fragment needs a properly specified
9445: interface. This chapter explains how such an interface looks
9446: like.</p>
1.41 asau 9447: <div class="sect1">
1.1 dsieger 9448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9449: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9450: <p>Whenever a variable is defined in the pkgsrc
9451: infrastructure, the location and the way of definition provide
9452: much information about the intended use of that variable.
9453: Additionally, more documentation may be found in a header
9454: comment or in this pkgsrc guide.</p>
9455: <p>A special file is
9456: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9457: variables that are intended to be user-defined. They are either
9458: defined using the <code class="literal">?=</code> operator or they are
9459: left undefined because defining them to anything would
1.23 wiz 9460: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9461: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9462: file.</p>
9463: <p>Outside this file, the following conventions apply:
9464: Variables that are defined using the <code class="literal">?=</code>
9465: operator may be overridden by a package.</p>
9466: <p>Variables that are defined using the <code class="literal">=</code>
9467: operator may be used read-only at run-time.</p>
9468: <p>Variables whose name starts with an underscore must not be
9469: accessed outside the pkgsrc infrastructure at all. They may
9470: change without further notice.</p>
1.41 asau 9471: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9472: <h3 class="title">Note</h3>
9473: <p>These conventions are currently not applied
9474: consistently to the complete pkgsrc
9475: infrastructure.</p>
9476: </div>
9477: </div>
1.41 asau 9478: <div class="sect1">
1.1 dsieger 9479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9480: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9481: <p>All variables that contain lists of things should default
9482: to being empty. Two examples that do not follow this rule are
9483: <code class="varname">USE_LANGUAGES</code> and
9484: <code class="varname">DISTFILES</code>. These variables cannot simply be
9485: modified using the <code class="literal">+=</code> operator in package
9486: <code class="filename">Makefile</code>s (or other files included by
9487: them), since there is no guarantee whether the variable is
9488: already set or not, and what its value is. In the case of
1.23 wiz 9489: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9490: the default value and just define it as in the following
9491: example.</p>
9492: <pre class="programlisting">
9493: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9494: </pre>
9495: <p>Because of the selection of this default value, the same
9496: value appears in many package Makefiles. Similarly for
9497: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9498: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9499: doesn't stand out. Nevertheless it is mentioned in many
9500: files.</p>
9501: </div>
1.41 asau 9502: <div class="sect1">
1.1 dsieger 9503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9504: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 9505: <div class="sect2">
1.1 dsieger 9506: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9507: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 9508: <p>Variable evaluation takes place either at load time or at
9509: runtime, depending on the context in which they occur. The
9510: contexts where variables are evaluated at load time are:</p>
1.41 asau 9511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9512: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9513: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9514: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9515: <code class="literal">.for</code>,</p></li>
1.23 wiz 9516: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9517: </ul></div>
9518: <p>A special exception are references to the iteration
9519: variables of <code class="literal">.for</code> loops, which are expanded
9520: inline, no matter in which context they appear.</p>
9521: <p>As the values of variables may change during load time,
9522: care must be taken not to evaluate them by accident. Typical
9523: examples for variables that should not be evaluated at load time
9524: are <code class="varname">DEPENDS</code> and
9525: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9526: clear, here is an example:</p>
9527: <pre class="programlisting">
9528: CONFIGURE_ARGS= # none
9529: CFLAGS= -O
9530: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9531:
9532: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9533:
9534: CFLAGS+= -Wall
1.111 ! sevan 9535: </pre>
1.1 dsieger 9536: <p>This code shows how the use of the <code class="literal">:=</code>
9537: operator can quickly lead to unexpected results. The first
9538: paragraph is fairly common code. The second paragraph evaluates
9539: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9540: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9541: <code class="literal">-Wall</code> is appended to the
9542: <code class="varname">CFLAGS</code>, but this addition will not appear in
9543: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9544: paragraphs from above typically occur in completely unrelated
9545: files.</p>
9546: </div>
1.41 asau 9547: <div class="sect2">
1.1 dsieger 9548: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9549: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9550: <p>After all the files have been loaded, the values of the
9551: variables cannot be changed anymore. Variables that are used in
9552: the shell commands are expanded at this point.</p>
9553: </div>
9554: </div>
1.41 asau 9555: <div class="sect1">
1.1 dsieger 9556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9557: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9558: <p>There are many ways in which the definition and use of a
1.108 rillig 9559: variable can be restricted in order to detect bugs and violations
9560: of the (mostly unwritten) policies. A package can be checked with
9561: <code class="literal">pkglint -Wall</code> to see whether it meets these
9562: rules.</p>
1.1 dsieger 9563: </div>
1.41 asau 9564: <div class="sect1">
1.1 dsieger 9565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9566: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9567: <p>Most of the <code class="filename">.mk</code> files fall into one
9568: of the following classes. Cases where a file falls into more
9569: than one class should be avoided as it often leads to subtle
9570: bugs.</p>
1.41 asau 9571: <div class="sect2">
1.1 dsieger 9572: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9573: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9574: <p>In a traditional imperative programming language some of
9575: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9576: procedures. They take some input parameters and—after
9577: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9578: variables in <code class="filename">Makefile</code>s have global scope
9579: care must be taken not to use parameter names that have already
9580: another meaning. For example, <code class="varname">PKGNAME</code> is a
9581: bad choice for a parameter name.</p>
9582: <p>Procedures are completely evaluated at preprocessing time.
9583: That is, when calling a procedure all input parameters must be
9584: completely resolvable. For example,
9585: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9586: parameter since it is very likely that further text will be
9587: added after calling the procedure, which would effectively apply
9588: the procedure to only a part of the variable. Also, references
1.108 rillig 9589: to other variables will be modified after calling the
1.1 dsieger 9590: procedure.</p>
9591: <p>A procedure can declare its output parameters either as
9592: suitable for use in preprocessing directives or as only
9593: available at runtime. The latter alternative is for variables
9594: that contain references to other runtime variables.</p>
9595: <p>Procedures shall be written such that it is possible to
9596: call the procedure more than once. That is, the file must not
9597: contain multiple-inclusion guards.</p>
9598: <p>Examples for procedures are
9599: <code class="filename">mk/bsd.options.mk</code> and
9600: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9601: that the parameters are evaluated at load time, they should be
9602: assigned using the <code class="literal">:=</code> operator, which should
9603: be used only for this purpose.</p>
9604: </div>
1.41 asau 9605: <div class="sect2">
1.1 dsieger 9606: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9607: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9608: <p>Action files take some input parameters and may define
9609: runtime variables. They shall not define loadtime variables.
9610: There are action files that are included implicitly by the
9611: pkgsrc infrastructure, while other must be included
9612: explicitly.</p>
9613: <p>An example for action files is
9614: <code class="filename">mk/subst.mk</code>.</p>
9615: </div>
9616: </div>
1.41 asau 9617: <div class="sect1">
1.1 dsieger 9618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9619: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 9620: <p>Package <code class="filename">Makefile</code>s usually consist of
9621: a set of variable definitions, and include the file
9622: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9623: Before that, they may also include various other
9624: <code class="filename">*.mk</code> files if they need to query the
9625: availability of certain features like the type of compiler or
9626: the X11 implementation. Due to the heavy use of preprocessor
9627: directives like <code class="literal">.if</code> and
9628: <code class="literal">.for</code>, the order in which the files are loaded
9629: matters.</p>
9630: <p>This section describes at which point the various files
9631: are loaded and gives reasons for that order.</p>
1.41 asau 9632: <div class="sect2">
1.1 dsieger 9633: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9634: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 9635: </h3></div></div></div>
9636: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
9637: is to define some essential variables like
9638: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9639: <code class="varname">MACHINE_ARCH</code>.</p>
9640: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 9641: 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 9642: After that, those variables
1.1 dsieger 9643: that have not been overridden by the user are loaded from
9644: <code class="filename">mk/defaults/mk.conf</code>.</p>
9645: <p>After the user settings, the system settings and platform
9646: settings are loaded, which may override the user
9647: settings.</p>
9648: <p>Then, the tool definitions are loaded. The tool wrappers
9649: are not yet in effect. This only happens when building a
9650: package, so the proper variables must be used instead of the
9651: direct tool names.</p>
9652: <p>As the last steps, some essential variables from the
9653: wrapper and the package system flavor are loaded, as well as the
9654: variables that have been cached in earlier phases of a package
9655: build.</p>
9656: </div>
1.41 asau 9657: <div class="sect2">
1.1 dsieger 9658: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9659: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 9660: </h3></div></div></div>
9661: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9662: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9663: loaded, which fill default values for those variables that have
9664: not been defined by the package. These variables may later
9665: be used even in unrelated files.</p>
9666: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9667: provides the target <code class="literal">error-check</code> that is added
9668: as a special dependency to all other targets that use
9669: <code class="varname">DELAYED_ERROR_MSG</code> or
9670: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9671: <p>Then, the package-specific hacks from
9672: <code class="filename">hacks.mk</code> are included.</p>
9673: <p>Then, various other files follow. Most of them don't have
9674: any dependencies on what they need to have included before or
9675: after them, though some do.</p>
9676: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9677: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9678: restricts the use of these variables to all the files that have
9679: been included before. Appearances in later files will be
9680: silently ignored.</p>
9681: <p>Then, the files for the main targets are included, in the
9682: order of later execution, though the actual order should not
9683: matter.</p>
9684: <p>At last, some more files are included that don't set any
9685: interesting variables but rather just define make targets to be
9686: executed.</p>
9687: </div>
9688: </div>
9689: </div>
1.41 asau 9690: <div class="chapter">
1.1 dsieger 9691: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9692: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 9693: <div class="toc">
9694: <p><b>Table of Contents</b></p>
1.100 leot 9695: <dl class="toc">
1.108 rillig 9696: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9697: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9698: <dd><dl>
1.108 rillig 9699: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9700: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9701: </dl></dd>
9702: </dl>
9703: </div>
9704: <p>The pkgsrc infrastructure consists of a large codebase,
9705: and there are many corners where every little bit of a file is
9706: well thought out, making pkgsrc likely to fail as soon as
9707: anything is changed near those parts. To prevent most changes
9708: from breaking anything, a suite of regression tests should go
9709: along with every important part of the pkgsrc infrastructure.
9710: This chapter describes how regression tests work in pkgsrc and
9711: how you can add new tests.</p>
1.41 asau 9712: <div class="sect1">
1.1 dsieger 9713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9714: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.79 snj 9715: <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 9716: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 9717: can simply run that command, which will run all tests in the
9718: <code class="filename">regress</code> category.</p>
9719: </div>
1.41 asau 9720: <div class="sect1">
1.1 dsieger 9721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9722: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.1 dsieger 9723: <p>Every directory in the <code class="filename">regress</code>
9724: category that contains a file called <code class="filename">spec</code>
9725: is considered a regression test. This file is a shell program
1.10 hubertf 9726: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 9727: The following functions can be overridden to suit your
9728: needs.</p>
1.41 asau 9729: <div class="sect2">
1.1 dsieger 9730: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9731: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
9732: <p>These functions do not take any parameters. Although they
9733: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9734: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9735: question</a> for details.</p>
1.41 asau 9736: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9737: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 9738: <dd><p>This function prepares the environment for the
9739: test. By default it does nothing.</p></dd>
1.108 rillig 9740: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9741: <dd>
9742: <p>This function runs the actual test. By default,
1.1 dsieger 9743: it calls <code class="varname">TEST_MAKE</code> with the arguments
9744: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9745: error messages into the file
1.108 rillig 9746: <code class="varname">TEST_OUTFILE</code>.</p>
9747: <p>When defining this function, make sure that all output that
9748: needs to be checked is written to the correct output file.
9749: Example:</p>
9750: <pre class="programlisting">
9751: do_test() {
9752: echo "Example output"
9753: } 1>$TEST_OUTFILE 2>&1
9754: </pre>
9755: </dd>
9756: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9757: <dd>
9758: <p>This function is run after the test and is
1.1 dsieger 9759: typically used to compare the actual output from the one that is
9760: expected. It can make use of the various helper functions from
1.108 rillig 9761: the next section. Example:</p>
9762: <pre class="programlisting">
9763: check_result() {
9764: exit_status 0
9765: output_require "Example"
9766: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9767: output_prohibit "no such file or directory"
9768: }
9769: </pre>
9770: </dd>
9771: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 9772: <dd><p>This function cleans everything up after the
9773: test has been run. By default it does nothing.</p></dd>
9774: </dl></div>
9775: </div>
1.41 asau 9776: <div class="sect2">
1.1 dsieger 9777: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9778: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.41 asau 9779: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9780: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 9781: <dd><p>This function compares the exitcode of the
1.108 rillig 9782: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 9783: If they differ, the test will fail.</p></dd>
1.108 rillig 9784: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9785: <dd>
9786: <p>This function checks for each of its parameters
9787: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 9788: extended regular expression. If it does not, the test will
1.108 rillig 9789: fail. Example:</p>
9790: <pre class="programlisting">
9791: output_require "looks fine"
9792: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9793: </pre>
9794: </dd>
1.1 dsieger 9795: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9796: <dd><p>This function checks for each of its parameters
1.10 hubertf 9797: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 9798: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9799: If any of the regular expressions matches, the test will
9800: fail.</p></dd>
9801: </dl></div>
9802: </div>
9803: </div>
9804: </div>
1.41 asau 9805: <div class="chapter">
1.1 dsieger 9806: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9807: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 9808: <div class="toc">
9809: <p><b>Table of Contents</b></p>
1.108 rillig 9810: <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 9811: </div>
9812: <p>The pkgsrc system has already been ported to many
9813: operating systems, hardware architectures and compilers. This
9814: chapter explains the necessary steps to make pkgsrc even more
9815: portable.</p>
1.41 asau 9816: <div class="sect1">
1.1 dsieger 9817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9818: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 9819: <p>To port pkgsrc to a new operating system (called
9820: <code class="literal">MyOS</code> in this example), you need to touch the
9821: following files:</p>
1.41 asau 9822: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9823: <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>
9824: <dd><p>This file contains some basic definitions, for
9825: example the name of the C
9826: compiler.</p></dd>
9827: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
9828: <dd><p>Insert code that defines the variables
9829: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
9830: <code class="varname">LOWER_OS_VERSION</code>,
9831: <code class="varname">LOWER_VENDOR</code>,
9832: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
9833: <code class="varname">APPEND_ELF</code>, and the other variables that
9834: appear in this file.</p></dd>
9835: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9836: <dd><p>This file contains the platform-specific
9837: definitions that are used by pkgsrc. Start by copying one of the
9838: other files and edit it to your
9839: needs.</p></dd>
9840: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9841: <dd><p>This file defines the paths to all the tools
9842: that are needed by one or the other package in pkgsrc, as well
9843: as by pkgsrc itself. Find out where these tools are on your
9844: platform and add them.</p></dd>
9845: </dl></div>
9846: <p>Now, you should be able to build some basic packages, like
1.79 snj 9847: <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 9848: </div>
9849: </div>
9850: </div>
1.41 asau 9851: <div class="appendix">
9852: <div class="titlepage"><div><div><h1 class="title">
9853: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 9854: <div class="toc">
9855: <p><b>Table of Contents</b></p>
1.100 leot 9856: <dl class="toc">
1.1 dsieger 9857: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
9858: <dd><dl>
9859: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
9860: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
9861: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 9862: <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 9863: </dl></dd>
9864: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
9865: </dl>
9866: </div>
9867: <p>We checked to find a piece of software that wasn't in the packages
9868: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 9869: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 9870: present in the tree is beyond us, but it's useful for the purposes of
9871: this exercise.</p>
1.41 asau 9872: <div class="sect1">
1.1 dsieger 9873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9874: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 9875: <div class="sect2">
1.1 dsieger 9876: <div class="titlepage"><div><div><h3 class="title">
9877: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
9878: <pre class="programlisting">
9879: # $NetBSD$
9880: #
9881:
9882: DISTNAME= bison-1.25
9883: CATEGORIES= devel
9884: MASTER_SITES= ${MASTER_SITE_GNU}
9885:
1.29 dholland 9886: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 9887: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
9888: COMMENT= GNU yacc clone
9889:
9890: GNU_CONFIGURE= yes
1.46 wiz 9891: INFO_FILES= yes
1.1 dsieger 9892:
9893: .include "../../mk/bsd.pkg.mk"
9894: </pre>
9895: </div>
1.41 asau 9896: <div class="sect2">
1.1 dsieger 9897: <div class="titlepage"><div><div><h3 class="title">
9898: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
9899: <pre class="programlisting">
9900: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.79 snj 9901: 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 9902: of the NetBSD source tree is beyond me.
9903: </pre>
9904: </div>
1.41 asau 9905: <div class="sect2">
1.1 dsieger 9906: <div class="titlepage"><div><div><h3 class="title">
9907: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
9908: <pre class="programlisting">
9909: @comment $NetBSD$
9910: bin/bison
9911: man/man1/bison.1.gz
9912: share/bison.simple
9913: share/bison.hairy
9914: </pre>
9915: </div>
1.41 asau 9916: <div class="sect2">
1.1 dsieger 9917: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 9918: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 9919: </h3></div></div></div>
9920: <p>The NetBSD package system comes with
1.79 snj 9921: <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 9922: which helps to check the contents of these
9923: files. After installation it is quite easy to use, just change to the
9924: directory of the package you wish to examine and execute
1.10 hubertf 9925: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 9926: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
9927: looks fine.</pre>
9928: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 9929: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 9930: -Wall</strong></span> for a very thorough check.</p>
9931: </div>
9932: </div>
1.41 asau 9933: <div class="sect1">
1.1 dsieger 9934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9935: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
9936: <p>Create the directory where the package lives,
9937: plus any auxiliary directories:</p>
9938: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
9939: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
9940: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
9941: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
9942: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 9943: <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 9944: then continue with fetching the distfile:</p>
9945: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
9946: >> bison-1.25.tar.gz doesn't seem to exist on this system.
9947: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
9948: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9949: ftp: Error retrieving file: 500 Internal error
9950:
9951: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
9952: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9953: ftp: Error retrieving file: 500 Internal error
9954:
9955: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
9956: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9957: Successfully retrieved file.</pre>
9958: <p>Generate the checksum of the distfile into
9959: <code class="filename">distinfo</code>:</p>
9960: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
9961: <p>Now compile:</p>
9962: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
9963: >> Checksum OK for bison-1.25.tar.gz.
9964: ===> Extracting for bison-1.25
9965: ===> Patching for bison-1.25
9966: ===> Ignoring empty patch directory
9967: ===> Configuring for bison-1.25
9968: creating cache ./config.cache
9969: checking for gcc... cc
9970: checking whether we are using GNU C... yes
9971: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
9972: checking how to run the C preprocessor... cc -E
9973: checking for minix/config.h... no
9974: checking for POSIXized ISC... no
9975: checking whether cross-compiling... no
9976: checking for ANSI C header files... yes
9977: checking for string.h... yes
9978: checking for stdlib.h... yes
9979: checking for memory.h... yes
9980: checking for working const... yes
9981: checking for working alloca.h... no
9982: checking for alloca... yes
9983: checking for strerror... yes
9984: updating cache ./config.cache
9985: creating ./config.status
9986: creating Makefile
9987: ===> Building for bison-1.25
9988: 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
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 allocate.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 closure.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 conflicts.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 derives.c
9993: 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
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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.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 reduce.c
10004: 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
10005: 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
10006: 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
10007: 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
10008: 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
10009: 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
10010: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10011: rm -f bison.s1
10012: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10013: <p>Everything seems OK, so install the files:</p>
10014: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10015: >> Checksum OK for bison-1.25.tar.gz.
10016: ===> Installing for bison-1.25
10017: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10018: rm -f /usr/pkg/bin/bison
10019: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10020: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10021: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10022: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10023: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10024: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10025: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10026: ===> Registering installation for bison-1.25</pre>
10027: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10028: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10029: binary package, do this now:</p>
10030: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10031: >> Checksum OK for bison-1.25.tar.gz.
10032: ===> Building package for bison-1.25
10033: Creating package bison-1.25.tgz
10034: Registering depends:.
10035: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10036: <p>Now that you don't need the source and object files
10037: any more, clean up:</p>
10038: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10039: ===> Cleaning for bison-1.25</pre>
10040: </div>
10041: </div>
1.41 asau 10042: <div class="appendix">
10043: <div class="titlepage"><div><div><h1 class="title">
10044: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10045: <div class="toc">
10046: <p><b>Table of Contents</b></p>
1.100 leot 10047: <dl class="toc">
1.1 dsieger 10048: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10049: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10050: </dl>
10051: </div>
1.41 asau 10052: <div class="sect1">
1.1 dsieger 10053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10054: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10055: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10056: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10057: => figlet221.tar.gz doesn't seem to exist on this system.
10058: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10059: => [172219 bytes]
10060: Connected to ftp.plig.net.
10061: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10062: 331 Guest login ok, send your complete e-mail address as password.
10063: 230-You are user #5 of 500 simultaneous users allowed.
10064: 230-
10065: 230- ___ _ _ _
10066: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10067: 230- | _| _| . |_| . | | | . |_| . | _| . |
10068: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10069: 230- |_| |_| |___| |___|
10070: 230-
10071: 230-** Welcome to ftp.plig.org **
10072: 230-
10073: 230-Please note that all transfers from this FTP site are logged. If you
10074: 230-do not like this, please disconnect now.
10075: 230-
1.18 snj 10076: 230-This archive is available via
1.1 dsieger 10077: 230-
10078: 230-HTTP: http://ftp.plig.org/
10079: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10080: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10081: 230-
10082: 230-Please email comments, bug reports and requests for packages to be
10083: 230-mirrored to ftp-admin@plig.org.
10084: 230-
10085: 230-
10086: 230 Logged in anonymously.
10087: Remote system type is UNIX.
10088: Using binary mode to transfer files.
10089: 200 Type okay.
10090: 250 "/pub" is new cwd.
10091: 250-"/pub/figlet" is new cwd.
10092: 250-
10093: 250-Welcome to the figlet archive at ftp.figlet.org
10094: 250-
10095: 250- ftp://ftp.figlet.org/pub/figlet/
10096: 250-
10097: 250-The official FIGlet web page is:
10098: 250- http://www.figlet.org/
10099: 250-
10100: 250-If you have questions, please mailto:info@figlet.org. If you want to
10101: 250-contribute a font or something else, you can email us.
10102: 250
10103: 250 "/pub/figlet/program" is new cwd.
10104: 250 "/pub/figlet/program/unix" is new cwd.
10105: local: figlet221.tar.gz remote: figlet221.tar.gz
10106: 502 Unimplemented command.
10107: 227 Entering Passive Mode (195,40,6,41,246,104)
10108: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10109: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10110: 226 Transfer completed.
10111: 172219 bytes received in 00:02 (75.99 KB/s)
10112: 221 Goodbye.
10113: => Checksum OK for figlet221.tar.gz.
10114: ===> Extracting for figlet-2.2.1nb2
10115: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10116: ===> Patching for figlet-2.2.1nb2
10117: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10118: ===> Overriding tools for figlet-2.2.1nb2
10119: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10120: ===> Configuring for figlet-2.2.1nb2
10121: ===> Building for figlet-2.2.1nb2
10122: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10123: chmod a+x figlet
10124: gcc -O2 -o chkfont chkfont.c
10125: => Unwrapping files-to-be-installed.
10126: <code class="prompt">#</code>
10127: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10128: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10129: ===> Installing for figlet-2.2.1nb2
10130: install -d -o root -g wheel -m 755 /usr/pkg/bin
10131: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10132: mkdir -p /usr/pkg/share/figlet
10133: cp figlet /usr/pkg/bin
10134: cp chkfont /usr/pkg/bin
10135: chmod 555 figlist showfigfonts
10136: cp figlist /usr/pkg/bin
10137: cp showfigfonts /usr/pkg/bin
10138: cp fonts/*.flf /usr/pkg/share/figlet
10139: cp fonts/*.flc /usr/pkg/share/figlet
10140: cp figlet.6 /usr/pkg/man/man6
10141: ===> Registering installation for figlet-2.2.1nb2
10142: <code class="prompt">#</code></pre>
10143: </div>
1.41 asau 10144: <div class="sect1">
1.1 dsieger 10145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10146: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10147: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10148: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10149: ===> Packaging figlet-2.2.1nb2
10150: ===> Building binary package for figlet-2.2.1nb2
10151: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10152: Using SrcDir value of /usr/pkg
10153: Registering depends:.
10154: <code class="prompt">#</code></pre>
10155: </div>
10156: </div>
1.41 asau 10157: <div class="appendix">
10158: <div class="titlepage"><div><div><h1 class="title">
10159: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10160: <div class="toc">
10161: <p><b>Table of Contents</b></p>
1.100 leot 10162: <dl class="toc">
1.23 wiz 10163: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10164: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10165: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10166: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10167: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10168: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10169: source packages</a></span></dt>
10170: </dl>
10171: </div>
10172: <p>As in other big projects, the directory layout of pkgsrc
10173: is quite complex for newbies. This chapter explains where you
10174: find things on the FTP server. The base directory on
1.10 hubertf 10175: <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 10176: On other servers it may be different, but inside this directory,
10177: everything should look the same, no matter on which server you
10178: are. This directory contains some subdirectories, which are
10179: explained below.</p>
1.41 asau 10180: <div class="sect1">
1.1 dsieger 10181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10182: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10183: <p>The directory <code class="filename">distfiles</code> contains lots
10184: of archive files from all pkgsrc packages, which are mirrored
10185: here. The subdirectories are called after their package names
10186: and are used when the distributed files have names that don't
10187: explicitly contain a version number or are otherwise too generic
10188: (for example <code class="filename">release.tar.gz</code>).</p>
10189: </div>
1.41 asau 10190: <div class="sect1">
1.1 dsieger 10191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10192: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10193: <p>This directory contains things that individual pkgsrc
10194: developers find worth publishing.</p>
10195: </div>
1.41 asau 10196: <div class="sect1">
1.1 dsieger 10197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10198: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10199: <p>This directory contains binary packages for the various
10200: platforms that are supported by pkgsrc.
10201: 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 10202: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10203: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10204: operating system for which the packages have been built. The
1.10 hubertf 10205: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10206: command, so it may differ from the one you are used to
10207: hear.</p></li>
1.23 wiz 10208: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10209: architecture of the platform for which the packages have been
1.10 hubertf 10210: built. It also includes the <code class="varname">ABI</code> (Application
10211: Binary Interface) for platforms that have several of
10212: them.</p></li>
1.23 wiz 10213: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10214: the operating system. For version numbers that change often (for
10215: example NetBSD-current), the often-changing part should be
10216: replaced with an <code class="literal">x</code>, for example
10217: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10218: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10219: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10220: for a stable branch, or <code class="literal">head</code> for packages
10221: built from the HEAD branch. The latter should only be used when
10222: the packages are updated on a regular basis. Otherwise the date
10223: from checking out pkgsrc should be appended, for example
10224: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10225: </ul></div>
10226: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10227: can quickly click through the directories on the
10228: server and find the best binary packages for their machines. Since they
10229: usually know the operating system and the hardware architecture, OPSYS
10230: and ARCH are placed first. After these choices, they can select the
10231: best combination of OSVERSION and TAG together, since it is usually the
10232: case that packages stay compatible between different version of the
10233: operating system.</p>
10234: <p>In each of these directories, there is a
10235: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10236: <code class="filename">All</code> which contains all binary packages.
10237: Besides that, there are various category directories that
10238: contain symbolic links to the real binary packages.</p>
10239: </div>
1.41 asau 10240: <div class="sect1">
1.1 dsieger 10241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10242: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10243: <p>Here are the reports from bulk builds, for those who want
10244: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10245: 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 10246: </div>
1.41 asau 10247: <div class="sect1">
1.8 rillig 10248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10249: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10250: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10251: source packages</h2></div></div></div>
1.23 wiz 10252: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10253: that is the files that define how to create binary packages from
10254: source archives.</p>
10255: <p>The directory <code class="filename">pkgsrc</code> contains a
10256: snapshot of the CVS repository, which is updated regularly. The
10257: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10258: directory, ready to be downloaded as a whole.</p>
10259: <p>In the directories for the quarterly branches, there is an
10260: additional file called
1.22 jakllsch 10261: <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 10262: which contains the state of pkgsrc when it was branched.</p>
10263: </div>
10264: </div>
1.41 asau 10265: <div class="appendix">
10266: <div class="titlepage"><div><div><h1 class="title">
10267: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10268: <div class="toc">
10269: <p><b>Table of Contents</b></p>
1.100 leot 10270: <dl class="toc">
1.1 dsieger 10271: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10272: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10273: </dl>
10274: </div>
10275: <p>This section contains information on editing the pkgsrc
10276: guide itself.</p>
1.41 asau 10277: <div class="sect1">
1.1 dsieger 10278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10279: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10280: <p>The pkgsrc guide's source code is stored in
10281: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10282: are created from it:</p>
1.41 asau 10283: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10284: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10285: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10286: <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>
10287: <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 10288: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10289: <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 10290: PostScript version of the pkgsrc guide.</p></li>
10291: </ul></div>
10292: </div>
1.41 asau 10293: <div class="sect1">
1.1 dsieger 10294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10295: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10296: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10297: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10298: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10299: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10300: documentation) installed. These are automatically installed when
1.79 snj 10301: 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 10302: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10303: right directory. All further steps will take place
10304: here.</p></li>
1.41 asau 10305: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10306: <code class="filename">files/</code>.</p></li>
1.41 asau 10307: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10308: guide for valid XML and to build the final output files. If you
10309: get any errors at this stage, you can just edit the files, as
10310: there are only symbolic links in the working directory, pointing
10311: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10312: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10313: commit)</strong></span></p></li>
1.41 asau 10314: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10315: regenerate the output files with the proper RCS
10316: Ids.</p></li>
1.41 asau 10317: <li class="step">
1.10 hubertf 10318: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10319: commit the files in both <code class="filename">pkgsrc/doc</code> and
10320: <code class="filename">htdocs</code>.</p>
1.41 asau 10321: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10322: <h3 class="title">Note</h3>
10323: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10324: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10325: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10326: directory.</p>
10327: </div>
10328: </li>
10329: </ol></div>
10330: </div>
10331: </div>
10332: </div></body>
10333: </html>
CVSweb <webmaster@jp.NetBSD.org>