Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.114
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.107 jnemeth 33: <div><p class="copyright">Copyright © 1994-2016 The NetBSD Foundation, Inc</p></div>
1.108 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.30 2016/06/11 18:14:42 rillig Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.100 leot 48: <dl class="toc">
1.1 dsieger 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
1.51 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
81: </dl></dd>
82: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
83: <dd><dl>
84: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
85: <dd><dl>
86: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
88: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
90: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
92: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
93: </dl></dd>
94: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
97: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
98: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
99: </dl></dd>
100: </dl></dd>
101: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
102: <dd><dl>
103: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
104: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 105: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 106: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 107: <dd><dl>
1.4 rillig 108: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 109: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
110: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 111: </dl></dd>
1.4 rillig 112: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
113: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 114: </dl></dd>
115: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
116: <dd><dl>
117: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
118: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 119: </dl></dd>
120: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
121: builds)</a></span></dt>
1.1 dsieger 122: <dd><dl>
1.71 wiz 123: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
124: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
125: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
126: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 127: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
128: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 129: </dl></dd>
130: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
131: <dd><dl>
1.23 wiz 132: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
133: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 134: </dl></dd>
135: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
136: <dd><dl>
137: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 138: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
139: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
140: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
141: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
142: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
143: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
144: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
145: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
146: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 147: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 148: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
149: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
150: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
151: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
152: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
153: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
154: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 155: </dl></dd>
156: </dl></dd>
157: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
158: <dd><dl>
1.6 rillig 159: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 160: <dd><dl>
1.6 rillig 161: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 162: <dd><dl>
1.6 rillig 163: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 164: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 165: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 166: </dl></dd>
1.6 rillig 167: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
168: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
169: </dl></dd>
170: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
171: <dd><dl>
1.23 wiz 172: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
173: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 174: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 175: <dd><dl>
176: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
177: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
178: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
179: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
180: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
181: </dl></dd>
182: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
183: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
184: <dd><dl>
185: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
186: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
187: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
188: </dl></dd>
1.23 wiz 189: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
190: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 191: </dl></dd>
1.23 wiz 192: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 193: <dd><dl>
194: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 195: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 196: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
197: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
198: <dd><dl>
199: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 200: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
201: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
202: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 203: </dl></dd>
204: </dl></dd>
205: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
206: <dd><dl>
207: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 208: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
209: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 210: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
211: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 212: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 213: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 214: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
215: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 216: </dl></dd>
217: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
218: <dd><dl>
219: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 220: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 221: <dd><dl>
222: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 223: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
224: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
225: and
226: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
227: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 228: </dl></dd>
1.23 wiz 229: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 230: <dd><dl>
1.23 wiz 231: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 232: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
233: </dl></dd>
234: </dl></dd>
235: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
236: <dd><dl>
237: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
238: <dd><dl>
239: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
240: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
241: </dl></dd>
242: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
243: <dd><dl>
1.23 wiz 244: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 245: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
246: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
247: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
248: </dl></dd>
249: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
250: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
251: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
252: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
253: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
254: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
255: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
256: </dl></dd>
257: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
258: <dd><dl>
259: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 260: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 261: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 262: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 263: </dl></dd>
264: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
265: <dd><dl>
266: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
267: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
268: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
269: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 270: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 271: <dd><dl>
272: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
273: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
274: </dl></dd>
1.23 wiz 275: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
276: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
277: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
279: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
280: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
281: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
282: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
283: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 285: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
286: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
287: </dl></dd>
288: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
291: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
292: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
293: </dl></dd>
294: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
295: <dd><dl>
296: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
297: <dd><dl>
1.108 rillig 298: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
299: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
300: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
301: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
302: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
303: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
304: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
305: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
306: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
307: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
308: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.6 rillig 309: </dl></dd>
1.108 rillig 310: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 311: <dd><dl>
312: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
313: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.88 tnn 314: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 315: </dl></dd>
1.108 rillig 316: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 317: <dd><dl>
318: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
319: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
320: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
321: </dl></dd>
322: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
323: <dd><dl>
324: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
325: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
326: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 327: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
328: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 329: </dl></dd>
1.108 rillig 330: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 331: <dd><dl>
332: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
333: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 334: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 335: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
336: </dl></dd>
1.108 rillig 337: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 338: <dd><dl>
339: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
340: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
341: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
342: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
343: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
344: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
345: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
346: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 347: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 348: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 349: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
350: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
351: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
352: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
353: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
354: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
355: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
356: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 357: emulation</a></span></dt>
1.6 rillig 358: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
359: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 360: </dl></dd>
1.6 rillig 361: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 362: </dl></dd>
1.6 rillig 363: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
364: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 365: <dd><dl>
1.6 rillig 366: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
367: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
368: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 369: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 370: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 371: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
372: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 373: </dl></dd>
374: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
375: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
376: <dd><dl>
377: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
378: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
379: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
380: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 381: </dl></dd>
382: </dl></dd>
383: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
384: <dd><dl>
1.6 rillig 385: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 386: <dd><dl>
1.6 rillig 387: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
388: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
389: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 390: <dd><dl>
1.6 rillig 391: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
392: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 393: </dl></dd>
1.6 rillig 394: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
395: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 396: <dd><dl>
1.6 rillig 397: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
398: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 399: </dl></dd>
1.6 rillig 400: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 401: <dd><dl>
1.23 wiz 402: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
403: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 404: </dl></dd>
405: </dl></dd>
1.6 rillig 406: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 407: <dd><dl>
1.108 rillig 408: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
409: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 410: <dd><dl>
1.108 rillig 411: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
412: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 413: </dl></dd>
414: </dl></dd>
1.6 rillig 415: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 416: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 417: </dl></dd>
418: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
419: <dd><dl>
420: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
421: <dd><dl>
422: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
423: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
424: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 425: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 426: </dl></dd>
427: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
428: </dl></dd>
429: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
430: <dd><dl>
431: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
432: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
433: </dl></dd>
434: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
435: <dd><dl>
1.23 wiz 436: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
437: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
438: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
439: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
440: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
441: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 442: source packages</a></span></dt>
443: </dl></dd>
444: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
445: <dd><dl>
446: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
447: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
448: </dl></dd>
449: </dl>
450: </div>
451: <div class="list-of-tables">
452: <p><b>List of Tables</b></p>
453: <dl>
454: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
455: </dt>
1.6 rillig 456: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 457: </dt>
1.6 rillig 458: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 459: </dt>
460: </dl>
461: </div>
1.41 asau 462: <div class="chapter">
463: <div class="titlepage"><div><div><h1 class="title">
464: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 465: <div class="toc">
466: <p><b>Table of Contents</b></p>
1.100 leot 467: <dl class="toc">
1.1 dsieger 468: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
469: <dd><dl>
470: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
471: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
472: </dl></dd>
473: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
474: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
475: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
476: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
477: </dl>
478: </div>
1.41 asau 479: <div class="sect1">
1.1 dsieger 480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
481: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
482: <p>There is a lot of software freely available for Unix-based
483: systems, which is usually available in form of the source code. Before
484: such software can be used, it needs to be configured to the local
485: system, compiled and installed, and this is exactly what The NetBSD
486: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
487: to handle binary packages, so that not every user has to build the
488: packages for himself, which is a time-costly task.</p>
489: <p>pkgsrc currently contains several thousand packages,
490: including:</p>
1.41 asau 491: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.104 sevan 492: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 493: web server</p></li>
1.79 snj 494: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 495: web browser</p></li>
1.79 snj 496: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 497: Desktop Environment</p></li>
1.102 ryoon 498: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 499: Desktop Environment</p></li>
500: </ul></div>
1.108 rillig 501: <p>… just to name a few.</p>
1.1 dsieger 502: <p>pkgsrc has built-in support for handling varying dependencies,
503: such as pthreads and X11, and extended features such as IPv6 support on
504: a range of platforms.</p>
1.41 asau 505: <div class="sect2">
1.1 dsieger 506: <div class="titlepage"><div><div><h3 class="title">
507: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
508: <p>
509: pkgsrc provides the following key features:
510: </p>
1.41 asau 511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 512: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 513: and installation of binary packages. The source and latest
514: patches are retrieved from a master or mirror download site, checksum
515: verified, then built on your system. Support for binary-only
516: distributions is available for both native platforms and NetBSD
517: emulated platforms.</p></li>
1.23 wiz 518: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 519: including binaries, libraries, man pages and other
520: documentation.</p></li>
1.104 sevan 521: <li class="listitem"><p>Tracking of package dependencies automatically, including when
522: performing updates, to ensure required packages are installed. The
523: configuration files of various packages are handled automatically during
524: updates, so local changes are preserved.</p></li>
1.23 wiz 525: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 526: consists of highly portable code. This allows the greatest speed of
1.25 spz 527: development when porting to a new platform. This portability also
1.1 dsieger 528: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
529: platforms</em></span>.</p></li>
1.23 wiz 530: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 531: international encryption requirements and build-time options for a
532: large number of packages are all set in a simple, central
533: configuration file.</p></li>
1.23 wiz 534: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 535: freely available under a BSD license, so you may extend and adapt
536: pkgsrc to your needs. Support for local packages and patches is
537: available right out of the box, so you can configure it specifically
538: for your environment.</p></li>
539: </ul></div>
540: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 542: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 543: — That means, if a package contains bugs, it's better to find
1.1 dsieger 544: them and to complain about them rather than to just install the package
545: and hope that it works. There are numerous checks in pkgsrc that try to
1.79 snj 546: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 547: of shell scripts), and post-installation checks (installed files,
548: references to shared libraries, script interpreters).</p></li>
1.23 wiz 549: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 550: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 551: pkgsrc has been ported to many operating systems. Care is taken that
552: packages behave the same on all platforms.</p></li>
553: </ul></div>
554: </div>
1.41 asau 555: <div class="sect2">
1.1 dsieger 556: <div class="titlepage"><div><div><h3 class="title">
557: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
558: <p>pkgsrc consists of both a source distribution and a binary
559: distribution for these operating systems. After retrieving the required
560: source or binaries, you can be up and running with pkgsrc in just
561: minutes!</p>
562: <p>pkgsrc was derived from FreeBSD's ports system, and
563: initially developed for NetBSD only. Since then, pkgsrc has
564: grown a lot, and now supports the following platforms:</p>
565: <div class="table">
566: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 567: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 568: <colgroup>
569: <col>
570: <col>
1.92 sevan 571: <col>
1.1 dsieger 572: </colgroup>
573: <thead><tr>
574: <th>Platform</th>
575: <th>Date Support Added</th>
1.92 sevan 576: <th>Notes</th>
1.1 dsieger 577: </tr></thead>
578: <tbody>
579: <tr>
1.10 hubertf 580: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 581: <td align="center">Aug 1997</td>
1.92 sevan 582: <td class="auto-generated"> </td>
1.1 dsieger 583: </tr>
584: <tr>
1.10 hubertf 585: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 586: <td align="center">Mar 1999</td>
1.93 sevan 587: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 588: </tr>
589: <tr>
1.10 hubertf 590: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 591: <td align="center">Jun 1999</td>
1.93 sevan 592: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 593: </tr>
594: <tr>
595: <td>
1.10 hubertf 596: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
597: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 598: </td>
599: <td align="center">Oct 2001</td>
1.93 sevan 600: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1 dsieger 601: </tr>
602: <tr>
1.10 hubertf 603: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 604: <td align="center">Nov 2002</td>
1.93 sevan 605: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 606: </tr>
607: <tr>
1.10 hubertf 608: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 609: <td align="center">Nov 2002</td>
1.93 sevan 610: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 611: </tr>
612: <tr>
1.10 hubertf 613: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 614: <td align="center">Dec 2002</td>
1.92 sevan 615: <td>
1.93 sevan 616: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
617: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92 sevan 618: </td>
1.1 dsieger 619: </tr>
620: <tr>
621: <td>BSD/OS</td>
622: <td align="center">Dec 2003</td>
1.92 sevan 623: <td class="auto-generated"> </td>
1.1 dsieger 624: </tr>
625: <tr>
1.10 hubertf 626: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 627: <td align="center">Dec 2003</td>
1.93 sevan 628: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 629: </tr>
630: <tr>
631: <td>
1.10 hubertf 632: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 633: (Microsoft Windows Services for Unix)
634: </td>
635: <td align="center">Mar 2004</td>
1.93 sevan 636: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 637: </tr>
638: <tr>
1.10 hubertf 639: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 640: <td align="center">Oct 2004</td>
1.92 sevan 641: <td class="auto-generated"> </td>
1.1 dsieger 642: </tr>
643: <tr>
1.10 hubertf 644: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 645: <td align="center">Nov 2004</td>
1.93 sevan 646: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 647: </tr>
648: <tr>
1.10 hubertf 649: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 650: <td align="center">Apr 2007</td>
1.93 sevan 651: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 652: </tr>
1.23 wiz 653: <tr>
654: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
655: <td align="center">Sep 2010</td>
1.93 sevan 656: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 657: </tr>
1.45 obache 658: <tr>
659: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 660: <td align="center">Jan 2011</td>
1.92 sevan 661: <td class="auto-generated"> </td>
1.45 obache 662: </tr>
663: <tr>
664: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
665: <td align="center">Nov 2011</td>
1.93 sevan 666: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 667: </tr>
668: <tr>
669: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
670: <td align="center">Mar 2013</td>
1.93 sevan 671: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 672: </tr>
1.58 ryoon 673: <tr>
674: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
675: <td align="center">Jul 2013</td>
1.93 sevan 676: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58 ryoon 677: </tr>
1.104 sevan 678: <tr>
679: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
680: <td align="center">Jun 2014</td>
681: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
682: </tr>
1.1 dsieger 683: </tbody>
684: </table></div>
685: </div>
686: <br class="table-break">
687: </div>
688: </div>
1.41 asau 689: <div class="sect1">
1.1 dsieger 690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
691: <a name="overview"></a>1.2. Overview</h2></div></div></div>
692: <p>This document is divided into three parts. The first,
1.10 hubertf 693: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 694: describes how one can use one of the packages in the Package
695: Collection, either by installing a precompiled binary package,
696: or by building one's own copy using the NetBSD package system.
1.10 hubertf 697: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 698: package so it can be easily built by other NetBSD users without
699: knowing about the package's building details. The third part,
1.10 hubertf 700: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 701: is intended for those who want to understand how pkgsrc is
702: implemented.</p>
703: <p>This document is available in various formats:
1.10 hubertf 704: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 705: </div>
1.41 asau 706: <div class="sect1">
1.1 dsieger 707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
708: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 709: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
710: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 711: terminology used within this document.</p>
1.41 asau 712: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 713: <dt><span class="term">Package</span></dt>
714: <dd><p>A set of files and building instructions
715: that describe what's necessary
716: to build a certain piece of software using
717: pkgsrc. Packages are traditionally stored under
718: <code class="filename">/usr/pkgsrc</code>.</p></dd>
719: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 720: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 721: is part of the NetBSD operating system and can be bootstrapped
722: to run on non-NetBSD operating systems as well. It handles
723: building (compiling), installing, and removing of
724: packages.</p></dd>
725: <dt><span class="term">Distfile</span></dt>
726: <dd><p>This term describes the file or files that are
727: provided by the author of the piece of software to
728: distribute his work. All the changes necessary to build on
729: NetBSD are reflected in the corresponding package. Usually
730: the distfile is in the form of a compressed tar-archive,
731: but other types are possible, too. Distfiles are usually
732: stored below
733: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
734: <dt><span class="term">Port</span></dt>
735: <dd><p>This is the term used by FreeBSD and OpenBSD people
736: for what we call a package.
1.23 wiz 737: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 738: architecture.</p></dd>
739: <dt><span class="term">Precompiled/binary package</span></dt>
740: <dd>
741: <p>A set of binaries built with pkgsrc from a distfile
742: and stuffed together in a single <code class="filename">.tgz</code>
743: file so it can be installed on machines of the same
744: machine architecture without the need to
745: recompile. Packages are usually generated in
746: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 747: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 748: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 749: especially in the context of precompiled packages.</p>
750: </dd>
751: <dt><span class="term">Program</span></dt>
752: <dd><p>The piece of software to be installed which will be
753: constructed from all the files in the distfile by the
754: actions defined in the corresponding package.</p></dd>
755: </dl></div>
1.41 asau 756: <div class="sect2">
1.1 dsieger 757: <div class="titlepage"><div><div><h3 class="title">
758: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 759: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 760: <dt><span class="term">pkgsrc users</span></dt>
761: <dd>
762: <p>The
763: pkgsrc users are people who use the packages provided by pkgsrc.
764: Typically they are system administrators. The people using the
1.23 wiz 765: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
766: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 767: <p>There are two kinds of pkgsrc users: Some only want to
768: install pre-built binary packages. Others build the pkgsrc
769: packages from source, either for installing them directly or for
1.10 hubertf 770: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 771: documentation.</p>
772: </dd>
773: <dt><span class="term">package maintainers</span></dt>
774: <dd><p>A
1.10 hubertf 775: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 776: <dt><span class="term">infrastructure developers</span></dt>
777: <dd><p>These people are involved in all those files
778: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 779: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 780: too.</p></dd>
781: </dl></div>
782: </div>
783: </div>
1.41 asau 784: <div class="sect1">
1.1 dsieger 785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
786: <a name="typography"></a>1.4. Typography</h2></div></div></div>
787: <p>When giving examples for commands, shell prompts are used to
788: show if the command should/can be issued as root, or if
1.23 wiz 789: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 790: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
791: shell prompt, assuming they use the C-shell or tcsh.</p>
792: </div>
793: </div>
1.41 asau 794: <div class="part">
1.1 dsieger 795: <div class="titlepage"><div><div><h1 class="title">
796: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
797: <div class="toc">
798: <p><b>Table of Contents</b></p>
1.100 leot 799: <dl class="toc">
1.1 dsieger 800: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
801: <dd><dl>
802: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
803: <dd><dl>
1.51 asau 804: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 805: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 806: </dl></dd>
807: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
808: <dd><dl>
809: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
810: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
811: </dl></dd>
812: </dl></dd>
813: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
814: <dd><dl>
815: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
816: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
817: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
818: </dl></dd>
819: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
820: <dd><dl>
821: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
824: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
825: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
826: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
827: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
828: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
829: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
830: </dl></dd>
831: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
832: <dd><dl>
833: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
834: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
835: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
836: </dl></dd>
837: </dl></dd>
838: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
839: <dd><dl>
840: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
841: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 842: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 843: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 844: <dd><dl>
1.4 rillig 845: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 846: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
847: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 848: </dl></dd>
1.4 rillig 849: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
850: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 851: </dl></dd>
852: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
853: <dd><dl>
854: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
855: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 856: </dl></dd>
857: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
858: builds)</a></span></dt>
1.1 dsieger 859: <dd><dl>
1.71 wiz 860: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
861: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
862: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
863: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 864: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
865: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 866: </dl></dd>
867: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
868: <dd><dl>
1.23 wiz 869: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
870: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 871: </dl></dd>
872: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
873: <dd><dl>
874: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 875: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
876: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
877: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
878: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
879: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
880: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
881: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
882: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
883: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 884: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 885: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
886: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
887: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
888: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
889: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
890: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
891: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 892: </dl></dd>
893: </dl>
894: </div>
1.41 asau 895: <div class="chapter">
1.1 dsieger 896: <div class="titlepage"><div><div><h2 class="title">
897: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
898: <div class="toc">
899: <p><b>Table of Contents</b></p>
1.100 leot 900: <dl class="toc">
1.1 dsieger 901: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
902: <dd><dl>
1.51 asau 903: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 904: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 905: </dl></dd>
906: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
907: <dd><dl>
908: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
909: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
910: </dl></dd>
911: </dl>
912: </div>
913: <p>Before you download and extract the files, you need to decide
914: where you want to extract them. When using pkgsrc as root user, pkgsrc
915: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
916: free to install the sources and binary packages wherever you want in
917: your filesystem, provided that the pathname does not contain white-space
918: or other characters that are interpreted specially by the shell and some
919: other programs. A safe bet is to use only letters, digits, underscores
920: and dashes.</p>
1.41 asau 921: <div class="sect1">
1.1 dsieger 922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
923: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
924: <p>Before you download any pkgsrc files, you should decide
925: whether you want the <span class="emphasis"><em>current</em></span> branch or the
926: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
927: quarterly basis from the current branch and only gets modified
928: for security updates. The names of the stable branches are built
929: from the year and the quarter, for example
1.78 snj 930: <code class="literal">2014Q3</code>.</p>
1.1 dsieger 931: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 932: want to download pkgsrc. You can get it as a tar file or via CVS.
933: Both ways are described here.</p>
1.51 asau 934: <p>Note that tar archive contains CVS working copy.
935: Thus you can switch to using CVS at any later time.</p>
1.41 asau 936: <div class="sect2">
1.1 dsieger 937: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 938: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 939: <p>The primary download location for all pkgsrc files is
1.51 asau 940: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
941: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
942: (it points to the same location).
943: There are a number of subdirectories for different purposes,
944: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
945: <p>The tar archive for the current branch is in the directory
946: <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.1 dsieger 947: It is autogenerated daily.</p>
1.51 asau 948: <p>To save download time we provide bzip2- and
949: xz-compressed archives which are published at
950: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
951: and
952: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
953: respectively.
954: </p>
955: <p>You can fetch the same files using FTP.</p>
1.78 snj 956: <p>The tar file for the stable branch 2014Q3 is in the
957: directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.12 weinem 958: <p>To download a pkgsrc stable tarball, run:</p>
959: <pre class="screen">
1.59 jnemeth 960: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.22 jakllsch 961: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 962: stable branch to be downloaded, for example,
1.78 snj 963: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
964: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 965: or your web browser.</p>
1.12 weinem 966: <p>Then, extract it with:</p>
1.78 snj 967: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 968: <p>This will create the directory <code class="filename">pkgsrc/</code>
969: in <code class="filename">/usr/</code> and all the package source will be
970: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
971: <p>To download pkgsrc-current, run:</p>
972: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 973: </div>
1.41 asau 974: <div class="sect2">
1.1 dsieger 975: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 976: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
977: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 978: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.23 wiz 979: </pre>
980: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.78 snj 981: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.23 wiz 982: <p>This will create the directory <code class="filename">pkgsrc/</code>
983: in your <code class="filename">/usr/</code> directory and all the package source
984: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
985: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 986: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 987: </pre>
1.78 snj 988: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 989: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 990: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 991: </pre>
992: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
993: For Bourne shells, you can set it in your <code class="filename">.profile</code>
994: or better globally in <code class="filename">/etc/profile</code>:</p>
995: <pre class="programlisting">
996: # set CVS remote shell command
997: CVS_RSH=ssh
998: export CVS_RSH
999: </pre>
1000: <p>By default, CVS doesn't do things like most people would expect it to do.
1001: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1002: in your home directory and saving the following lines to it.
1003: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1004: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1005: <pre class="programlisting">
1006: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1007: cvs -q -z2
1.2 rillig 1008: checkout -P
1.4 rillig 1009: update -dP
1010: diff -upN
1.2 rillig 1011: rdiff -u
1.23 wiz 1012: release -d
1.2 rillig 1013: </pre>
1.1 dsieger 1014: </div>
1015: </div>
1.41 asau 1016: <div class="sect1">
1.1 dsieger 1017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1018: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1019: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1020: (which also works if you have first installed it via a tar
1021: file). It saves bandwidth and hard disk activity, compared to
1022: downloading the tar file again.</p>
1.41 asau 1023: <div class="sect2">
1.1 dsieger 1024: <div class="titlepage"><div><div><h3 class="title">
1025: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1026: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1027: <h3 class="title">Warning</h3>
1028: <p>When updating from a tar file, you first need to
1029: completely remove the old pkgsrc directory. Otherwise those
1030: files that have been removed from pkgsrc in the mean time will
1031: not be removed on your local disk, resulting in inconsistencies.
1032: When removing the old files, any changes that you have done to
1033: the pkgsrc files will be lost after updating. Therefore updating
1034: via CVS is strongly recommended.</p>
1035: </div>
1036: <p>Note that by default the distfiles and the binary packages
1037: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1038: before updating. You can also configure pkgsrc to store distfiles
1039: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1040: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1041: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1042: <p>To update pkgsrc from a tar file, download the tar file as
1043: explained above. Then, make sure that you have not made any
1044: changes to the files in the pkgsrc directory. Remove the pkgsrc
1045: directory and extract the new tar file. Done.</p>
1046: </div>
1.41 asau 1047: <div class="sect2">
1.1 dsieger 1048: <div class="titlepage"><div><div><h3 class="title">
1049: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1050: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1051: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1052: </pre>
1053: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1054: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1055: </pre>
1.41 asau 1056: <div class="sect3">
1.1 dsieger 1057: <div class="titlepage"><div><div><h4 class="title">
1058: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1059: <p>When updating pkgsrc, the CVS program keeps track of the
1060: branch you selected. But if you, for whatever reason, want to
1061: switch from the stable branch to the current one, you can do it
1.23 wiz 1062: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1063: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1064: back to the stable branch, add the
1.78 snj 1065: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.1 dsieger 1066: </div>
1.41 asau 1067: <div class="sect3">
1.1 dsieger 1068: <div class="titlepage"><div><div><h4 class="title">
1069: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1070: <p>When you update pkgsrc, the CVS program will only touch
1071: those files that are registered in the CVS repository. That
1072: means that any packages that you created on your own will stay
1073: unmodified. If you change files that are managed by CVS, later
1074: updates will try to merge your changes with those that have been
1075: done by others. See the CVS manual, chapter
1.23 wiz 1076: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1077: </div>
1078: </div>
1079: </div>
1080: </div>
1.41 asau 1081: <div class="chapter">
1.1 dsieger 1082: <div class="titlepage"><div><div><h2 class="title">
1083: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1084: <div class="toc">
1085: <p><b>Table of Contents</b></p>
1.100 leot 1086: <dl class="toc">
1.1 dsieger 1087: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1088: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1089: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1090: </dl>
1091: </div>
1.41 asau 1092: <div class="sect1">
1.1 dsieger 1093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1094: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1095: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.1 dsieger 1096: </div>
1.41 asau 1097: <div class="sect1">
1.1 dsieger 1098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1099: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1100: <p>pkgsrc can be bootstrapped for use in two different modes:
1101: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1102: to privileged one all programs are installed under one particular user
1.43 asau 1103: and cannot utilise privileged operations (packages don't create
1104: special users and all special file permissions like setuid are ignored).
1105: </p>
1.1 dsieger 1106: <p>Installing the bootstrap kit from source should be as simple as:</p>
1107: <pre class="screen">
1.60 asau 1108: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1109: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1110: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1111: </pre>
1.43 asau 1112: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1113: <p>By default, in privileged mode pkgsrc uses
1114: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1115: where programs will be installed in,
1.1 dsieger 1116: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1117: directory where pkgsrc will do its internal bookkeeping,
1118: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1119: where packages install their persistent data.
1120: In unprivileged mode pkgsrc uses
1121: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1122: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1123: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1124: </p>
1125: <p>You can change default layout using command-line arguments.
1126: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1127: </p>
1.41 asau 1128: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1129: <h3 class="title">Note</h3>
1.10 hubertf 1130: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1131: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1132: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1133: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1134: </div>
1.43 asau 1135: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1136: <h3 class="title">Note</h3>
1137: <p>It is possible to bootstrap multiple instances of pkgsrc
1138: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1139: corresponding to the installation you're working with to build
1140: and install packages.
1141: </p>
1142: </div>
1.1 dsieger 1143: </div>
1.41 asau 1144: <div class="sect1">
1.1 dsieger 1145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1146: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.111 sevan 1147: <p>For platform-specific notes consult the <code class="filename">README</code>
1148: files found in the notes column of <a class="xref" href="#supported-platforms" title="Table 1.1. Platforms supported by pkgsrc">Table 1.1, “Platforms supported by pkgsrc”</a></p>
1.1 dsieger 1149: </div>
1150: </div>
1.41 asau 1151: <div class="chapter">
1.1 dsieger 1152: <div class="titlepage"><div><div><h2 class="title">
1153: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1154: <div class="toc">
1155: <p><b>Table of Contents</b></p>
1.100 leot 1156: <dl class="toc">
1.1 dsieger 1157: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1158: <dd><dl>
1159: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1160: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1161: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1162: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1163: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1164: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1165: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1166: </dl></dd>
1167: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1168: <dd><dl>
1169: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1170: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1171: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1172: </dl></dd>
1173: </dl>
1174: </div>
1175: <p>Basically, there are two ways of using pkgsrc. The first
1176: is to only install the package tools and to use binary packages
1.23 wiz 1177: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1178: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1179: of pkgsrc, too. Then you are able to build your own packages,
1180: and you can still use binary packages from someone else.</p>
1.41 asau 1181: <div class="sect1">
1.1 dsieger 1182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1183: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1184: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1185: server and its mirrors, there are collections of binary packages,
1186: ready to be installed. These binary packages have been built using the
1187: default settings for the directories, that is:</p>
1.41 asau 1188: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1189: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1190: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1191: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1192: </ul></div>
1193: <p>If you cannot use these directories for whatever reasons (maybe
1194: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1195: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1196: <div class="sect2">
1.1 dsieger 1197: <div class="titlepage"><div><div><h3 class="title">
1198: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1199: <p>To install binary packages, you first need to know from where
1200: to get them. The first place where you should look is on the main
1.10 hubertf 1201: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1202: <p>This directory contains binary packages for multiple
1203: platforms. First, select your operating system. (Ignore the
1204: directories with version numbers attached to it, they just exist for
1205: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1206: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1207: <p>In this directory, you often find a file called
1208: <code class="filename">bootstrap.tar.gz</code> which contains the package
1209: management tools. If the file is missing, it is likely that your
1210: operating system already provides those tools. Download the file and
1211: extract it in the <code class="filename">/</code> directory. It will create
1212: the directories <code class="filename">/usr/pkg</code> (containing the tools
1213: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1214: (the database of installed packages).</p>
1.1 dsieger 1215: </div>
1.41 asau 1216: <div class="sect2">
1.1 dsieger 1217: <div class="titlepage"><div><div><h3 class="title">
1218: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1219: <p>In the directory from the last section, there is a
1.85 wiz 1220: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1221: binary packages that are available for the platform, excluding those
1222: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1223: medium you are using).</p>
1.9 rillig 1224: <p>To install packages directly from an FTP or HTTP server, run
1225: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1226: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1227: <pre class="screen">
1228: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85 wiz 1229: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.9 rillig 1230: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1231: </pre>
1232: <p>Instead of URLs, you can also use local paths, for example if
1233: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1234: repository. If you want to install packages from multiple sources,
1235: you can separate them by a semicolon in
1236: <code class="varname">PKG_PATH</code>.</p>
1237: <p>After these preparations, installing a package is very
1238: easy:</p>
1239: <pre class="screen">
1240: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1241: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1242: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1243: </pre>
1.1 dsieger 1244: <p>Note that any prerequisite packages needed to run the
1245: package in question will be installed, too, assuming they are
1246: present where you install from.</p>
1.23 wiz 1247: <p>Adding packages might install vulnerable packages.
1248: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1249: regularly, especially after installing new packages, and verify
1250: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1251: <p>After you've installed packages, be sure to have
1252: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1253: <code class="varname">PATH</code> so you can actually start the just
1254: installed program.</p>
1255: </div>
1.41 asau 1256: <div class="sect2">
1.1 dsieger 1257: <div class="titlepage"><div><div><h3 class="title">
1258: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1259: <p>To deinstall a package, it does not matter whether it was
1260: installed from source code or from a binary package. The
1.10 hubertf 1261: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1262: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1263: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1264: name can be given with or without version number. Wildcards can
1265: also be used to deinstall a set of packages, for example
1266: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1267: so that the shell does not expand them before
1268: <code class="literal">pkg_delete</code> sees them.</p>
1269: <p>The <code class="option">-r</code> option is very powerful: it
1270: removes all the packages that require the package in question
1271: and then removes the package itself. For example:
1272:
1273: </p>
1274: <pre class="screen">
1275: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1276: </pre>
1277: <p>
1278:
1279: will remove jpeg and all the packages that used it; this allows
1280: upgrading the jpeg package.</p>
1281: </div>
1.41 asau 1282: <div class="sect2">
1.1 dsieger 1283: <div class="titlepage"><div><div><h3 class="title">
1284: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1285: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1286: installed packages or binary package files.</p>
1287: </div>
1.41 asau 1288: <div class="sect2">
1.1 dsieger 1289: <div class="titlepage"><div><div><h3 class="title">
1290: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1291: <p>
1292: The NetBSD Security-Officer and Packages Groups maintain a list of
1293: known security vulnerabilities to packages which are (or have been)
1294: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1295: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1 dsieger 1296: </p>
1297: <p>
1.22 jakllsch 1298: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1299: this list can be downloaded
1300: automatically, and a security audit of all packages installed on a system
1301: can take place.
1302: </p>
1303: <p>
1.22 jakllsch 1304: There are two components to auditing. The first
1305: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1306: is for downloading
1.1 dsieger 1307: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1308: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1309: installed packages are vulnerable. If a package is vulnerable, you
1310: will see output similar to the following:
1311: </p>
1312: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1313: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1314: <p>
1.22 jakllsch 1315: You may wish to have the
1.10 hubertf 1316: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1317: file downloaded daily so that
1318: it remains current. This may be done by adding an appropriate entry
1.79 snj 1319: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1320: </p>
1321: <pre class="screen">
1322: # download vulnerabilities file
1323: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1324: </pre>
1325: <p>
1326: will update the vulnerability list every day at 3AM. You may wish to do
1327: this more often than once a day.
1328:
1329: In addition, you may wish to run the package audit from the daily
1330: security script. This may be accomplished by adding the following
1331: line to <code class="filename">/etc/security.local</code>:
1332: </p>
1333: <pre class="screen">
1334: /usr/sbin/pkg_admin audit
1335: </pre>
1336: <p>
1.1 dsieger 1337: </p>
1338: </div>
1.41 asau 1339: <div class="sect2">
1.1 dsieger 1340: <div class="titlepage"><div><div><h3 class="title">
1341: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1342: <p>
1.79 snj 1343: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1344: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1345: argument to check if your packages are up-to-date, e.g.
1346: </p>
1347: <pre class="screen">
1348: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1349: ...
1350: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1351: </pre>
1.10 hubertf 1352: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1353: package on your system and rebuild any dependencies.
1354: </p>
1355: </div>
1.41 asau 1356: <div class="sect2">
1.1 dsieger 1357: <div class="titlepage"><div><div><h3 class="title">
1358: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1359: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1360: administrative functions on the package system.</p>
1361: </div>
1362: </div>
1.41 asau 1363: <div class="sect1">
1.1 dsieger 1364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1365: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1366: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1367: directory now contains a set of packages, organized into
1368: categories. You can browse the online index of packages, or run
1.10 hubertf 1369: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1370: directory to build local <code class="filename">README.html</code> files for
1.79 snj 1371: all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1372: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1373: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1374: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1375: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1376: different <code class="varname">LOCALBASE</code> definitions on the same
1377: system (inside a chroot is an exception). </p>
1378: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1379: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1380: instructions how to create your own packages.</p>
1.41 asau 1381: <div class="sect2">
1.1 dsieger 1382: <div class="titlepage"><div><div><h3 class="title">
1383: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1384: <p>To build packages from source, you need a working C
1385: compiler. On NetBSD, you need to install the
1.23 wiz 1386: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1387: sets. If you want to build X11-related packages, the
1.23 wiz 1388: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1389: sets are required, too.</p>
1390: </div>
1.41 asau 1391: <div class="sect2">
1.1 dsieger 1392: <div class="titlepage"><div><div><h3 class="title">
1393: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1394: <p>The first step for building a package is downloading the
1395: distfiles (i.e. the unmodified source). If they have not yet been
1396: downloaded, pkgsrc will fetch them automatically.</p>
1397: <p>If you have all files that you need in the
1398: <code class="filename">distfiles</code> directory,
1399: you don't need to connect. If the distfiles are on CD-ROM, you can
1400: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1401: </p>
1402: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1403: <p>
1.10 hubertf 1404: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1405: <p>By default a list of distribution sites will be randomly
1406: intermixed to prevent huge load on servers which holding popular
1407: packages (for example, SourceForge.net mirrors). Thus, every
1408: time when you need to fetch yet another distfile all the mirrors
1409: will be tried in new (random) order. You can turn this feature
1410: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1411: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1412: <p>You can overwrite some of the major distribution sites to
1413: fit to sites that are close to your own. By setting one or two
1414: variables you can modify the order in which the master sites are
1415: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1416: delimited list of domain suffixes.
1417: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1418: contains a whitespace delimited list of regular expressions. It
1419: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1420: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1421: some examples. This may save some of your bandwidth and
1422: time.</p>
1423: <p>You can change these settings either in your shell's environment, or,
1424: if you want to keep the settings, by editing the
1.10 hubertf 1425: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1426: and adding the definitions there.</p>
1427: <p>
1428: If a package depends on many other packages (such as
1.79 snj 1429: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.1 dsieger 1430: alternate between periods of
1431: downloading source, and compiling. To ensure you have all the source
1432: downloaded initially you can run the command:
1433: </p>
1434: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1435: <p>
1436: which will output and run a set of shell commands to fetch the
1437: necessary files into the <code class="filename">distfiles</code> directory. You can
1438: also choose to download the files manually.
1439: </p>
1440: </div>
1.41 asau 1441: <div class="sect2">
1.1 dsieger 1442: <div class="titlepage"><div><div><h3 class="title">
1443: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1444: <p>
1445: Once the software has downloaded, any patches will be applied, then it
1446: will be compiled for you. This may take some time depending on your
1447: computer, and how many other packages the software depends on and their
1448: compile time.
1449: </p>
1.41 asau 1450: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1451: <h3 class="title">Note</h3>
1452: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1453: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1454: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1455: </div>
1456: <p>For example, type</p>
1457: <pre class="screen">
1458: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1459: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1460: </pre>
1461: <p>at the shell prompt to build the various components of the
1462: package.</p>
1463: <p>The next stage is to actually install the newly compiled
1464: program onto your system. Do this by entering:
1465:
1466: </p>
1467: <pre class="screen">
1468: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1469: </pre>
1470: <p>
1471:
1472: while you are still in the directory for whatever package you
1473: are installing.</p>
1474: <p>Installing the package on your system may require you to
1475: be root. However, pkgsrc has a
1476: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1477: to only become root for the actual installation step.</p>
1478: <p>That's it, the software should now be installed and setup for use.
1479: You can now enter:
1480:
1481: </p>
1482: <pre class="screen">
1483: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1484: </pre>
1485: <p>
1486:
1487: to remove the compiled files in the work directory, as you shouldn't need
1488: them any more. If other packages were also added to your system
1489: (dependencies) to allow your program to compile, you can tidy these up
1490: also with the command:</p>
1491: <pre class="screen">
1492: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1493: </pre>
1494: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1495: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 1496: <p>The program is installed under the default root of the
1497: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1498: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1499: variable in your environment, and it will use that value as the
1500: root of your packages tree. So, to use
1501: <code class="filename">/usr/local</code>, set
1502: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1503: Please note that you should use a directory which is dedicated to
1504: packages and not shared with other programs (i.e., do not try and
1505: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1506: to add any of your own files or directories (such as
1507: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1508: <code class="filename">pkgsrc/</code>) below the
1509: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1510: conflicts between programs and other files installed by the
1511: package system and whatever else may have been installed
1512: there.</p>
1.10 hubertf 1513: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1514: alter some configuration options at build time. Have a look at
1515: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1516: of what will be set there by default. Environment variables such
1517: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1518: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1519: set them each time you want to use pkgsrc.</p>
1.23 wiz 1520: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1521: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1522: or being installed. This may be for debugging purposes, or out of
1523: simple curiosity. A number of utility values have been added to
1524: help with this.</p>
1.23 wiz 1525: <div class="orderedlist"><ol class="orderedlist" type="1">
1526: <li class="listitem">
1.79 snj 1527: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1528: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1529: information will be displayed. For example,</p>
1530: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1531: <p>will show all the commands that are invoked, up to and
1.23 wiz 1532: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1533: </li>
1.23 wiz 1534: <li class="listitem">
1.79 snj 1535: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1536: definition, then the <code class="varname">VARNAME</code> definition
1537: should be used, in conjunction with the show-var
1.79 snj 1538: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1539: variable <code class="varname">LOCALBASE</code>:</p>
1540: <pre class="screen">
1541: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1542: /usr/pkg
1543: <code class="prompt">%</code>
1544: </pre>
1545: </li>
1546: </ol></div>
1547: <p>If you want to install a binary package that you've either
1548: created yourself (see next section), that you put into
1549: pkgsrc/packages manually or that is located on a remote FTP
1550: server, you can use the "bin-install" target. This target will
1.79 snj 1551: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1552: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1553: sites searched is kept in the variable
1554: <code class="varname">BINPKG_SITES</code>, which defaults to
1.79 snj 1555: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1556: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1557: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1558: details.</p>
1559: <p>A final word of warning: If you set up a system that has a
1560: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1561: set that before any packages are installed, as you cannot use
1562: several directories for the same purpose. Doing so will result in
1563: pkgsrc not being able to properly detect your installed packages,
1564: and fail miserably. Note also that precompiled binary packages are
1565: usually built with the default <code class="varname">LOCALBASE</code> of
1566: <code class="filename">/usr/pkg</code>, and that you should
1567: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1568: <code class="varname">LOCALBASE</code>.</p>
1569: </div>
1570: </div>
1571: </div>
1.41 asau 1572: <div class="chapter">
1.1 dsieger 1573: <div class="titlepage"><div><div><h2 class="title">
1574: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
1575: <div class="toc">
1576: <p><b>Table of Contents</b></p>
1.100 leot 1577: <dl class="toc">
1.1 dsieger 1578: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
1579: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 1580: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 1581: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 1582: <dd><dl>
1.4 rillig 1583: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 1584: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1585: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 1586: </dl></dd>
1.4 rillig 1587: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
1588: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1589: </dl>
1590: </div>
1.4 rillig 1591: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1592: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1593: that file depends on the installation. On NetBSD, when you use
1.79 snj 1594: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 1595: <code class="filename">/etc/</code>. In all other cases the default location is
1596: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1597: bootstrap program to install the binary packages.</p>
1598: <p>The format of the configuration file is that of the usual
1599: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1600: is done by setting variables in this file. Note that you can define all
1601: kinds of variables, and no special error checking (for example for
1.112 rillig 1602: spelling mistakes) takes place.</p>
1.41 asau 1603: <div class="sect1">
1.1 dsieger 1604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1605: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.112 rillig 1606: <p>The following variables apply to all
1.1 dsieger 1607: pkgsrc packages. A complete list of the variables that can be
1608: configured by the user is available in
1609: <code class="filename">mk/defaults/mk.conf</code>, together with some
1610: comments that describe each variable's intent.</p>
1.41 asau 1611: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1612: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1613: packages will be installed. The default is
1614: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1615: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1616: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1617: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1618: installed. The default is
1619: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1620: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1621: X11 is installed on the system. The default is
1.84 wiz 1622: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1623: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1624: downloaded copies of the original source distributions used
1625: for building pkgsrc packages. The default is
1626: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1627: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1628: database about installed packages is stored. The default is
1629: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 1630: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1631: If set, override the packages'
1632: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1633: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1634: Backup location(s) for distribution files and patch files
1635: if not found locally or in
1636: <code class="filename">${MASTER_SITES}</code> or
1637: <code class="filename">${PATCH_SITES}</code> respectively.
1638: The defaults are
1.25 spz 1639: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 1640: and
1641: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1642: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1643: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1644: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1645: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1646: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1647: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1648: List of acceptable licenses. License names are case-sensitive.
1649: Whenever you try to build a package whose license is not in this
1650: list, you will get an error message. If the license condition is
1651: simple enough, the error message will include specific
1652: instructions on how to change this variable.</p></li>
1.1 dsieger 1653: </ul></div>
1654: </div>
1.41 asau 1655: <div class="sect1">
1.1 dsieger 1656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1657: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1658: <p>
1.1 dsieger 1659: </p>
1.41 asau 1660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1661: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1662: directory for the binary packages. The default is
1663: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1664: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1665: The top level directory where, if defined, the separate
1666: working directories will get created, and symbolically
1667: linked to from <code class="filename">${WRKDIR}</code> (see below).
1668: This is useful for building packages on several
1669: architectures, then <code class="filename">${PKGSRCDIR}</code>
1670: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1671: is local to every architecture. (It should be noted that
1672: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1673: — it is an internal definition which refers to the
1.1 dsieger 1674: root of the pkgsrc tree. It is possible to have many
1675: pkgsrc tree instances.)</p></li>
1.23 wiz 1676: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1677: Directory for local patches that aren't part of pkgsrc.
1.108 rillig 1678: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1679: information.</p></li>
1.23 wiz 1680: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1681: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1682: BSD-style Makefile. If this is not set,
1683: <code class="varname">MAKECONF</code> is set to
1684: <code class="filename">/dev/null</code> to avoid picking up
1685: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 1686: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 1687: By default, dependencies are only installed, and no binary
1688: package is created for them. You can set this variable to
1.66 asau 1689: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 1690: packages after installing dependencies. Please note that the
1.84 wiz 1691: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 1692: <code class="literal">yes</code> to preserve binary packages when
1693: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 1694: </ul></div>
1695: </div>
1.41 asau 1696: <div class="sect1">
1.1 dsieger 1697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 1698: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.107 jnemeth 1699: <p>Packages have to support installation into a
1.4 rillig 1700: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1701: to be built, before the actual filesystem is touched. DESTDIR
1702: support exists in two variations:</p>
1.41 asau 1703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1704: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1705: installation and packaging is still run as root.</p></li>
1706: <li class="listitem"><p>Full DESTDIR support can run the complete
1707: build, installation and packaging as normal user. Root
1708: privileges are only needed to add packages.</p></li>
1709: </ul></div>
1.4 rillig 1710: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1711: clean</code></strong> needs to be run as root.</p>
1.17 imil 1712: <p>Considering the <code class="filename">foo/bar</code> package,
1713: DESTDIR full support can be tested using the following commands
1714:
1715: </p>
1716: <pre class="programlisting">
1717: <code class="prompt">$</code> id
1718: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1719: <code class="prompt">$</code> mkdir $HOME/packages
1720: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1721: </pre>
1722: <p>
1723:
1724: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1725: should be needed
1726:
1727: </p>
1728: <pre class="programlisting">
1.66 asau 1729: <code class="prompt">$</code> make stage-install
1.17 imil 1730: </pre>
1731: <p>
1732:
1733: Create a package without root privileges
1734:
1735: </p>
1736: <pre class="programlisting">
1.66 asau 1737: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1738: </pre>
1739: <p>
1740:
1741: For the following command, you must be able to gain root
1.79 snj 1742: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1743:
1744: </p>
1745: <pre class="programlisting">
1.66 asau 1746: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1747: </pre>
1748: <p>
1749:
1750: Then, as a simple user
1751:
1752: </p>
1753: <pre class="programlisting">
1754: <code class="prompt">$</code> make clean
1755: </pre>
1756: <p>
1757:
1758: </p>
1.4 rillig 1759: </div>
1.41 asau 1760: <div class="sect1">
1.4 rillig 1761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1762: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1763: <div class="sect2">
1.1 dsieger 1764: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1765: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1766: <p>By default, pkgsrc will use GCC to build packages. This may be
1767: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1768: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1769: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1770: <dd>
1771: <p>This is a list of values specifying the chain of
1772: compilers to invoke when building packages. Valid values
1773: are:</p>
1.41 asau 1774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1775: <li class="listitem"><p><code class="varname">ccc</code>:
1776: Compaq C Compilers (Tru64)</p></li>
1777: <li class="listitem"><p><code class="varname">ccache</code>:
1778: compiler cache (chainable)</p></li>
1779: <li class="listitem"><p><code class="varname">clang</code>:
1780: Clang C and Objective-C compiler</p></li>
1.23 wiz 1781: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1782: distributed C/C++ (chainable)</p></li>
1.66 asau 1783: <li class="listitem"><p><code class="varname">f2c</code>:
1784: Fortran 77 to C compiler (chainable)</p></li>
1785: <li class="listitem"><p><code class="varname">icc</code>:
1786: Intel C++ Compiler (Linux)</p></li>
1787: <li class="listitem"><p><code class="varname">ido</code>:
1788: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1789: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1790: GNU C/C++ Compiler</p></li>
1.66 asau 1791: <li class="listitem"><p><code class="varname">hp</code>:
1792: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1793: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1794: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1795: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1796: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1797: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1798: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1799: <li class="listitem"><p><code class="varname">xlc</code>:
1800: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 1801: </ul></div>
1802: <p>The default is
1.23 wiz 1803: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1804: <code class="varname">ccache</code> and/or
1805: <code class="varname">distcc</code> with an appropriate
1806: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1807: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1808: variable should always be terminated with a value for
1809: a real compiler. Note that only one real compiler
1.23 wiz 1810: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1811: is not allowed).</p>
1812: </dd>
1813: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1814: <dd><p>This specifies the minimum version of GCC to use
1815: when building packages. If the system GCC doesn't
1816: satisfy this requirement, then pkgsrc will build and
1817: install one of the GCC packages to use instead.</p></dd>
1.114 ! maya 1818: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
! 1819: <dd><p>Specifies which version of python to use when several
! 1820: options are available.</p></dd>
! 1821: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
! 1822: <dd><p>Specifies the fortran compiler to use.
! 1823: The default is <code class="varname">g95</code>, and
! 1824: <code class="varname">gfortran</code> is an alternative.</p></dd>
! 1825: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
! 1826: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
! 1827: <code class="varname">gfortran</code> is used, this option specifies which
! 1828: version to use.</p></dd>
1.1 dsieger 1829: </dl></div>
1830: </div>
1.41 asau 1831: <div class="sect2">
1.1 dsieger 1832: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1833: <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 1834: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1835: please make sure to use the <code class="literal">+=</code> operator
1836: instead of the <code class="literal">=</code> operator:</p>
1837: <pre class="programlisting">
1838: CFLAGS+= -your -flags
1839: </pre>
1840: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1841: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1842: need to add their own flags. You may want to take a look
1.79 snj 1843: 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 1844: package if you're interested in optimization specifically
1845: for the current CPU. </p>
1.1 dsieger 1846: </div>
1.41 asau 1847: <div class="sect2">
1.1 dsieger 1848: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1849: <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 1850: <p>If you want to pass flags to the linker, both in the configure
1851: step and the build step, you can do this in two ways. Either set
1852: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1853: between the two is that <code class="varname">LIBS</code> will be appended to
1854: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1855: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1856: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1857: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1858: <code class="varname">CFLAGS</code>, if you do not wish to override these
1859: settings, use the <code class="literal">+=</code> operator:</p>
1860: <pre class="programlisting">
1861: LDFLAGS+= -your -linkerflags
1862: </pre>
1863: </div>
1864: </div>
1.41 asau 1865: <div class="sect1">
1.1 dsieger 1866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1867: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1868: <p>
1.1 dsieger 1869: </p>
1.41 asau 1870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1871: <li class="listitem">
1.1 dsieger 1872: <p><code class="varname">PKG_DEVELOPER</code>:
1873: Run some sanity checks that package developers want:
1874: </p>
1.41 asau 1875: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1876: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1877: fuzz</p></li>
1.23 wiz 1878: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1879: binaries will find their shared libs.</p></li>
1880: </ul></div>
1881: <p>
1882: </p>
1883: </li>
1.23 wiz 1884: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1885: of debugging output which is displayed whilst making and
1886: installing the package. The default value for this is 0,
1887: which will not display the commands as they are executed
1888: (normal, default, quiet operation); the value 1 will display
1889: all shell commands before their invocation, and the value 2
1890: will display both the shell commands before their invocation,
1.112 rillig 1891: as well as their actual execution progress with <span class="command"><strong>set
1892: -x</strong></span>.</p></li>
1.1 dsieger 1893: </ul></div>
1894: <p>
1895: </p>
1896: </div>
1.41 asau 1897: <div class="sect1">
1.1 dsieger 1898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1899: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1900: <p>Some packages have build time options, usually to select
1901: between different dependencies, enable optional support for big
1902: dependencies or enable experimental features.</p>
1903: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1904: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1905: show-options</strong></span>, for example:</p>
1906: <pre class="programlisting">
1907: The following options are supported by this package:
1908: ssl Enable SSL support.
1909: Exactly one of the following gecko options is required:
1910: firefox Use firefox as gecko rendering engine.
1911: mozilla Use mozilla as gecko rendering engine.
1912: At most one of the following database options may be selected:
1913: mysql Enable support for MySQL database.
1914: pgsql Enable support for PostgreSQL database.
1915:
1916: These options are enabled by default: firefox
1917: These options are currently enabled: mozilla ssl
1918: </pre>
1919: <p>The following variables can be defined in
1.10 hubertf 1920: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1921: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1922: which can be used to select or disable options for all packages
1923: that support them, and
1924: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1925: which can be used to select or disable options specifically for
1926: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1927: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1928: are disabled. A few examples:</p>
1929: <pre class="screen">
1.10 hubertf 1930: <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 1931: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1932: PKG_OPTIONS.kdebase= debug -sasl
1933: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1934: <p>It is important to note that options that were specifically
1.18 snj 1935: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1936: you do not wish to include the option. If you are unsure you can view
1937: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1938: <p>The following settings are consulted in the order given, and
1939: the last setting that selects or disables an option is
1940: used:</p>
1.23 wiz 1941: <div class="orderedlist"><ol class="orderedlist" type="1">
1942: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1943: maintainer</p></li>
1.23 wiz 1944: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1945: variables (see below)</p></li>
1.23 wiz 1946: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1947: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1948: </ol></div>
1949: <p>For groups of mutually exclusive options, the last option
1950: selected is used, all others are automatically disabled. If an
1951: option of the group is explicitly disabled, the previously
1952: selected option, if any, is used. It is an error if no option
1953: from a required group of options is selected, and building the
1954: package will fail.</p>
1955: <p>Before the options framework was introduced, build options
1956: were selected by setting a variable (often named
1957: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 1958: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 1959: transition to the options framework for the user, these legacy
1960: variables are converted to the appropriate options setting
1961: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1962: automatically. A warning is issued to prompt the user to update
1.10 hubertf 1963: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 1964: directly. Support for the legacy variables will be removed
1965: eventually.</p>
1966: </div>
1967: </div>
1.41 asau 1968: <div class="chapter">
1.1 dsieger 1969: <div class="titlepage"><div><div><h2 class="title">
1970: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
1971: <div class="toc">
1972: <p><b>Table of Contents</b></p>
1.100 leot 1973: <dl class="toc">
1.1 dsieger 1974: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
1975: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1976: </dl>
1977: </div>
1.41 asau 1978: <div class="sect1">
1.1 dsieger 1979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1980: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1981: <p>Once you have built and installed a package, you can create
1982: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.79 snj 1983: 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 1984: the same package on a group of hosts and wasting CPU time. It also
1985: provides a simple means for others to install your package, should
1986: you distribute it.</p>
1987: <p>To create a binary package, change into the appropriate
1.10 hubertf 1988: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 1989: package</strong></span>:</p>
1990: <pre class="screen">
1.112 rillig 1991: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1992: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
1993: </pre>
1.1 dsieger 1994: <p>This will build and install your package (if not already done),
1995: and then build a binary package from what was installed. You can
1.10 hubertf 1996: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 1997: it. Binary packages are created by default in
1998: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 1999: 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 2000: 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 2001: <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 2002: such a binary package.</p>
2003: </div>
1.41 asau 2004: <div class="sect1">
1.1 dsieger 2005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2006: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2007: <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 2008: </div>
2009: </div>
1.41 asau 2010: <div class="chapter">
1.6 rillig 2011: <div class="titlepage"><div><div><h2 class="title">
2012: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2013: builds)</h2></div></div></div>
2014: <div class="toc">
2015: <p><b>Table of Contents</b></p>
1.100 leot 2016: <dl class="toc">
1.71 wiz 2017: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2018: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2019: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2020: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2021: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2022: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2023: </dl>
2024: </div>
1.71 wiz 2025: <p>For a number of reasons you may want to build binary packages
2026: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2027: For instance, when you have multiple machines that should run the same software,
2028: it is wasted time if they all build their packages themselves from source.
2029: Or you may want to build a list of packages you want and check them before
2030: deploying onto production system.
2031: There is a way of getting a set of binary packages:
1.112 rillig 2032: The bulk build system, or pbulk ("p" stands for "parallel").
2033: This chapter describes how to set it up.</p>
1.41 asau 2034: <div class="sect1">
1.6 rillig 2035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2036: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2037: <p>First of all, you have to decide whether you build all packages
2038: or a limited set of them. Full bulk builds usually consume a lot more resources,
2039: both space and time, than builds for some practical sets of packages.
2040: There exists a number of particularly heavy packages that are not actually
2041: interesting to a wide audience.
2042:
2043: For a limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2044: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2045: </p>
2046: <p>During bulk builds various packages are installed and deinstalled
2047: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2048: so make sure that you don't need any package during the builds.
1.112 rillig 2049: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2050: or something even more restrictive, depending on what the operating system provides,
2051: or dedicate the whole physical machine.
2052: As a useful side effect this makes sure that bulk builds cannot
2053: break anything in your system. There have been numerous cases where
1.6 rillig 2054: certain packages tried to install files outside the
2055: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2056: <code class="filename">/etc</code>.
2057: </p>
1.6 rillig 2058: </div>
1.41 asau 2059: <div class="sect1">
1.6 rillig 2060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2061: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2062: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2063: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2064: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2065: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2066: </ul></div>
1.41 asau 2067: <div class="sect2">
1.15 rillig 2068: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2069: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.112 rillig 2070: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2071: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2072: Configure network access to fetch distribution files.
1.112 rillig 2073: Create a user with name "pbulk".</p>
1.68 asau 2074: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2075: <pre class="screen">
1.72 wiz 2076: <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>
2077: <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>
2078: <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 2079: </pre>
2080: <p>Or any other way that fits (e.g., curl, wget).</p>
2081: <p>Deploy and configure pbulk tools, e.g.:</p>
2082: <pre class="screen">
2083: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2084: <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>
2085: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2086: </pre>
2087: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2088: <h3 class="title">Note</h3>
2089: <p><code class="filename">mk.conf.frag</code> is a fragment of
2090: <code class="filename">mk.conf</code> that contains settings you want to
2091: apply to packages you build. For instance,</p>
2092: <pre class="programlisting">
1.112 rillig 2093: PKG_DEVELOPER= yes # perform more checks
2094: X11_TYPE= modular # use pkgsrc X11
2095: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2096: # when building all packages)
1.68 asau 2097: </pre>
2098: </div>
2099: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2100: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2101: <pre class="programlisting">
2102: www/firefox
2103: mail/thunderbird
2104: misc/libreoffice4
2105: </pre>
1.69 asau 2106: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2107: and make final amendments, if wanted.</p>
1.68 asau 2108: <p>Start it:</p>
2109: <pre class="screen">
2110: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2111: </pre>
2112: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2113: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2114: </p>
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 does not cover all possible use cases.
2118: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2119: The script is kept small enough for better understanding.</p>
2120: </div>
2121: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2122: <h3 class="title">Note</h3>
2123: <p>The <code class="filename">pbulk.sh</code> script supports running
2124: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2125: </div>
1.6 rillig 2126: </div>
2127: </div>
1.41 asau 2128: <div class="sect1">
1.6 rillig 2129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2130: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2131: <p>A complete bulk build requires lots of disk space. Some of the
2132: disk space can be read-only, some other must be writable. Some can be on
2133: remote filesystems (such as NFS) and some should be local. Some can be
2134: temporary filesystems, others must survive a sudden reboot.</p>
2135: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2136: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2137: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2138: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2139: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2140: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2141: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2142: </ul></div>
2143: </div>
2144: <div class="sect1">
2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2146: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2147: <p>After your pkgsrc bulk-build has completed, you may wish to
2148: create a CD-ROM set of the resulting binary packages to assist
2149: in installing packages on other machines. The
1.79 snj 2150: <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 2151: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2152: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2153: way that keeps all the dependencies for a given package on the same
2154: CD as that package.</p>
1.41 asau 2155: <div class="sect2">
1.1 dsieger 2156: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2157: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2158: <p>Complete documentation for cdpack is found in the cdpack(1)
2159: man page. The following short example assumes that the binary
2160: packages are left in
2161: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2162: sufficient disk space exists in <code class="filename">/u2</code> to
2163: hold the ISO 9660 images.</p>
2164: <pre class="screen">
2165: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2166: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2167: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2168: </pre>
2169: <p>If you wish to include a common set of files
2170: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2171: etc.) on each CD in the collection, then you need to create a
2172: directory which contains these files. e.g.</p>
2173: <pre class="screen">
2174: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2175: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2176: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2177: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2178: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2179: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2180: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2181: </pre>
2182: <p>Now create the images:</p>
2183: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2184: <p>Each image will contain <code class="filename">README</code>,
2185: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2186: in their root directories.</p>
2187: </div>
2188: </div>
2189: </div>
1.41 asau 2190: <div class="chapter">
1.1 dsieger 2191: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2192: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2193: <div class="toc">
2194: <p><b>Table of Contents</b></p>
1.100 leot 2195: <dl class="toc">
1.23 wiz 2196: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2197: <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 2198: </dl>
2199: </div>
2200: <p>The files that are installed by pkgsrc are organized in a way that
2201: is similar to what you find in the <code class="filename">/usr</code> directory
2202: of the base system. But some details are different. This is because
2203: pkgsrc initially came from FreeBSD and had adopted its file system
2204: hierarchy. Later it was largely influenced by NetBSD. But no matter
2205: which operating system you are using pkgsrc with, you can expect the
2206: same layout for pkgsrc.</p>
2207: <p>There are mainly four root directories for pkgsrc, which are all
2208: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2209: When pkgsrc has been installed as root, the default locations
2210: are:</p>
2211: <pre class="programlisting">
2212: LOCALBASE= /usr/pkg
2213: PKG_SYSCONFBASE= /usr/pkg/etc
2214: VARBASE= /var
2215: PKG_DBDIR= /var/db/pkg
2216: </pre>
2217: <p>In unprivileged mode (when pkgsrc has been installed as any other
2218: user), the default locations are:</p>
2219: <pre class="programlisting">
2220: LOCALBASE= ${HOME}/pkg
2221: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2222: VARBASE= ${HOME}/pkg/var
2223: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2224: </pre>
2225: <p>What these four directories are for, and what they look like is
2226: explained below.</p>
1.41 asau 2227: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2228: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2229: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2230: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2231: the well-known subdirectories like <code class="filename">bin</code>,
2232: <code class="filename">include</code>, <code class="filename">lib</code>,
2233: <code class="filename">share</code> and
2234: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2235: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2236: <code class="filename">/var</code> in the base system. Some programs (especially
2237: games, network daemons) need write access to it during normal
2238: operation.</p></li>
1.23 wiz 2239: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2240: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2241: 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 2242: itself.</p></li>
2243: </ul></div>
1.41 asau 2244: <div class="sect1">
1.1 dsieger 2245: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2246: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2247: </h2></div></div></div>
2248: <p>The following directories exist in a typical pkgsrc installation
2249: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2250: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2251: <dt><span class="term"><code class="filename">bin</code></span></dt>
2252: <dd><p>Contains executable programs that are intended to be
2253: directly used by the end user.</p></dd>
2254: <dt><span class="term"><code class="filename">emul</code></span></dt>
2255: <dd><p>Contains files for the emulation layers of various other
2256: operating systems, especially for
2257: NetBSD.</p></dd>
2258: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2259: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2260: <dd><p>Contains
2261: the configuration files.</p></dd>
2262: <dt><span class="term"><code class="filename">include</code></span></dt>
2263: <dd><p>Contains headers for the C and C++ programming
2264: languages.</p></dd>
2265: <dt><span class="term"><code class="filename">info</code></span></dt>
2266: <dd><p>Contains GNU info files of various
2267: packages.</p></dd>
2268: <dt><span class="term"><code class="filename">lib</code></span></dt>
2269: <dd><p>Contains shared and static
2270: libraries.</p></dd>
2271: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2272: <dd><p>Contains data files that don't change after
2273: installation. Other data files belong into
2274: <code class="filename">${VARBASE}</code>.</p></dd>
2275: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2276: <dd><p>Contains programs that are not intended to be used by
2277: end users, such as helper programs or network
2278: daemons.</p></dd>
2279: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2280: <dd><p>Contains programs that are intended to be executed as
2281: CGI scripts by a web server.</p></dd>
2282: <dt><span class="term"><code class="filename">man</code> (the usual value of
2283: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2284: <dd><p>Contains brief
2285: documentation in form of manual pages.</p></dd>
2286: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2287: <dd><p>Contains programs that are intended to be used only by
2288: the super-user.</p></dd>
2289: <dt><span class="term"><code class="filename">share</code></span></dt>
2290: <dd><p>Contains platform-independent data files that don't
2291: change after installation.</p></dd>
2292: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2293: <dd><p>Contains documentation files provided by the
2294: packages.</p></dd>
2295: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2296: <dd><p>Contains example files provided by the packages. Among
2297: others, the original configuration files are saved here and copied to
2298: <code class="filename">${PKG_SYSCONFDIR}</code> during
2299: installation.</p></dd>
2300: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2301: <dd><p>Contains the original files for rc.d
2302: scripts.</p></dd>
2303: <dt><span class="term"><code class="filename">var</code> (the usual location of
2304: <code class="filename">${VARBASE}</code>)</span></dt>
2305: <dd><p>Contains files
2306: that may be modified after
2307: installation.</p></dd>
2308: </dl></div>
2309: </div>
1.41 asau 2310: <div class="sect1">
1.1 dsieger 2311: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2312: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2313: </h2></div></div></div>
1.41 asau 2314: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2315: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2316: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2317: <dd><p>Contains
2318: information about the currently installed
2319: packages.</p></dd>
2320: <dt><span class="term"><code class="filename">games</code></span></dt>
2321: <dd><p>Contains highscore
2322: files.</p></dd>
2323: <dt><span class="term"><code class="filename">log</code></span></dt>
2324: <dd><p>Contains log files.</p></dd>
2325: <dt><span class="term"><code class="filename">run</code></span></dt>
2326: <dd><p>Contains informational files about daemons that are
2327: currently running.</p></dd>
2328: </dl></div>
2329: </div>
2330: </div>
1.41 asau 2331: <div class="chapter">
1.1 dsieger 2332: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2333: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2334: <div class="toc">
2335: <p><b>Table of Contents</b></p>
1.100 leot 2336: <dl class="toc">
1.6 rillig 2337: <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 2338: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2339: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2340: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2341: <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>
2342: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2343: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2344: <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>
2345: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2346: <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 2347: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2348: <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>
2349: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2350: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2351: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2352: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2353: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2354: <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 2355: </dl>
2356: </div>
2357: <p>This section contains hints, tips & tricks on special things in
2358: pkgsrc that we didn't find a better place for in the previous chapters, and
2359: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2360: <div class="sect1">
1.1 dsieger 2361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2362: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2363: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2365: <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 2366: This is a general purpose list for most issues regarding
2367: pkgsrc, regardless of platform, e.g. soliciting user help
2368: for pkgsrc configuration, unexpected build failures, using
2369: particular packages, upgrading pkgsrc installations,
2370: questions regarding the pkgsrc release branches, etc. General announcements or
2371: proposals for changes that impact the pkgsrc user community,
2372: e.g. major infrastructure changes, new features, package
2373: removals, etc., may also be posted.</p></li>
1.23 wiz 2374: <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 2375: A list where the results of pkgsrc bulk builds are sent and
2376: discussed.</p></li>
1.23 wiz 2377: <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 2378: This list is for those who are interested in getting a
2379: commit message for every change committed to pkgsrc. It is
2380: also available in digest form, meaning one daily message
2381: containing all commit messages for changes to the package
2382: source tree in that 24 hour period.</p></li>
2383: </ul></div>
2384: <p>To subscribe, do:</p>
2385: <pre class="programlisting">
2386: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2387: </pre>
2388: <p>Archives for all these mailing lists are available from
1.10 hubertf 2389: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2390: </div>
1.41 asau 2391: <div class="sect1">
1.1 dsieger 2392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2393: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2394: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2395: a number of useful utilities for both users and developers of pkgsrc. This
2396: section attempts only to make the reader aware of the utilities and when
2397: they might be useful, and not to duplicate the documentation that comes
2398: with each package.</p>
2399: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.79 snj 2400: <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 2401: Symlinks for use by buildlink.</p></li></ul></div>
2402: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2403: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2404: <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 2405: Calculates various kinds of checksums (including SHA1).</p></li>
1.79 snj 2406: <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 2407: Compatibility library for pkgsrc tools.</p></li>
1.79 snj 2408: <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 2409: non-BSD systems due to lack of native mtree.</p></li>
1.79 snj 2410: <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 2411: Up-to-date replacement for
2412: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2413: systems where pkg_install is not present.</p></li>
2414: </ul></div>
2415: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2416: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2417: <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 2418: Create a binary package from an
1.10 hubertf 2419: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2420: save the old package.</p></li>
1.79 snj 2421: <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 2422: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2423: from multiple locations. It currently supports the following
2424: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.79 snj 2425: <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 2426: the best compiler flags to optimise code for your current
1.23 wiz 2427: CPU and compiler. </p></li>
1.1 dsieger 2428: </ul></div>
2429: <p>Utilities for keeping track of installed packages, being up to date,
2430: etc:</p>
1.41 asau 2431: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2432: <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 2433: update tool similar to apt(1). Download, install, and upgrade
2434: binary packages easily.</p></li>
1.79 snj 2435: <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 2436: packages whose installed versions do not match the latest pkgsrc
2437: entries.</p></li>
1.79 snj 2438: <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 2439: dependency graphs of packages, to aid in choosing a strategy for
2440: updating.</p></li>
1.79 snj 2441: <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
2442: 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>
2443: <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 2444: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.79 snj 2445: <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 2446: does various checks on the complete pkgsrc system.</p></li>
1.79 snj 2447: <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 2448: packages you have installed.</p></li>
2449: </ul></div>
2450: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2451: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2452: <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 2453: making and maintaining patches for a package (includes pkgdiff,
2454: pkgvi, mkpatches, etc.).</p></li>
1.79 snj 2455: <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 2456: converting to pkgsrc.</p></li>
2457: </ul></div>
2458: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2459: utilities)</p>
1.41 asau 2460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2461: <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 2462: packages in a chrooted area.</p></li>
1.79 snj 2463: <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 2464: kernel version for chrooted cross builds.</p></li>
2465: </ul></div>
2466: </div>
1.41 asau 2467: <div class="sect1">
1.1 dsieger 2468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2469: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2470: <p>To install packages from source as a non-root user, download
2471: 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
2472: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2473: --unprivileged</strong></span>.</p>
2474: <p>This will install the binary part of pkgsrc to
2475: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2476: into <code class="filename">~/pkg/etc</code>.</p>
2477: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2478: </div>
1.41 asau 2479: <div class="sect1">
1.1 dsieger 2480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2481: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2482: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2483: enable this feature by adding the option
2484: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2485: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2486: distfile is found, pkgsrc will try to resume it.</p>
2487: <p>You can also
1.61 wiz 2488: use a different program than the platform default program by changing the
1.16 jnemeth 2489: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2490: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2491: by using the value manual. A value of custom disables the system defaults
2492: and dependency tracking for the fetch program. In that case you have to
2493: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2494: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2495: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2496: <p>For example, if you want to use
1.16 jnemeth 2497: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2498: like:</p>
2499: <pre class="programlisting">
1.112 rillig 2500: FETCH_USING= wget
1.1 dsieger 2501: </pre>
2502: </div>
1.41 asau 2503: <div class="sect1">
1.1 dsieger 2504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2505: <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 2506: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2507: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2508: you will have to add the following line into
1.10 hubertf 2509: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2510: <pre class="programlisting">
1.4 rillig 2511: X11_TYPE=modular
1.1 dsieger 2512: </pre>
1.41 asau 2513: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 2514: <h3 class="title">Note</h3>
1.4 rillig 2515: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
2516: </p>
1.1 dsieger 2517: </div>
2518: </div>
1.41 asau 2519: <div class="sect1">
1.1 dsieger 2520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2521: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2522: <p>If you are sitting behind a firewall which does not allow direct
2523: connections to Internet hosts (i.e. non-NAT), you may specify the
2524: relevant proxy hosts. This is done using an environment variable in the
2525: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2526: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2527: port 80 as the proxy port number. So the proxy environment variables
2528: are:</p>
2529: <pre class="programlisting">
2530: ftp_proxy=ftp://orpheus.amdahl.com:80/
2531: http_proxy=http://orpheus.amdahl.com:80/
2532: </pre>
2533: </div>
1.41 asau 2534: <div class="sect1">
1.1 dsieger 2535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2536: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2537: <p>Some fetch tools are not prepared to support HTTPS by default
2538: (for example, the one in NetBSD 6.0), or the one installed by the
2539: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2540: dependency graph).</p>
2541: <p>Usually you won't notice, because distribution files are
2542: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2543: be often enough if you are following pkgsrc-current. In that case, set
2544: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2545: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2546: with HTTPS support by default. Of course, these tools need to be
2547: installed before you can use them this way.</p>
2548: </div>
2549: <div class="sect1">
2550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2551: <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 2552: <p>This depends on which utility is used to retrieve distfiles. From
2553: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2554: the first available command from the following list:</p>
1.41 asau 2555: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2556: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2557: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2558: </ul></div>
2559: <p>On a default NetBSD installation, this will be
2560: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2561: connections first, and falls back to active connections if the server
2562: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2563: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2564: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2565: <p>Having that option present will prevent
2566: <code class="filename">/usr/bin/ftp</code> from falling back to active
2567: transfers.</p>
2568: </div>
1.41 asau 2569: <div class="sect1">
1.1 dsieger 2570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2571: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2572: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2573: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2574: 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 2575: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2576: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2577: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2578: resulting list to your machine at work/school and use it there. If you
1.79 snj 2579: 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 2580: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2581: URL:</p>
2582: <p>At home:</p>
2583: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2584: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2585: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2586: <p>At work:</p>
2587: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2588: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2589: home.</p>
2590: <p>If you have a machine running NetBSD, and you want to get
2591: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2592: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2593: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2594: directly by running:</p>
2595: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2596: <p>If you even decide to ignore
2597: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2598: by running:</p>
2599: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2600: </div>
1.41 asau 2601: <div class="sect1">
1.1 dsieger 2602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2603: <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 2604: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.79 snj 2605: <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 2606: package, you get the error from make that it doesn't know how to make
2607: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2608: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2609: the NetBSD base distribution on your machine. It is recommended to do
2610: that to format man pages.</p>
1.79 snj 2611: <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 2612: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2613: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2614: </div>
1.41 asau 2615: <div class="sect1">
1.1 dsieger 2616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2617: <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 2618: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2619: when you installed your NetBSD machine. Please get and install it, by
2620: extracting it in <code class="filename">/</code>:</p>
2621: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2622: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2623: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2624: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2625: -r</strong></span>).</p>
2626: </div>
1.41 asau 2627: <div class="sect1">
1.1 dsieger 2628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2629: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2630: <p>When installing packages as non-root user and using the just-in-time
1.79 snj 2631: <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 2632: password for each required package installed. To avoid this, the sudo
2633: package can be used, which does password caching over a limited time. To
2634: use it, install sudo (either as binary package or from
1.79 snj 2635: <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 2636: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2637: <span class="emphasis"><em>after</em></span> the definition of the
2638: <code class="varname">LOCALBASE</code> variable:</p>
2639: <pre class="programlisting">
2640: .if exists(${LOCALBASE}/bin/sudo)
2641: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2642: .endif
2643: </pre>
2644: </div>
1.41 asau 2645: <div class="sect1">
1.1 dsieger 2646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2647: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2648: <p>As the system administrator, you can choose where configuration files
2649: are installed. The default settings make all these files go into
2650: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2651: be suboptimal depending on your expectations (e.g., a read-only,
2652: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2653: configuration of the provided packages).</p>
2654: <p>In order to change the defaults, you can modify the
2655: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2656: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2657: directory; some common examples include <code class="filename">/etc</code> or
2658: <code class="filename">/etc/pkg</code>.</p>
2659: <p>Furthermore, you can change this value on a per-package basis by
2660: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2661: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2662: package you would like to modify, that is, the contents of
2663: <code class="varname">PKGBASE</code>.</p>
2664: <p>Note that after changing these settings, you must rebuild and
2665: reinstall any affected packages.</p>
2666: </div>
1.41 asau 2667: <div class="sect1">
1.1 dsieger 2668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2669: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2670: <p>Please be aware that there can often be bugs in third-party software,
2671: and some of these bugs can leave a machine vulnerable to exploitation by
2672: attackers. In an effort to lessen the exposure, the NetBSD packages team
2673: maintains a database of known-exploits to packages which have at one time
2674: been included in pkgsrc. The database can be downloaded automatically, and
2675: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2676: do this, refer to the following two tools (installed as part of the
1.79 snj 2677: <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 2678: <div class="orderedlist"><ol class="orderedlist" type="1">
2679: <li class="listitem">
1.20 snj 2680: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2681: download a list of the security vulnerabilities information. This list
1.25 spz 2682: is kept up to date by the pkgsrc security team, and is distributed
2683: from the NetBSD ftp server:</p>
2684: <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 2685: </li>
1.23 wiz 2686: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2687: current machine, checking each known vulnerability. If a
1.1 dsieger 2688: vulnerable package is installed, it will be shown by output to stdout,
2689: including a description of the type of vulnerability, and a URL
2690: containing more information.</p></li>
2691: </ol></div>
1.14 jmcneill 2692: <p>Use of these tools is strongly recommended! After
1.23 wiz 2693: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 2694: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 2695: pkg_install</code></strong>.</p>
1.1 dsieger 2696: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 2697: 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 2698: check.</p>
2699: </div>
1.41 asau 2700: <div class="sect1">
1.1 dsieger 2701: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2702: <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 2703: <p>When you add your own preferences to the
2704: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2705: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2706: environment variables to the <code class="filename">./configure</code>
1.79 snj 2707: 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 2708: <code class="varname">CFLAGS</code> from the environment variable by
2709: overriding them in the <code class="filename">Makefile</code>s of their
2710: package.</p>
2711: <p>Currently there is no solution to this problem. If you
2712: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2713: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2714: directory and then inspect any <code class="filename">Makefile</code> and
2715: <code class="filename">Makefile.in</code> for whether they define
2716: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2717: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2718: programmers write so bad code that it only works for the
2719: specific combination of <code class="varname">CFLAGS</code> they have
2720: chosen.</p>
2721: </div>
1.41 asau 2722: <div class="sect1">
1.1 dsieger 2723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2724: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2725: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2726: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2727: case that occurs often is that people only update pkgsrc in
2728: parts, because of performance reasons. Since pkgsrc is one large
2729: system, not a collection of many small systems, there are
2730: sometimes changes that only work when the whole pkgsrc tree is
2731: updated.</p></li>
1.41 asau 2732: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2733: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2734: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2735: files.</p></li>
1.41 asau 2736: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2737: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2738: verify this.</p></li>
1.108 rillig 2739: <li class="step"><p>If you are a package developer who wants to invest
2740: 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 2741: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2742: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2743: </ol></div>
2744: </div>
1.41 asau 2745: <div class="sect1">
1.1 dsieger 2746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2747: <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 2748: <p>You have modified a file from pkgsrc, and someone else has
2749: modified that same file afterwards in the CVS repository. Both changes
2750: are in the same region of the file, so when you updated pkgsrc, the
2751: <code class="literal">cvs</code> command marked the conflicting changes in the
2752: file. Because of these markers, the file is no longer a valid
2753: <code class="filename">Makefile</code>.</p>
2754: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2755: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2756: -dP</strong></span> in that directory to download the current version.</p>
2757: </div>
2758: </div>
2759: </div>
1.41 asau 2760: <div class="part">
1.1 dsieger 2761: <div class="titlepage"><div><div><h1 class="title">
2762: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2763: <div class="partintro">
1.1 dsieger 2764: <div></div>
2765: <p>This part of the book deals with creating and
1.23 wiz 2766: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2767: guide on creating a new package. The remaining chapters are more
2768: like a reference manual for pkgsrc.</p>
2769: <div class="toc">
2770: <p><b>Table of Contents</b></p>
1.100 leot 2771: <dl class="toc">
1.6 rillig 2772: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2773: <dd><dl>
1.6 rillig 2774: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2775: <dd><dl>
1.6 rillig 2776: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 2777: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 2778: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 2779: </dl></dd>
1.6 rillig 2780: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
2781: <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>
2782: </dl></dd>
2783: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
2784: <dd><dl>
1.23 wiz 2785: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
2786: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 2787: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2788: <dd><dl>
2789: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
2790: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
2791: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
2792: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
2793: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
2794: </dl></dd>
2795: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
2796: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
2797: <dd><dl>
2798: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
2799: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
2800: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
2801: </dl></dd>
1.23 wiz 2802: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
2803: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2804: </dl></dd>
1.23 wiz 2805: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2806: <dd><dl>
2807: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 2808: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 2809: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
2810: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
2811: <dd><dl>
2812: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 2813: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
2814: <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>
2815: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2816: </dl></dd>
2817: </dl></dd>
2818: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
2819: <dd><dl>
2820: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 2821: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2822: <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 2823: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
2824: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 2825: <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 2826: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 2827: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
2828: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2829: </dl></dd>
2830: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
2831: <dd><dl>
2832: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 2833: <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 2834: <dd><dl>
2835: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 2836: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
2837: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2838: and
2839: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2840: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2841: </dl></dd>
1.23 wiz 2842: <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 2843: <dd><dl>
1.23 wiz 2844: <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 2845: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
2846: </dl></dd>
2847: </dl></dd>
2848: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
2849: <dd><dl>
2850: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
2851: <dd><dl>
2852: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
2853: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
2854: </dl></dd>
2855: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
2856: <dd><dl>
1.23 wiz 2857: <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 2858: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
2859: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
2860: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
2861: </dl></dd>
2862: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
2863: <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>
2864: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
2865: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
2866: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
2867: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
2868: <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>
2869: </dl></dd>
2870: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
2871: <dd><dl>
2872: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 2873: <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 2874: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 2875: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 2876: </dl></dd>
2877: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
2878: <dd><dl>
2879: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
2880: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
2881: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
2882: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 2883: <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 2884: <dd><dl>
2885: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
2886: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
2887: </dl></dd>
1.23 wiz 2888: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2889: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2890: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2891: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2892: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2893: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2894: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2895: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2896: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2897: <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 2898: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
2899: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
2900: </dl></dd>
2901: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
2902: <dd><dl>
2903: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
2904: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
2905: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
2906: </dl></dd>
2907: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
2908: <dd><dl>
2909: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
2910: <dd><dl>
1.108 rillig 2911: <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>
2912: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
2913: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
2914: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
2915: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
2916: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
2917: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
2918: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
2919: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
2920: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2921: <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 2922: </dl></dd>
1.108 rillig 2923: <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 2924: <dd><dl>
2925: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2926: <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 2927: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 2928: </dl></dd>
1.108 rillig 2929: <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 2930: <dd><dl>
2931: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
2932: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2933: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
2934: </dl></dd>
2935: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
2936: <dd><dl>
2937: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
2938: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
2939: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 2940: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
2941: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 2942: </dl></dd>
1.108 rillig 2943: <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 2944: <dd><dl>
2945: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
2946: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 2947: <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 2948: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
2949: </dl></dd>
1.108 rillig 2950: <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 2951: <dd><dl>
2952: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
2953: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
2954: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
2955: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
2956: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2957: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
2958: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
2959: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 2960: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 2961: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 2962: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
2963: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
2964: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
2965: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
2966: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
2967: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
2968: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
2969: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 2970: emulation</a></span></dt>
1.6 rillig 2971: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
2972: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 2973: </dl></dd>
1.6 rillig 2974: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 2975: </dl></dd>
1.6 rillig 2976: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
2977: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 2978: <dd><dl>
1.6 rillig 2979: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
2980: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
2981: <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 2982: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 2983: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 2984: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
2985: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 2986: </dl></dd>
2987: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
2988: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
2989: <dd><dl>
2990: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
2991: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
2992: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
2993: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 2994: </dl></dd>
2995: </dl>
2996: </div>
2997: </div>
1.41 asau 2998: <div class="chapter">
1.1 dsieger 2999: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3000: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3001: <div class="toc">
3002: <p><b>Table of Contents</b></p>
1.100 leot 3003: <dl class="toc">
1.6 rillig 3004: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3005: <dd><dl>
1.6 rillig 3006: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3007: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3008: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3009: </dl></dd>
1.6 rillig 3010: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3011: <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 3012: </dl>
3013: </div>
3014: <p>When you find a package that is not yet in pkgsrc, you
3015: most likely have a URL from where you can download the source
3016: code. Starting with this URL, creating a package involves only a
3017: few steps.</p>
1.23 wiz 3018: <div class="procedure"><ol class="procedure" type="1">
1.79 snj 3019: <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 3020: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3021: category in which you want to place your package. You can also create a
3022: directory of your own (maybe called <code class="filename">local</code>). In that
3023: category directory, create another directory for your package and change
3024: into it.</p></li>
1.41 asau 3025: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3026: you for a URL. Enter the URL of the distribution file (in most cases a
3027: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3028: of your package are created automatically. The distribution file is
3029: extracted automatically to fill in some details in the
3030: <code class="filename">Makefile</code> that would otherwise have to be done
3031: manually.</p></li>
1.41 asau 3032: <li class="step">
1.1 dsieger 3033: <p>Examine the extracted files to determine the dependencies of
3034: your package. Ideally, this is mentioned in some
3035: <code class="filename">README</code> file, but things may differ. For each of
3036: these dependencies, look where it exists in pkgsrc, and if there is a
3037: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3038: line to your package <code class="filename">Makefile</code> which includes that
3039: file just before the last line. If the
1.25 spz 3040: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3041: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3042: <p>If you just need binaries from a package, add a
1.1 dsieger 3043: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3044: version of the dependency and where it can be found in pkgsrc. This line
3045: should be placed in the third paragraph. If the dependency is only
3046: needed for building the package, but not when using it, use
3047: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3048: Your package may then look like this:</p>
3049: <pre class="programlisting">
3050: [...]
3051:
1.66 asau 3052: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3053: DEPENDS+= screen-[0-9]*:../../misc/screen
3054: DEPENDS+= screen>=4.0:../../misc/screen
3055:
3056: [...]
3057:
3058: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3059: .include "../../devel/glib2/buildlink3.mk"
3060: .include "../../mk/bsd.pkg.mk"
3061: </pre>
3062: </li>
1.41 asau 3063: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3064: 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 3065: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3066: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3067: -e</strong></span>, which outputs additional
3068: explanations.</p></li>
1.41 asau 3069: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3070: 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 3071: over there, you can hopefully continue here.</p></li>
1.41 asau 3072: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3073: directory from the extracted files. Besides these files, a lot of cache
3074: files and other system information has been saved in the working
3075: directory, which may become wrong after you edited the
3076: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3077: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3078: 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 3079: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3080: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3081: everything works.</p></li>
1.41 asau 3082: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3083: contains a list of the files that are installed by the package, is
1.10 hubertf 3084: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3085: >PLIST</strong></span> to generate a probably correct list. Check
3086: the file using your preferred text editor to see if the list of
3087: files looks plausible.</p></li>
1.41 asau 3088: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3089: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3090: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3091: has been registered in the database of installed files, but with an
1.10 hubertf 3092: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3093: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3094: registered with the list of files from
3095: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3096: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3097: package from the set of installed files.</p></li>
3098: </ol></div>
1.41 asau 3099: <div class="sect1">
1.1 dsieger 3100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3101: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3102: <div class="sect2">
1.1 dsieger 3103: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3104: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3105: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3106: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3107: </div>
1.41 asau 3108: <div class="sect2">
1.1 dsieger 3109: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 3110: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3111: <p>KDE3 applications should always include
1.1 dsieger 3112: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 asau 3113: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3114: </div>
1.41 asau 3115: <div class="sect2">
1.17 imil 3116: <div class="titlepage"><div><div><h3 class="title">
3117: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3118: <p>Python modules and programs packages are easily created using a
3119: set of predefined variables.</p>
3120: <p>
1.63 wiz 3121: If some Python versions are not supported by the software, set the
3122: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3123: that are not supported, e.g.
1.17 imil 3124: </p>
3125: <pre class="programlisting">
1.93 sevan 3126: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3127: </pre>
3128: <p>
1.103 wiz 3129: If the packaged software is a Python module, include one of
3130: <code class="filename">../../lang/python/egg.mk</code>,
3131: <code class="filename">../../lang/python/distutils.mk</code>, or
3132: <code class="filename">../../lang/python/extension.mk</code>.</p>
3133: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3134: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3135: if the packaged software is using setuptools, you only need
3136: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3137: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3138: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3139: so pkgsrc will use this framework.
3140: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3141: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3142: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3143: to the name of the script.</p>
3144: <p>Either way, the package directory should be called
1.23 wiz 3145: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3146: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3147: </p>
3148: <pre class="programlisting">
3149: DISTNAME= foopymodule-1.2.10
3150: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3151: </pre>
1.63 wiz 3152: <p>If it is an application, include
3153: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3154: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3155: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3156: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3157: For example:
1.17 imil 3158: </p>
3159: <pre class="programlisting">
1.35 wiz 3160: REPLACE_PYTHON= *.py
1.17 imil 3161: </pre>
1.63 wiz 3162: <p>Some Python modules have separate distributions for Python-2.x
3163: and Python-3.x support. In pkgsrc this is handled by the
3164: <code class="filename">versioned_dependencies.mk</code> file. Set
3165: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3166: packages that should be depended upon and include
3167: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3168: then the pkgsrc infrastructure will depend on the appropriate package
3169: version. For example:
3170: </p>
3171: <pre class="programlisting">
1.110 wiz 3172: PYTHON_VERSIONED_DEPENDENCIES=dateutil
1.63 wiz 3173: </pre>
3174: <p>
3175: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3176: of supported packages.</p>
1.17 imil 3177: </div>
1.1 dsieger 3178: </div>
1.41 asau 3179: <div class="sect1">
1.1 dsieger 3180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3181: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3182: <div class="sect2">
1.1 dsieger 3183: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3184: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3185: <div class="sect3">
1.1 dsieger 3186: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3187: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3188: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3189: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3190: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3191: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3192: <pre class="programlisting">
3193: <code class="prompt">$</code> mkdir www/nvu
3194: <code class="prompt">$</code> cd www/nvu
3195: </pre>
3196: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3197: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3198: <pre class="programlisting">
3199: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3200: </pre>
3201: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3202: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3203: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3204: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3205: <code class="varname">COMMENT</code> fields. Then the package
3206: <code class="filename">Makefile</code> looked like that:</p>
3207: <pre class="programlisting">
3208: # $NetBSD$
3209: #
3210:
3211: DISTNAME= nvu-1.0-sources
3212: PKGNAME= nvu-1.0
3213: CATEGORIES= www
3214: MASTER_SITES= http://cvs.nvu.com/download/
3215: EXTRACT_SUFX= .tar.bz2
3216:
3217: MAINTAINER= rillig@NetBSD.org
3218: HOMEPAGE= http://cvs.nvu.com/
3219: COMMENT= Web Authoring System
3220:
3221: # url2pkg-marker (please do not remove this line.)
3222: .include "../../mk/bsd.pkg.mk"
3223: </pre>
3224: <p>Then, I quit the editor and watched pkgsrc downloading a large
3225: source archive:</p>
3226: <pre class="programlisting">
3227: url2pkg> Running "make makesum" ...
3228: => Required installed package digest>=20010302: digest-20060826 found
3229: => Fetching nvu-1.0-sources.tar.bz2
3230: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3231: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3232: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3233: url2pkg> Running "make extract" ...
3234: => Required installed package digest>=20010302: digest-20060826 found
3235: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3236: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3237: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3238: ===> Installing dependencies for nvu-1.0
3239: ===> Overriding tools for nvu-1.0
3240: ===> Extracting for nvu-1.0
3241: url2pkg> Adjusting the Makefile.
3242:
3243: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3244:
3245: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3246: </pre>
3247: </div>
1.41 asau 3248: <div class="sect3">
1.1 dsieger 3249: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3250: <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 3251: <p>Now that the package has been extracted, let's see what's inside
3252: it. The package has a <code class="filename">README.txt</code>, but that only
3253: says something about mozilla, so it's probably useless for seeing what
3254: dependencies this package has. But since there is a GNU configure script
3255: in the package, let's hope that it will complain about everything it
3256: needs.</p>
3257: <pre class="programlisting">
3258: <code class="prompt">$</code> bmake
3259: => Required installed package digest>=20010302: digest-20060826 found
3260: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3261: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3262: ===> Patching for nvu-1.0
3263: ===> Creating toolchain wrappers for nvu-1.0
3264: ===> Configuring for nvu-1.0
3265: [...]
3266: configure: error: Perl 5.004 or higher is required.
3267: [...]
3268: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3269: [...]
3270: </pre>
3271: <p>That worked quite well. So I opened the package Makefile in my
3272: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3273: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3274: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3275: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3276: from scratch.</p>
3277: <pre class="programlisting">
3278: <code class="prompt">$</code> bmake clean
3279: ===> Cleaning for nvu-1.0
3280: <code class="prompt">$</code> bmake
3281: [...]
3282: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3283: GNU Make. You will not be able to build Mozilla without GNU Make.
3284: [...]
3285: </pre>
1.23 wiz 3286: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3287: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3288: <pre class="programlisting">
3289: [...]
3290: checking for GTK - version >= 1.2.0... no
3291: *** Could not run GTK test program, checking why...
3292: [...]
3293: </pre>
3294: <p>Now to the other dependencies. The first question is: Where is the
3295: GTK package hidden in pkgsrc?</p>
3296: <pre class="programlisting">
3297: <code class="prompt">$</code> echo ../../*/gtk*
3298: [many packages ...]
3299: <code class="prompt">$</code> echo ../../*/gtk
3300: ../../x11/gtk
3301: <code class="prompt">$</code> echo ../../*/gtk2
3302: ../../x11/gtk2
3303: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3304: ../../x11/gtk2/buildlink3.mk
3305: </pre>
3306: <p>The first try was definitely too broad. The second one had exactly
3307: one result, which is very good. But there is one pitfall with GNOME
3308: packages. Before GNOME 2 had been released, there were already many
3309: GNOME 1 packages in pkgsrc. To be able to continue to use these
3310: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3311: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3312: whether this was the case here, and indeed it was.</p>
3313: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3314: file, adding the dependency is very easy. I just inserted an
3315: <code class="literal">.include</code> line before the last line of the package
3316: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3317: <pre class="programlisting">
3318: [...]
3319: .include "../../x11/gtk2/buildlink3.mk"
3320: .include "../../mk/bsd.pkg.mk
3321: </pre>
1.10 hubertf 3322: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3323: was:</p>
3324: <pre class="programlisting">
3325: [...]
3326: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3327: checking for GTK - version >= 1.2.0... no
3328: *** Could not run GTK test program, checking why...
3329: *** The test program failed to compile or link. See the file config.log for the
3330: *** exact error that occured. This usually means GTK was incorrectly installed
3331: *** or that you have moved GTK since it was installed. In the latter case, you
3332: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3333: configure: error: Test for GTK failed.
3334: [...]
3335: </pre>
1.23 wiz 3336: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3337: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3338: told me that this package really wanted to have the GNOME 1 version of
3339: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3340: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3341: So I changed the <code class="literal">x11/gtk2</code> to
3342: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3343: and tried again.</p>
3344: <pre class="programlisting">
3345: [...]
1.59 jnemeth 3346: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3347: In file included from xpidl.c:42:
3348: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3349: In file included from xpidl.c:42:
3350: xpidl.h:132: error: parse error before "IDL_ns"
3351: [...]
3352: </pre>
3353: <p>The package still does not find all of its dependencies. Now the
3354: question is: Which package provides the
3355: <code class="filename">libIDL/IDL.h</code> header file?</p>
3356: <pre class="programlisting">
3357: <code class="prompt">$</code> echo ../../*/*idl*
3358: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3359: <code class="prompt">$</code> echo ../../*/*IDL*
3360: ../../net/libIDL
3361: </pre>
3362: <p>Let's take the one from the second try. So I included the
3363: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3364: again. But the error didn't change. After digging through some of the
3365: code, I concluded that the build process of the package was broken and
3366: couldn't have ever worked, but since the Mozilla source tree is quite
3367: large, I didn't want to fix it. So I added the following to the package
3368: <code class="filename">Makefile</code> and tried again:</p>
3369: <pre class="programlisting">
3370: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3371: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3372: </pre>
3373: <p>The latter line is needed because the package expects the library
3374: <code class="filename">libIDL.so</code>, but only
3375: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3376: wrapper to rewrite that on the fly.</p>
3377: <p>The next problem was related to a recent change of the FreeType
1.79 snj 3378: 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 3379: which patch files were relevant for this issue and copied them to the
3380: <code class="filename">patches</code> directory. Then I retried, fixed the
3381: patches so that they applied cleanly and retried again. This time,
3382: everything worked.</p>
3383: </div>
1.41 asau 3384: <div class="sect3">
1.1 dsieger 3385: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3386: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3387: <pre class="programlisting">
3388: <code class="prompt">$</code> bmake CHECK_FILES=no install
3389: [...]
3390: <code class="prompt">$</code> bmake print-PLIST >PLIST
3391: <code class="prompt">$</code> bmake deinstall
3392: <code class="prompt">$</code> bmake install
3393: </pre>
3394: </div>
3395: </div>
3396: </div>
3397: </div>
1.41 asau 3398: <div class="chapter">
1.1 dsieger 3399: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3400: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3401: <div class="toc">
3402: <p><b>Table of Contents</b></p>
1.100 leot 3403: <dl class="toc">
1.23 wiz 3404: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3405: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 3406: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3407: <dd><dl>
3408: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3409: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3410: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3411: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3412: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3413: </dl></dd>
3414: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3415: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3416: <dd><dl>
3417: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3418: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3419: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3420: </dl></dd>
1.23 wiz 3421: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3422: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3423: </dl>
3424: </div>
3425: <p>Whenever you're preparing a package, there are a number of
3426: files involved which are described in the following
3427: sections.</p>
1.41 asau 3428: <div class="sect1">
1.1 dsieger 3429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3430: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3431: </h2></div></div></div>
3432: <p>Building, installation and creation of a binary package are all
3433: controlled by the package's <code class="filename">Makefile</code>.
3434: The <code class="filename">Makefile</code> describes various things about
3435: a package, for example from where to get it, how to configure,
3436: build, and install it.</p>
3437: <p>A package <code class="filename">Makefile</code> contains several
3438: sections that describe the package.</p>
3439: <p>In the first section there are the following variables, which
3440: should appear exactly in the order given here. The order and
3441: grouping of the variables is mostly historical and has no further
3442: meaning.</p>
1.41 asau 3443: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3444: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3445: distribution file to be downloaded from the package's
3446: website.</p></li>
1.23 wiz 3447: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3448: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3449: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3450: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3451: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3452: directory name together with the version number. It must match the
3453: regular expression
3454: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3455: starts with a letter or digit, and contains only letters, digits,
3456: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3457: <li class="listitem">
1.1 dsieger 3458: <p><code class="varname">CATEGORIES</code> is a list of categories
3459: which the package fits in. You can choose any of the top-level
3460: directories of pkgsrc for it.</p>
3461: <p>Currently the following values are available for
3462: <code class="varname">CATEGORIES</code>. If more than
3463: one is used, they need to be separated by spaces:</p>
3464: <pre class="programlisting">
3465: archivers cross geography meta-pkgs security
3466: audio databases graphics misc shells
3467: benchmarks devel ham multimedia sysutils
3468: biology editors inputmethod net textproc
3469: cad emulators lang news time
3470: chat finance mail parallel wm
3471: comms fonts math pkgtools www
3472: converters games mbone print x11
3473: </pre>
3474: </li>
1.23 wiz 3475: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3476: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3477: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3478: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 3479: <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 3480: </ul></div>
3481: <p>The second section contains information about separately
3482: downloaded patches, if any.
3483: </p>
1.41 asau 3484: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3485: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3486: Name(s) of additional files that contain distribution patches.
3487: There is no default. pkgsrc will look for them at
3488: <code class="varname">PATCH_SITES</code>.
3489: They will automatically be uncompressed before patching if
3490: the names end with <code class="filename">.gz</code> or
3491: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3492: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3493: Primary location(s) for distribution patch files (see
1.80 wiz 3494: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3495: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
3496: 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
3497: help find the correct files to patch. It defaults to
3498: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3499: </ul></div>
3500: <p>The third section contains the following variables.
3501: </p>
1.41 asau 3502: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3503: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3504: address of the person who feels responsible for this package,
3505: and who is most likely to look at problems or questions regarding
1.79 snj 3506: 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 3507: Other developers may contact the <code class="varname">MAINTAINER</code>
3508: before making changes to the package, but are not required to
3509: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3510: to yourself. If you really can't maintain the package for future
3511: updates, set it to
1.10 hubertf 3512: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3513: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3514: of <code class="varname">MAINTAINER</code> when you do not want other
3515: developers to update or change the package without contacting
3516: you first. A package Makefile should contain one of
3517: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3518: not both. </p></li>
1.23 wiz 3519: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3520: find more information about the package.</p></li>
1.23 wiz 3521: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3522: description of the package (should not include the package
3523: name).</p></li>
3524: </ul></div>
3525: <p>Other variables that affect the build:
3526: </p>
1.41 asau 3527: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3528: <p><code class="varname">WRKSRC</code>: The directory where the
3529: interesting distribution files of the package are found. The
3530: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3531: works for most packages.</p>
3532: <p>If a package doesn't create a subdirectory for itself
3533: (most GNU software does, for instance), but extracts itself in
3534: the current directory, you should set
3535: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3536: <p>If a package doesn't create a subdirectory with the
3537: name of <code class="varname">DISTNAME</code> but some different name,
3538: set <code class="varname">WRKSRC</code> to point to the proper name in
3539: <code class="filename">${WRKDIR}</code>, for example
3540: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.79 snj 3541: <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 3542: <p>The name of the working directory created by pkgsrc is
3543: taken from the <code class="varname">WRKDIR_BASENAME</code>
3544: variable. By default, its value is
3545: <code class="filename">work</code>. If you want to use the same
3546: pkgsrc tree for building different kinds of binary packages,
3547: you can change the variable according to your needs. Two
3548: other variables handle common cases of setting
3549: <code class="varname">WRKDIR_BASENAME</code> individually. If
3550: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3551: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3552: the host's name is attached to the directory name. If
3553: <code class="varname">OBJMACHINE</code> is defined, the platform name
3554: is attached, which might look like
3555: <code class="filename">work.i386</code> or
3556: <code class="filename">work.sparc</code>.</p>
3557: </li></ul></div>
3558: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3560: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3561: installed in compressed form by the package. For packages using
3562: BSD-style makefiles which honor MANZ, there is
3563: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3564: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3565: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3566: below).</p></li>
1.23 wiz 3567: <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 3568: </ul></div>
3569: </div>
1.41 asau 3570: <div class="sect1">
1.1 dsieger 3571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3572: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 3573: </h2></div></div></div>
3574: <p>The <code class="filename">distinfo</code> file contains the message
3575: digest, or checksum, of each distfile needed for the package. This
3576: ensures that the distfiles retrieved from the Internet have not been
3577: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3578: a security hole. To provide maximum security, all distfiles are
3579: protected using three different message digest algorithms (SHA1,
3580: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3581: <p>The <code class="filename">distinfo</code> file also contains the
3582: checksums for all the patches found in the
1.108 rillig 3583: <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 3584: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3585: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3586: <p>Some packages have different sets of distfiles depending on
1.79 snj 3587: 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 3588: <code class="filename">distinfo</code> file and care should be taken when
3589: upgrading such a package to ensure distfile information is not
3590: lost.</p>
3591: </div>
1.41 asau 3592: <div class="sect1">
1.1 dsieger 3593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 3594: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
3595: </h2></div></div></div>
3596: <p>Some packages don't work out-of-the box on the various
3597: platforms that are supported by pkgsrc. These packages need
3598: to be patched to make them work. The patch files can be
1.1 dsieger 3599: found in the <code class="filename">patches/</code> directory.</p>
3600: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3601: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3602: extracting them, in alphabetic order.</p>
1.41 asau 3603: <div class="sect2">
1.1 dsieger 3604: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3605: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3606: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3607: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3608: problems. (To force patches to apply with fuzz you can set
3609: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3610: should contain only changes for a single file, and no file should be
3611: patched by more than one patch file. This helps to keep future
3612: modifications simple.</p>
3613: <p>Each patch file is structured as follows: In the first line,
3614: there is the RCS Id of the patch itself. The second line should be
3615: empty for aesthetic reasons. After that, there should be a comment for
3616: each change that the patch does. There are a number of standard
3617: cases:</p>
1.41 asau 3618: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3619: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3620: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3621: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3622: platform and other environment (for example, the compiler) that the
3623: patch is needed for.</p></li>
3624: </ul></div>
1.108 rillig 3625: <p>The patch should be commented so that any
1.1 dsieger 3626: developer who knows the code of the application can make some use of
3627: the patch. Special care should be taken for the upstream developers,
3628: since we generally want that they accept our patches, so we have less
3629: work in the future.</p>
3630: </div>
1.41 asau 3631: <div class="sect2">
1.1 dsieger 3632: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3633: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3634: <p>One important thing to mention is to pay attention that no RCS
3635: IDs get stored in the patch files, as these will cause problems when
3636: later checked into the NetBSD CVS tree. Use the
1.79 snj 3637: <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 3638: problems.</p>
3639: <p>For even more automation, we recommend using
1.10 hubertf 3640: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3641: whole set of patches. You just have to backup files before you
3642: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3643: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3644: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3645: you upgrade a package this way, you can easily compare the new
3646: set of patches with the previously existing one with
1.24 wiz 3647: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3648: are replaced by new files, so carefully check if you want to take all
3649: the changes.</p>
1.1 dsieger 3650: <p>When you have finished a package, remember to generate
1.10 hubertf 3651: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 3652: 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 3653: <p>When adding a patch that corrects a problem in the
3654: distfile (rather than e.g. enforcing pkgsrc's view of where
3655: man pages should go), send the patch as a bug report to the
3656: maintainer. This benefits non-pkgsrc users of the package,
3657: and usually makes it possible to remove the patch in future
3658: version.</p>
1.2 rillig 3659: <p>The file names of the patch files are usually of the form
1.24 wiz 3660: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3661: Many packages still use the previous convention
3662: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3663: but new patches should be of the form containing the filename.
1.79 snj 3664: <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 3665: automatically.</p>
1.1 dsieger 3666: </div>
1.41 asau 3667: <div class="sect2">
1.1 dsieger 3668: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3669: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3670: <p>If you want to share patches between multiple packages
3671: in pkgsrc, e.g. because they use the same distfiles, set
3672: <code class="varname">PATCHDIR</code> to the path where the patch files
3673: can be found, e.g.:</p>
3674: <pre class="programlisting">
3675: PATCHDIR= ${.CURDIR}/../xemacs/patches
3676: </pre>
3677: <p>Patch files that are distributed by the author or other
3678: maintainers can be listed in
3679: <code class="varname">PATCHFILES</code>.</p>
3680: <p>If it is desired to store any patches that should not be
3681: committed into pkgsrc, they can be kept outside the pkgsrc
3682: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3683: directory tree there is expected to have the same
1.23 wiz 3684: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3685: patches are expected to be stored inside these dirs (also
3686: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3687: example, if you want to keep a private patch for
3688: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3689: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3690: files in the named directory are expected to be patch files,
3691: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3692: applied</em></span>.</p>
3693: </div>
1.41 asau 3694: <div class="sect2">
1.1 dsieger 3695: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3696: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3697: <p>When fixing a portability issue in the code do not use
3698: preprocessor magic to check for the current operating system nor
3699: platform. Doing so hurts portability to other platforms because
3700: the OS-specific details are not abstracted appropriately.</p>
3701: <p>The general rule to follow is: instead of checking for the
3702: operating system the application is being built on, check for the
3703: specific <span class="emphasis"><em>features</em></span> you need. For example,
3704: instead of assuming that kqueue is available under NetBSD and
3705: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3706: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3707: yes, this generally involves patching the
1.10 hubertf 3708: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3709: that prevents some OSes from adopting interfaces from other OSes
3710: (e.g. Linux implementing kqueue), something that the above checks
3711: cannot take into account.</p>
3712: <p>Of course, checking for features generally involves more
3713: work on the developer's side, but the resulting changes are
3714: cleaner and there are chances they will work on many other
3715: platforms. Not to mention that there are higher chances of being
3716: later integrated into the mainstream sources. Remember:
3717: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3718: <p>Some typical examples:</p>
3719: <div class="table">
1.6 rillig 3720: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.106 tnn 3721: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3722: <colgroup>
3723: <col>
3724: <col>
3725: <col>
3726: </colgroup>
3727: <thead><tr>
3728: <th>Where</th>
3729: <th>Incorrect</th>
3730: <th>Correct</th>
3731: </tr></thead>
3732: <tbody>
3733: <tr>
3734: <td>configure script</td>
3735: <td>
3736: <pre class="programlisting">
3737: case ${target_os} in
3738: netbsd*) have_kvm=yes ;;
3739: *) have_kvm=no ;;
3740: esac
3741: </pre>
3742: </td>
3743: <td>
3744: <pre class="programlisting">
3745: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3746: </pre>
3747: </td>
3748: </tr>
3749: <tr>
3750: <td>C source file</td>
3751: <td>
3752: <pre class="programlisting">
3753: #if defined(__NetBSD__)
3754: # include <sys/event.h>
3755: #endif
3756: </pre>
3757: </td>
3758: <td>
3759: <pre class="programlisting">
3760: #if defined(HAVE_SYS_EVENT_H)
3761: # include <sys/event.h>
3762: #endif
3763: </pre>
3764: </td>
3765: </tr>
3766: <tr>
3767: <td>C source file</td>
3768: <td>
3769: <pre class="programlisting">
3770: int
3771: monitor_file(...)
3772: {
3773: #if defined(__NetBSD__)
3774: int fd = kqueue();
3775: ...
3776: #else
3777: ...
3778: #endif
3779: }
3780: </pre>
3781: </td>
3782: <td>
3783: <pre class="programlisting">
3784: int
3785: monitor_file(...)
3786: {
3787: #if defined(HAVE_KQUEUE)
3788: int fd = kqueue();
3789: ...
3790: #else
1.112 rillig 3791: ...
1.1 dsieger 3792: #endif
3793: }
3794: </pre>
3795: </td>
3796: </tr>
3797: </tbody>
3798: </table></div>
3799: </div>
3800: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 3801: 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
3802: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 3803: 2</a>). It summarizes multiple details on how to make
3804: software easier to package; all the suggestions in it were
3805: collected from our experience in pkgsrc work, so they are possibly
3806: helpful when creating patches too.</p>
3807: </div>
1.41 asau 3808: <div class="sect2">
1.1 dsieger 3809: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3810: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3811: <p>Always, always, <span class="strong"><strong>always</strong></span>
3812: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3813: improvements you do to a package to the mainstream developers.
3814: This is the only way to get their attention on portability issues
3815: and to ensure that future versions can be built out-of-the box on
3816: NetBSD. Furthermore, any user that gets newer distfiles will get
3817: the fixes straight from the packaged code.</p>
3818: <p>This generally involves cleaning up the patches
3819: (because sometimes the patches that are
1.40 wiz 3820: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3821: appropriate trackers for the projects and working with the
3822: mainstream authors to accept your changes. It is
3823: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3824: the packages in pkgsrc are kept simple and thus further changes
3825: can be done without much hassle.</p>
1.24 wiz 3826: <p>When you have done this, please add a URL to the upstream
3827: bug report to the patch comment.</p>
1.1 dsieger 3828: <p>Support the idea of free software!</p>
3829: </div>
3830: </div>
1.41 asau 3831: <div class="sect1">
1.1 dsieger 3832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3833: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 3834: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3835: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3836: <dd><p>A multi-line description of the piece of software. This should include
3837: any credits where they are due. Please bear in mind that others do not
3838: share your sense of humour (or spelling idiosyncrasies), and that others
3839: will read everything that you write here.</p></dd>
3840: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3841: <dd><p>This file governs the files that are installed on your
3842: system: all the binaries, manual pages, etc. There are other
3843: directives which may be entered in this file, to control the
3844: creation and deletion of directories, and the location of
1.10 hubertf 3845: 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 3846: information.</p></dd>
3847: </dl></div>
3848: </div>
1.41 asau 3849: <div class="sect1">
1.1 dsieger 3850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3851: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 3852: <div class="sect2">
1.1 dsieger 3853: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3854: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 3855: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3856: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 3857: <dd>
1.79 snj 3858: <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 3859: First time after package extraction and before files are
3860: moved in place, the second time after the files to install
3861: are moved in place. This can be used to do any custom
3862: procedures not possible with @exec commands in
1.79 snj 3863: <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
3864: <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 3865: Please note that you can modify variables in it easily by using
3866: <code class="varname">FILES_SUBST</code> in the package's
3867: <code class="filename">Makefile</code>:</p>
3868: <pre class="programlisting">
3869: FILES_SUBST+= SOMEVAR="somevalue"
3870: </pre>
3871: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3872: <code class="filename">INSTALL</code>. By default, substitution is
3873: performed for <code class="varname">PREFIX</code>,
3874: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3875: <code class="varname">VARBASE</code>, and a few others, type
3876: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3877: complete list.</p>
3878: </dd>
1.1 dsieger 3879: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3880: <dd><p>This script is executed before and after any files are removed. It is
3881: this script's responsibility to clean up any additional messy details
3882: around the package's installation, since all pkg_delete knows is how to
3883: delete the files created in the original distribution.
1.79 snj 3884: 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>
3885: 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 3886: The same methods to replace variables can be used as for
3887: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 3888: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3889: <dd>
3890: <p>This file is displayed after installation of the package.
3891: Useful for things like legal notices on almost-free
3892: software and hints for updating config files after
3893: installing modules for apache, PHP etc.
3894: Please note that you can modify variables in it easily by using
3895: <code class="varname">MESSAGE_SUBST</code> in the package's
3896: <code class="filename">Makefile</code>:</p>
3897: <pre class="programlisting">
3898: MESSAGE_SUBST+= SOMEVAR="somevalue"
3899: </pre>
1.23 wiz 3900: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 3901: <code class="filename">MESSAGE</code>. By default, substitution is
3902: performed for <code class="varname">PKGNAME</code>,
3903: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 3904: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 3905: <code class="varname">PKG_SYSCONFDIR</code>,
3906: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 3907: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 3908: <p>You can display a different or additional files by
3909: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3910: default is <code class="filename">MESSAGE</code>, if the file
3911: exists.</p>
3912: </dd>
3913: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 3914: <dd>
3915: <p>This file is used by the alternatives framework.
3916: It creates, configures, and destroys generic wrappers used to
3917: run programs with similar interfaces.
3918: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3919: for more information.</p>
3920: <p>Each line of the file contains two filenames, first
3921: the wrapper and then the alternative provided by the package.
3922: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3923: </dd>
1.1 dsieger 3924: </dl></div>
3925: </div>
1.41 asau 3926: <div class="sect2">
1.1 dsieger 3927: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3928: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 3929: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3930: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3931: <dd><p>This file contains arbitrary things that could
3932: also go into a <code class="filename">Makefile</code>, but its purpose is
3933: to be used by more than one package. This file should only be
3934: used when the packages that will use the file are known in
3935: advance. For other purposes it is often better to write a
3936: <code class="filename">*.mk</code> file and give it a good name that
3937: describes what it does.</p></dd>
3938: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3939: <dd><p>This file contains the dependency information
1.10 hubertf 3940: 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 3941: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3942: <dd><p>This file contains workarounds for compiler bugs
3943: and similar things. It is included automatically by the pkgsrc
3944: infrastructure, so you don't need an extra
3945: <code class="literal">.include</code> line for
3946: it.</p></dd>
3947: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3948: <dd><p>This file contains the code for the
1.10 hubertf 3949: 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 3950: selected by the user. If a package has only one or two options,
3951: it is equally acceptable to put the code directly into the
3952: <code class="filename">Makefile</code>.</p></dd>
3953: </dl></div>
3954: </div>
1.41 asau 3955: <div class="sect2">
1.1 dsieger 3956: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3957: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 3958: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3959: <dt><span class="term"><code class="filename">README*</code></span></dt>
3960: <dd><p>These files do not take place in the creation of
3961: a package and thus are purely informative to the package
3962: developer.</p></dd>
3963: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3964: <dd><p>This file contains things that need to be done
3965: to make the package even
3966: better.</p></dd>
3967: </dl></div>
3968: </div>
3969: </div>
1.41 asau 3970: <div class="sect1">
1.1 dsieger 3971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3972: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 3973: </h2></div></div></div>
1.10 hubertf 3974: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 3975: unpacked into the directory denoted by
3976: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 3977: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 3978: directory is also used to keep various timestamp files.
3979: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3980: The default is <code class="filename">${.CURDIR}/work</code>
3981: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3982: if <code class="varname">OBJMACHINE</code> is set.</p>
3983: </div>
1.41 asau 3984: <div class="sect1">
1.1 dsieger 3985: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3986: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 3987: </h2></div></div></div>
3988: <p>If you have any files that you wish to be placed in the package prior
3989: to configuration or building, you could place these files here and use
1.10 hubertf 3990: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 3991: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 3992: this. Alternatively, you could simply diff the file against
3993: <code class="filename">/dev/null</code> and use the patch mechanism to manage
3994: the creation of this file.</p>
3995: <p>If you want to share files in this way with other
3996: packages, set the <code class="varname">FILESDIR</code> variable to point
3997: to the other package's <code class="filename">files</code> directory,
3998: e.g.:</p>
3999: <pre class="programlisting">
4000: FILESDIR=${.CURDIR}/../xemacs/files
4001: </pre>
4002: </div>
4003: </div>
1.41 asau 4004: <div class="chapter">
1.1 dsieger 4005: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4006: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4007: <div class="toc">
4008: <p><b>Table of Contents</b></p>
1.100 leot 4009: <dl class="toc">
1.6 rillig 4010: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4011: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4012: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4013: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4014: <dd><dl>
4015: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 4016: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
4017: <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>
4018: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4019: </dl></dd>
4020: </dl>
4021: </div>
4022: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4023: each of which forms a well-defined part of the pkgsrc system. Using
1.79 snj 4024: 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 4025: like pkgsrc requires some discipline to keep the code correct and
4026: understandable.</p>
4027: <p>The basic ingredients for <code class="filename">Makefile</code>
4028: programming are variables (which are actually macros) and shell
4029: commands. Among these shell commands may even be more complex ones
1.79 snj 4030: 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 4031: as intended it is necessary to quote all variables correctly when they
4032: are used.</p>
4033: <p>This chapter describes some patterns, that appear quite often in
4034: <code class="filename">Makefile</code>s, including the pitfalls that come along
4035: with them.</p>
1.41 asau 4036: <div class="sect1">
1.1 dsieger 4037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4038: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4039: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4040: <p>When you are creating a file as a
4041: target of a rule, always write the data to a temporary file first
4042: and finally rename that file. Otherwise there might occur an error
4043: in the middle of generating the file, and when the user runs
1.79 snj 4044: <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 4045: regenerated properly. Example:</p>
4046: <pre class="programlisting">
4047: wrong:
4048: @echo "line 1" > ${.TARGET}
4049: @echo "line 2" >> ${.TARGET}
4050: @false
4051:
4052: correct:
4053: @echo "line 1" > ${.TARGET}.tmp
4054: @echo "line 2" >> ${.TARGET}.tmp
4055: @false
4056: @mv ${.TARGET}.tmp ${.TARGET}
4057: </pre>
1.10 hubertf 4058: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4059: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4060: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4061: correct</strong></span> gives an error message twice, as expected.</p>
1.79 snj 4062: <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 4063: <code class="literal">${.TARGET}</code> in case of error, but this only
4064: happens when it is interrupted, for example by pressing
4065: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.79 snj 4066: 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 4067: </li></ul></div>
4068: </div>
1.41 asau 4069: <div class="sect1">
1.1 dsieger 4070: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4071: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4072: <p><code class="filename">Makefile</code> variables contain strings that
4073: can be processed using the five operators ``='', ``+='', ``?='',
1.79 snj 4074: ``:='', 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 4075: page.</p>
4076: <p>When a variable's value is parsed from a
4077: <code class="filename">Makefile</code>, the hash character ``#'' and the
4078: backslash character ``\'' are handled specially. If a backslash is
4079: followed by a newline, any whitespace immediately in front of the
4080: backslash, the backslash, the newline, and any whitespace
4081: immediately behind the newline are replaced with a single space. A
4082: backslash character and an immediately following hash character are
4083: replaced with a single hash character. Otherwise, the backslash is
4084: passed as is. In a variable assignment, any hash character that is
4085: not preceded by a backslash starts a comment that continues upto the
4086: end of the logical line.</p>
1.108 rillig 4087: <p>The evaluation of variables either happens immediately or lazy.
4088: It happens immediately when the variable occurs
4089: on the right-hand side of the ``:='' or the ``!='' operator, in a
4090: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4091: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4092: <p>Some of the modifiers split the string into words and then
4093: operate on the words, others operate on the string as a whole. When
1.108 rillig 4094: 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 4095: <p>There are several types of variables that should be handled
4096: differently. Strings and two types of lists.</p>
1.41 asau 4097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4098: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4099: characters. Nevertheless, you should restrict yourself to only
4100: using printable characters. Examples are
4101: <code class="varname">PREFIX</code> and
4102: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4103: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4104: are never exported to any shell command. Their elements are
4105: separated by whitespace. Therefore, the elements themselves cannot
4106: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4107: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4108: Examples are <code class="varname">DEPENDS</code> and
4109: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4110: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4111: may be exported to a shell command. Their elements can contain any
4112: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4113: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4114: <code class="varname">DISTFILES</code> and
4115: <code class="varname">MASTER_SITES</code>.</p></li>
4116: </ul></div>
1.41 asau 4117: <div class="sect2">
1.1 dsieger 4118: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4119: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4120: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4121: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4122: are reserved for use by the pkgsrc infrastructure. They shall
4123: not be used by package
4124: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4125: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4126: lowercase variable names for the iteration
4127: variables.</p></li>
1.23 wiz 4128: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4129: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4130: <code class="varname">DISTFILES</code>.</p></li>
4131: </ul></div>
4132: </div>
4133: </div>
1.41 asau 4134: <div class="sect1">
1.1 dsieger 4135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4136: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.41 asau 4137: <div class="sect2">
1.1 dsieger 4138: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4139: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4140: <p>When adding a string that possibly contains whitespace or quotes to
4141: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4142: modifier.</p>
4143: <p>When adding another list to a list (example 2), it must not be
4144: quoted, since its elements are already quoted.</p>
1.1 dsieger 4145: <pre class="programlisting">
1.108 rillig 4146: STRING= foo * bar `date`
4147: LIST= # empty
4148: ANOTHER_LIST= a=b c=d
4149:
4150: LIST+= ${STRING:Q} # 1
4151: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4152: </pre>
4153: </div>
1.41 asau 4154: <div class="sect2">
1.1 dsieger 4155: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4156: <a name="echo-literal"></a>12.3.2. Echoing a string exacty as-is</h3></div></div></div>
4157: <p>Echoing a string containing special characters needs special
4158: work.</p>
1.1 dsieger 4159: <pre class="programlisting">
4160: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4161: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4162:
4163: all:
4164: echo ${STRING} # 1
1.108 rillig 4165: echo ${STRING:Q} # 2
4166: printf '%s\n' ${STRING:Q}'' # 3
4167: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4168: </pre>
4169: <p>Example 1 leads to a syntax error in the shell, as the characters
4170: are just copied.</p>
4171: <p>Example 2 quotes the string so that the shell interprets it
4172: correctly. But the echo command may additionally interpret strings with a
4173: leading dash or those containing backslashes.</p>
4174: <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
4175: interprets the format string, but not the next argument.</p>
4176: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4177: need to be quoted because the quoting has already been done
4178: when adding elements to the list.</p>
1.1 dsieger 4179: </div>
1.41 asau 4180: <div class="sect2">
1.1 dsieger 4181: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4182: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4183: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4184: GNU-style configure script (especially those that call other configure
4185: scripts), it must not have leading or trailing whitespace, since
4186: otherwise the configure script gets confused. To trim leading and
4187: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4188: following example:</p>
1.1 dsieger 4189: <pre class="programlisting">
4190: CPPFLAGS= # empty
1.108 rillig 4191: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4192: CPPFLAGS+= ${MY_CPPFLAGS}
4193:
4194: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4195:
4196: all:
4197: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4198: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4199: </pre>
1.108 rillig 4200: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4201: trailing whitespace because the <code class="code">+=</code> operator always adds a
4202: space.</p>
4203: </div>
4204: <div class="sect2">
4205: <div class="titlepage"><div><div><h3 class="title">
4206: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4207: <p>When a possibly empty variable is used in a shell program, it may
4208: lead to a syntax error.</p>
4209: <pre class="programlisting">
4210: EGFILES= # empty
4211:
4212: install-examples: # produces a syntax error in the shell
4213: for egfile in ${EGFILES}; do \
4214: echo "Installing $$egfile"; \
4215: done
4216: </pre>
4217: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
4218: <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>.
4219: To fix this syntax error, use one of the snippets below.</p>
4220: <pre class="programlisting">
4221: EMPTY= # empty
4222:
4223: install-examples:
4224: for egfile in ${EGFILES} ""; do \
4225: [ -n "$$egfile" ] || continue; \
4226: echo "Installing $$egfile"; \
1.1 dsieger 4227: done
1.108 rillig 4228: </pre>
4229: <p>In this case, an empty string is appended to the iteration list (to
4230: prevent the syntax error) and filtered out later.</p>
4231: <pre class="programlisting">
4232: EGFILES= # empty
1.1 dsieger 4233:
1.108 rillig 4234: install-examples:
4235: .for egfile in ${EGFILES}
4236: echo "Installing ${egfile}"
1.1 dsieger 4237: .endfor
4238: </pre>
1.108 rillig 4239: <p>This variant only works when <code class="varname">EGFILES</code> does not
4240: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4241: simple whitespace.</p>
4242: <p>To have a shell command test whether a make variable is empty, use
4243: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4244: </div>
4245: </div>
4246: </div>
1.41 asau 4247: <div class="chapter">
1.1 dsieger 4248: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4249: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4250: <div class="toc">
4251: <p><b>Table of Contents</b></p>
1.100 leot 4252: <dl class="toc">
1.6 rillig 4253: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4254: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4255: <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 4256: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4257: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4258: <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 4259: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4260: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4261: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4262: </dl>
4263: </div>
4264: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4265: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4266: the package (relative to the <code class="filename">${PREFIX}</code>
4267: directory it's been installed in) plus some additional statements
1.79 snj 4268: - 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 4269: This chapter addresses some issues that need attention when
4270: dealing with the <code class="filename">PLIST</code> file (or files, see
4271: below!).</p>
1.41 asau 4272: <div class="sect1">
1.1 dsieger 4273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4274: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4275: <p>Be sure to add a RCS ID line as the first thing in any
4276: <code class="filename">PLIST</code> file you write:</p>
4277: <pre class="programlisting">
4278: @comment $NetBSD$
1.111 sevan 4279: </pre>
1.1 dsieger 4280: </div>
1.41 asau 4281: <div class="sect1">
1.1 dsieger 4282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4283: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4284: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4285: to output a PLIST that matches any new files since the package
1.10 hubertf 4286: 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 4287: more information on this target.</p>
4288: </div>
1.41 asau 4289: <div class="sect1">
1.1 dsieger 4290: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4291: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4292: </h2></div></div></div>
4293: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4294: of AWK patterns and actions that are used to filter the output of
4295: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4296: scripting you like to it, but be careful with quoting.</p>
4297: <p>For example, to get all files inside the
4298: <code class="filename">libdata/foo</code> directory removed from the
4299: resulting PLIST:</p>
4300: <pre class="programlisting">
4301: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4302: </pre>
1.1 dsieger 4303: </div>
1.41 asau 4304: <div class="sect1">
1.1 dsieger 4305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4306: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4307: <p>A number of variables are substituted automatically in
4308: PLISTs when a package is installed on a system. This includes the
4309: following variables:</p>
1.41 asau 4310: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4311: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4312: <dd>
4313: <p>Some packages like emacs and perl embed information
4314: about which architecture they were built on into the
4315: pathnames where they install their files. To handle this
4316: case, PLIST will be preprocessed before actually used, and
4317: the symbol
1.23 wiz 4318: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4319: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4320: same is done if the string
4321: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4322: PLIST somewhere - use this on packages that have GNU
4323: autoconf-created configure scripts.</p>
1.41 asau 4324: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4325: <h3 class="title">Legacy note</h3>
4326: <p>There used to be a symbol
1.23 wiz 4327: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4328: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4329: -m</strong></span>, but that's no longer supported and has
4330: been removed.</p>
4331: </div>
4332: </dd>
4333: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4334: <dd>
4335: <p>Some packages want to embed the OS name and version
4336: into some paths. To do this, use these variables in the
4337: <code class="filename">PLIST</code>:
4338: </p>
1.41 asau 4339: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4340: <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>
4341: <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>
4342: <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 4343: </ul></div>
4344: </dd>
4345: </dl></div>
1.88 tnn 4346: <p>For a list of values which are replaced by
4347: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4348: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4349: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4350: <p>If you want to change other variables not listed above, you
4351: can add variables and their expansions to this variable in the
1.10 hubertf 4352: 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 4353: <pre class="programlisting">
4354: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4355: </pre>
1.23 wiz 4356: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4357: in the <code class="filename">PLIST</code> with
1.23 wiz 4358: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4359: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4360: the common case of conditionally including some
4361: <code class="filename">PLIST</code> entries. It can be done by adding
4362: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4363: setting the corresponding <code class="varname">PLIST.foo</code> variable
4364: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4365: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4366: in the <code class="filename">PLIST</code> with either
1.23 wiz 4367: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4368: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4369: For example, in <code class="filename">Makefile</code>:</p>
4370: <pre class="programlisting">
1.112 rillig 4371: PLIST_VARS+= foo
1.18 snj 4372: .if <em class="replaceable"><code>condition</code></em>
1.112 rillig 4373: PLIST.foo= yes
1.18 snj 4374: .else
1.111 sevan 4375: </pre>
1.18 snj 4376: <p>And then in <code class="filename">PLIST</code>:</p>
4377: <pre class="programlisting">
4378: @comment $NetBSD$
4379: bin/bar
4380: man/man1/bar.1
4381: ${PLIST.foo}bin/foo
4382: ${PLIST.foo}man/man1/foo.1
4383: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4384: </pre>
1.1 dsieger 4385: </div>
1.41 asau 4386: <div class="sect1">
1.1 dsieger 4387: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4388: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 4389: <p>Man pages should be installed in compressed form if
4390: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4391: and uncompressed otherwise. To handle this in the
1.23 wiz 4392: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4393: appended/removed automatically for man pages according to
4394: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4395: or not, see above for details. This modification of the
4396: <code class="filename">PLIST</code> file is done on a copy of it, not
4397: <code class="filename">PLIST</code> itself.</p>
4398: </div>
1.41 asau 4399: <div class="sect1">
1.1 dsieger 4400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4401: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4402: </h2></div></div></div>
4403: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4404: in generating the binary package, set the variable
4405: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.79 snj 4406: 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 4407: important. The default for <code class="varname">PLIST_SRC</code> is
4408: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4409: </div>
1.41 asau 4410: <div class="sect1">
1.1 dsieger 4411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4412: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4413: <p>Some packages decide to install a different set of files based on
4414: the operating system being used. These differences can be
4415: automatically handled by using the following files:</p>
1.41 asau 4416: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4417: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4418: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4419: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4420: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4421: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4422: </ul></div>
4423: </div>
1.41 asau 4424: <div class="sect1">
1.1 dsieger 4425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 4426: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4427: <p>Some packages decide to generate hard-to-guess file names
4428: during installation that are hard to wire down.</p>
4429: <p>In such cases, you can set the
4430: <code class="varname">GENERATE_PLIST</code> variable to shell code
4431: terminated (with a semicolon) that will output PLIST entries which
4432: will be appended to the PLIST</p>
4433: <p>You can find one example in editors/xemacs:</p>
4434: <pre class="programlisting">
1.111 sevan 4435: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4436: </pre>
1.86 wiz 4437: <p>which will append something like
4438: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4439: <code class="filename">PLIST</code>.
4440: </p>
4441: </div>
4442: <div class="sect1">
4443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4444: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4445: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4446: multiple (and unrelated) packages install files. These
1.22 jakllsch 4447: directories were problematic because you had to add special
4448: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4449: centralized package handle them.</p>
1.22 jakllsch 4450: <p>In pkgsrc, it is now easy: Each package should create
4451: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4452: will remove any directories left empty after uninstalling a
4453: package.</p>
4454: <p>If a package needs an empty directory to work, create
4455: the directory during installation as usual, and also add an
4456: entry to the PLIST:
1.111 sevan 4457:
4458: </p>
1.1 dsieger 4459: <pre class="programlisting">
1.22 jakllsch 4460: @pkgdir path/to/empty/directory
1.111 sevan 4461: </pre>
1.22 jakllsch 4462: <p>
1.111 sevan 4463:
1.86 wiz 4464: or take a look at <code class="varname">MAKE_DIRS</code> and
4465: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4466: </p>
1.1 dsieger 4467: </div>
4468: </div>
1.41 asau 4469: <div class="chapter">
1.1 dsieger 4470: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4471: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4472: <div class="toc">
4473: <p><b>Table of Contents</b></p>
1.100 leot 4474: <dl class="toc">
1.6 rillig 4475: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 4476: <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 4477: <dd><dl>
1.6 rillig 4478: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 4479: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
4480: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4481: and
4482: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4483: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4484: </dl></dd>
1.23 wiz 4485: <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 4486: <dd><dl>
1.23 wiz 4487: <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 4488: <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 4489: </dl></dd>
4490: </dl>
4491: </div>
4492: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4493: are seen by a package's configure and build processes. This is implemented
4494: in a two step process:</p>
1.23 wiz 4495: <div class="orderedlist"><ol class="orderedlist" type="1">
4496: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4497: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4498: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4499: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4500: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4501: <code class="option">-L${LOCALBASE}/lib</code> into references to
4502: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4503: native compiler on some operating systems look like GCC, so that
4504: packages that expect GCC won't require modifications to build with
4505: those native compilers.</p></li>
4506: </ol></div>
4507: <p>This normalizes the environment in which a package is built so that the
4508: package may be built consistently despite what other software may be
4509: installed. Please note that the normal system header and library paths,
4510: e.g. <code class="filename">/usr/include</code>,
4511: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4512: designed to insulate the package build from non-system-supplied
4513: software.</p>
1.41 asau 4514: <div class="sect1">
1.1 dsieger 4515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4516: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4517: <p>The process of converting packages to use the buildlink3
1.23 wiz 4518: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4519: The things to keep in mind are:</p>
1.23 wiz 4520: <div class="orderedlist"><ol class="orderedlist" type="1">
4521: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4522: instead of the actual toolchain. Some packages are tricky,
4523: and the only way to know for sure is the check
4524: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4525: wrappers are being invoked.</p></li>
1.23 wiz 4526: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4527: the package Makefile, e.g. Java VMs, standalone shells,
4528: etc., because the code to symlink files into
4529: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4530: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4531: </p></li>
1.23 wiz 4532: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4533: <code class="filename">buildlink3.mk</code> files that you list in a
4534: package's Makefile are added as dependencies for that package.
4535: </p></li>
4536: </ol></div>
4537: <p>If a dependency on a particular package is required for its libraries and
4538: headers, then we replace:</p>
4539: <pre class="programlisting">
4540: DEPENDS+= foo>=1.1.0:../../category/foo
4541: </pre>
4542: <p>with</p>
4543: <pre class="programlisting">
4544: .include "../../category/foo/buildlink3.mk"
4545: </pre>
4546: <p>The buildlink3.mk files usually define the required dependencies.
4547: If you need a newer version of the dependency when using buildlink3.mk
4548: files, then you can define it in your Makefile; for example:</p>
4549: <pre class="programlisting">
4550: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4551: .include "../../category/foo/buildlink3.mk"
4552: </pre>
4553: <p>There are several <code class="filename">buildlink3.mk</code>
4554: files in <code class="filename">pkgsrc/mk</code>
4555: that handle special package issues:</p>
1.41 asau 4556: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4557: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4558: the native or a pkgsrc Berkeley DB implementation based on
4559: the values of <code class="varname">BDB_ACCEPTED</code> and
4560: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4561: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4562: comes with neither Curses nor NCurses, this will take care
1.79 snj 4563: 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 4564: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4565: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4566: adding a dependency on Heimdal or MIT-krb5 for packages that
4567: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4568: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4569: system-provided Motif installation or adds a dependency on
1.79 snj 4570: <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 4571: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 4572: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
4573: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 4574: which Motif version will be used.</p></li>
1.55 ryoon 4575: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4576: system-provided GNU readline or editline (libedit) installation,
1.79 snj 4577: 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>,
4578: <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 4579: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4580: If your package really needs GNU readline library, its Makefile
4581: should include <code class="filename">devel/readline/buildlink3.mk</code>
4582: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4583: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4584: variables that may be used by packages that use the
4585: Open Sound System (OSS) API.</p></li>
1.23 wiz 4586: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4587: any of the Postgres versions in the variable
4588: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4589: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4590: the file for more information.</p></li>
1.23 wiz 4591: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4592: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.79 snj 4593: 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 4594: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4595: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4596: library.</p></li>
4597: </ul></div>
4598: <p>The comments in those <code class="filename">buildlink3.mk</code>
4599: files provide a more complete
4600: description of how to use them properly.</p>
4601: </div>
1.41 asau 4602: <div class="sect1">
1.1 dsieger 4603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4604: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4605: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4606: included by Makefiles to indicate the need to compile and link
4607: against header files and libraries provided by the package. A
4608: <code class="filename">buildlink3.mk</code> file should always provide
4609: enough information to add the correct type of dependency
4610: relationship and include any other
4611: <code class="filename">buildlink3.mk</code> files that it needs to find
4612: headers and libraries that it needs in turn.</p>
4613: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.79 snj 4614: 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 4615: package is highly recommended. For most packages, the following
4616: command will generate a good starting point for
4617: <code class="filename">buildlink3.mk</code> files:</p>
4618: <pre class="screen">
4619: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4620: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4621: </pre>
1.41 asau 4622: <div class="sect2">
1.1 dsieger 4623: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4624: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4625: <p>The following real-life example
4626: <code class="filename">buildlink3.mk</code> is taken
4627: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4628: <pre class="programlisting">
1.18 snj 4629: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4630:
1.112 rillig 4631: BUILDLINK_TREE+= tiff
1.1 dsieger 4632:
1.18 snj 4633: .if !defined(TIFF_BUILDLINK3_MK)
4634: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4635:
1.112 rillig 4636: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4637: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4638: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4639:
4640: .include "../../devel/zlib/buildlink3.mk"
4641: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4642: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4643:
1.112 rillig 4644: BUILDLINK_TREE+= -tiff
1.1 dsieger 4645: </pre>
4646: <p>The header and footer manipulate
1.18 snj 4647: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4648: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4649: the dependency tree.</p>
4650: <p>The main section is protected from multiple inclusion
1.1 dsieger 4651: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4652: added. Several important variables are set in the section:</p>
1.41 asau 4653: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4654: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4655: is the actual dependency recorded in the installed
4656: package; this should always be set using
1.10 hubertf 4657: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4658: we're appending to any pre-existing list of values. This
4659: variable should be set to the first version of the
1.26 wiz 4660: package that had an backwards-incompatible API change.
1.1 dsieger 4661: </p></li>
1.23 wiz 4662: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4663: is the location of the <em class="replaceable"><code>pkg</code></em>
4664: pkgsrc directory.</p></li>
1.23 wiz 4665: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4666: (not shown above) controls whether we use
4667: <code class="varname">BUILD_DEPENDS</code> or
4668: <code class="varname">DEPENDS</code> to add the dependency on
4669: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4670: selected by setting
4671: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4672: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4673: used.</p></li>
1.23 wiz 4674: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4675: and
4676: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4677: (not shown above) are lists of subdirectories of
4678: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4679: to add to the header and library search paths. These
1.23 wiz 4680: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4681: respectively.</p></li>
1.23 wiz 4682: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4683: (not shown above) is the list of preprocessor flags to add
4684: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4685: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4686: should be avoided and instead be handled using
4687: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4688: above.</p></li>
4689: </ul></div>
4690: <p>The following variables are all optionally defined within
4691: this second section (protected against multiple inclusion) and
4692: control which package files are symlinked into
4693: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4694: transformed during the symlinking:</p>
1.41 asau 4695: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4696: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4697: (not shown above) is a shell glob pattern relative to
4698: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4699: to be symlinked into
4700: <code class="filename">${BUILDLINK_DIR}</code>,
4701: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4702: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4703: (not shown above) is a shell pipeline that
4704: outputs to stdout a list of files relative to
4705: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4706: The resulting files are to be symlinked
4707: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4708: this takes the <code class="filename">+CONTENTS</code> of a
4709: <em class="replaceable"><code>pkg</code></em> and filters it through
4710: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4711: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4712: (not shown above) is a filter command that filters
4713: <code class="filename">+CONTENTS</code> input into a list of files
4714: relative to
4715: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4716: on stdout. By default,
1.1 dsieger 4717: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4718: outputs the contents of the <code class="filename">include</code>
4719: and <code class="filename">lib</code> directories in the package
1.84 wiz 4720: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4721: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4722: (not shown above) is a list of sed arguments used to
4723: transform the name of the source filename into a
1.10 hubertf 4724: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4725: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4726: </ul></div>
1.18 snj 4727: <p>This section can additionally include any
1.1 dsieger 4728: <code class="filename">buildlink3.mk</code> needed for
4729: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4730: Including these <code class="filename">buildlink3.mk</code> files
4731: means that the headers and libraries for these
4732: dependencies are also symlinked into
4733: <code class="filename">${BUILDLINK_DIR}</code>
4734: whenever the <em class="replaceable"><code>pkg</code></em>
4735: <code class="filename">buildlink3.mk</code>
1.18 snj 4736: file is included. Dependencies are only added for directly
4737: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4738: <p>When providing a <code class="filename">buildlink3.mk</code> and
4739: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4740: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4741: header files are automatically exposed when the package is
4742: use.</p>
4743: <p>In particular, if only an executable
4744: (<code class="filename">bin/foo</code>) is linked against a library, that
4745: library does not need to be propagated in the
4746: <code class="filename">buildlink3.mk</code> file.</p>
4747: <p>The following steps should help you decide if a
4748: <code class="filename">buildlink3.mk</code> file needs to be included:
4749: </p>
4750: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4751: <li class="listitem"><p>Look at the installed header files: What
4752: headers do they include? The packages providing these files
4753: must be buildlinked.</p></li>
1.49 wiz 4754: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4755: libraries and look against what other libraries they link.
4756: Some of the packages providing these probably need to be
4757: buildlinked; however, it's not automatic, since e.g. GTK on
4758: some systems pulls in the X libraries, so they will show up in
4759: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4760: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4761: used as a hint.</p></li>
1.47 wiz 4762: </ul></div>
4763: <p>
4764: </p>
1.1 dsieger 4765: </div>
1.41 asau 4766: <div class="sect2">
1.1 dsieger 4767: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 4768: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 4769: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4770: and
4771: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4772: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4773: <p>These two variables differ in that one describes source
4774: compatibility (API) and the other binary compatibility (ABI).
4775: The difference is that a change in the API breaks compilation of
4776: programs while changes in the ABI stop compiled programs from
4777: running.</p>
4778: <p>Changes to the
1.27 wiz 4779: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4780: variable in a <code class="filename">buildlink3.mk</code> file happen
4781: very rarely. One possible reason is that all packages depending
4782: on this already need a newer version. In case it is bumped see
4783: the description below.</p>
4784: <p>The most common example of an ABI change is that the major
4785: version of a shared library is increased. In this case,
4786: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4787: should be adjusted to require at least the new package version.
4788: Then the packages that depend on this package need their
4789: <code class="varname">PKGREVISION</code>s increased and, if they have
4790: <code class="filename">buildlink3.mk</code> files, their
4791: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4792: adjusted, too. This is needed so pkgsrc will require the correct
4793: package dependency and not settle for an older one when building
4794: the source.</p>
1.108 rillig 4795: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.26 wiz 4796: more information about dependencies on other packages,
4797: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4798: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4799: <p>Please take careful consideration before adjusting
4800: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4801: or
4802: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4803: as we don't want to cause unneeded package deletions and
4804: rebuilds. In many cases, new versions of packages work just
4805: fine with older dependencies.</p>
4806: <p>Also it is not needed to set
1.26 wiz 4807: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4808: when it is identical to
1.1 dsieger 4809: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4810: </div>
4811: </div>
1.41 asau 4812: <div class="sect1">
1.1 dsieger 4813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4814: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4815: <p>Some packages in pkgsrc install headers and libraries that
4816: coincide with headers and libraries present in the base system.
4817: Aside from a <code class="filename">buildlink3.mk</code> file, these
4818: packages should also include a <code class="filename">builtin.mk</code>
4819: file that includes the necessary checks to decide whether using
4820: the built-in software or the pkgsrc software is
4821: appropriate.</p>
4822: <p>The only requirements of a builtin.mk file for
4823: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4824: <div class="orderedlist"><ol class="orderedlist" type="1">
4825: <li class="listitem"><p>It should set
1.1 dsieger 4826: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4827: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4828: after it is included.</p></li>
1.23 wiz 4829: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4830: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4831: which is already set before the
4832: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4833: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4834: is <span class="emphasis"><em>very</em></span> important and takes careful
4835: attention to <code class="filename">Makefile</code> coding.</p></li>
4836: </ol></div>
1.41 asau 4837: <div class="sect2">
1.1 dsieger 4838: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4839: <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 4840: <p>The following is the recommended template for builtin.mk
4841: files:</p>
4842: <pre class="programlisting">
4843: .if !defined(IS_BUILTIN.foo)
4844: #
4845: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4846: # genuinely exists in the system or not.
4847: #
4848: IS_BUILTIN.foo?= no
4849:
4850: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4851: # version can be determined.
4852: #
4853: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4854: BUILTIN_PKG.foo?= foo-1.0
4855: . endif
4856: .endif # IS_BUILTIN.foo
4857:
4858: .if !defined(USE_BUILTIN.foo)
4859: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4860: . if defined(BUILTIN_PKG.foo)
4861: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4862: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4863: USE_BUILTIN.foo!= \
4864: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4865: && ${ECHO} "yes" || ${ECHO} "no"
4866: . endif
4867: . endfor
4868: . endif
4869: .endif # USE_BUILTIN.foo
4870:
4871: CHECK_BUILTIN.foo?= no
4872: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4873: #
4874: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4875: # "yes" or "no".
4876: #
4877: .endif # CHECK_BUILTIN.foo
4878: </pre>
4879: <p>The first section sets
4880: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4881: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4882: in the base system. This should not be a base system software
4883: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 4884: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 4885: included as part of the base system. This variable is only
4886: used internally within the <code class="filename">builtin.mk</code>
4887: file.</p>
4888: <p>The second section sets
4889: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4890: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4891: system if it exists (if
4892: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4893: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 4894: within the <code class="filename">builtin.mk</code> file.</p>
4895: <p>The third section sets
4896: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4897: and is <span class="emphasis"><em>required</em></span> in all
4898: <code class="filename">builtin.mk</code> files. The code in this
4899: section must make the determination whether the built-in
4900: software is adequate to satisfy the dependencies listed in
4901: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4902: This is typically done by comparing
4903: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4904: against each of the dependencies in
4905: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4906: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4907: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4908: end of the <code class="filename">builtin.mk</code> file. Note that
4909: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4910: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 4911: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4912: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 4913: that the built-in version of the software is similar enough to
4914: be used as a replacement.</p>
4915: <p>The last section is guarded by
4916: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4917: and includes code that uses the value of
4918: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4919: set in the previous section. This typically includes, e.g.,
4920: adding additional dependency restrictions and listing additional
4921: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4922: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
4923: </div>
1.41 asau 4924: <div class="sect2">
1.1 dsieger 4925: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4926: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 4927: <p>When building packages, it's possible to choose whether to set
4928: a global preference for using either the built-in (native)
4929: version or the pkgsrc version of software to satisfy a
4930: dependency. This is controlled by setting
4931: <code class="varname">PREFER_PKGSRC</code> and
4932: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 4933: 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 4934: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4935: use the pkgsrc versions of software, while
4936: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4937: built-in versions. Preferences are determined by the most
4938: specific instance of the package in either
4939: <code class="varname">PREFER_PKGSRC</code> or
4940: <code class="varname">PREFER_NATIVE</code>. If a package is specified
4941: in neither or in both variables, then
4942: <code class="varname">PREFER_PKGSRC</code> has precedence over
4943: <code class="varname">PREFER_NATIVE</code>. For example, to require
4944: using pkgsrc versions of software for all but the most basic
4945: bits on a NetBSD system, you can set:</p>
4946: <pre class="programlisting">
4947: PREFER_PKGSRC= yes
4948: PREFER_NATIVE= getopt skey tcp_wrappers
4949: </pre>
4950: <p>A package <span class="emphasis"><em>must</em></span> have a
4951: <code class="filename">builtin.mk</code>
4952: file to be listed in <code class="varname">PREFER_NATIVE</code>,
4953: otherwise it is simply ignored in that list.</p>
4954: </div>
4955: </div>
4956: </div>
1.41 asau 4957: <div class="chapter">
1.1 dsieger 4958: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4959: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 4960: <div class="toc">
4961: <p><b>Table of Contents</b></p>
1.100 leot 4962: <dl class="toc">
1.6 rillig 4963: <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 4964: <dd><dl>
1.6 rillig 4965: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
4966: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 4967: </dl></dd>
1.6 rillig 4968: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 4969: <dd><dl>
1.23 wiz 4970: <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 4971: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
4972: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
4973: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
4974: </dl></dd>
4975: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
4976: <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>
4977: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
4978: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
4979: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
4980: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
4981: <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 4982: </dl>
4983: </div>
4984: <p>This chapter describes the framework known as
4985: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 4986: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4987: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 4988: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 4989: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 4990: provided that packages are correctly designed.</p></li>
1.23 wiz 4991: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
4992: <li class="listitem"><p>Registration of system users and groups.</p></li>
4993: <li class="listitem"><p>Registration of system shells.</p></li>
4994: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 4995: </ul></div>
4996: <p>The following sections inspect each of the above points in detail.</p>
4997: <p>You may be thinking that many of the things described here could be
4998: easily done with simple code in the package's post-installation target
4999: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5000: as the code in them is only executed when building from source. Machines
5001: using binary packages could not benefit from it at all (as the code itself
5002: could be unavailable). Therefore, the only way to achieve any of the items
5003: described above is by means of the installation scripts, which are
5004: automatically generated by pkginstall.</p>
1.41 asau 5005: <div class="sect1">
1.1 dsieger 5006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5007: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5008: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5009: of files and directories that belong to a package. The names used in it
5010: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5011: which means that it cannot register files outside this directory (absolute
5012: path names are not allowed). Despite this restriction, some packages need
5013: to install files outside this location; e.g., under
5014: <code class="filename">${VARBASE}</code> or
5015: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5016: is to create such files during installation time by using
5017: installation scripts.</p>
5018: <p>The generic installation scripts are shell scripts that can
5019: contain arbitrary code. The list of scripts to execute is taken from
5020: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5021: <code class="filename">INSTALL</code>. A similar variable exists for package
5022: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5023: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5024: commands, so they have the potential to create and manage files
5025: anywhere in the file system.</p>
5026: <p>Using these general installation files is not recommended, but
5027: may be needed in some special cases. One reason for avoiding them is
5028: that the user has to trust the packager that there is no unwanted or
5029: simply erroneous code included in the installation script. Also,
5030: previously there were many similar scripts for the same functionality,
5031: and fixing a common error involved finding and changing all of
5032: them.</p>
5033: <p>The pkginstall framework offers another, standardized way. It
5034: provides generic scripts to abstract the manipulation of such files
5035: and directories based on variables set in the package's
5036: <code class="filename">Makefile</code>. The rest of this section describes
5037: these variables.</p>
1.41 asau 5038: <div class="sect2">
1.1 dsieger 5039: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5040: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5041: <p>The following variables can be set to request the creation of
5042: directories anywhere in the file system:</p>
1.41 asau 5043: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5044: <li class="listitem">
5045: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5046: contain a list of directories that should be created and should attempt
5047: to be destroyed by the installation scripts. The difference between
5048: the two is that the latter prompts the administrator to remove any
5049: directories that may be left after deinstallation (because they were
1.108 rillig 5050: not empty), while the former does not. Example:</p>
5051: <pre class="programlisting">
5052: MAKE_DIRS+= ${VARBASE}/foo/private
5053: </pre>
5054: </li>
1.23 wiz 5055: <li class="listitem">
1.1 dsieger 5056: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5057: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5058: which directories should be created and should attempt to be destroyed
5059: by the installation scripts. Each tuple holds the following values,
5060: separated by spaces: the directory name, its owner, its group and its
5061: numerical mode. For example:</p>
5062: <pre class="programlisting">
1.108 rillig 5063: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5064: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5065: </pre>
5066: <p>The difference between the two is exactly the same as their
5067: non-<code class="varname">PERMS</code> counterparts.</p>
5068: </li>
5069: </ul></div>
5070: </div>
1.41 asau 5071: <div class="sect2">
1.1 dsieger 5072: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5073: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5074: <p>Creating non-empty files outside the installation prefix is tricky
5075: because the <code class="filename">PLIST</code> forces all files to be inside it.
5076: To overcome this problem, the only solution is to extract the file in the
5077: known place (i.e., inside the installation prefix) and copy it to the
5078: appropriate location during installation (done by the installation scripts
5079: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5080: file</em></span> in the following paragraphs, which describe the variables
5081: that can be used to automatically and consistently handle files outside the
5082: installation prefix:</p>
1.41 asau 5083: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5084: <li class="listitem">
1.1 dsieger 5085: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5086: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5087: During installation time, the master file is copied to the target one
5088: if and only if the latter does not exist. Upon deinstallation, the
5089: target file is removed provided that it was not modified by the
5090: installation.</p>
5091: <p>The difference between the two is that the latter prompts the
5092: administrator to remove any files that may be left after
5093: deinstallation (because they were not empty), while the former does
5094: not.</p>
5095: </li>
1.23 wiz 5096: <li class="listitem">
1.1 dsieger 5097: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5098: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5099: files as well as their target locations. For each of them, it also
5100: specifies their owner, their group and their numeric permissions, in
5101: this order. For example:</p>
5102: <pre class="programlisting">
1.108 rillig 5103: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5104: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5105: </pre>
5106: <p>The difference between the two is exactly the same as their
5107: non-<code class="varname">PERMS</code> counterparts.</p>
5108: </li>
5109: </ul></div>
5110: </div>
5111: </div>
1.41 asau 5112: <div class="sect1">
1.1 dsieger 5113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5114: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5115: <p>Configuration files are special in the sense that they are installed
5116: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5117: need special treatment during installation (most of which is automated by
5118: pkginstall). The main concept you must bear in mind is that files marked
5119: as configuration files are automatically copied to the right place (somewhere
5120: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5121: and only if</em></span> they didn't exist before. Similarly, they will not
5122: be removed if they have local modifications. This ensures that
5123: administrators never lose any custom changes they may have made.</p>
1.41 asau 5124: <div class="sect2">
1.1 dsieger 5125: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5126: <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 5127: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5128: specifies where configuration files shall be installed. Its contents are
5129: set based upon the following variables:</p>
1.41 asau 5130: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5131: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5132: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5133: be overridden by the user to point to his preferred location (e.g.,
5134: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5135: Packages must not use it directly.</p></li>
1.23 wiz 5136: <li class="listitem">
1.1 dsieger 5137: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5138: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5139: for the package being built shall be installed. The definition of this
5140: variable only makes sense in the package's
5141: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5142: <p>As an example, consider the Apache package,
1.79 snj 5143: <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 5144: configuration files under the
5145: <code class="filename">httpd/</code> subdirectory of
5146: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5147: Makefile.</p>
5148: </li>
1.23 wiz 5149: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5150: variable that holds this package's configuration directory (if
5151: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5152: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5153: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5154: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5155: directory where the configuration files for the package identified by
5156: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5157: </ul></div>
5158: <p>Based on the above variables, pkginstall determines the value of
5159: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5160: variable that can be used within a package to refer to its configuration
5161: directory. The algorithm used to set its value is basically the
5162: following:</p>
1.23 wiz 5163: <div class="orderedlist"><ol class="orderedlist" type="1">
5164: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5165: its value is used.</p></li>
1.23 wiz 5166: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5167: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5168: <code class="filename">Makefile</code>, the resulting value is
5169: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5170: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5171: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5172: </ol></div>
5173: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5174: 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
5175: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5176: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5177: </div>
1.41 asau 5178: <div class="sect2">
1.1 dsieger 5179: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5180: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5181: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5182: known place, you need to teach each package where it shall install its
5183: files. In some cases you will have to patch the package Makefiles to
5184: achieve it. If you are lucky, though, it may be as easy as passing an
5185: extra flag to the configuration script; this is the case of GNU Autoconf-
5186: generated files:</p>
5187: <pre class="programlisting">
5188: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5189: </pre>
5190: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5191: for</em></span> its configuration files, not where they will be originally
5192: installed (although the difference is never explicit,
5193: unfortunately).</p>
5194: </div>
1.41 asau 5195: <div class="sect2">
1.1 dsieger 5196: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5197: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5198: <p>As said before, pkginstall automatically handles configuration files.
5199: This means that <span class="strong"><strong>the packages themselves must not
5200: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5201: directly</strong></span>. Bad news is that many software installation scripts
5202: will, out of the box, mess with the contents of that directory. So what is
5203: the correct procedure to fix this issue?</p>
5204: <p>You must teach the package (usually by manually patching it) to
5205: install any configuration files under the examples hierarchy,
5206: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5207: <code class="filename">PLIST</code> registers them and the administrator always
5208: has the original copies available.</p>
5209: <p>Once the required configuration files are in place (i.e., under the
5210: examples hierarchy), the pkginstall framework can use them as master copies
5211: during the package installation to update what is in
5212: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5213: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5214: 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 5215: about their syntax and their purpose. Here is an example, taken from the
1.79 snj 5216: <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 5217: <pre class="programlisting">
5218: EGDIR= ${PREFIX}/share/doc/mutt/samples
5219: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5220: </pre>
5221: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5222: package and has no meaning outside it.</p>
5223: </div>
1.41 asau 5224: <div class="sect2">
1.1 dsieger 5225: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5226: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5227: <p>The automatic copying of config files can be toggled by setting the
5228: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5229: installation.</p>
5230: </div>
5231: </div>
1.41 asau 5232: <div class="sect1">
1.1 dsieger 5233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5234: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5235: <p>System startup scripts are special files because they must be
5236: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5237: 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 5238: can be used. However, pkginstall provides a special mechanism to handle
5239: these files.</p>
5240: <p>In order to provide system startup scripts, the package has
5241: to:</p>
1.23 wiz 5242: <div class="orderedlist"><ol class="orderedlist" type="1">
5243: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5244: the <code class="literal">.sh</code> suffix appended. Considering the
1.79 snj 5245: <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 5246: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5247: <li class="listitem">
1.1 dsieger 5248: <p>Tell pkginstall to handle it, appending the name of the script,
5249: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5250: Continuing the previous example:</p>
5251: <pre class="programlisting">
5252: RCD_SCRIPTS+= cupsd
5253: </pre>
5254: </li>
5255: </ol></div>
5256: <p>Once this is done, pkginstall will do the following steps for each
5257: script in an automated fashion:</p>
1.23 wiz 5258: <div class="orderedlist"><ol class="orderedlist" type="1">
5259: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5260: substitutions described in the <code class="filename">FILES_SUBST</code>
5261: variable.</p></li>
1.23 wiz 5262: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5263: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5264: that this master file must be explicitly registered in the
5265: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5266: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5267: from the examples hierarchy into the system-wide startup scripts
5268: directory.</p></li>
5269: </ol></div>
1.41 asau 5270: <div class="sect2">
1.1 dsieger 5271: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5272: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5273: <p>The automatic copying of config files can be toggled by setting the
5274: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5275: installation. Note that the scripts will be always copied inside the
5276: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5277: matter what the value of this variable is.</p>
5278: </div>
5279: </div>
1.41 asau 5280: <div class="sect1">
1.1 dsieger 5281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5282: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5283: <p>If a package needs to create special users and/or groups during
5284: installation, it can do so by using the pkginstall framework.</p>
5285: <p>Users can be created by adding entries to the
5286: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5287: syntax:</p>
5288: <pre class="programlisting">
5289: user:group
5290: </pre>
5291: <p>Further specification of user details may be done by setting
5292: per-user variables.
5293: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5294: numeric UID for the user.
5295: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5296: user's description or comment.
5297: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5298: user's home directory, and defaults to
5299: <code class="filename">/nonexistent</code> if not specified.
5300: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5301: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5302: not specified.</p>
5303: <p>Similarly, groups can be created by adding entries to the
5304: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5305: <pre class="programlisting">
5306: group
5307: </pre>
5308: <p>The numeric GID of the group may be set by defining
5309: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5310: <p>If a package needs to create the users and groups at an earlier
5311: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5312: either <code class="literal">configure</code> or <code class="literal">build</code> to
5313: indicate the phase before which the users and groups are created. In
5314: this case, the numeric UIDs and GIDs of the created users and groups
5315: are automatically hardcoded into the final installation scripts.</p>
5316: </div>
1.41 asau 5317: <div class="sect1">
1.1 dsieger 5318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5319: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5320: <p>Packages that install system shells should register them in the shell
5321: database, <code class="filename">/etc/shells</code>, to make things easier to the
5322: administrator. This must be done from the installation scripts to keep
5323: binary packages working on any system. pkginstall provides an easy way to
5324: accomplish this task.</p>
5325: <p>When a package provides a shell interpreter, it has to set the
5326: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5327: add some hooks to the installation scripts to handle it. Consider the
1.79 snj 5328: 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 5329: <pre class="programlisting">
5330: PKG_SHELL= ${PREFIX}/bin/zsh
5331: </pre>
1.41 asau 5332: <div class="sect2">
1.1 dsieger 5333: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5334: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5335: <p>The automatic registration of shell interpreters can be disabled by
5336: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5337: environment variable to <code class="literal">NO</code>.</p>
5338: </div>
5339: </div>
1.41 asau 5340: <div class="sect1">
1.1 dsieger 5341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5342: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5343: <p>Packages that install X11 fonts should update the database files
5344: that index the fonts within each fonts directory. This can easily be
5345: accomplished within the pkginstall framework.</p>
5346: <p>When a package installs X11 fonts, it must list the directories in
5347: which fonts are installed in the
5348: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5349: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5350: <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 5351: installation scripts to run the appropriate commands to update the fonts
5352: database files within each of those directories. For convenience, if the
5353: directory path is relative, it is taken to be relative to the package's
1.79 snj 5354: 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 5355: <pre class="programlisting">
1.67 wiz 5356: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5357: </pre>
1.41 asau 5358: <div class="sect2">
1.1 dsieger 5359: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5360: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5361: <p>The automatic update of fonts databases can be disabled by
5362: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5363: environment variable to <code class="literal">NO</code>.</p>
5364: </div>
5365: </div>
5366: </div>
1.41 asau 5367: <div class="chapter">
1.1 dsieger 5368: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5369: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5370: <div class="toc">
5371: <p><b>Table of Contents</b></p>
1.100 leot 5372: <dl class="toc">
1.6 rillig 5373: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5374: <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 5375: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5376: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5377: </dl>
5378: </div>
5379: <p>Many packages have the ability to be built to support different
5380: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5381: in pkgsrc that provides generic handling of those options that
5382: determine different ways in which the packages can be built. It's
5383: possible for the user to specify exactly which sets of options will be
5384: built into a package or to allow a set of global default options
5385: apply.</p>
1.7 rillig 5386: <p>There are two broad classes of behaviors that one might want to
5387: control via options. One is whether some particular feature is
5388: enabled in a program that will be built anyway, often by including or
5389: not including a dependency on some other package. The other is
5390: whether or not an additional program will be built as part of the
5391: package. Generally, it is better to make a split package for such
5392: additional programs instead of using options, because it enables
5393: binary packages to be built which can then be added separately. For
5394: example, the foo package might have minimal dependencies (those
5395: packages without which foo doesn't make sense), and then the foo-gfoo
5396: package might include the GTK frontend program gfoo. This is better
5397: than including a gtk option to foo that adds gfoo, because either that
5398: option is default, in which case binary users can't get foo without
5399: gfoo, or not default, in which case they can't get gfoo. With split
5400: packages, they can install foo without having GTK, and later decide to
5401: install gfoo (pulling in GTK at that time). This is an advantage to
5402: source users too, avoiding the need for rebuilds.</p>
5403: <p>Plugins with widely varying dependencies should usually be split
5404: instead of options.</p>
5405: <p>It is often more work to maintain split packages, especially if
5406: the upstream package does not support this. The decision of split
5407: vs. option should be made based on the likelihood that users will want
5408: or object to the various pieces, the size of the dependencies that are
5409: included, and the amount of work.</p>
5410: <p>A further consideration is licensing. Non-free parts, or parts
5411: that depend on non-free dependencies (especially plugins) should
5412: almost always be split if feasible.</p>
1.41 asau 5413: <div class="sect1">
1.1 dsieger 5414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5415: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 5416: <p>Global default options are listed in
5417: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5418: that should be built into every package if that option is supported.
1.10 hubertf 5419: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5420: </div>
1.41 asau 5421: <div class="sect1">
1.1 dsieger 5422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5423: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5424: </h2></div></div></div>
5425: <p>The following example shows how
5426: <code class="filename">bsd.options.mk</code> should be used
5427: by the hypothetical ``wibble'' package, either in the package
5428: <code class="filename">Makefile</code>, or in a file,
5429: e.g. <code class="filename">options.mk</code>, that is included by the
5430: main package <code class="filename">Makefile</code>.</p>
5431: <pre class="programlisting">
5432: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5433: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5434: PKG_OPTIONS_OPTIONAL_GROUPS= database
5435: PKG_OPTIONS_GROUP.database= mysql pgsql
5436: PKG_SUGGESTED_OPTIONS= wibble-foo
5437: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5438: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5439:
5440: .include "../../mk/bsd.prefs.mk"
5441:
5442: # this package was previously named wibble2
5443: .if defined(PKG_OPTIONS.wibble2)
5444: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5445: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5446: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5447: .endif
5448:
5449: .include "../../mk/bsd.options.mk"
5450:
5451: # Package-specific option-handling
5452:
5453: ###
5454: ### FOO support
5455: ###
5456: .if !empty(PKG_OPTIONS:Mwibble-foo)
5457: CONFIGURE_ARGS+= --enable-foo
5458: .endif
5459:
5460: ###
5461: ### LDAP support
5462: ###
5463: .if !empty(PKG_OPTIONS:Mldap)
5464: . include "../../databases/openldap-client/buildlink3.mk"
5465: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5466: .endif
5467:
5468: ###
5469: ### database support
5470: ###
5471: .if !empty(PKG_OPTIONS:Mmysql)
5472: . include "../../mk/mysql.buildlink3.mk"
5473: .endif
5474: .if !empty(PKG_OPTIONS:Mpgsql)
5475: . include "../../mk/pgsql.buildlink3.mk"
5476: .endif
5477: </pre>
5478: <p>The first section contains the information about which build
5479: options are supported by the package, and any default options settings
5480: if needed.</p>
1.23 wiz 5481: <div class="orderedlist"><ol class="orderedlist" type="1">
5482: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.79 snj 5483: <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 5484: options. It should be set to
5485: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5486: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5487: at the point where the options are processed.</p></li>
1.23 wiz 5488: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5489: build options supported by the package.</p></li>
1.23 wiz 5490: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5491: list of names of groups of mutually exclusive options. The options in
5492: each group are listed in
5493: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5494: The most specific setting of any option from the group takes
5495: precedence over all other options in the group. Options from the
5496: groups will be automatically added to
5497: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5498: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5499: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5500: packages will fail if no option from the group is
5501: selected.</p></li>
1.23 wiz 5502: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5503: of names of sets of options. At least one option from each set must
5504: be selected. The options in each set are listed in
5505: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5506: Options from the sets will be automatically added to
5507: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5508: fail if no option from the set is selected.</p></li>
1.23 wiz 5509: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5510: build options which are enabled by default.</p></li>
1.23 wiz 5511: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5512: of
1.23 wiz 5513: <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 5514: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5515: their option counterparts. Pairs should be added with
1.23 wiz 5516: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5517: warning will be issued if the user uses a legacy
5518: variable.</p></li>
1.23 wiz 5519: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5520: of
1.23 wiz 5521: <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 5522: pairs that map options that have been renamed to their new
1.23 wiz 5523: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5524: the listing of global legacy options. A warning will be issued if
5525: the user uses a legacy option.</p></li>
1.23 wiz 5526: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5527: options implied by deprecated variables used. This can be used for
5528: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5529: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5530: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5531: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5532: a list of warnings about deprecated variables or options used, and
5533: what to use instead.</p></li>
5534: </ol></div>
5535: <p>A package should never modify
5536: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5537: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5538: To suggest a default set of options, use
5539: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5540: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5541: including <code class="filename">bsd.options.mk</code>. If none of
5542: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5543: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5544: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5545: happen with platform-specific options if none of them is supported on
5546: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5547: empty list and the package is otherwise treated as not using the
5548: options framework.</p>
5549: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5550: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5551: build options, properly filtered to remove unsupported and duplicate
5552: options.</p>
5553: <p>The remaining sections contain the logic that is specific to
5554: each option. The correct way to check for an option is to check
5555: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5556: <pre class="programlisting">
5557: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5558: </pre>
5559: </div>
1.41 asau 5560: <div class="sect1">
1.1 dsieger 5561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5562: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 5563: <p>Options that enable similar features in different packages (like
5564: optional support for a library) should use a common name in all
5565: packages that support it (like the name of the library). If another
5566: package already has an option with the same meaning, use the same
5567: name.</p>
5568: <p>Options that enable features specific to one package, where it's
5569: unlikely that another (unrelated) package has the same (or a similar)
5570: optional feature, should use a name prefixed with
5571: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5572: <p>If a group of related packages share an optional feature
5573: specific to that group, prefix it with the name of the
1.23 wiz 5574: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5575: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5576: <p>For new options, add a line to
5577: <code class="filename">mk/defaults/options.description</code>. Lines have two
5578: fields, separated by tab. The first field is the option name, the
5579: second its description. The description should be a whole sentence
5580: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5581: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5582: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5583: </div>
1.41 asau 5584: <div class="sect1">
1.7 rillig 5585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5586: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5587: <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 5588: different dependencies based on the options with which the package was
5589: built. For querying these options, the file
5590: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5591: typical example looks like this:</p>
5592: <pre class="programlisting">
5593: pkgbase := libpurple
5594: .include "../../mk/pkg-build-options.mk"
5595:
5596: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5597: ...
5598: .endif
5599: </pre>
5600: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5601: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5602: options of the libpurple package, which can then be queried like
5603: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5604: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5605: details.</p>
5606: </div>
1.1 dsieger 5607: </div>
1.41 asau 5608: <div class="chapter">
1.1 dsieger 5609: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5610: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 5611: <div class="toc">
5612: <p><b>Table of Contents</b></p>
1.100 leot 5613: <dl class="toc">
1.6 rillig 5614: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
5615: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
5616: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
5617: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 5618: <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 5619: <dd><dl>
5620: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
5621: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
5622: </dl></dd>
1.23 wiz 5623: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5624: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5625: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5626: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5627: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5628: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5629: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5630: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5631: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5632: <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 5633: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
5634: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 5635: </dl>
5636: </div>
1.41 asau 5637: <div class="sect1">
1.1 dsieger 5638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5639: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 5640: <p>This chapter gives a detailed description on how a package is
5641: built. Building a package is separated into different
5642: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5643: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5644: described in the following sections. Each phase is split into
1.1 dsieger 5645: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5646: containing phase, prefixed by one of <code class="varname">pre-</code>,
5647: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5648: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5649: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5650: <p>Never override the regular targets (like
5651: <code class="varname">fetch</code>), if you have to, override the
5652: <code class="varname">do-*</code> ones instead.</p>
5653: <p>The basic steps for building a program are always the same. First
5654: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5655: the local system and then extracted. After any pkgsrc-specific patches
5656: to compile properly are applied, the software can be configured, then
5657: built (usually by compiling), and finally the generated binaries, etc.
5658: can be put into place on the system.</p>
5659: <p>To get more details about what is happening at each step,
5660: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5661: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5662: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5663: </div>
1.41 asau 5664: <div class="sect1">
1.1 dsieger 5665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5666: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 5667: <p>Before outlining the process performed by the NetBSD package system in
5668: the next section, here's a brief discussion on where programs are
5669: installed, and which variables influence this.</p>
5670: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5671: where all files of the final program shall be installed. It is
5672: usually set to <code class="varname">LOCALBASE</code>
5673: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5674: for pkgs in the <code class="filename">cross</code> category. The value of
5675: <code class="varname">PREFIX</code> needs to be put
5676: into the various places in the program's source where paths to
1.108 rillig 5677: 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 5678: <p>When choosing which of these variables to use,
5679: follow the following rules:</p>
1.41 asau 5680: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5681: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5682: where the current pkg will be installed. When referring to a
5683: pkg's own installation path, use
1.23 wiz 5684: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5685: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5686: are installed. If you need to construct a -I or -L argument
5687: to the compiler to find includes and libraries installed by
1.23 wiz 5688: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5689: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5690: installed all packages in <code class="filename">/usr/local</code>. As
5691: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5692: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5693: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5694: distribution (from xsrc, etc.) is installed. When looking for
5695: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5696: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5697: <li class="listitem"><p>X11-based packages using imake must set
5698: <code class="varname">USE_IMAKE</code> to be installed correctly under
5699: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5700: <li class="listitem">
1.99 sevan 5701: <p>To determine the prefix of an
1.1 dsieger 5702: installed package, the <code class="varname">EVAL_PREFIX</code>
5703: definition can be used. It takes pairs in the format
1.79 snj 5704: <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 5705: variable <code class="varname">DIRNAME</code> will be set to the prefix
5706: of the installed package <package>, or
1.99 sevan 5707: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> if the package is not
1.1 dsieger 5708: installed.</p>
5709: <p>This is best illustrated by example.</p>
5710: <p>The following lines are taken from
5711: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
5712: <pre class="programlisting">
5713: EVAL_PREFIX+= GTKDIR=gtk+
5714: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
5715: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
5716: CONFIGURE_ARGS+= --enable-multibyte
5717: </pre>
5718: <p>Specific defaults can be defined for the packages
5719: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
5720: definition of the form:</p>
5721: <pre class="programlisting">
5722: GTKDIR_DEFAULT= ${LOCALBASE}
5723: </pre>
5724: <p>where <code class="varname">GTKDIR</code> corresponds
5725: to the first definition in
5726: the <code class="varname">EVAL_PREFIX</code> pair.</p>
5727: </li>
1.23 wiz 5728: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.79 snj 5729: 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 5730: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5731: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5732: </ul></div>
5733: </div>
1.41 asau 5734: <div class="sect1">
1.1 dsieger 5735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5736: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5737: <p>When building a package, various directories are used to store
1.1 dsieger 5738: source files, temporary files, pkgsrc-internal files, and so on. These
5739: directories are explained here.</p>
5740: <p>Some of the directory variables contain relative pathnames. There
5741: are two common base directories for these relative directories:
5742: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5743: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5744: inside the package itself.</p>
1.41 asau 5745: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5746: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5747: <dd><p>This is an absolute pathname that points to the pkgsrc
5748: root directory. Generally, you don't need
5749: it.</p></dd>
5750: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5751: <dd><p>This is an absolute pathname that points to the
5752: current package.</p></dd>
5753: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5754: <dd><p>This is a pathname relative to
5755: <code class="varname">PKGSRCDIR</code> that points to the current
5756: package.</p></dd>
5757: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5758: <dd><p>This is an absolute pathname pointing to the directory
5759: where all work takes place. The distfiles are extracted to this
5760: directory. It also contains temporary directories and log files used by
5761: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5762: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5763: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5764: <dd><p>This is an absolute pathname pointing to the directory
5765: where the distfiles are extracted. It is usually a direct subdirectory
5766: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5767: that isn't hidden. This variable may be changed by a package
5768: <code class="filename">Makefile</code>.</p></dd>
5769: </dl></div>
1.14 jmcneill 5770: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5771: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5772: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5773: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5774: If users would like to have their pkgsrc trees behave in a
5775: read-only manner, then the value of
5776: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5777: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5778: </div>
1.41 asau 5779: <div class="sect1">
1.1 dsieger 5780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5781: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 5782: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5783: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5784: phase. This will automatically run all phases that are required for this
5785: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5786: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5787: the package will be built, but not installed.</p>
5788: </div>
1.41 asau 5789: <div class="sect1">
1.1 dsieger 5790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5791: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5792: <p>The first step in building a package is to fetch the
5793: distribution files (distfiles) from the sites that are providing
5794: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5795: phase.</p>
1.41 asau 5796: <div class="sect2">
1.1 dsieger 5797: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5798: <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 5799: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5800: defines all URLs from where the distfile, whose name is
5801: derived from the <code class="varname">DISTNAME</code> variable, is
5802: fetched. The more complicated cases are described
5803: below.</p>
5804: <p>The variable <code class="varname">DISTFILES</code> specifies
5805: the list of distfiles that have to be fetched. Its value
1.66 asau 5806: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5807: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5808: so that most packages don't need to define it at all.
5809: <code class="varname">EXTRACT_SUFX</code> is
5810: <code class="literal">.tar.gz</code> by default, but can be changed
5811: freely. Note that if your package requires additional
5812: distfiles to the default one, you cannot just append the
5813: additional filenames using the <code class="literal">+=</code>
5814: operator, but you have write for example:</p>
5815: <pre class="programlisting">
1.66 asau 5816: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5817: </pre>
5818: <p>Each distfile is fetched from a list of sites, usually
5819: <code class="varname">MASTER_SITES</code>. If the package has multiple
5820: <code class="varname">DISTFILES</code> or multiple
5821: <code class="varname">PATCHFILES</code> from different sites, you can
5822: set
5823: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5824: to the list of URLs where the file
5825: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5826: (including the suffix) can be found.</p>
5827: <pre class="programlisting">
5828: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5829: DISTFILES+= foo-file.tar.gz
5830: SITES.foo-file.tar.gz= \
5831: http://www.somewhere.com/somehow/ \
5832: http://www.somewhereelse.com/mirror/somehow/
5833: </pre>
5834: <p>When actually fetching the distfiles, each item from
5835: <code class="varname">MASTER_SITES</code> or
5836: <code class="varname">SITES.*</code> gets the name of each distfile
5837: appended to it, without an intermediate slash. Therefore,
5838: all site values have to end with a slash or other separator
5839: character. This allows for example to set
5840: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5841: that gets the name of the distfile as a parameter. In this
5842: case, the definition would look like:</p>
5843: <pre class="programlisting">
5844: MASTER_SITES= http://www.example.com/download.cgi?file=
5845: </pre>
1.22 jakllsch 5846: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5847: In that case the URL is taken as is, fetched and the result
5848: stored under the name of the distfile. You can use this style
5849: for the case when the download URL style does not match the
5850: above common case. For example, if permanent download URL is a
5851: redirector to the real download URL, or the download file name
5852: is offered by an HTTP Content-Disposition header. In the
5853: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5854: created instead of the default
5855: <code class="filename">v1.0.0.tar.gz</code>.</p>
5856: <pre class="programlisting">
5857: DISTNAME= foo-1.0.0
5858: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5859: </pre>
1.1 dsieger 5860: <p>There are some predefined values for
5861: <code class="varname">MASTER_SITES</code>, which can be used in
5862: packages. The names of the variables should speak for
5863: themselves.</p>
5864: <pre class="programlisting">
5865: ${MASTER_SITE_APACHE}
5866: ${MASTER_SITE_BACKUP}
5867: ${MASTER_SITE_CYGWIN}
5868: ${MASTER_SITE_DEBIAN}
5869: ${MASTER_SITE_FREEBSD}
5870: ${MASTER_SITE_FREEBSD_LOCAL}
5871: ${MASTER_SITE_GENTOO}
5872: ${MASTER_SITE_GNOME}
5873: ${MASTER_SITE_GNU}
5874: ${MASTER_SITE_GNUSTEP}
1.66 asau 5875: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 5876: ${MASTER_SITE_IFARCHIVE}
5877: ${MASTER_SITE_KDE}
5878: ${MASTER_SITE_MOZILLA}
1.66 asau 5879: ${MASTER_SITE_MOZILLA_ALL}
5880: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 5881: ${MASTER_SITE_MYSQL}
1.66 asau 5882: ${MASTER_SITE_NETLIB}
1.1 dsieger 5883: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 5884: ${MASTER_SITE_OSDN}
1.1 dsieger 5885: ${MASTER_SITE_PERL_CPAN}
5886: ${MASTER_SITE_PGSQL}
1.66 asau 5887: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 5888: ${MASTER_SITE_R_CRAN}
5889: ${MASTER_SITE_SOURCEFORGE}
5890: ${MASTER_SITE_SUNSITE}
5891: ${MASTER_SITE_SUSE}
5892: ${MASTER_SITE_TEX_CTAN}
5893: ${MASTER_SITE_XCONTRIB}
5894: ${MASTER_SITE_XEMACS}
1.66 asau 5895: ${MASTER_SITE_XORG}
1.1 dsieger 5896: </pre>
5897: <p>Some explanations for the less self-explaining ones:
5898: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 5899: 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 5900: 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 5901: <p>If you choose one of these predefined sites, you may
5902: want to specify a subdirectory of that site. Since these
5903: macros may expand to more than one actual site, you
5904: <span class="emphasis"><em>must</em></span> use the following construct to
5905: specify a subdirectory:</p>
5906: <pre class="programlisting">
5907: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5908: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5909: </pre>
5910: <p>Note the trailing slash after the subdirectory
5911: name.</p>
5912: </div>
1.41 asau 5913: <div class="sect2">
1.1 dsieger 5914: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5915: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 5916: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5917: all the distfiles exist in a local directory
5918: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
5919: user). If the files do not exist, they are fetched using
5920: commands of the form</p>
5921: <pre class="programlisting">
5922: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5923: </pre>
5924: <p>where <code class="literal">${site}</code> varies through
5925: several possibilities in turn: first,
5926: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
5927: sites specified in either <code class="varname">SITES.file</code> if
5928: defined, else <code class="varname">MASTER_SITES</code> or
5929: <code class="varname">PATCH_SITES</code>, as applies, then finally the
5930: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
5931: all except the first and the last can be optionally sorted
5932: by the user, via setting either
5933: <code class="varname">MASTER_SORT_RANDOM</code>, and
5934: <code class="varname">MASTER_SORT_AWK</code> or
5935: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 5936: <p> The specific command and arguments used depend on the
5937: <code class="varname">FETCH_USING</code> parameter. The example above is
5938: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 5939: <p>The distfiles mirror run by the NetBSD Foundation uses the
5940: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
5941: distfiles, if they are freely distributable. Packages setting
5942: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 5943: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 5944: mirrored.</p>
5945: </div>
5946: </div>
1.41 asau 5947: <div class="sect1">
1.1 dsieger 5948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5949: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 5950: <p>After the distfile(s) are fetched, their checksum is
5951: generated and compared with the checksums stored in the
5952: distinfo file. If the checksums don't match, the build is
5953: aborted. This is to ensure the same distfile is used for
5954: building, and that the distfile wasn't changed, e.g. by some
5955: malign force, deliberately changed distfiles on the master
5956: distribution site or network lossage.</p>
5957: </div>
1.41 asau 5958: <div class="sect1">
1.1 dsieger 5959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5960: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 5961: <p>When the distfiles are present on the local system, they
5962: need to be extracted, as they usually come in the form of some
5963: compressed archive format.</p>
5964: <p>By default, all <code class="varname">DISTFILES</code> are
5965: extracted. If you only need some of them, you can set the
5966: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
5967: files.</p>
5968: <p>Extracting the files is usually done by a little
5969: program, <code class="filename">mk/extract/extract</code>, which
5970: already knows how to extract various archive formats, so most
5971: likely you will not need to change anything here. But if you
5972: need, the following variables may help you:</p>
1.41 asau 5973: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5974: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
5975: <dd><p>Use these variables to override the default
5976: options for an extract command, which are defined in
5977: <code class="filename">mk/extract/extract</code>.</p></dd>
5978: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
5979: <dd><p>This variable can be set to
1.14 jmcneill 5980: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
5981: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 5982: absolute pathname pointing to the command with which tar
1.14 jmcneill 5983: archives should be extracted. It is preferred to choose bsdtar over gtar
5984: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 5985: </dl></div>
5986: <p>If the <code class="filename">extract</code> program doesn't
5987: serve your needs, you can also override the
5988: <code class="varname">EXTRACT_CMD</code> variable, which holds the
5989: command used for extracting the files. This command is
5990: executed in the <code class="filename">${WRKSRC}</code>
5991: directory. During execution of this command, the shell
5992: variable <code class="varname">extract_file</code> holds the absolute
5993: pathname of the file that is going to be extracted.</p>
5994: <p>And if that still does not suffice, you can override the
5995: <code class="varname">do-extract</code> target in the package
5996: Makefile.</p>
5997: </div>
1.41 asau 5998: <div class="sect1">
1.1 dsieger 5999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6000: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6001: <p>After extraction, all the patches named by the
6002: <code class="varname">PATCHFILES</code>, those present in the patches
6003: subdirectory of the package as well as in
6004: $LOCALPATCHES/$PKGPATH (e.g.
6005: <code class="filename">/usr/local/patches/graphics/png</code>) are
6006: applied. Patchfiles ending in <code class="filename">.Z</code> or
6007: <code class="filename">.gz</code> are uncompressed before they are
6008: applied, files ending in <code class="filename">.orig</code> or
6009: <code class="filename">.rej</code> are ignored. Any special options to
1.79 snj 6010: <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 6011: <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 6012: <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 6013: it fail if the patches apply with some lines of fuzz. Please
6014: fix (regen) the patches so that they apply cleanly. The
6015: rationale behind this is that patches that don't apply cleanly
6016: may end up being applied in the wrong place, and cause severe
6017: harm there.</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.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6022: <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 6023: </p>
6024: </div>
1.41 asau 6025: <div class="sect1">
1.1 dsieger 6026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6027: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6028: <p>This phase creates wrapper programs for the compilers and
6029: linkers. The following variables can be used to tweak the
6030: wrappers.</p>
1.41 asau 6031: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6032: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6033: <dd><p>The command used to print progress
6034: messages. Does nothing by default. Set to
6035: <code class="literal">${ECHO}</code> to see the progress
6036: messages.</p></dd>
6037: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6038: <dd><p>This variable can be set to
6039: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6040: depending on whether you want additional information in the
6041: wrapper log file.</p></dd>
6042: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6043: <dd><p>This variable can be set to
6044: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6045: on whether the wrapper should use its cache, which will
6046: improve the speed. The default value is
6047: <code class="literal">yes</code>, but is forced to
6048: <code class="literal">no</code> if the platform does not support
6049: it.</p></dd>
6050: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6051: <dd><p>A list of reordering commands. A reordering
6052: command has the form
6053: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6054: It ensures that that
6055: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6056: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6057: </p></dd>
6058: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6059: <dd><p>A list of transformation commands. [TODO:
6060: investigate further]</p></dd>
6061: </dl></div>
6062: </div>
1.41 asau 6063: <div class="sect1">
1.1 dsieger 6064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6065: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6066: <p>Most pieces of software need information on the header
6067: files, system calls, and library routines which are available
6068: on the platform they run on. The process of determining this
6069: information is known as configuration, and is usually
6070: automated. In most cases, a script is supplied with the
6071: distfiles, and its invocation results in generation of header
6072: files, Makefiles, etc.</p>
6073: <p>If the package contains a configure script, this can be
6074: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6075: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6076: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6077: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6078: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6079: <pre class="programlisting">
6080: .for d in ${CONFIGURE_DIRS}
6081: cd ${WRKSRC} \
6082: && cd ${d} \
6083: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6084: .endfor
6085: </pre>
6086: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6087: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6088: <code class="varname">WRKSRC</code>. In each of these directories, the
6089: configure script is run with the environment
6090: <code class="varname">CONFIGURE_ENV</code> and arguments
6091: <code class="varname">CONFIGURE_ARGS</code>. The variables
6092: <code class="varname">CONFIGURE_ENV</code>,
6093: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6094: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6095: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6096: package.</p>
1.37 wiz 6097: <p>If the program uses the Perl way of configuration (mainly Perl
6098: modules, but not only), i.e. a file called
6099: <code class="filename">Makefile.PL</code>, it should include
6100: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6101: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6102: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6103: <p>If the program uses an <code class="filename">Imakefile</code>
6104: for configuration, the appropriate steps can be invoked by
6105: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6106: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6107: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6108: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6109: <p>If the program uses <code class="filename">cmake</code>
6110: for configuration, the appropriate steps can be invoked by
1.23 wiz 6111: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6112: You can add variables to cmake's environment by adding them to the
6113: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6114: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6115: The top directory argument is given by the
6116: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6117: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6118: <p>If there is no configure step at all, set
1.23 wiz 6119: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6120: </div>
1.41 asau 6121: <div class="sect1">
1.1 dsieger 6122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6123: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6124: <p>For building a package, a rough equivalent of the
6125: following code is executed.</p>
6126: <pre class="programlisting">
6127: .for d in ${BUILD_DIRS}
6128: cd ${WRKSRC} \
6129: && cd ${d} \
6130: && env ${MAKE_ENV} \
6131: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6132: -f ${MAKE_FILE} \
6133: ${BUILD_TARGET}
6134: .endfor
6135: </pre>
6136: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6137: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6138: <code class="varname">WRKSRC</code>. In each of these directories,
6139: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6140: <code class="varname">MAKE_ENV</code> and arguments
6141: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6142: <code class="varname">MAKE_ENV</code>,
6143: <code class="varname">BUILD_MAKE_FLAGS</code>,
6144: <code class="varname">MAKE_FILE</code> and
6145: <code class="varname">BUILD_TARGET</code> may all be changed by the
6146: package.</p>
6147: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6148: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6149: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6150: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6151: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6152: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6153: <p>If there is no build step at all, set
1.23 wiz 6154: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6155: </div>
1.41 asau 6156: <div class="sect1">
1.1 dsieger 6157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6158: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6159: <p>[TODO]</p>
6160: </div>
1.41 asau 6161: <div class="sect1">
1.1 dsieger 6162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6163: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6164: <p>Once the build stage has completed, the final step is to
6165: install the software in public directories, so users can
6166: access the programs and files.</p>
6167: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6168: equivalent of the following code is executed. Additionally,
6169: before and after this code, much magic is performed to do
6170: consistency checks, registering the package, and so on.</p>
6171: <pre class="programlisting">
6172: .for d in ${INSTALL_DIRS}
6173: cd ${WRKSRC} \
6174: && cd ${d} \
6175: && env ${MAKE_ENV} \
6176: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6177: -f ${MAKE_FILE} \
6178: ${INSTALL_TARGET}
6179: .endfor
6180: </pre>
6181: <p>The variable's meanings are analogous to the ones in the
6182: <span class="emphasis"><em>build</em></span> phase.
6183: <code class="varname">INSTALL_DIRS</code> defaults to
6184: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6185: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6186: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6187: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6188: defined.</p>
6189: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6190: variables are useful. They are all variations of the
1.79 snj 6191: <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 6192: permissions preset. <code class="varname">INSTALL</code> is the plain
6193: install command. The specialized variants, together with their
6194: intended use, are:</p>
1.41 asau 6195: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6196: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6197: <dd><p>directories that contain
6198: binaries</p></dd>
6199: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6200: <dd><p>directories that contain
6201: scripts</p></dd>
6202: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6203: <dd><p>directories that contain shared and static
6204: libraries</p></dd>
6205: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6206: <dd><p>directories that contain data
6207: files</p></dd>
6208: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6209: <dd><p>directories that contain man
6210: pages</p></dd>
1.100 leot 6211: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6212: <dd><p>directories that contain data files for games
6213: </p></dd>
1.1 dsieger 6214: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6215: <dd><p>binaries that can be stripped from debugging
6216: symbols</p></dd>
6217: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6218: <dd><p>binaries that cannot be
6219: stripped</p></dd>
6220: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6221: <dd><p>game
6222: binaries</p></dd>
6223: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6224: <dd><p>shared and static
6225: libraries</p></dd>
6226: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6227: <dd><p>data files</p></dd>
6228: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6229: <dd><p>data files for
6230: games</p></dd>
6231: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6232: <dd><p>man pages</p></dd>
6233: </dl></div>
6234: <p>Some other variables are:</p>
1.41 asau 6235: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6236: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
6237: <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>
6238: when installing binaries. Any debugging sections and symbols present in
6239: binaries will be preserved.
6240: </p></dd>
1.1 dsieger 6241: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6242: <dd><p>A list of directories relative to
6243: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6244: beginning of the <span class="emphasis"><em>install</em></span> phase.
6245: The package is supposed to create all needed directories itself
6246: before installing files to it and list all other directories here.
6247: </p></dd>
6248: </dl></div>
6249: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6250: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6251: mostly relevant for packages in the <code class="filename">regress</code>
6252: category.</p>
6253: </div>
1.41 asau 6254: <div class="sect1">
1.1 dsieger 6255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6256: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6257: <p>Once the install stage has completed, a binary package of
6258: the installed files can be built. These binary packages can be
6259: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6260: the <span class="command"><strong>make bin-install</strong></span> or by using
6261: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6262: <p>By default, the binary packages are created in
6263: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6264: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6265: one for each category in the <code class="varname">CATEGORIES</code>
6266: variable. <code class="varname">PACKAGES</code> defaults to
6267: <code class="filename">pkgsrc/packages</code>.</p>
6268: </div>
1.41 asau 6269: <div class="sect1">
1.1 dsieger 6270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6271: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6272: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6273: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6274: to clean the work directories of all dependencies too, use
1.10 hubertf 6275: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6276: </div>
1.41 asau 6277: <div class="sect1">
1.1 dsieger 6278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6279: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6280: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6281: <dt><span class="term">pre/post-*</span></dt>
6282: <dd><p>For any of the main targets described in the
6283: previous section, two auxiliary targets exist with
1.23 wiz 6284: <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 6285: prefix for the main target's name. These targets are
6286: invoked before and after the main target is called,
6287: allowing extra configuration or installation steps be
6288: performed from a package's Makefile, for example, which
6289: a program's configure script or install target
6290: omitted.</p></dd>
6291: <dt><span class="term">do-*</span></dt>
6292: <dd><p>Should one of the main targets do the wrong thing,
6293: and should there be no variable to fix this, you can
6294: redefine it with the do-* target. (Note that redefining
6295: the target itself instead of the do-* target is a bad
6296: idea, as the pre-* and post-* targets won't be called
6297: anymore, etc.) You will not usually need to do
6298: this.</p></dd>
6299: <dt><span class="term">reinstall</span></dt>
6300: <dd>
1.10 hubertf 6301: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6302: you noticed some file was not installed properly, you
6303: can repeat the installation with this target, which will
1.23 wiz 6304: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6305: <p>This is the default value of
6306: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6307: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6308: package</strong></span>, where the defaults are
1.23 wiz 6309: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6310: respectively.</p>
6311: </dd>
6312: <dt><span class="term">deinstall</span></dt>
6313: <dd>
1.79 snj 6314: <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 6315: current directory, effectively de-installing the
6316: package. The following variables can be used to tune the
6317: behaviour:</p>
1.41 asau 6318: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6319: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.79 snj 6320: <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 6321: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6322: <dd><p>Remove all packages that require (depend on)
6323: the given package. This can be used to remove any
6324: packages that may have been pulled in by a given
1.10 hubertf 6325: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6326: DEINSTALLDEPENDS=1</strong></span> is done in
6327: <code class="filename">pkgsrc/x11/kde</code>, this is
6328: likely to remove whole KDE. Works by adding
1.79 snj 6329: <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 6330: command line.</p></dd>
6331: </dl></div>
6332: </dd>
6333: <dt><span class="term">bin-install</span></dt>
6334: <dd><p>Install a binary package from local disk and via FTP
6335: from a list of sites (see the
6336: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6337: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6338: available anywhere. The arguments given to
1.10 hubertf 6339: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6340: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6341: operation, etc.</p></dd>
1.95 wiz 6342: <dt><span class="term">install-clean</span></dt>
6343: <dd><p>This target removes the state files for the "install" and later
6344: phases so that the "install" target may be re-invoked. This can be
6345: used after editing the PLIST to install the package without
6346: rebuilding it.</p></dd>
6347: <dt><span class="term">build-clean</span></dt>
6348: <dd><p>This target removes the state files for the "build" and later
6349: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6350: <dt><span class="term">update</span></dt>
6351: <dd>
6352: <p>This target causes the current package to be
6353: updated to the latest version. The package and all
6354: depending packages first get de-installed, then current
6355: versions of the corresponding packages get compiled and
6356: installed. This is similar to manually noting which
6357: packages are currently installed, then performing a
1.10 hubertf 6358: series of <span class="command"><strong>make deinstall</strong></span> and
6359: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6360: <code class="varname">UPDATE_TARGET</code> is set to) for these
6361: packages.</p>
1.23 wiz 6362: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6363: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6364: update</strong></span> was interrupted for some reason.
6365: However, in this case, make sure you don't call
1.10 hubertf 6366: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6367: list of dependent packages in <code class="varname">WRKDIR</code>.
6368: Otherwise, you lose the ability to automatically update
6369: the current package along with the dependent packages
6370: you have installed.</p>
1.10 hubertf 6371: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6372: update</strong></span> will only work as long as the package
6373: tree remains unchanged. If the source code for one of
6374: the packages to be updated has been changed, resuming
1.10 hubertf 6375: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6376: fail!</p>
6377: <p>The following variables can be used either on the
1.10 hubertf 6378: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6379: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6380: update</strong></span>:</p>
1.41 asau 6381: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6382: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6383: <dd><p>Install target to recursively use for the
6384: updated package and the dependent packages.
6385: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6386: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6387: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6388: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6389: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6390: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6391: endless loop!</p></dd>
6392: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6393: <dd><p>Don't clean up after updating. Useful if
6394: you want to leave the work sources of the updated
6395: packages around for inspection or other purposes.
6396: Be sure you eventually clean up the source tree
1.23 wiz 6397: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6398: or you may run into troubles with old source code
6399: still lying around on your next
1.10 hubertf 6400: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6401: update</strong></span>.</p></dd>
6402: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6403: <dd><p>Deinstall each package before installing
6404: (making <code class="varname">DEPENDS_TARGET</code>). This
6405: may be necessary if the
1.23 wiz 6406: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6407: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6408: update</strong></span>.</p></dd>
6409: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6410: <dd><p>Allows you to disable recursion and hardcode
6411: the target for packages. The default is
1.23 wiz 6412: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6413: facilitating a recursive update of prerequisite
6414: packages. Only set
6415: <code class="varname">DEPENDS_TARGET</code> if you want to
6416: disable recursive updates. Use
6417: <code class="varname">UPDATE_TARGET</code> instead to just
6418: set a specific target for each package to be
1.10 hubertf 6419: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6420: (see above).</p></dd>
6421: </dl></div>
6422: </dd>
6423: <dt><span class="term">clean-update</span></dt>
6424: <dd>
6425: <p>Clean the source tree for all packages that would
1.10 hubertf 6426: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6427: from the current directory. This target should not be
6428: used if the current package (or any of its depending
6429: packages) have already been de-installed (e.g., after
1.10 hubertf 6430: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6431: some packages you intended to update. As a rule of
6432: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6433: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6434: and only if you have a dirty package tree (e.g., if you
6435: used <code class="varname">NOCLEAN</code>).</p>
6436: <p>If you are unsure about whether your tree is
1.10 hubertf 6437: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6438: clean</strong></span> at the top of the tree, or use the
6439: following sequence of commands from the directory of the
6440: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6441: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6442: time, otherwise you lose all the packages you wanted to
6443: update!):</p>
6444: <pre class="screen">
6445: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6446: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6447: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6448: </pre>
6449: <p>The following variables can be used either on the
1.10 hubertf 6450: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6451: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6452: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6453: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6454: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6455: reconstruct the list of directories to update for
1.10 hubertf 6456: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6457: update</strong></span> successfully installed all
6458: packages you wanted to update. Normally, this is
1.10 hubertf 6459: done automatically on <span class="command"><strong>make
1.1 dsieger 6460: update</strong></span>, but may have been suppressed by
6461: the <code class="varname">NOCLEAN</code> variable (see
6462: above).</p></dd>
6463: </dl></div>
6464: </dd>
6465: <dt><span class="term">replace</span></dt>
6466: <dd>
6467: <p>Update the installation of the current package. This
6468: differs from update in that it does not replace dependent
1.79 snj 6469: 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 6470: target to work.</p>
6471: <p><span class="emphasis"><em>Be careful when using this
6472: target!</em></span> There are no guarantees that dependent
6473: packages will still work, in particular they will most
1.10 hubertf 6474: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6475: library package whose shared library major version changed
6476: between your installed version and the new one. For this
6477: reason, this target is not officially supported and only
6478: recommended for advanced users.</p>
6479: </dd>
6480: <dt><span class="term">info</span></dt>
1.79 snj 6481: <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 6482: package. You can use this to check which version of a
6483: package is installed.</p></dd>
6484: <dt><span class="term">index</span></dt>
6485: <dd>
6486: <p>This is a top-level command, i.e. it should be used in
6487: the <code class="filename">pkgsrc</code> directory. It creates a
6488: database of all packages in the local pkgsrc tree, including
6489: dependencies, comment, maintainer, and some other useful
6490: information. Individual entries are created by running
1.10 hubertf 6491: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6492: directories. This index file is saved as
6493: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6494: verbose format by running <span class="command"><strong>make
1.1 dsieger 6495: print-index</strong></span>. You can search in it with
1.10 hubertf 6496: <span class="command"><strong>make search
1.1 dsieger 6497: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6498: extract a list of all packages that depend on a particular
1.10 hubertf 6499: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6500: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6501: <p>Running this command takes a very long time, some
6502: hours even on fast machines!</p>
6503: </dd>
6504: <dt><span class="term">readme</span></dt>
6505: <dd>
6506: <p>This target generates a
6507: <code class="filename">README.html</code> file, which can be
1.79 snj 6508: 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 6509: contain references to any packages which are in the
6510: <code class="varname">PACKAGES</code> directory on the local
6511: host. The generated files can be made to refer to URLs
6512: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6513: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6514: wanted to generate <code class="filename">README.html</code>
6515: files which pointed to binary packages on the local
6516: machine, in the directory
6517: <code class="filename">/usr/packages</code>, set
6518: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6519: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6520: <code class="varname">${PACKAGES}</code> directory and its
6521: subdirectories will be searched for all the binary
6522: packages.</p>
6523: <p>The target can be run at the toplevel or in category
6524: directories, in which case it descends recursively.</p>
6525: </dd>
6526: <dt><span class="term">readme-all</span></dt>
6527: <dd><p>This is a top-level command, run it in
6528: <code class="filename">pkgsrc</code>. Use this target to create a
6529: file <code class="filename">README-all.html</code> which contains a
6530: list of all packages currently available in the NetBSD
6531: Packages Collection, together with the category they belong
6532: to and a short description. This file is compiled from the
6533: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6534: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6535: readme</strong></span>.</p></dd>
6536: <dt><span class="term">cdrom-readme</span></dt>
6537: <dd><p>This is very much the same as the
1.23 wiz 6538: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6539: used when generating a pkgsrc tree to be written to a
6540: CD-ROM. This target also produces
6541: <code class="filename">README.html</code> files, and can be made
6542: to refer to URLs based on
6543: <code class="varname">CDROM_PKG_URL_HOST</code> and
6544: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6545: <dt><span class="term">show-distfiles</span></dt>
6546: <dd><p>This target shows which distfiles and patchfiles
6547: are needed to build the package
6548: (<code class="varname">ALLFILES</code>, which contains all
6549: <code class="varname">DISTFILES</code> and
6550: <code class="varname">PATCHFILES</code>, but not
6551: <code class="filename">patches/*</code>).</p></dd>
6552: <dt><span class="term">show-downlevel</span></dt>
6553: <dd><p>This target shows nothing if the package is not
6554: installed. If a version of this package is installed,
6555: but is not the version provided in this version of
6556: pkgsrc, then a warning message is displayed. This target
6557: can be used to show which of your installed packages are
6558: downlevel, and so the old versions can be deleted, and
6559: the current ones added.</p></dd>
6560: <dt><span class="term">show-pkgsrc-dir</span></dt>
6561: <dd><p>This target shows the directory in the pkgsrc
6562: hierarchy from which the package can be built and
6563: installed. This may not be the same directory as the one
6564: from which the package was installed. This target is
6565: intended to be used by people who may wish to upgrade
6566: many packages on a single host, and can be invoked from
6567: the top-level pkgsrc Makefile by using the
1.23 wiz 6568: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6569: <dt><span class="term">show-installed-depends</span></dt>
6570: <dd><p>This target shows which installed packages match
6571: the current package's <code class="varname">DEPENDS</code>. Useful
6572: if out of date dependencies are causing build
6573: problems.</p></dd>
1.95 wiz 6574: <dt><span class="term">print-build-depends-list</span></dt>
6575: <dd><p>This target shows the list of packages that the current package
6576: depends on for building.</p></dd>
6577: <dt><span class="term">print-run-depends-list</span></dt>
6578: <dd><p>This target shows the list of packages that the current package
6579: depends on for running.</p></dd>
1.1 dsieger 6580: <dt><span class="term">check-shlibs</span></dt>
6581: <dd><p>After a package is installed, check all its
6582: binaries and (on ELF platforms) shared libraries to see
6583: if they find the shared libs they need. Run by default
1.10 hubertf 6584: 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 6585: <dt><span class="term">print-PLIST</span></dt>
6586: <dd>
1.23 wiz 6587: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6588: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6589: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6590: -newer work/.extract_done</strong></span>. An attempt is made
6591: to care for shared libs etc., but it is
6592: <span class="emphasis"><em>strongly</em></span> recommended to review the
6593: result before putting it into
6594: <code class="filename">PLIST</code>. On upgrades, it's useful to
6595: diff the output of this command against an already
6596: existing <code class="filename">PLIST</code> file.</p>
1.79 snj 6597: <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 6598: other methods that don't update file access times, be
6599: sure to add these files manually to your
1.23 wiz 6600: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6601: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6602: them!</p>
1.23 wiz 6603: <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 6604: information on this target.</p>
6605: </dd>
6606: <dt><span class="term">bulk-package</span></dt>
6607: <dd>
6608: <p>Used to do bulk builds. If an appropriate binary
6609: package already exists, no action is taken. If not, this
6610: target will compile, install and package it (and its
6611: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 6612: 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
6613: builds)</i></a>).
1.1 dsieger 6614: After creating the binary package, the sources, the
6615: just-installed package and its required packages are
6616: removed, preserving free disk space.</p>
6617: <p><span class="emphasis"><em>Beware that this target may deinstall
6618: all packages installed on a system!</em></span></p>
6619: </dd>
6620: <dt><span class="term">bulk-install</span></dt>
6621: <dd>
6622: <p>Used during bulk-installs to install required
6623: packages. If an up-to-date binary package is available,
1.79 snj 6624: 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 6625: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6626: but the installed binary won't be removed.</p>
6627: <p>A binary package is considered
1.23 wiz 6628: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.79 snj 6629: <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 6630: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6631: <li class="listitem"><p>None of the package's files
1.1 dsieger 6632: (<code class="filename">Makefile</code>, ...) were modified
6633: since it was built.</p></li>
1.23 wiz 6634: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6635: packages were modified since it was built.</p></li>
6636: </ul></div>
6637: <p><span class="emphasis"><em>Beware that this target may deinstall
6638: all packages installed on a system!</em></span></p>
6639: </dd>
6640: </dl></div>
6641: </div>
6642: </div>
1.41 asau 6643: <div class="chapter">
1.1 dsieger 6644: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6645: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6646: <div class="toc">
6647: <p><b>Table of Contents</b></p>
1.100 leot 6648: <dl class="toc">
1.6 rillig 6649: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
6650: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
6651: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6652: </dl>
6653: </div>
6654: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6655: by pkgsrc and also for individual packages to define what commands
6656: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
6657: or for later run-time of an installed packaged (such as
6658: <code class="varname">DEPENDS</code>).
6659: If the native system provides an adequate tool, then in many cases, a pkgsrc
6660: package will not be used.</p>
6661: <p>When building a package, the replacement tools are
6662: made available in a directory (as symlinks or wrapper scripts)
6663: that is early in the executable search path. Just like the buildlink
6664: system, this helps with consistent builds.</p>
6665: <p>A tool may be needed to help build a specific package. For example,
6666: perl, GNU make (gmake) or yacc may be needed.</p>
6667: <p>Also a tool may be needed, for example, because the native system's supplied
6668: tool may be inefficient for building a package with pkgsrc.
6669: For example, a package may need GNU awk, bison (instead of
6670: yacc) or a better sed.</p>
6671: <p>The tools used by a package can be listed by running
1.10 hubertf 6672: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6673: <div class="sect1">
1.1 dsieger 6674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6675: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6676: <p>The default set of tools used by pkgsrc is defined in
6677: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6678: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6679: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6680: These can be seen by running:
1.10 hubertf 6681: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6682: <p>If a package needs a specific program to build
6683: then the <code class="varname">USE_TOOLS</code> variable can be used
6684: to define the tools needed.</p>
6685: </div>
1.41 asau 6686: <div class="sect1">
1.1 dsieger 6687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6688: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6689: <p>In the following examples, the :run means that it is needed at
6690: run-time (and becomes a DEPENDS).
1.1 dsieger 6691: The default is a build dependency which can be set with
6692: :build. (So in this example, it is the same as gmake:build
6693: and pkg-config:build.)</p>
6694: <pre class="programlisting">
6695: USE_TOOLS+= gmake perl:run pkg-config
6696: </pre>
6697: <p>When using the tools framework, a
6698: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6699: which contains the full path to the appropriate tool. For example,
1.23 wiz 6700: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6701: on Linux systems.</p>
6702: <p>If you always need a pkgsrc version of the
6703: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6704: </p>
6705: </div>
1.41 asau 6706: <div class="sect1">
1.1 dsieger 6707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6708: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6709: <p>When improving or porting pkgsrc to a new platform, have a look
6710: at (or create) the corresponding platform specific make file fragment under
6711: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6712: the name of the common tools. For example:</p>
6713: <pre class="programlisting">
6714: .if exists(/usr/bin/bzcat)
6715: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6716: .elif exists(/usr/bin/bzip2)
6717: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6718: .endif
6719:
6720: TOOLS_PLATFORM.true?= true # shell builtin
6721: </pre>
6722: </div>
6723: </div>
1.41 asau 6724: <div class="chapter">
1.1 dsieger 6725: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6726: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 6727: <div class="toc">
6728: <p><b>Table of Contents</b></p>
1.100 leot 6729: <dl class="toc">
1.6 rillig 6730: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 6731: <dd><dl>
1.108 rillig 6732: <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>
6733: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
6734: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
6735: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
6736: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
6737: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
6738: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
6739: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
6740: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
6741: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6742: <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 6743: </dl></dd>
1.108 rillig 6744: <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 6745: <dd><dl>
6746: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6747: <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 6748: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 6749: </dl></dd>
1.108 rillig 6750: <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 6751: <dd><dl>
6752: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
6753: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6754: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
6755: </dl></dd>
6756: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
6757: <dd><dl>
6758: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
6759: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
6760: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 6761: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
6762: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 6763: </dl></dd>
1.108 rillig 6764: <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 6765: <dd><dl>
6766: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
6767: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 6768: <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 6769: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
6770: </dl></dd>
1.108 rillig 6771: <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 6772: <dd><dl>
6773: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
6774: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
6775: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
6776: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
6777: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6778: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
6779: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
6780: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 6781: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 6782: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 6783: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
6784: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
6785: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
6786: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
6787: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
6788: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
6789: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
6790: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 6791: emulation</a></span></dt>
1.6 rillig 6792: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
6793: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6794: </dl></dd>
1.6 rillig 6795: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6796: </dl>
6797: </div>
1.41 asau 6798: <div class="sect1">
1.1 dsieger 6799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6800: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 6801: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6802: different platforms. As a result, it is important to ensure,
6803: where possible, that packages in pkgsrc are portable. This
6804: chapter mentions some particular details you should pay
6805: attention to while working on pkgsrc.</p>
1.41 asau 6806: <div class="sect2">
1.1 dsieger 6807: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6808: <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 6809: </h3></div></div></div>
6810: <p>The pkgsrc user can configure pkgsrc by overriding several
6811: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6812: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6813: want to use those variables in the preprocessor directives of
1.79 snj 6814: <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 6815: <code class="literal">.for</code>), you need to include the file
6816: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6817: loads the user preferences.</p>
6818: <p>But note that some variables may not be completely defined
6819: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6820: included, as they may contain references to variables that are
1.108 rillig 6821: not yet defined. In shell commands (the lines in
6822: <code class="filename">Makefile</code> that are indented with a tab) this
6823: is no problem, since variables are only expanded when they are
6824: used. But in the preprocessor directives mentioned above and in
6825: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6826: dependencies</code>) the variables are expanded at load
6827: time.</p>
1.41 asau 6828: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6829: <h3 class="title">Note</h3>
1.108 rillig 6830: <p>To check whether a variable can be used at load time,
6831: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6832: </div>
6833: </div>
1.41 asau 6834: <div class="sect2">
1.1 dsieger 6835: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6836: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6837: <p>Occasionally, packages require interaction from the user,
6838: and this can be in a number of ways:</p>
1.41 asau 6839: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6840: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 6841: interaction such as entering username/password or accepting a
6842: license on a web page.</p></li>
1.23 wiz 6843: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 6844: passwords.</p></li>
1.23 wiz 6845: <li class="listitem"><p>help to configure the package before it is built</p></li>
6846: <li class="listitem"><p>help during the build process</p></li>
6847: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 6848: </ul></div>
1.108 rillig 6849: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6850: variable to define which stages need interaction. This should be
6851: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 6852: <pre class="programlisting">
6853: INTERACTIVE_STAGE= configure install
1.111 sevan 6854: </pre>
1.1 dsieger 6855: <p>The user can then decide to skip this package by setting the
1.108 rillig 6856: <code class="varname">BATCH</code> variable. Packages that require interaction
6857: are also excluded from bulk builds.</p>
1.1 dsieger 6858: </div>
1.41 asau 6859: <div class="sect2">
1.1 dsieger 6860: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6861: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 6862: <p>Authors of software can choose the licence under which software
6863: can be copied. The Free Software Foundation has declared some
6864: licenses "Free", and the Open Source Initiative has a definition of
6865: "Open Source".</p>
6866: <p>By default, pkgsrc allows packages with Free or Open Source
6867: licenses to be built. To allow packages with other licenses to be
6868: built as well, the pkgsrc user needs to add these licenses to the
6869: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6870: that this variable only affects which packages may be
6871: <span class="emphasis"><em>built</em></span>, while the license terms often also
6872: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 6873: <p>One might want to only install packages with a BSD license,
1.108 rillig 6874: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 6875: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 6876: user can override the default by setting the
6877: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 6878: of "+=". The licenses accepted by default are defined in the
6879: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6880: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 6881: <p>The license tag mechanism is intended to address
6882: copyright-related issues surrounding building, installing and
6883: using a package, and not to address redistribution issues (see
6884: <code class="varname">RESTRICTED</code> and
1.111 sevan 6885: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 6886: Packages with redistribution restrictions should set these
6887: tags.</p>
1.1 dsieger 6888: <p>Denoting that a package may be copied according to a
6889: particular license is done by placing the license in
6890: <code class="filename">pkgsrc/licenses</code> and setting the
6891: <code class="varname">LICENSE</code> variable to a string identifying the
1.79 snj 6892: 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 6893: <pre class="programlisting">
6894: LICENSE= xv-license
1.111 sevan 6895: </pre>
1.1 dsieger 6896: <p>When trying to build, the user will get a notice that the
6897: package is covered by a license which has not been placed in the
6898: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
6899: <pre class="programlisting">
6900: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6901: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6902: ===> To view the license, enter "/usr/bin/make show-license".
6903: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6904: ===> ACCEPTABLE_LICENSES+=xv-license
6905: *** Error code 1
1.111 sevan 6906: </pre>
1.10 hubertf 6907: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 6908: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 6909: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 6910: convey to pkgsrc that it should not in the future fail because of
6911: that license:</p>
6912: <pre class="programlisting">
6913: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 6914: </pre>
6915: <p>The use of <code class="varname">LICENSE=shareware</code>,
6916: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
6917: is deprecated because it does not crisply refer to a particular
6918: license text. Another problem with such usage is that it does not
6919: enable a user to tell pkgsrc to proceed for a single package
6920: without also telling pkgsrc to proceed for all packages with that
6921: tag.</p>
6922: <div class="sect3">
6923: <div class="titlepage"><div><div><h4 class="title">
6924: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 6925: <p>When adding a package with a new license, the following steps
6926: are required:</p>
6927: <div class="orderedlist"><ol class="orderedlist" type="1">
6928: <li class="listitem">
1.111 sevan 6929: <p>Check whether the license qualifies as Free or Open
6930: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
6931: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
6932: Open Source Initiative</a>. If this is the case, the filename in
6933: <code class="filename">pkgsrc/licenses/</code> does not need the
6934: <code class="filename">-license</code> suffix, and the license name should be
6935: added to:</p>
1.48 rodent 6936: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6937: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
6938: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
6939: </ul></div>
6940: </li>
6941: <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>
6942: </ol></div>
1.111 sevan 6943: </div>
6944: <div class="sect3">
6945: <div class="titlepage"><div><div><h4 class="title">
6946: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 6947: <p>When the license changes (in a way other than formatting),
1.111 sevan 6948: make sure that the new license has a different name (e.g.,
1.1 dsieger 6949: append the version number if it exists, or the date). Just
6950: because a user told pkgsrc to build programs under a previous
6951: version of a license does not mean that pkgsrc should build
6952: programs under the new licenses. The higher-level point is that
6953: pkgsrc does not evaluate licenses for reasonableness; the only
6954: test is a mechanistic test of whether a particular text has been
1.111 sevan 6955: approved by either of two bodies (FSF or OSI).</p>
6956: </div>
1.1 dsieger 6957: </div>
1.41 asau 6958: <div class="sect2">
1.1 dsieger 6959: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6960: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 6961: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 6962: By declaring the restrictions, package tools can
1.1 dsieger 6963: automatically refrain from e.g. placing binary packages on FTP
6964: sites.</p>
1.111 sevan 6965: <p>There are four possible restrictions, which are
1.1 dsieger 6966: the cross product of sources (distfiles) and binaries not being
6967: placed on FTP sites and CD-ROMs. Because this is rarely the exact
6968: language in any license, and because non-Free licenses tend to be
6969: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 6970: CD-ROM.
6971:
6972: "FTP" means making the source or binary file available over the
6973: Internet at no charge.
6974:
6975: "CD-ROM" means making the source or binary available on some kind of
6976: media, together with other source and binary packages, which is sold
6977: for a distribution charge.
1.1 dsieger 6978: </p>
6979: <p>In order to encode these restrictions, the package system
6980: defines five make variables that can be set to note these
6981: restrictions:</p>
1.41 asau 6982: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6983: <li class="listitem">
1.1 dsieger 6984: <p><code class="varname">RESTRICTED</code></p>
6985: <p>This variable should be set whenever a restriction
6986: exists (regardless of its kind). Set this variable to a
6987: string containing the reason for the restriction. It should
6988: be understood that those wanting to understand the restriction
6989: will have to read the license, and perhaps seek advice of
6990: counsel.</p>
6991: </li>
1.23 wiz 6992: <li class="listitem">
1.1 dsieger 6993: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
6994: <p>Binaries may not be placed on CD-ROM containing other
6995: binary packages, for which a distribution charge may be made.
6996: In this case, set this variable to
6997: <code class="varname">${RESTRICTED}</code>.</p>
6998: </li>
1.23 wiz 6999: <li class="listitem">
1.1 dsieger 7000: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7001: <p>Binaries may not made available on the Internet without
7002: charge. In this case, set this variable to
7003: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7004: binary packages will not be included on ftp.NetBSD.org.</p>
7005: </li>
1.23 wiz 7006: <li class="listitem">
1.1 dsieger 7007: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7008: <p>Distfiles may not be placed on CD-ROM, together with
7009: other distfiles, for which a fee may be charged. In this
7010: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7011: </p>
7012: </li>
1.23 wiz 7013: <li class="listitem">
1.1 dsieger 7014: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7015: <p>Distfiles may not made available via FTP at no charge.
7016: In this case, set this variable to
7017: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7018: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7019: </li>
7020: </ul></div>
1.111 sevan 7021: <p>Please note that packages will be removed from pkgsrc when the
7022: distfiles are not distributable and cannot be obtained for a period
7023: of one full quarter branch. Packages with manual/interactive fetch
7024: must have a maintainer and it is his/her responsibility to ensure
7025: this.</p>
1.1 dsieger 7026: </div>
1.41 asau 7027: <div class="sect2">
1.1 dsieger 7028: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7029: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7030: <p>Your package may depend on some other package being present
7031: - and there are various ways of expressing this dependency.
7032: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7033: <code class="varname">DEPENDS</code> definitions, the
7034: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7035: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7036: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7037: 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 7038: <p>The basic difference between the two variables is as
7039: follows: The <code class="varname">DEPENDS</code> definition registers
7040: that pre-requisite in the binary package so it will be pulled in
7041: when the binary package is later installed, whilst the
7042: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7043: dependency that is only needed for building the package.</p>
7044: <p>This means that if you only need a package present whilst
7045: you are building, it should be noted as a
7046: <code class="varname">BUILD_DEPENDS</code>.</p>
7047: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7048: <code class="varname">DEPENDS</code> definition is:</p>
7049: <pre class="programlisting">
7050: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7051: </pre>
1.23 wiz 7052: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7053: may include any of the wildcard version numbers recognized by
1.79 snj 7054: <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 7055: <div class="orderedlist"><ol class="orderedlist" type="1">
7056: <li class="listitem">
1.1 dsieger 7057: <p>If your package needs another package's binaries or
1.54 wiz 7058: libraries to build and run, and if that package has a
1.1 dsieger 7059: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7060: <pre class="programlisting">
7061: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7062: </pre>
1.1 dsieger 7063: </li>
1.23 wiz 7064: <li class="listitem">
1.54 wiz 7065: <p>If your package needs another package's binaries or
7066: libraries only for building, and if that package has a
7067: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7068: <pre class="programlisting">
7069: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7070: </pre>
1.54 wiz 7071: <p>but set
7072: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7073: to make it a build dependency only. This case is rather
7074: rare.</p>
7075: </li>
7076: <li class="listitem">
1.25 spz 7077: <p>If your package needs binaries from another package to build,
7078: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7079: <pre class="programlisting">
1.25 spz 7080: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.111 sevan 7081: </pre>
1.1 dsieger 7082: </li>
1.25 spz 7083: <li class="listitem"><p>If your package needs a library with which to link and
7084: there is no <code class="filename">buildlink3.mk</code> file
7085: available, create one. Using
7086: <code class="varname">DEPENDS</code> won't be sufficient because the
7087: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7088: <li class="listitem">
1.25 spz 7089: <p>If your package needs some executable to be able to run
7090: correctly and if there's no
7091: <code class="filename">buildlink3.mk</code> file, this is specified
7092: using the <code class="varname">DEPENDS</code> variable. The
1.79 snj 7093: <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 7094: be able to execute the latex binary from the teTeX package
7095: when it runs, and that is specified:</p>
1.1 dsieger 7096: <pre class="programlisting">
1.25 spz 7097: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.111 sevan 7098: </pre>
1.25 spz 7099: </li>
7100: <li class="listitem">
7101: <p>You can use wildcards in package dependencies. Note that
7102: such wildcard dependencies are retained when creating binary
7103: packages. The dependency is checked when installing the binary
7104: package and any package which matches the pattern will be
7105: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7106: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7107: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7108: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7109: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7110: <p>Wildcards can also be used to specify that a package
7111: will only build against a certain minimum version of a
7112: pre-requisite:</p>
7113: <pre class="programlisting">
1.25 spz 7114: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7115: </pre>
1.25 spz 7116: <p>This means that the package will build using version 6.0
7117: of ImageMagick or newer. Such a dependency may be warranted
7118: if, for example, the command line options of an executable
7119: have changed.</p>
7120: <p>If you need to depend on minimum versions of libraries,
7121: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7122: <p>For security fixes, please update the package
1.108 rillig 7123: 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 7124: information.</p>
7125: </li>
7126: </ol></div>
7127: <p>If your package needs files from another package to build,
7128: add the relevant distribution files to
7129: <code class="varname">DISTFILES</code>, so they will be extracted
1.79 snj 7130: 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 7131: (It relies on the jpeg sources being present in source form
7132: during the build.)</p>
7133: </div>
1.41 asau 7134: <div class="sect2">
1.1 dsieger 7135: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7136: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7137: <p>Your package may conflict with other packages a user might
7138: already have installed on his system, e.g. if your package
7139: installs the same set of files as another package in the pkgsrc
1.80 wiz 7140: tree or has the same <code class="varname">PKGNAME</code>.</p>
7141: <p>These cases are handled automatically by the packaging tools
7142: at package installation time and do not need to be handled
7143: manually.</p>
7144: <p>In case the conflicts can not be recognized automatically
7145: (e.g., packages using the same config file location but no other
7146: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7147: space-separated list of packages (including version string) your
7148: package conflicts with.</p>
1.80 wiz 7149: <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>
7150: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7151: use the same config file, you would set in
7152: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7153: <pre class="programlisting">
1.80 wiz 7154: CONFLICTS= baz-[0-9]*
1.111 sevan 7155: </pre>
1.80 wiz 7156: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7157: <pre class="programlisting">
1.80 wiz 7158: CONFLICTS= bar-[0-9]*
1.111 sevan 7159: </pre>
1.1 dsieger 7160: </div>
1.41 asau 7161: <div class="sect2">
1.1 dsieger 7162: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7163: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7164: <p>There are several reasons why a package might be
7165: instructed to not build under certain circumstances. If the
7166: package builds and runs on most platforms, the exceptions
1.83 dholland 7167: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7168: the package builds and runs on a small handful of platforms,
7169: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7170: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7171: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7172: (OS-version-platform) that can use glob-style
7173: wildcards.</p>
7174: <p>If a package is not appropriate for some platforms (as
1.114 ! maya 7175: opposed to merely broken), a different set of variables should be
1.83 dholland 7176: used as this affects failure reporting and statistics.
7177: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7178: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7179: the package is appropriate for only a small handful of platforms
7180: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7181: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7182: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7183: (OS-version-platform) that can use glob-style
7184: wildcards.</p>
7185: <p>Some packages are tightly bound to a specific version of an
1.79 snj 7186: 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 7187: backwards compatible with other versions of the OS, and should be
7188: uploaded to a version specific directory on the FTP server. Mark
7189: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7190: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7191: the package system internals, but may be used in the
7192: future.</p>
7193: <p>If the package should be skipped (for example, because it
7194: provides functionality already provided by the system), set
7195: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7196: the package should fail because some preconditions are not met,
7197: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7198: message.</p>
7199: </div>
1.41 asau 7200: <div class="sect2">
1.1 dsieger 7201: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7202: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7203: <p>To ensure that a package may not be deleted, once it has been
7204: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7205: be set in the package Makefile. This will be carried into any
7206: binary package that is made from this pkgsrc entry. A
1.23 wiz 7207: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.79 snj 7208: 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 7209: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7210: </div>
1.41 asau 7211: <div class="sect2">
1.1 dsieger 7212: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7213: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7214: <p>When a vulnerability is found, this should be noted in
7215: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7216: and after committing that file, ask pkgsrc-security@NetBSD.org to
7217: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7218: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7219: <code class="varname">PKGREVISION</code> should be increased (this is of
7220: course not necessary if the problem is fixed by using a newer
7221: release of the software), and the pattern in the
7222: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7223: <p>Also, if the fix should be applied to the stable pkgsrc
7224: branch, be sure to submit a pullup request!</p>
7225: <p>Binary packages already on ftp.NetBSD.org will be handled
7226: semi-automatically by a weekly cron job.</p>
7227: </div>
1.41 asau 7228: <div class="sect2">
1.1 dsieger 7229: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7230: <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 7231: <p>When making fixes to an existing package it can be useful
7232: to change the version number in <code class="varname">PKGNAME</code>. To
7233: avoid conflicting with future versions by the original author, a
1.23 wiz 7234: <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 7235: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7236: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7237: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7238: <pre class="programlisting">
7239: DISTNAME= foo-17.42
7240: PKGREVISION= 9
1.111 sevan 7241: </pre>
1.1 dsieger 7242: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7243: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7244: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7245: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7246: <code class="varname">PKGNAME_NOREV</code>.</p>
7247: <p>When a new release of the package is released, the
7248: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7249: minor release of the above package, things should be like:</p>
7250: <pre class="programlisting">
7251: DISTNAME= foo-17.43
1.111 sevan 7252: </pre>
1.1 dsieger 7253: <p><code class="varname">PKGREVISION</code> should be incremented for any
7254: non-trivial change in the resulting binary package. Without a
7255: <code class="varname">PKGREVISION</code> bump, someone with the previous
7256: version installed has no way of knowing that their package is out
7257: of date. Thus, changes without increasing
7258: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7259: trivial that no reasonable person would want to upgrade", and this
7260: is the rough test for when increasing
7261: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7262: changes that do not merit increasing
7263: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7264: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7265: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7266: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7267: or comments in Makefile.</p></li>
1.23 wiz 7268: <li class="listitem"><p>
1.1 dsieger 7269: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7270: <li class="listitem"><p>
1.1 dsieger 7271: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7272: <li class="listitem"><p>
1.1 dsieger 7273: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7274: </ul></div>
7275: <p>Examples of changes that do merit an increase to
7276: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7277: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7278: <li class="listitem"><p>
1.1 dsieger 7279: Security fixes</p></li>
1.23 wiz 7280: <li class="listitem"><p>
1.1 dsieger 7281: Changes or additions to a patch file</p></li>
1.23 wiz 7282: <li class="listitem"><p>
1.1 dsieger 7283: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 7284: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 7285: </ul></div>
7286: <p>PKGREVISION must also be incremented when dependencies have ABI
7287: changes.</p>
7288: </div>
1.41 asau 7289: <div class="sect2">
1.1 dsieger 7290: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7291: <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 7292: <p>When you want to replace the same text in multiple files
7293: or when the replacement text varies, patches alone cannot help.
7294: This is where the SUBST framework comes in. It provides an
7295: easy-to-use interface for replacing text in files.
7296: Example:</p>
7297: <pre class="programlisting">
7298: SUBST_CLASSES+= fix-paths
7299: SUBST_STAGE.fix-paths= pre-configure
7300: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7301: SUBST_FILES.fix-paths= src/*.c
7302: SUBST_FILES.fix-paths+= scripts/*.sh
7303: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7304: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 sevan 7305: </pre>
1.1 dsieger 7306: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7307: that are used to identify the different SUBST blocks that are
7308: defined. The SUBST framework is heavily used by pkgsrc, so it is
7309: important to always use the <code class="literal">+=</code> operator with
7310: this variable. Otherwise some substitutions may be
7311: skipped.</p>
7312: <p>The remaining variables of each SUBST block are
7313: parameterized with the identifier from the first line
7314: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7315: parameters to a function call.</p>
7316: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7317: which the replacement will take place. All combinations of
7318: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7319: <code class="literal">post-</code> together with a phase name are
7320: possible, though only few are actually used. Most commonly used
7321: are <code class="literal">post-patch</code> and
7322: <code class="literal">pre-configure</code>. Of these two,
7323: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7324: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7325: have the state after applying the patches but before making any
7326: other changes. This is especially useful when you are debugging
7327: a package in order to create new patches for it. Similarly,
7328: <code class="literal">post-build</code> is preferred over
7329: <code class="literal">pre-install</code>, because the install phase should
7330: generally be kept as simple as possible. When you use
7331: <code class="literal">post-build</code>, you have the same files in the
7332: working directory that will be installed later, so you can check
7333: if the substitution has succeeded.</p>
7334: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7335: that is printed just before the substitution is done.</p>
7336: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7337: globbing patterns that specifies the files in which the
7338: substitution will take place. The patterns are interpreted
7339: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7340: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.79 snj 7341: <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 7342: command should be prefixed with <code class="literal">-e</code>, so that
7343: all SUBST blocks look uniform.</p>
7344: <p>There are some more variables, but they are so seldomly
7345: used that they are only documented in the
7346: <code class="filename">mk/subst.mk</code> file.</p>
7347: </div>
7348: </div>
1.41 asau 7349: <div class="sect1">
1.1 dsieger 7350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7351: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7352: <div class="sect2">
1.1 dsieger 7353: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7354: <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 7355: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7356: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7357: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7358: with the name of each file to download as an argument, expecting
7359: it to output the URL of the directory from which to download
1.79 snj 7360: 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 7361: example of this usage.</p>
7362: <p>If the download can't be automated, because the user must
7363: submit personal information to apply for a password, or must pay
7364: for the source, or whatever, you can set
7365: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7366: displayed to the user before aborting the build. Example:</p>
7367: <pre class="programlisting">
7368: FETCH_MESSAGE= "Please download the files"
7369: FETCH_MESSAGE+= " "${DISTFILES:Q}
7370: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7371: </pre>
1.1 dsieger 7372: </div>
1.41 asau 7373: <div class="sect2">
1.1 dsieger 7374: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7375: <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 7376: <p>Sometimes authors of a software package make some
7377: modifications after the software was released, and they put up a
7378: new distfile without changing the package's version number. If a
7379: package is already in pkgsrc at that time, the checksum will
7380: no longer match. The contents of the new distfile should be
7381: compared against the old one before changing anything, to make
7382: sure the distfile was really updated on purpose, and that
7383: no trojan horse or so crept in.
7384: Please mention that the distfiles were compared and what was found
1.53 rodent 7385: in your commit message.</p>
1.109 wiz 7386: <p>Then, the correct way to work around this is to set
7387: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7388: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7389: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7390: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7391: <code class="varname">PATCHFILES</code> for this package will be put in that
1.109 wiz 7392: 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 7393: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7394: including the <code class="filename">nbX</code> suffix) or a date stamp can
7395: be appended, like
7396: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53 rodent 7397: <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>
7398: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7399: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7400: path in the filenames.
1.53 rodent 7401: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7402: Furthermore, a mail to the package's authors seems appropriate
7403: telling them that changing distfiles after releases without
7404: changing the file names is not good practice.</p>
7405: </div>
1.88 tnn 7406: <div class="sect2">
7407: <div class="titlepage"><div><div><h3 class="title">
7408: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 7409: <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:
7410: </p>
1.88 tnn 7411: <div class="sect3">
7412: <div class="titlepage"><div><div><h4 class="title">
7413: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
7414: <p>
7415: 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.
7416: </p>
7417: <pre class="programlisting">
7418: DISTNAME= exampleproject-1.0
1.90 tnn 7419: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7420: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7421: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7422: EXTRACT_SUFX= .zip
7423: </pre>
7424: </div>
7425: <div class="sect3">
7426: <div class="titlepage"><div><div><h4 class="title">
7427: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
7428: <p>
7429: 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.
7430: </p>
7431: <pre class="programlisting">
7432: DISTNAME= example-1.0
1.107 jnemeth 7433: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7434: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7435: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7436: </pre>
1.88 tnn 7437: </div>
7438: <div class="sect3">
7439: <div class="titlepage"><div><div><h4 class="title">
7440: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
7441: <p>
7442: 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.
7443: </p>
7444: <pre class="programlisting">
7445: DISTNAME= offensive-1.6
1.90 tnn 7446: PKGNAME= ${DISTNAME:S/offensive/proper/}
7447: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7448: GITHUB_PROJECT= exampleproject
7449: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7450: EXTRACT_SUFX= .zip
1.111 sevan 7451: </pre>
1.88 tnn 7452: </div>
7453: </div>
1.1 dsieger 7454: </div>
1.41 asau 7455: <div class="sect1">
1.1 dsieger 7456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7457: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7458: <div class="sect2">
1.1 dsieger 7459: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7460: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7461: <p>pkgsrc supports many different machines, with different
7462: object formats like a.out and ELF, and varying abilities to do
7463: shared library and dynamic loading at all. To accompany this,
7464: varying commands and options have to be passed to the
7465: compiler, linker, etc. to get the Right Thing, which can be
7466: pretty annoying especially if you don't have all the machines
7467: at your hand to test things. The
1.79 snj 7468: <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 7469: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7470: both static and dynamic libraries from a set of source files,
7471: thus being platform-independent.</p>
7472: <p>Here's how to use libtool in a package in seven simple
7473: steps:</p>
1.23 wiz 7474: <div class="orderedlist"><ol class="orderedlist" type="1">
7475: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7476: Makefile.</p></li>
1.23 wiz 7477: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7478: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7479: add it to the definition of <code class="varname">CC</code>, if only
7480: libraries are being built in a given Makefile. This one command
7481: will build both PIC and non-PIC library objects, so you need not
7482: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7483: <li class="listitem">
1.1 dsieger 7484: <p>For the linking of the library, remove any
1.23 wiz 7485: <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
7486: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7487: <pre class="programlisting">
7488: ${LIBTOOL} --mode=link \
7489: ${CC} -o ${.TARGET:.a=.la} \
7490: ${OBJS:.o=.lo} \
7491: -rpath ${PREFIX}/lib \
7492: -version-info major:minor
1.111 sevan 7493: </pre>
1.1 dsieger 7494: <p>Note that the library is changed to have a
7495: <code class="filename">.la</code> extension, and the objects are
7496: changed to have a <code class="filename">.lo</code>
7497: extension. Change <code class="varname">OBJS</code> as
7498: necessary. This automatically creates all of the
7499: <code class="filename">.a</code>,
7500: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7501: necessary) in the build directory. Be sure to include
1.23 wiz 7502: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7503: minor are zero, as libtool will otherwise strip off the
7504: shared library version.</p>
7505: <p>From the libtool manual:</p>
7506: <pre class="programlisting">
7507: So, libtool library versions are described by three integers:
7508:
7509: CURRENT
7510: The most recent interface number that this library implements.
7511:
7512: REVISION
7513: The implementation number of the CURRENT interface.
7514:
7515: AGE
7516: The difference between the newest and oldest interfaces that
7517: this library implements. In other words, the library implements
7518: all the interface numbers in the range from number `CURRENT -
7519: AGE' to `CURRENT'.
7520:
7521: If two libraries have identical CURRENT and AGE numbers, then the
7522: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 7523: </pre>
1.23 wiz 7524: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7525: different results for a.out and ELF (excluding symlinks)
7526: in only one case. An ELF library of the form
1.23 wiz 7527: <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 7528: will have a symlink of
1.23 wiz 7529: <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 7530: on an a.out platform. This is handled
7531: automatically.</p>
1.23 wiz 7532: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7533: directory of the library being built.</p>
7534: <p>In the <code class="filename">PLIST</code>, include only the
7535: <code class="filename">.la</code> file, the other files will be
7536: added automatically.</p>
7537: </li>
1.23 wiz 7538: <li class="listitem">
1.1 dsieger 7539: <p>When linking shared object (<code class="filename">.so</code>)
1.79 snj 7540: 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 7541: shared libraries, use <span class="quote">“<span class="quote">-module
7542: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7543: tacked on.</p>
7544: <p>The <code class="filename">PLIST</code> file gets the
7545: <code class="filename">foo.so</code> entry.</p>
7546: </li>
1.23 wiz 7547: <li class="listitem">
1.1 dsieger 7548: <p>When linking programs that depend on these libraries
7549: <span class="emphasis"><em>before</em></span> they are installed, preface
1.79 snj 7550: 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 7551: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7552: libraries (static or shared), but please be aware that
7553: libtool will not allow you to specify a relative path in
1.23 wiz 7554: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7555: expects you to change that argument to be the
7556: <code class="filename">.la</code> file. e.g.</p>
7557: <pre class="programlisting">
7558: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 7559: </pre>
1.1 dsieger 7560: <p>should be changed to:</p>
7561: <pre class="programlisting">
7562: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 7563: </pre>
1.1 dsieger 7564: <p>and it will do the right thing with the libraries.</p>
7565: </li>
1.23 wiz 7566: <li class="listitem">
1.79 snj 7567: <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>
7568: 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 7569: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7570: <code class="filename">.la</code>. e.g.</p>
7571: <pre class="programlisting">
1.22 jakllsch 7572: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 7573: </pre>
1.1 dsieger 7574: <p>This will install the static <code class="filename">.a</code>,
7575: shared library, any needed symlinks, and run
1.79 snj 7576: <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 7577: </li>
1.23 wiz 7578: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7579: the <code class="filename">.la</code>
7580: file (this is a change from previous behaviour).</p></li>
7581: </ol></div>
7582: </div>
1.41 asau 7583: <div class="sect2">
1.1 dsieger 7584: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7585: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7586: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7587: package Makefile. This will override the package's own libtool
7588: in most cases. For older libtool using packages, libtool is
7589: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7590: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7591: configure; find work*/ -name libtool</strong></span>.</p>
7592: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7593: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7594: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7595: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7596: package's libtool script(s), set it as appropriate.</p>
7597: <p>If you do not need <code class="filename">*.a</code> static
7598: libraries built and installed, then use
7599: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7600: <p>If your package makes use of the platform-independent library
7601: for loading dynamic shared objects, that comes with libtool
7602: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7603: <p>Some packages use libtool incorrectly so that the package
7604: may not work or build in some circumstances. Some of the more
7605: common errors are:</p>
1.41 asau 7606: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7607: <li class="listitem">
1.1 dsieger 7608: <p>The inclusion of a shared object (-module) as a dependent library in an
7609: executable or library. This in itself isn't a problem if one of two things
7610: has been done:</p>
1.23 wiz 7611: <div class="orderedlist"><ol class="orderedlist" type="1">
7612: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7613: <code class="filename">libfoo.la</code>, not
7614: <code class="filename">foo.la</code></p></li>
1.23 wiz 7615: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7616: </ol></div>
7617: </li>
1.23 wiz 7618: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7619: The function lt_dlinit() should be called and the macro
7620: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7621: executables.</p></li>
7622: </ul></div>
7623: </div>
1.41 asau 7624: <div class="sect2">
1.1 dsieger 7625: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7626: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7627: <p>If a package needs GNU autoconf or automake to be executed
7628: to regenerate the configure script and Makefile.in makefile
7629: templates, then they should be executed in a pre-configure
7630: target.</p>
7631: <p>For packages that need only autoconf:</p>
7632: <pre class="programlisting">
7633: AUTOCONF_REQD= 2.50 # if default version is not good enough
7634: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7635: ...
7636:
7637: pre-configure:
7638: cd ${WRKSRC} && autoconf
7639:
7640: ...
1.111 sevan 7641: </pre>
1.1 dsieger 7642: <p>and for packages that need automake and autoconf:</p>
7643: <pre class="programlisting">
7644: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7645: USE_TOOLS+= automake # use "automake14" for automake-1.4
7646: ...
7647:
7648: pre-configure:
7649: set -e; cd ${WRKSRC}; \
7650: aclocal; autoheader; automake -a --foreign -i; autoconf
7651:
7652: ...
1.111 sevan 7653: </pre>
1.1 dsieger 7654: <p>Packages which use GNU Automake will almost certainly
7655: require GNU Make.</p>
7656: <p>There are times when the configure process makes
7657: additional changes to the generated files, which then causes
7658: the build process to try to re-execute the automake sequence.
7659: This is prevented by touching various files in the configure
7660: stage. If this causes problems with your package you can set
7661: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7662: Makefile.</p>
7663: </div>
7664: </div>
1.41 asau 7665: <div class="sect1">
1.1 dsieger 7666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7667: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 7668: <div class="sect2">
1.1 dsieger 7669: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7670: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7671: <p>Compilers for the C, C++, and Fortran languages comes with
7672: the NetBSD base system. By default, pkgsrc assumes that a package
7673: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 7674: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7675: <p>To declare which language's compiler a package needs, set
7676: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7677: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7678: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7679: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7680: written in C++, usually need a C compiler for the configure
7681: phase.</p>
7682: </div>
1.41 asau 7683: <div class="sect2">
1.1 dsieger 7684: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7685: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 7686: <p>If a program is written in Java, use the Java framework in
7687: pkgsrc. The package must include
7688: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7689: provides the following variables:</p>
1.41 asau 7690: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7691: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7692: dependency on the JDK is added. If
1.23 wiz 7693: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7694: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7695: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7696: JDK.</p></li>
1.23 wiz 7697: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7698: a package needs a Java2 implementation. The supported values
1.23 wiz 7699: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7700: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7701: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7702: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7703: above. This variable is not set by default.</p></li>
1.24 wiz 7704: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7705: automatically set to the runtime location of the used Java
7706: implementation dependency. It may be used to set
7707: <code class="varname">JAVA_HOME</code> to a good value if the program
7708: needs this variable to be defined.
7709: </p></li>
1.1 dsieger 7710: </ul></div>
7711: </div>
1.41 asau 7712: <div class="sect2">
1.1 dsieger 7713: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7714: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7715: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7716: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7717: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7718: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7719: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7720: that you want adjusted. Every occurrence of
7721: <code class="filename">*/bin/perl</code> in a she-bang line will be
7722: replaced with the full path to the perl executable.</p>
1.1 dsieger 7723: <p>If a particular version of perl is needed, set the
7724: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7725: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 7726: <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 7727: about handling perl modules.</p>
7728: </div>
1.41 asau 7729: <div class="sect2">
1.1 dsieger 7730: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 7731: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
7732: <p><code class="varname">REPLACE_SH</code>,
7733: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7734: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7735: hash bangs in files. Please use the appropriate one, prefering
7736: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7737: Each should contain a list of scripts, relative to
7738: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7739: occurrence of the matching shell in a she-bang line will be
7740: replaced with the full path to the shell executable.
1.40 wiz 7741: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7742: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7743: </div>
1.41 asau 7744: <div class="sect2">
1.40 wiz 7745: <div class="titlepage"><div><div><h3 class="title">
7746: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7747: <p>Currently, there is no special handling for other languages
7748: in pkgsrc. If a compiler package provides a
7749: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7750: just add a (build) dependency on the appropriate compiler
7751: package.</p>
7752: </div>
7753: </div>
1.41 asau 7754: <div class="sect1">
1.1 dsieger 7755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7756: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7757: <p>The most common failures when building a package are that
7758: some platforms do not provide certain header files, functions or
7759: libraries, or they provide the functions in a library that the
7760: original package author didn't know. To work around this, you
7761: can rewrite the source code in most cases so that it does not
7762: use the missing functions or provides a replacement function.</p>
1.41 asau 7763: <div class="sect2">
1.1 dsieger 7764: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7765: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7766: <p>If a package already comes with a GNU configure script, the
7767: preferred way to fix the build failure is to change the
7768: configure script, not the code. In the other cases, you can
7769: utilize the C preprocessor, which defines certain macros
7770: depending on the operating system and hardware architecture it
7771: compiles for. These macros can be queried using for example
7772: <code class="varname">#if defined(__i386)</code>. Almost every operating
7773: system, hardware architecture and compiler has its own macro.
7774: For example, if the macros <code class="varname">__GNUC__</code>,
7775: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7776: are all defined, you know that you are using NetBSD on an i386
7777: compatible CPU, and your compiler is GCC.</p>
7778: <p>The list of the following macros for hardware and
7779: operating system depends on the compiler that is used. For
7780: example, if you want to conditionally compile code on Solaris,
7781: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7782: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7783: <div class="sect3">
1.1 dsieger 7784: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7785: <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 7786: <p>To distinguish between 4.4 BSD-derived systems and the
7787: rest of the world, you should use the following code.</p>
7788: <pre class="programlisting">
7789: #include <sys/param.h>
7790: #if (defined(BSD) && BSD >= 199306)
7791: /* BSD-specific code goes here */
7792: #else
7793: /* non-BSD-specific code goes here */
7794: #endif
7795: </pre>
7796: <p>If this distinction is not fine enough, you can also test
7797: for the following macros.</p>
7798: <pre class="programlisting">
1.45 obache 7799: Cygwin __CYGWIN__
7800: DragonFly __DragonFly__
1.1 dsieger 7801: FreeBSD __FreeBSD__
1.45 obache 7802: Haiku __HAIKU__
1.1 dsieger 7803: Interix __INTERIX
7804: IRIX __sgi (TODO: get a definite source for this)
7805: Linux linux, __linux, __linux__
1.83 dholland 7806: Mac OS X __APPLE__
1.45 obache 7807: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7808: Minix3 __minix
1.1 dsieger 7809: NetBSD __NetBSD__
7810: OpenBSD __OpenBSD__
7811: Solaris sun, __sun
7812: </pre>
7813: </div>
1.41 asau 7814: <div class="sect3">
1.1 dsieger 7815: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7816: <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 7817: <pre class="programlisting">
7818: i386 i386, __i386, __i386__
7819: MIPS __mips
7820: SPARC sparc, __sparc
7821: </pre>
7822: </div>
1.41 asau 7823: <div class="sect3">
1.1 dsieger 7824: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7825: <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 7826: <pre class="programlisting">
7827: GCC __GNUC__ (major version), __GNUC_MINOR__
7828: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7829: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7830: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7831: </pre>
7832: </div>
7833: </div>
1.41 asau 7834: <div class="sect2">
1.1 dsieger 7835: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7836: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 7837: <p>Some source files trigger bugs in the compiler, based on
7838: combinations of compiler version and architecture and almost
7839: always relation to optimisation being enabled. Common symptoms
7840: are gcc internal errors or never finishing compiling a
7841: file.</p>
7842: <p>Typically, a workaround involves testing the
7843: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7844: optimisation for that combination of file,
1.87 tnn 7845: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7846: <p>This used to be a big problem in the past, but is rarely
7847: needed now as compiler technology has matured. If you still need
7848: to add a compiler specific workaround, please do so in the file
7849: <code class="filename">hacks.mk</code> and describe the symptom and
7850: compiler version as detailed as possible.</p>
1.1 dsieger 7851: </div>
1.41 asau 7852: <div class="sect2">
1.1 dsieger 7853: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 7854: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
7855: </h3></div></div></div>
1.1 dsieger 7856: <p>This error message often means that a package did not
7857: link to a shared library it needs. The following functions are
7858: known to cause this error message over and over.</p>
7859: <div class="informaltable">
1.106 tnn 7860: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 7861: <colgroup>
7862: <col>
7863: <col>
7864: <col>
7865: </colgroup>
7866: <thead><tr>
7867: <th>Function</th>
7868: <th>Library</th>
7869: <th>Affected platforms</th>
7870: </tr></thead>
7871: <tbody>
7872: <tr>
7873: <td>accept, bind, connect</td>
7874: <td>-lsocket</td>
7875: <td>Solaris</td>
7876: </tr>
7877: <tr>
7878: <td>crypt</td>
7879: <td>-lcrypt</td>
7880: <td>DragonFly, NetBSD</td>
7881: </tr>
7882: <tr>
7883: <td>dlopen, dlsym</td>
7884: <td>-ldl</td>
7885: <td>Linux</td>
7886: </tr>
7887: <tr>
7888: <td>gethost*</td>
7889: <td>-lnsl</td>
7890: <td>Solaris</td>
7891: </tr>
7892: <tr>
7893: <td>inet_aton</td>
7894: <td>-lresolv</td>
7895: <td>Solaris</td>
7896: </tr>
7897: <tr>
7898: <td>nanosleep, sem_*, timer_*</td>
7899: <td>-lrt</td>
7900: <td>Solaris</td>
7901: </tr>
7902: <tr>
7903: <td>openpty</td>
7904: <td>-lutil</td>
7905: <td>Linux</td>
7906: </tr>
7907: </tbody>
7908: </table>
7909: </div>
7910: <p>To fix these linker errors, it is often sufficient to say
7911: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
7912: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 7913: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 7914: bmake</strong></span>.</p>
1.41 asau 7915: <div class="sect3">
1.1 dsieger 7916: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7917: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 7918: <p>When you are using the SunPro compiler, there is another
7919: possibility. That compiler cannot handle the following code:</p>
7920: <pre class="programlisting">
7921: extern int extern_func(int);
7922:
7923: static inline int
7924: inline_func(int x)
7925: {
7926: return extern_func(x);
7927: }
7928:
7929: int main(void)
7930: {
7931: return 0;
7932: }
7933: </pre>
7934: <p>It generates the code for <code class="function">inline_func</code> even if
7935: that function is never used. This code then refers to
7936: <code class="function">extern_func</code>, which can usually not be resolved. To
7937: solve this problem you can try to tell the package to disable inlining
7938: of functions.</p>
7939: </div>
7940: </div>
1.41 asau 7941: <div class="sect2">
1.1 dsieger 7942: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7943: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 7944: <p>Sometimes packages fail to build because the compiler runs
7945: into an operating system specific soft limit. With the
7946: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 7947: to unlimit the resources. Currently, the allowed values are any combination of
7948: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
7949: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 7950: Setting this variable is similar to running the shell builtin
1.10 hubertf 7951: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 7952: segment size or maximum stack size of a process, respectively, to
7953: their hard limits.</p>
7954: </div>
7955: </div>
1.41 asau 7956: <div class="sect1">
1.1 dsieger 7957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7958: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 7959: <div class="sect2">
1.1 dsieger 7960: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7961: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 7962: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 7963: with some operating systems cannot create more than one
7964: directory at a time. As such, you should call
7965: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
7966: <pre class="programlisting">
7967: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7968: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 7969: </pre>
1.23 wiz 7970: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
7971: dir2</code></span>”</span> to the
1.1 dsieger 7972: <code class="varname">INSTALLATION_DIRS</code> variable, which will
7973: automatically do the right thing.</p>
7974: </div>
1.41 asau 7975: <div class="sect2">
1.1 dsieger 7976: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7977: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 7978: <p>In general, documentation should be installed into
7979: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7980: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
7981: includes the version number of the package).</p>
7982: <p>Many modern packages using GNU autoconf allow to set the
7983: directory where HTML documentation is installed with the
1.23 wiz 7984: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 7985: is needed because otherwise the documentation ends up in
7986: <code class="filename">${PREFIX}/share/doc/html</code> or other
7987: places.</p>
7988: <p>An exception to the above is that library API documentation
1.79 snj 7989: 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 7990: browsers (devhelp) should be left at their default location, which
7991: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
7992: documentation can be recognized from files ending in
7993: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
7994: (It is also acceptable to install such files in
7995: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7996: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
7997: <code class="filename">.devhelp*</code> file must be directly in that
7998: directory then, no additional subdirectory level is allowed in
7999: this case. This is usually achieved by using
1.23 wiz 8000: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8001: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8002: though.)</p>
8003: </div>
1.41 asau 8004: <div class="sect2">
1.1 dsieger 8005: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8006: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8007: <p>Certain packages, most of them in the games category, install
8008: a score file that allows all users on the system to record their
8009: highscores. In order for this to work, the binaries need to be
8010: installed setgid and the score files owned by the appropriate
1.35 wiz 8011: group and/or owner (traditionally the "games" user/group). Set
8012: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8013: following variables, documented in more detail in
8014: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8015: behaviour: <code class="varname">GAMEDATAMODE</code>,
8016: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8017: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8018: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8019: <code class="varname">GAMEDATA_PERMS</code> and
8020: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8021: <p>An example that illustrates some of the variables described above is
8022: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8023: used to properly set directory permissions of the directory where the
8024: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8025: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8026: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8027: binary:</p>
8028: <pre class="programlisting">
1.112 rillig 8029: USE_GAMESGROUP= yes
1.100 leot 8030:
1.112 rillig 8031: BUILD_DEFS+= VARBASE
1.100 leot 8032:
1.112 rillig 8033: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8034: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8035: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8036: </pre>
1.100 leot 8037: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8038: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8039: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8040: needed to be accessed by setgid games and
8041: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8042: <p>A package should therefore never hard code file ownership or
1.100 leot 8043: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8044: or alternatively on <code class="varname">INSTALL_GAME</code>,
8045: <code class="varname">INSTALL_GAME_DATA</code> and
8046: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8047: </div>
1.41 asau 8048: <div class="sect2">
1.1 dsieger 8049: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8050: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8051: <p><code class="varname">DESTDIR</code> support means that a package
8052: installs into a staging directory, not the final location of the
8053: files. Then a binary package is created which can be used for
8054: installation as usual. There are two ways: Either the package must
1.23 wiz 8055: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8056: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8057: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8058: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8059: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8060: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8061: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8062: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8063: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8064: the inclusion.</p></li>
1.23 wiz 8065: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8066: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8067: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8068: automatically. Many manual rules and pre/post-install often are
8069: incorrect; fix them.</p></li>
1.23 wiz 8070: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8071: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8072: <li class="listitem"><p>In general, packages should support
1.4 rillig 8073: <code class="varname">UNPRIVILEGED</code> to be able to use
8074: DESTDIR.</p></li>
8075: </ul></div>
8076: </div>
1.41 asau 8077: <div class="sect2">
1.4 rillig 8078: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8079: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8080: <p>Your package may also contain scripts with hardcoded paths to
8081: other interpreters besides (or as well as) perl. To correct the
8082: full pathname to the script interpreter, you need to set the
8083: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8084: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8085: <pre class="programlisting">
8086: REPLACE_INTERPRETER+= tcl
8087: REPLACE.tcl.old= .*/bin/tclsh
8088: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8089: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8090: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8091: </pre>
1.41 asau 8092: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8093: <h3 class="title">Note</h3>
8094: <p>Before March 2006, these variables were called
8095: <code class="varname">_REPLACE.*</code> and
8096: <code class="varname">_REPLACE_FILES.*</code>.</p>
8097: </div>
8098: </div>
1.41 asau 8099: <div class="sect2">
1.1 dsieger 8100: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8101: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8102: <p>Makefiles of packages providing perl5 modules should include
8103: the Makefile fragment
8104: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8105: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8106: configuration for such modules as well as various hooks to tune
8107: this configuration. See comments in this file for
8108: details.</p>
8109: <p>Perl5 modules will install into different places depending
8110: on the version of perl used during the build process. To
8111: address this, pkgsrc will append lines to the
8112: <code class="filename">PLIST</code> corresponding to the files listed in
8113: the installed <code class="filename">.packlist</code> file generated by
8114: most perl5 modules. This is invoked by defining
8115: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8116: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8117: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8118: e.g.:</p>
1.1 dsieger 8119: <pre class="programlisting">
1.47 wiz 8120: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8121: </pre>
1.47 wiz 8122: <p>The perl5 config variables
8123: <code class="varname">installarchlib</code>,
8124: <code class="varname">installscript</code>,
8125: <code class="varname">installvendorbin</code>,
8126: <code class="varname">installvendorscript</code>,
8127: <code class="varname">installvendorarch</code>,
8128: <code class="varname">installvendorlib</code>,
8129: <code class="varname">installvendorman1dir</code>, and
8130: <code class="varname">installvendorman3dir</code> represent those
8131: locations in which components of perl5 modules may be installed,
8132: provided as variable with uppercase and prefixed with
8133: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8134: and may be used by perl5 packages that don't have a packlist.
8135: These variables are also substituted for in the
8136: <code class="filename">PLIST</code> as uppercase prefixed with
8137: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8138: </div>
1.41 asau 8139: <div class="sect2">
1.1 dsieger 8140: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8141: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8142: <p>Some packages install info files or use the
1.23 wiz 8143: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8144: commands. <code class="varname">INFO_FILES</code> should be defined in
8145: the package Makefile so that <code class="filename">INSTALL</code> and
8146: <code class="filename">DEINSTALL</code> scripts will be generated to
8147: handle registration of the info files in the Info directory
1.23 wiz 8148: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8149: files registration is either provided by the system, or by a
8150: special purpose package automatically added as dependency if
8151: needed.</p>
8152: <p><code class="varname">PKGINFODIR</code> is the directory under
8153: <code class="filename">${PREFIX}</code> where info files are primarily
8154: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8155: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8156: <p>The info files for the package should be listed in the
8157: package <code class="filename">PLIST</code>; however any split info files
8158: need not be listed.</p>
1.23 wiz 8159: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8160: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8161: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8162: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8163: should be noted with the <code class="varname">TEXINFO_REQD</code>
8164: variable in the package <code class="filename">Makefile</code>. By
8165: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8166: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8167: does not match the required minimum, a build dependency on the
1.79 snj 8168: <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 8169: be added automatically.</p>
8170: <p>The build and installation process of the software provided
8171: by the package should not use the
1.10 hubertf 8172: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8173: info files is the task of the package
8174: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8175: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8176: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8177: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8178: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8179: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8180: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8181: no effect except the logging of a message. The script overriding
1.10 hubertf 8182: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8183: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8184: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8185: </div>
1.41 asau 8186: <div class="sect2">
1.1 dsieger 8187: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8188: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8189: <p>All packages that install manual pages should install them
8190: into the same directory, so that there is one common place to look
8191: for them. In pkgsrc, this place is
8192: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8193: should be used in packages. The default for
8194: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8195: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8196: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8197: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8198: <h3 class="title">Note</h3>
8199: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8200: is far from complete.</p>
8201: </div>
8202: <p>The <code class="filename">PLIST</code> files can just use
8203: <code class="filename">man/</code> as the top level directory for the man
8204: page file entries, and the pkgsrc framework will convert as
8205: needed. In all other places, the correct
8206: <code class="varname">PKGMANDIR</code> must be used.</p>
8207: <p>Packages that are
8208: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8209: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8210: <code class="filename">./configure</code>
8211: --mandir switch to set where the man pages should be installed.
8212: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8213: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8214: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8215: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8216: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8217: Or if the <code class="filename">./configure</code> script uses
8218: a non-standard use of --mandir, you can set
8219: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8220: <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 8221: information on installation of compressed manual pages.</p>
8222: </div>
1.41 asau 8223: <div class="sect2">
1.1 dsieger 8224: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8225: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8226: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8227: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8228: you need to take some extra steps to make sure they get registered
8229: in the database:</p>
1.23 wiz 8230: <div class="orderedlist"><ol class="orderedlist" type="1">
8231: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8232: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8233: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8234: deinstallation time, and tells the package where to install
1.7 rillig 8235: GConf data files using some standard configure arguments. It
1.1 dsieger 8236: also disallows any access to the database directly from the
8237: package.</p></li>
1.23 wiz 8238: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8239: <code class="filename">.schemas</code> files under
8240: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8241: installed under <code class="filename">${PREFIX}/etc</code>, you will
8242: need to manually patch the package.</p></li>
1.23 wiz 8243: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8244: directory, as they will be handled automatically. See
1.84 wiz 8245: <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 8246: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8247: your <code class="filename">Makefile</code> with a list of all
8248: <code class="filename">.schemas</code> files installed by the package, if
8249: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8250: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8251: your <code class="filename">Makefile</code> with a
8252: list of all <code class="filename">.entries</code> files installed by the
8253: package, if any. Names must not contain any directories in
8254: them.</p></li>
8255: </ol></div>
8256: </div>
1.41 asau 8257: <div class="sect2">
1.1 dsieger 8258: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8259: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8260: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8261: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8262: get registered in the database:</p>
1.23 wiz 8263: <div class="orderedlist"><ol class="orderedlist" type="1">
8264: <li class="listitem"><p>Include
1.18 snj 8265: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8266: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8267: takes care of rebuilding the scrollkeeper database at
8268: installation and deinstallation time, and disallows any access
8269: to it directly from the package.</p></li>
1.23 wiz 8270: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8271: <code class="filename">libdata/scrollkeeper</code> directory, as they
8272: will be handled automatically.</p></li>
1.23 wiz 8273: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8274: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8275: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8276: </ol></div>
8277: </div>
1.41 asau 8278: <div class="sect2">
1.1 dsieger 8279: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8280: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8281: <p>If a package installs font files, you will need to rebuild
8282: the fonts database in the directory where they get installed at
8283: installation and deinstallation time. This can be automatically
8284: done by using the pkginstall framework.</p>
8285: <p>You can list the directories where fonts are installed in the
8286: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8287: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8288: <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 8289: Also make sure that the database file
8290: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8291: <p>Note that you should not create new directories for fonts;
8292: instead use the standard ones to avoid that the user needs to
8293: manually configure his X server to find them.</p>
8294: </div>
1.41 asau 8295: <div class="sect2">
1.1 dsieger 8296: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8297: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8298: <p>If a package installs GTK2 immodules or loaders, you need to
8299: take some extra steps to get them registered in the GTK2 database
8300: properly:</p>
1.23 wiz 8301: <div class="orderedlist"><ol class="orderedlist" type="1">
8302: <li class="listitem"><p>Include
1.1 dsieger 8303: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8304: <code class="filename">buildlink3.mk</code> file. This takes care of
8305: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8306: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8307: your package installs GTK2 immodules.</p></li>
1.23 wiz 8308: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8309: GTK2 loaders.</p></li>
1.23 wiz 8310: <li class="listitem">
1.1 dsieger 8311: <p>Patch the package to not touch any of the GTK2
8312: databases directly. These are:</p>
1.41 asau 8313: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8314: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8315: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8316: </ul></div>
8317: </li>
1.23 wiz 8318: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8319: any entries under the <code class="filename">libdata/gtk-2.0</code>
8320: directory, as they will be handled automatically.</p></li>
8321: </ol></div>
8322: </div>
1.41 asau 8323: <div class="sect2">
1.1 dsieger 8324: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8325: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8326: <p>If a package installs SGML or XML data files that need to be
8327: registered in system-wide catalogs (like DTDs, sub-catalogs,
8328: etc.), you need to take some extra steps:</p>
1.23 wiz 8329: <div class="orderedlist"><ol class="orderedlist" type="1">
8330: <li class="listitem"><p>Include
1.1 dsieger 8331: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8332: your <code class="filename">Makefile</code>, which takes care of
8333: registering those files in system-wide catalogs at
8334: installation and deinstallation time.</p></li>
1.23 wiz 8335: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8336: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8337: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8338: any XML catalogs installed by the package.</p></li>
1.23 wiz 8339: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8340: to be added to the SGML catalog. These come in groups of
8341: three strings; see xmlcatmgr(1) for more information
8342: (specifically, arguments recognized by the 'add' action).
8343: Note that you will normally not use this variable.</p></li>
1.23 wiz 8344: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8345: to be added to the XML catalog. These come in groups of three
8346: strings; see xmlcatmgr(1) for more information (specifically,
8347: arguments recognized by the 'add' action). Note that you will
8348: normally not use this variable.</p></li>
8349: </ol></div>
8350: </div>
1.41 asau 8351: <div class="sect2">
1.1 dsieger 8352: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8353: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8354: <p>If a package provides extensions to the MIME database by
8355: installing <code class="filename">.xml</code> files inside
8356: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8357: need to take some extra steps to ensure that the database is kept
8358: consistent with respect to these new files:</p>
1.23 wiz 8359: <div class="orderedlist"><ol class="orderedlist" type="1">
8360: <li class="listitem"><p>Include
1.1 dsieger 8361: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8362: (avoid using the <code class="filename">buildlink3.mk</code> file from
8363: this same directory, which is reserved for inclusion from
8364: other <code class="filename">buildlink3.mk</code> files). It takes
8365: care of rebuilding the MIME database at installation and
8366: deinstallation time, and disallows any access to it directly
8367: from the package.</p></li>
1.23 wiz 8368: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8369: <code class="filename">share/mime</code> directory,
8370: <span class="emphasis"><em>except</em></span> for files saved under
8371: <code class="filename">share/mime/packages</code>. The former are
8372: handled automatically by
8373: the update-mime-database program, but the latter are
8374: package-dependent and must be removed by the package that
8375: installed them in the first place.</p></li>
1.23 wiz 8376: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8377: from the PLIST. They will be handled by the shared-mime-info
8378: package.</p></li>
8379: </ol></div>
8380: </div>
1.41 asau 8381: <div class="sect2">
1.1 dsieger 8382: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8383: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8384: <p>If a package uses intltool during its build, add
8385: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8386: which forces it to use the intltool package provided by pkgsrc,
8387: instead of the one bundled with the distribution file.</p>
8388: <p>This tracks intltool's build-time dependencies and uses the
8389: latest available version; this way, the package benefits of any
8390: bug fixes that may have appeared since it was released.</p>
8391: </div>
1.41 asau 8392: <div class="sect2">
1.1 dsieger 8393: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8394: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8395: <p>If a package contains a rc.d script, it won't be copied into
8396: the startup directory by default, but you can enable it, by adding
8397: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8398: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8399: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8400: it will automatically remove the scripts when the package is
8401: deinstalled.</p>
8402: </div>
1.41 asau 8403: <div class="sect2">
1.1 dsieger 8404: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8405: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8406: <p>If a package installs TeX packages into the texmf tree,
8407: the <code class="filename">ls-R</code> database of the tree needs to be
8408: updated.</p>
1.41 asau 8409: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8410: <h3 class="title">Note</h3>
1.22 jakllsch 8411: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8412: packages should install files
1.22 jakllsch 8413: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8414: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8415: </div>
1.23 wiz 8416: <div class="orderedlist"><ol class="orderedlist" type="1">
8417: <li class="listitem"><p>Include
1.22 jakllsch 8418: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8419: takes care of rebuilding the <code class="filename">ls-R</code>
8420: database at installation and deinstallation time.</p></li>
1.23 wiz 8421: <li class="listitem">
1.1 dsieger 8422: <p>If your package installs files into a texmf
8423: tree other than the one
1.22 jakllsch 8424: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8425: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8426: trees that need database update.</p>
8427: <p>If your package also installs font map files that need
1.10 hubertf 8428: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8429: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8430: set <code class="varname">TEX_MAP_FILES</code> and/or
8431: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8432: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8433: be run automatically at installation/deinstallation to
8434: enable/disable font map files for TeX output
8435: drivers.</p>
8436: </li>
1.23 wiz 8437: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8438: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8439: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8440: </ol></div>
8441: </div>
1.41 asau 8442: <div class="sect2">
1.1 dsieger 8443: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8444: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 8445: emulation</h3></div></div></div>
8446: <p>There are some packages that provide libraries and
8447: executables for running binaries from a one operating system
8448: on a different one (if the latter supports it). One example
8449: is running Linux binaries on NetBSD.</p>
1.79 snj 8450: <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 8451: helps in extracting and packaging Linux rpm packages.</p>
8452: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8453: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8454: if all libraries for each installed executable can be found by
8455: the dynamic linker. Since the standard dynamic linker is run,
8456: this fails for emulation packages, because the libraries used
8457: by the emulation are not in the standard directories.</p>
8458: </div>
1.41 asau 8459: <div class="sect2">
1.1 dsieger 8460: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8461: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8462: <p>If a package installs images under the
8463: <code class="filename">share/icons/hicolor</code> and/or updates the
8464: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8465: database, you need to take some extra steps to make sure that the
8466: shared theme directory is handled appropriately and that the cache
8467: database is rebuilt:</p>
1.23 wiz 8468: <div class="orderedlist"><ol class="orderedlist" type="1">
8469: <li class="listitem"><p>Include
1.1 dsieger 8470: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8471: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8472: entry that refers to the theme cache.</p></li>
1.23 wiz 8473: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8474: directories from the <code class="filename">share/icons/hicolor</code>
8475: hierarchy because they will be handled automatically.</p></li>
8476: </ol></div>
8477: <p>The best way to verify that the PLIST is correct with
8478: respect to the last two points is to regenerate it using
1.10 hubertf 8479: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8480: </div>
1.41 asau 8481: <div class="sect2">
1.1 dsieger 8482: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8483: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8484: <p>If a package installs <code class="filename">.desktop</code> files
8485: under <code class="filename">share/applications</code> and these include
1.53 rodent 8486: MIME information (MimeType key), you need to take extra steps to
8487: ensure that they are registered into the MIME database:</p>
1.23 wiz 8488: <div class="orderedlist"><ol class="orderedlist" type="1">
8489: <li class="listitem"><p>Include
1.1 dsieger 8490: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8491: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8492: <code class="filename">share/applications/mimeinfo.cache</code> file.
8493: It will be handled automatically.</p></li>
8494: </ol></div>
8495: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8496: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8497: print-PLIST</strong></span>.</p>
8498: </div>
8499: </div>
1.41 asau 8500: <div class="sect1">
1.1 dsieger 8501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8502: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8503: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8504: immediately. In this case, one can plainly mark a package as broken. For
8505: this, one just sets the variable <code class="varname">BROKEN</code> to the
8506: reason why the package is broken (similar to the
8507: <code class="varname">RESTRICTED</code> variable). A user trying to build
8508: the package will immediately be shown this message, and the build
8509: will not be even tried.</p>
8510: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8511: intervals.</p>
8512: </div>
8513: </div>
1.41 asau 8514: <div class="chapter">
1.1 dsieger 8515: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8516: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 8517: <p>To check out all the gotchas when building a package, here are
8518: the steps that I do in order to get a package working. Please note
8519: this is basically the same as what was explained in the previous
8520: sections, only with some debugging aids.</p>
1.41 asau 8521: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8522: <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>
8523: <li class="listitem">
1.79 snj 8524: <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 8525: create a directory for a new package, change into it, then run
1.10 hubertf 8526: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8527: <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>
8528: <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>
8529: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8530: </li>
1.23 wiz 8531: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8532: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8533: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8534: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8535: configure step to the package's
8536: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8537: <li class="listitem">
1.1 dsieger 8538: <p>Make the package compile, doing multiple rounds of</p>
8539: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8540: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8541: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8542: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8543: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8544: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8545: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8546: <p>Doing this step as non-root user will ensure that no files
8547: are modified that shouldn't be, especially during the build
1.10 hubertf 8548: phase. <span class="command"><strong>mkpatches</strong></span>,
8549: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.79 snj 8550: 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 8551: package.</p>
8552: </li>
1.23 wiz 8553: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
8554: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
8555: <li class="listitem">
1.1 dsieger 8556: <p>Generate a <code class="filename">PLIST</code>:</p>
8557: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8558: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8559: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8560: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8561: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8562: <p>You usually need to be <code class="username">root</code> to do
8563: this. Look if there are any files left:</p>
8564: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8565: <p>If this reveals any files that are missing in
8566: <code class="filename">PLIST</code>, add them.</p>
8567: </li>
1.23 wiz 8568: <li class="listitem">
1.1 dsieger 8569: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8570: package again and make a binary package:</p>
8571: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8572: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8573: </li>
1.23 wiz 8574: <li class="listitem">
1.1 dsieger 8575: <p>Delete the installed package:</p>
8576: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8577: </li>
1.23 wiz 8578: <li class="listitem">
1.10 hubertf 8579: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8580: command, which shouldn't find anything now:</p>
8581: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8582: </li>
1.23 wiz 8583: <li class="listitem">
1.1 dsieger 8584: <p>Reinstall the binary package:</p>
8585: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8586: </li>
1.23 wiz 8587: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8588: <li class="listitem">
1.79 snj 8589: <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 8590: reports:</p>
8591: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8592: </li>
1.23 wiz 8593: <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 8594: </ul></div>
8595: </div>
1.41 asau 8596: <div class="chapter">
1.1 dsieger 8597: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8598: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8599: <div class="toc">
8600: <p><b>Table of Contents</b></p>
1.100 leot 8601: <dl class="toc">
1.6 rillig 8602: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
8603: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8604: <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 8605: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 8606: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 8607: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
8608: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8609: </dl>
8610: </div>
1.41 asau 8611: <div class="sect1">
1.1 dsieger 8612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8613: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8614: <p>Our policy is that we accept binaries only from pkgsrc
8615: developers to guarantee that the packages don't contain any
8616: trojan horses etc. This is not to annoy anyone but rather to
8617: protect our users! You're still free to put up your home-made
8618: binary packages and tell the world where to get them. NetBSD
8619: developers doing bulk builds and wanting to upload them please
1.66 asau 8620: 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
8621: builds)</i></a>.</p>
1.1 dsieger 8622: </div>
1.41 asau 8623: <div class="sect1">
1.1 dsieger 8624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8625: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8626: <p>First, check that your package is complete, compiles and
1.10 hubertf 8627: 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 8628: 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 8629: archive that contains all files that make up the package.
8630: Finally, send this package to the pkgsrc bug tracking system,
1.79 snj 8631: 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 8632: that, go to the web page
1.10 hubertf 8633: <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 8634: which contains some instructions and a link to a form where you
8635: can submit packages. The
1.79 snj 8636: <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 8637: also available as a substitute for either of the above two tools.
8638: </p>
1.1 dsieger 8639: <p>In the form of the problem report, the category should be
1.23 wiz 8640: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8641: and version number, and the description field should contain a
8642: short description of your package (contents of the COMMENT
8643: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8644: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8645: <p>If you want to submit several packages, please send a
8646: separate PR for each one, it's easier for us to track things
8647: that way.</p>
8648: <p>Alternatively, you can also import new packages into
1.23 wiz 8649: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8650: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8651: for details.</p>
8652: </div>
1.41 asau 8653: <div class="sect1">
1.1 dsieger 8654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8655: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8656: <p>Please note all package additions, updates, moves, and
8657: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8658: important to keep this file up to date and conforming to the
8659: existing format, because it will be used by scripts to
1.10 hubertf 8660: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8661: sites. Additionally, check the
8662: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
8663: for the package you updated or removed, in case it was mentioned
8664: there.</p>
8665: <p>When the <code class="varname">PKGREVISION</code> of a package is
8666: bumped, the change should appear in
8667: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
8668: related or otherwise relevant. Mass bumps that result from a
8669: dependency being updated should not be mentioned. In all other
8670: cases it's the developer's decision.</p>
8671: <p>There is a make target that helps in creating proper
1.10 hubertf 8672: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 8673: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8674: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
8675: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
8676: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 8677: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8678: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 8679: For new packages, or package moves or removals, set the
8680: <code class="varname">CTYPE</code> variable on the command line to "Added",
8681: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 8682: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 8683: not the same as your NetBSD login name. The target also automatically
8684: removes possibly existing entries for the package in the
8685: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 8686: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 8687: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
8688: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8689: makes the cvs commands use the main repository.
8690: </p>
1.1 dsieger 8691: </div>
1.41 asau 8692: <div class="sect1">
1.1 dsieger 8693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 8694: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 8695: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 8696: access to the pkgsrc repository.</p>
8697: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8698: Start by adding the directory and then files in the directory. Don't
8699: forget to add the new package to the category's
8700: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8701: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8702: <pre class="programlisting">
8703: <code class="prompt">$</code> cd .../pkgsrc/category
8704: <code class="prompt">$</code> cvs add pkgname
8705: <code class="prompt">$</code> cd pkgname
8706: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8707: <code class="prompt">$</code> cvs add patches/p*
8708: <code class="prompt">$</code> cvs status | less
1.34 wiz 8709: <code class="prompt">$</code> cvs commit
1.33 wiz 8710: <code class="prompt">$</code> cd ..
8711: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 8712: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 8713: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 8714: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 8715: </pre>
1.1 dsieger 8716: <p>The commit message of the initial import should include part of the
8717: <code class="filename">DESCR</code> file, so people reading the mailing lists know
8718: what the package is/does.</p>
1.33 wiz 8719: <p>Also mention the new package in
8720: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8721: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8722: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 8723: </div>
1.41 asau 8724: <div class="sect1">
1.1 dsieger 8725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8726: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 8727: <p>Please always put a concise, appropriate and relevant summary of the
8728: changes between old and new versions into the commit log when updating
8729: a package. There are various reasons for this:</p>
1.41 asau 8730: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8731: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 8732: or its information may be overwritten by newer information.</p></li>
1.23 wiz 8733: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8734: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 8735: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8736: repository is very useful for people who read the pkgsrc-changes mailing
8737: list, so that they can make tactical decisions about when to upgrade
8738: the package.</p></li>
8739: </ul></div>
8740: <p>Please also recognize that, just because a new version of a package
8741: has been released, it should not automatically be upgraded in the CVS
8742: repository. We prefer to be conservative in the packages that are
8743: included in pkgsrc - development or beta packages are not really the
8744: best thing for most places in which pkgsrc is used. Please use your
8745: judgement about what should go into pkgsrc, and bear in mind that
8746: stability is to be preferred above new and possibly untested features.</p>
8747: </div>
1.41 asau 8748: <div class="sect1">
1.1 dsieger 8749: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 8750: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
8751: <p>Renaming packages is not recommended.</p>
8752: <p>When renaming packages, be sure to fix any references to old name
8753: in other Makefiles, options, buildlink files, etc.</p>
8754: <p>Also When renaming a package, please define
8755: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8756: pattern(s) of the previous package name.
8757: This may be repeated for multiple renames.
8758: The new package would be an exact replacement.
8759: </p>
1.23 wiz 8760: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 8761: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8762: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8763: not be an exact replacement but is a suggestion for the replaced
8764: functionality.</p>
8765: </div>
1.41 asau 8766: <div class="sect1">
1.20 snj 8767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8768: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
8769: <p>It is preferred that packages are not renamed or moved, but if needed
8770: please follow these steps.
8771: </p>
1.23 wiz 8772: <div class="orderedlist"><ol class="orderedlist" type="1">
8773: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8774: <li class="listitem">
1.1 dsieger 8775: <p>Remove all CVS dirs.</p>
8776: <p>Alternatively to the first two steps you can also do:</p>
8777: <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>
8778: <p>and use that for further work.</p>
8779: </li>
1.23 wiz 8780: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8781: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8782: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8783: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 8784: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8785: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8786: for doing an update using pkgsrc building; for example, it can
1.79 snj 8787: 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 8788: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8789: new <code class="varname">PKGPATH</code> for that moved package. Note that
8790: it may have multiple matches, so the tool should also check on the
8791: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8792: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8793: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 8794: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 8795: place.</p></li>
1.23 wiz 8796: <li class="listitem">
1.1 dsieger 8797: <p>Check if any package depends on it:
8798: </p>
8799: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8800: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8801: </li>
1.23 wiz 8802: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8803: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8804: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8805: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8806: <li class="listitem">
1.1 dsieger 8807: <p>Commit the changed and removed files:</p>
8808: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
8809: <p>(and any packages from step 5, of course).</p>
8810: </li>
8811: </ol></div>
8812: </div>
8813: </div>
1.41 asau 8814: <div class="chapter">
1.1 dsieger 8815: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8816: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 8817: <p>This section contains the answers to questions that may
8818: arise when you are writing a package. If you don't find your
8819: question answered here, first have a look in the other chapters,
8820: and if you still don't have the answer, ask on the
8821: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 8822: <div class="qandaset">
1.114 ! maya 8823: <a name="idm80465328"></a><dl>
1.6 rillig 8824: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 8825: MAKEFLAGS, .MAKEFLAGS and
8826: MAKE_FLAGS?</a>
8827: </dt>
1.6 rillig 8828: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 8829: MAKE, GMAKE and
8830: MAKE_PROGRAM?</a>
8831: </dt>
1.6 rillig 8832: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 8833: CC, PKG_CC and
8834: PKGSRC_COMPILER?</a>
8835: </dt>
1.6 rillig 8836: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 8837: BUILDLINK_LDFLAGS,
8838: BUILDLINK_LDADD and
8839: BUILDLINK_LIBS?</a>
8840: </dt>
1.6 rillig 8841: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 8842: VARNAME=BUILDLINK_PREFIX.foo
8843: say it's empty?</a>
8844: </dt>
1.6 rillig 8845: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 8846: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
8847: don't understand the := inside
8848: it.</a>
8849: </dt>
1.6 rillig 8850: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 8851: developers?</a>
8852: </dt>
1.6 rillig 8853: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 8854: documentation?</a>
8855: </dt>
1.6 rillig 8856: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 8857: do?</a>
8858: </dt>
8859: </dl>
1.41 asau 8860: <table border="0" style="width: 100%;">
8861: <colgroup>
1.1 dsieger 8862: <col align="left" width="1%">
1.23 wiz 8863: <col>
1.41 asau 8864: </colgroup>
1.1 dsieger 8865: <tbody>
1.41 asau 8866: <tr class="question">
1.1 dsieger 8867: <td align="left" valign="top">
1.114 ! maya 8868: <a name="devfaq.makeflags"></a><a name="idm80464944"></a><p><b>22.1.</b></p>
1.1 dsieger 8869: </td>
8870: <td align="left" valign="top"><p>What is the difference between
8871: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
8872: <code class="varname">MAKE_FLAGS</code>?</p></td>
8873: </tr>
8874: <tr class="answer">
8875: <td align="left" valign="top"></td>
8876: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.79 snj 8877: 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 8878: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
8879: the <code class="varname">MAKE_PROGRAM</code> when building the
8880: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
8881: </tr>
1.41 asau 8882: <tr class="question">
1.1 dsieger 8883: <td align="left" valign="top">
1.114 ! maya 8884: <a name="devfaq.make"></a><a name="idm80460976"></a><p><b>22.2.</b></p>
1.1 dsieger 8885: </td>
8886: <td align="left" valign="top"><p>What is the difference between
8887: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
8888: <code class="varname">MAKE_PROGRAM</code>?</p></td>
8889: </tr>
8890: <tr class="answer">
8891: <td align="left" valign="top"></td>
8892: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.79 snj 8893: <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 8894: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
8895: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
8896: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
8897: Make program that is used for building the
8898: package.</p></td>
8899: </tr>
1.41 asau 8900: <tr class="question">
1.1 dsieger 8901: <td align="left" valign="top">
1.114 ! maya 8902: <a name="devfaq.cc"></a><a name="idm80456496"></a><p><b>22.3.</b></p>
1.1 dsieger 8903: </td>
8904: <td align="left" valign="top"><p>What is the difference between
8905: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
8906: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
8907: </tr>
8908: <tr class="answer">
8909: <td align="left" valign="top"></td>
8910: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
8911: compiler, which can be configured by the pkgsrc user.
8912: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
8913: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
8914: path to a compiler, but the type of compiler that should be
8915: used. See <code class="filename">mk/compiler.mk</code> for more
8916: information about the latter variable.</p></td>
8917: </tr>
1.41 asau 8918: <tr class="question">
1.1 dsieger 8919: <td align="left" valign="top">
1.114 ! maya 8920: <a name="devfaq.bl3flags"></a><a name="idm80452400"></a><p><b>22.4.</b></p>
1.1 dsieger 8921: </td>
8922: <td align="left" valign="top"><p>What is the difference between
8923: <code class="varname">BUILDLINK_LDFLAGS</code>,
8924: <code class="varname">BUILDLINK_LDADD</code> and
8925: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
8926: </tr>
8927: <tr class="answer">
8928: <td align="left" valign="top"></td>
8929: <td align="left" valign="top"><p>[FIXME]</p></td>
8930: </tr>
1.41 asau 8931: <tr class="question">
1.1 dsieger 8932: <td align="left" valign="top">
1.114 ! maya 8933: <a name="devfaq.bl3prefix"></a><a name="idm80450096"></a><p><b>22.5.</b></p>
1.1 dsieger 8934: </td>
1.10 hubertf 8935: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 8936: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
8937: say it's empty?</p></td>
8938: </tr>
8939: <tr class="answer">
8940: <td align="left" valign="top"></td>
8941: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 8942: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
8943: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 8944: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 8945: command.</p></td>
8946: </tr>
1.41 asau 8947: <tr class="question">
1.1 dsieger 8948: <td align="left" valign="top">
1.114 ! maya 8949: <a name="devfaq.master_sites"></a><a name="idm80447024"></a><p><b>22.6.</b></p>
1.1 dsieger 8950: </td>
8951: <td align="left" valign="top"><p>What does
1.108 rillig 8952: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
8953: don't understand the <code class="code">:=</code> inside
1.1 dsieger 8954: it.</p></td>
8955: </tr>
8956: <tr class="answer">
8957: <td align="left" valign="top"></td>
1.108 rillig 8958: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
8959: assignment operator, although it looks like it.
1.1 dsieger 8960: Instead, it is a degenerate form of
1.108 rillig 8961: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
8962: 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
8963: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 8964: case of <code class="varname">MASTER_SITE_*</code>,
8965: <em class="replaceable"><code>old_string</code></em> is the empty string and
8966: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 8967: <code class="code">package/</code>. That's where the
8968: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 8969: together.</p></td>
8970: </tr>
1.41 asau 8971: <tr class="question">
1.1 dsieger 8972: <td align="left" valign="top">
1.114 ! maya 8973: <a name="devfaq.mailinglists"></a><a name="idm80440112"></a><p><b>22.7.</b></p>
1.1 dsieger 8974: </td>
8975: <td align="left" valign="top"><p>Which mailing lists are there for package
8976: developers?</p></td>
8977: </tr>
8978: <tr class="answer">
8979: <td align="left" valign="top"></td>
1.41 asau 8980: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 8981: <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 8982: <dd><p>This is a list for technical discussions related
8983: to pkgsrc development, e.g. soliciting feedback for changes to
8984: pkgsrc infrastructure, proposed new features, questions related
8985: to porting pkgsrc to a new platform, advice for maintaining a
8986: package, patches that affect many packages, help requests moved
8987: from pkgsrc-users when an infrastructure bug is found,
8988: etc.</p></dd>
1.10 hubertf 8989: <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 8990: <dd><p>All bug reports in category "pkg" sent with
1.79 snj 8991: <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 8992: directly; use one of the other mailing
8993: lists.</p></dd>
8994: </dl></div></td>
8995: </tr>
1.41 asau 8996: <tr class="question">
1.1 dsieger 8997: <td align="left" valign="top">
1.114 ! maya 8998: <a name="devfaq.documentation"></a><a name="idm80436400"></a><p><b>22.8.</b></p>
1.1 dsieger 8999: </td>
9000: <td align="left" valign="top"><p>Where is the pkgsrc
9001: documentation?</p></td>
9002: </tr>
9003: <tr class="answer">
9004: <td align="left" valign="top"></td>
9005: <td align="left" valign="top">
9006: <p>There are many places where you can find
9007: documentation about pkgsrc:</p>
1.41 asau 9008: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9009: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9010: of chapters that explain large parts of pkgsrc, but some
9011: chapters tend to be outdated. Which ones they are is hard to
9012: say.</p></li>
1.23 wiz 9013: <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 9014: about certain features, announcements of new parts of the pkgsrc
9015: infrastructure and sometimes even announcements that a certain
9016: feature has been marked as obsolete. The benefit here is that
9017: each message has a date appended to it.</p></li>
1.23 wiz 9018: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9019: <code class="filename">mk/</code> directory start with a comment that
9020: describes the purpose of the file and how it can be used by the
9021: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9022: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9023: help</strong></span>.</p></li>
1.23 wiz 9024: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9025: information, but they tend to be highly abbreviated, especially
9026: for actions that occur often. Some contain a detailed
9027: description of what has changed, but they are geared towards the
9028: other pkgsrc developers, not towards an average pkgsrc user.
9029: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9030: don't know what has been before, these messages may not be worth
9031: too much to you.</p></li>
1.23 wiz 9032: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9033: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9034: mind of the developer who wrote the code. To get this
1.10 hubertf 9035: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9036: to see who has written it and ask on the
9037: <code class="literal">tech-pkg</code> mailing list, so that others can
9038: find your questions later (see above). To be sure that the
9039: developer in charge reads the mail, you may CC him or
9040: her.</p></li>
9041: </ul></div>
9042: </td>
9043: </tr>
1.41 asau 9044: <tr class="question">
1.1 dsieger 9045: <td align="left" valign="top">
1.114 ! maya 9046: <a name="devfaq.too-much-time"></a><a name="idm80429872"></a><p><b>22.9.</b></p>
1.1 dsieger 9047: </td>
9048: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9049: do?</p></td>
9050: </tr>
9051: <tr class="answer">
9052: <td align="left" valign="top"></td>
9053: <td align="left" valign="top">
9054: <p>This is not really an FAQ yet, but here's the answer
9055: anyway.</p>
1.41 asau 9056: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9057: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.79 snj 9058: <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 9059: will tell you about newer versions of installed packages that are
9060: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9061: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9062: — it contains a list of suggested new packages and a list of
1.1 dsieger 9063: cleanups and enhancements for pkgsrc that would be nice to
9064: have.</p></li>
1.23 wiz 9065: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9066: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9067: mailing list.</p></li>
9068: </ul></div>
9069: </td>
9070: </tr>
9071: </tbody>
9072: </table>
9073: </div>
9074: </div>
1.41 asau 9075: <div class="chapter">
1.1 dsieger 9076: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9077: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9078: <div class="toc">
9079: <p><b>Table of Contents</b></p>
1.100 leot 9080: <dl class="toc">
1.6 rillig 9081: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9082: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9083: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9084: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9085: </dl>
9086: </div>
1.10 hubertf 9087: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9088: site</a>:</p>
9089: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9090: environment, an intuitive and attractive desktop for users, and the
9091: GNOME development platform, an extensive framework for building
9092: applications that integrate into the rest of the desktop.</p></blockquote></div>
9093: <p>pkgsrc provides a seamless way to automatically build and install
9094: a complete GNOME environment <span class="emphasis"><em>under many different
9095: platforms</em></span>. We can say with confidence that pkgsrc is one of
9096: the most advanced build and packaging systems for GNOME due to its
9097: included technologies buildlink3, the wrappers and tools framework and
9098: automatic configuration file management. Lots of efforts are put into
9099: achieving a completely clean deinstallation of installed software
9100: components.</p>
1.10 hubertf 9101: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9102: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9103: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9104: pkgsrc as its preferred packaging system, contributing lots of
9105: portability fixes to make GNOME build and install under it.</p>
9106: <p>This chapter is aimed at pkgsrc developers and other people
9107: interested in helping our GNOME porting and packaging efforts. It
9108: provides instructions on how to manage the existing packages and some
9109: important information regarding their internals.</p>
1.41 asau 9110: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9111: <h3 class="title">We need your help!</h3>
9112: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9113: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9114: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9115: work</a> list! There is still a long way to go to get a
9116: fully-functional GNOME desktop under NetBSD and we need your help to
9117: achieve it!</p>
9118: </div>
1.41 asau 9119: <div class="sect1">
1.1 dsieger 9120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9121: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9122: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9123: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 9124: <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 9125: the core GNOME desktop environment. It only includes the necessary
9126: bits to get it to boot correctly, although it may lack important
9127: functionality for daily operation. The idea behind this package is
9128: to let end users build their own configurations on top of this one,
9129: first installing this meta package to achieve a functional setup and
9130: then adding individual applications.</p></li>
1.79 snj 9131: <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 9132: complete installation of the GNOME platform and desktop as defined
9133: by the GNOME project; this is based on the components distributed in
9134: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9135: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9136: official FTP server. Developer-only tools found in those
9137: directories are not installed unless required by some other
9138: component to work properly. Similarly, packages from the bindings
9139: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9140: in unless required as a dependency for an end-user component. This
1.79 snj 9141: 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>
9142: <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 9143: Installs all the tools required to build a GNOME component when
9144: fetched from the CVS repository. These are required to let the
1.10 hubertf 9145: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9146: </ul></div>
9147: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9148: sorted in a way that eases updates: a package may depend on other
9149: packages listed before it but not on any listed after it. It is very
9150: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9151: change it to alphabetical sorting!</em></span></p>
9152: </div>
1.41 asau 9153: <div class="sect1">
1.1 dsieger 9154: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9155: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9156: <p>Almost all GNOME applications are written in C and use a common
9157: set of tools as their build system. Things get different with the new
9158: bindings to other languages (such as Python), but the following will
9159: give you a general idea on the minimum required tools:</p>
1.41 asau 9160: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9161: <li class="listitem">
1.1 dsieger 9162: <p>Almost all GNOME applications use the GNU Autotools as their
9163: build system. As a general rule you will need to tell this to your
9164: package:</p>
9165: <pre class="programlisting">
9166: GNU_CONFIGURE=yes
9167: USE_LIBTOOL=yes
9168: USE_TOOLS+=gmake
9169: </pre>
9170: </li>
1.23 wiz 9171: <li class="listitem">
1.1 dsieger 9172: <p>If the package uses pkg-config to detect dependencies, add this
9173: tool to the list of required utilities:</p>
1.111 sevan 9174: <pre class="programlisting">
9175: USE_TOOLS+=pkg-config
9176: </pre>
1.79 snj 9177: <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 9178: the end of the build process to ensure that you did not miss to
9179: specify any dependency in your package and that the version
9180: requirements are all correct.</p>
9181: </li>
1.23 wiz 9182: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9183: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9184: to handle dependencies and to force the package to use the latest
9185: available version.</p></li>
1.23 wiz 9186: <li class="listitem">
1.1 dsieger 9187: <p>If the package uses gtk-doc (a documentation generation
9188: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9189: tool is rather big and the distfile should come with pregenerated
9190: documentation anyway; if it does not, it is a bug that you ought to
9191: report. For such packages you should disable gtk-doc (unless it is
9192: the default):</p>
1.111 sevan 9193: <pre class="programlisting">
9194: CONFIGURE_ARGS+=--disable-gtk-doc
9195: </pre>
1.1 dsieger 9196: <p>The default location of installed HTML files
9197: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9198: and should not be changed unless the package insists on installing
9199: them somewhere else. Otherwise programs as
1.10 hubertf 9200: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9201: do that with an entry similar to:</p>
1.111 sevan 9202: <pre class="programlisting">
9203: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9204: </pre>
1.1 dsieger 9205: </li>
9206: </ul></div>
9207: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9208: files under the installation prefix to maintain databases. In this
9209: context, shared means that those exact same directories and files are
9210: used among several different packages, leading to conflicts in the
9211: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9212: handle the most common cases, so you have to forget about using
9213: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9214: omitting shared files from them. If you find yourself doing those,
9215: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9216: <p>The following table lists the common situations that result in
9217: using shared directories or files. For each of them, the appropriate
9218: solution is given. After applying the solution be sure to
9219: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9220: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9221: <div class="table">
1.6 rillig 9222: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9223: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9224: <colgroup>
9225: <col>
9226: <col>
9227: </colgroup>
9228: <thead><tr>
9229: <th>If the package...</th>
9230: <th>Then...</th>
9231: </tr></thead>
9232: <tbody>
9233: <tr>
9234: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9235: <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 9236: </tr>
9237: <tr>
9238: <td>Installs icons under the
9239: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9240: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9241: <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 9242: </tr>
9243: <tr>
9244: <td>Installs files under
9245: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9246: <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 9247: </tr>
9248: <tr>
9249: <td>Installs <code class="filename">.desktop</code> files under
9250: <code class="filename">share/applications</code> and these include MIME
9251: information.</td>
1.10 hubertf 9252: <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 9253: </tr>
9254: </tbody>
9255: </table></div>
9256: </div>
9257: <br class="table-break">
9258: </div>
1.41 asau 9259: <div class="sect1">
1.1 dsieger 9260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9261: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9262: <p>When seeing GNOME as a whole, there are two kinds of
9263: updates:</p>
1.41 asau 9264: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9265: <dt><span class="term">Major update</span></dt>
9266: <dd>
9267: <p>Given that there is still a very long way for GNOME 3 (if it
9268: ever appears), we consider a major update one that goes from a
9269: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9270: where <code class="literal">Y</code> is even and greater than
9271: <code class="literal">X</code>. These are hard to achieve because they
9272: introduce lots of changes in the components' code and almost all
9273: GNOME distfiles are updated to newer versions. Some of them can
9274: even break API and ABI compatibility with the previous major
9275: version series. As a result, the update needs to be done all at
9276: once to minimize breakage.</p>
9277: <p>A major update typically consists of around 80 package
9278: updates and the addition of some new ones.</p>
9279: </dd>
9280: <dt><span class="term">Minor update</span></dt>
9281: <dd>
9282: <p>We consider a minor update one that goes from a
9283: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9284: one where <code class="literal">Y</code> is greater than
9285: <code class="literal">X</code>. These are easy to achieve because they do
9286: not update all GNOME components, can be done in an incremental way
9287: and do not break API nor ABI compatibility.</p>
9288: <p>A minor update typically consists of around 50 package
9289: updates, although the numbers here may vary a lot.</p>
9290: </dd>
9291: </dl></div>
9292: <p>In order to update the GNOME components in pkgsrc to a new stable
9293: release (either major or minor), the following steps should be
9294: followed:</p>
1.23 wiz 9295: <div class="orderedlist"><ol class="orderedlist" type="1">
9296: <li class="listitem">
1.1 dsieger 9297: <p>Get a list of all the tarballs that form the new release by
9298: using the following commands. These will leave the full list of the
1.18 snj 9299: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9300: file:</p>
9301: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9302: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9303: awk '{ print $9 }' >list.txt</code></strong>
9304: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9305: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9306: awk '{ print $9 }' >>list.txt</code></strong></pre>
9307: </li>
1.23 wiz 9308: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9309: bump their version to the release you are updating them to. The
9310: three meta packages should be always consistent with versioning.
9311: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9312: in them.</p></li>
1.23 wiz 9313: <li class="listitem">
1.1 dsieger 9314: <p>For each meta package, update all its
9315: <code class="varname">DEPENDS</code> lines to match the latest versions as
9316: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9317: newer version (even if found in the FTP) because the meta packages
9318: are supposed to list the exact versions that form a specific GNOME
9319: release. Exceptions are permitted here if a newer version solves a
9320: serious issue in the overall desktop experience; these typically
9321: come in the form of a revision bump in pkgsrc, not in newer versions
9322: from the developers.</p>
9323: <p>Packages not listed in the <code class="filename">list.txt</code> file
9324: should be updated to the latest version available (if found in
9325: pkgsrc). This is the case, for example, of the dependencies on the
1.79 snj 9326: 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 9327: </li>
1.23 wiz 9328: <li class="listitem">
1.1 dsieger 9329: <p>Generate a patch from the modified meta packages and extract the
9330: list of "new" lines. This will provide you an outline on what
9331: packages need to be updated in pkgsrc and in what order:</p>
9332: <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>
9333: </li>
1.23 wiz 9334: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9335: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9336: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9337: of <code class="filename">todo.txt</code> and update the packages listed in
9338: it in order. For major desktop updates none of these should be
9339: committed until the entire set is completed because there are chances
9340: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9341: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9342: the tree one by one with appropriate log messages. At the end,
9343: commit the three meta package updates and all the corresponding
9344: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9345: <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>
9346: </ol></div>
9347: </div>
1.41 asau 9348: <div class="sect1">
1.1 dsieger 9349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9350: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9351: <p>GNOME is a very big component in pkgsrc which approaches 100
9352: packages. Please, it is very important that you always, always,
9353: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9354: 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 9355: their attention on portability issues and to ensure that future versions
9356: can be built out-of-the box on NetBSD. The less custom patches in
9357: pkgsrc, the easier further updates are. Those developers in charge of
9358: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9359: <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 9360: Bugzilla</a>. Not all components use these to track bugs, but most
9361: of them do. Do not be short on your reports: always provide detailed
9362: explanations of the current failure, how it can be improved to achieve
9363: maximum portability and, if at all possible, provide a patch against CVS
9364: head. The more verbose you are, the higher chances of your patch being
9365: accepted.</p>
9366: <p>Also, please avoid using preprocessor magic to fix portability
9367: issues. While the FreeBSD GNOME people are doing a great job in porting
9368: GNOME to their operating system, the official GNOME sources are now
9369: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9370: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 9371: 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 9372: details.</p>
9373: </div>
9374: </div>
9375: </div>
1.41 asau 9376: <div class="part">
1.1 dsieger 9377: <div class="titlepage"><div><div><h1 class="title">
9378: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9379: <div class="partintro">
1.1 dsieger 9380: <div></div>
9381: <p>This part of the guide deals with everything
9382: from the infrastructure that is behind the interfaces described
9383: in the developer's guide. A casual package maintainer should not
9384: need anything from this part.</p>
9385: <div class="toc">
9386: <p><b>Table of Contents</b></p>
1.100 leot 9387: <dl class="toc">
1.6 rillig 9388: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9389: <dd><dl>
1.6 rillig 9390: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9391: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9392: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9393: <dd><dl>
1.6 rillig 9394: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9395: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9396: </dl></dd>
1.6 rillig 9397: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9398: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9399: <dd><dl>
1.6 rillig 9400: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9401: <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 9402: </dl></dd>
1.6 rillig 9403: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9404: <dd><dl>
1.23 wiz 9405: <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>
9406: <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 9407: </dl></dd>
9408: </dl></dd>
1.6 rillig 9409: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 9410: <dd><dl>
1.108 rillig 9411: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9412: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9413: <dd><dl>
1.108 rillig 9414: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9415: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9416: </dl></dd>
9417: </dl></dd>
1.6 rillig 9418: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 9419: <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 9420: </dl>
9421: </div>
9422: </div>
1.41 asau 9423: <div class="chapter">
1.1 dsieger 9424: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9425: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9426: <div class="toc">
9427: <p><b>Table of Contents</b></p>
1.100 leot 9428: <dl class="toc">
1.6 rillig 9429: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9430: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9431: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9432: <dd><dl>
1.6 rillig 9433: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9434: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9435: </dl></dd>
1.6 rillig 9436: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9437: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9438: <dd><dl>
1.6 rillig 9439: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9440: <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 9441: </dl></dd>
1.6 rillig 9442: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9443: <dd><dl>
1.23 wiz 9444: <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>
9445: <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 9446: </dl></dd>
9447: </dl>
9448: </div>
9449: <p>The pkgsrc infrastructure consists of many small Makefile
9450: fragments. Each such fragment needs a properly specified
9451: interface. This chapter explains how such an interface looks
9452: like.</p>
1.41 asau 9453: <div class="sect1">
1.1 dsieger 9454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9455: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9456: <p>Whenever a variable is defined in the pkgsrc
9457: infrastructure, the location and the way of definition provide
9458: much information about the intended use of that variable.
9459: Additionally, more documentation may be found in a header
9460: comment or in this pkgsrc guide.</p>
9461: <p>A special file is
9462: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9463: variables that are intended to be user-defined. They are either
9464: defined using the <code class="literal">?=</code> operator or they are
9465: left undefined because defining them to anything would
1.23 wiz 9466: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9467: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9468: file.</p>
9469: <p>Outside this file, the following conventions apply:
9470: Variables that are defined using the <code class="literal">?=</code>
9471: operator may be overridden by a package.</p>
9472: <p>Variables that are defined using the <code class="literal">=</code>
9473: operator may be used read-only at run-time.</p>
9474: <p>Variables whose name starts with an underscore must not be
9475: accessed outside the pkgsrc infrastructure at all. They may
9476: change without further notice.</p>
1.41 asau 9477: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9478: <h3 class="title">Note</h3>
9479: <p>These conventions are currently not applied
9480: consistently to the complete pkgsrc
9481: infrastructure.</p>
9482: </div>
9483: </div>
1.41 asau 9484: <div class="sect1">
1.1 dsieger 9485: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9486: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9487: <p>All variables that contain lists of things should default
9488: to being empty. Two examples that do not follow this rule are
9489: <code class="varname">USE_LANGUAGES</code> and
9490: <code class="varname">DISTFILES</code>. These variables cannot simply be
9491: modified using the <code class="literal">+=</code> operator in package
9492: <code class="filename">Makefile</code>s (or other files included by
9493: them), since there is no guarantee whether the variable is
9494: already set or not, and what its value is. In the case of
1.23 wiz 9495: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9496: the default value and just define it as in the following
9497: example.</p>
9498: <pre class="programlisting">
9499: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9500: </pre>
9501: <p>Because of the selection of this default value, the same
9502: value appears in many package Makefiles. Similarly for
9503: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9504: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9505: doesn't stand out. Nevertheless it is mentioned in many
9506: files.</p>
9507: </div>
1.41 asau 9508: <div class="sect1">
1.1 dsieger 9509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9510: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 9511: <div class="sect2">
1.1 dsieger 9512: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9513: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 9514: <p>Variable evaluation takes place either at load time or at
9515: runtime, depending on the context in which they occur. The
9516: contexts where variables are evaluated at load time are:</p>
1.41 asau 9517: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9518: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9519: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9520: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9521: <code class="literal">.for</code>,</p></li>
1.23 wiz 9522: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9523: </ul></div>
9524: <p>A special exception are references to the iteration
9525: variables of <code class="literal">.for</code> loops, which are expanded
9526: inline, no matter in which context they appear.</p>
9527: <p>As the values of variables may change during load time,
9528: care must be taken not to evaluate them by accident. Typical
9529: examples for variables that should not be evaluated at load time
9530: are <code class="varname">DEPENDS</code> and
9531: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9532: clear, here is an example:</p>
9533: <pre class="programlisting">
9534: CONFIGURE_ARGS= # none
9535: CFLAGS= -O
9536: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9537:
9538: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9539:
9540: CFLAGS+= -Wall
1.111 sevan 9541: </pre>
1.1 dsieger 9542: <p>This code shows how the use of the <code class="literal">:=</code>
9543: operator can quickly lead to unexpected results. The first
9544: paragraph is fairly common code. The second paragraph evaluates
9545: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9546: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9547: <code class="literal">-Wall</code> is appended to the
9548: <code class="varname">CFLAGS</code>, but this addition will not appear in
9549: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9550: paragraphs from above typically occur in completely unrelated
9551: files.</p>
9552: </div>
1.41 asau 9553: <div class="sect2">
1.1 dsieger 9554: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9555: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9556: <p>After all the files have been loaded, the values of the
9557: variables cannot be changed anymore. Variables that are used in
9558: the shell commands are expanded at this point.</p>
9559: </div>
9560: </div>
1.41 asau 9561: <div class="sect1">
1.1 dsieger 9562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9563: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9564: <p>There are many ways in which the definition and use of a
1.108 rillig 9565: variable can be restricted in order to detect bugs and violations
9566: of the (mostly unwritten) policies. A package can be checked with
9567: <code class="literal">pkglint -Wall</code> to see whether it meets these
9568: rules.</p>
1.1 dsieger 9569: </div>
1.41 asau 9570: <div class="sect1">
1.1 dsieger 9571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9572: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9573: <p>Most of the <code class="filename">.mk</code> files fall into one
9574: of the following classes. Cases where a file falls into more
9575: than one class should be avoided as it often leads to subtle
9576: bugs.</p>
1.41 asau 9577: <div class="sect2">
1.1 dsieger 9578: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9579: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9580: <p>In a traditional imperative programming language some of
9581: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9582: procedures. They take some input parameters and—after
9583: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9584: variables in <code class="filename">Makefile</code>s have global scope
9585: care must be taken not to use parameter names that have already
9586: another meaning. For example, <code class="varname">PKGNAME</code> is a
9587: bad choice for a parameter name.</p>
9588: <p>Procedures are completely evaluated at preprocessing time.
9589: That is, when calling a procedure all input parameters must be
9590: completely resolvable. For example,
9591: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9592: parameter since it is very likely that further text will be
9593: added after calling the procedure, which would effectively apply
9594: the procedure to only a part of the variable. Also, references
1.108 rillig 9595: to other variables will be modified after calling the
1.1 dsieger 9596: procedure.</p>
9597: <p>A procedure can declare its output parameters either as
9598: suitable for use in preprocessing directives or as only
9599: available at runtime. The latter alternative is for variables
9600: that contain references to other runtime variables.</p>
9601: <p>Procedures shall be written such that it is possible to
9602: call the procedure more than once. That is, the file must not
9603: contain multiple-inclusion guards.</p>
9604: <p>Examples for procedures are
9605: <code class="filename">mk/bsd.options.mk</code> and
9606: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9607: that the parameters are evaluated at load time, they should be
9608: assigned using the <code class="literal">:=</code> operator, which should
9609: be used only for this purpose.</p>
9610: </div>
1.41 asau 9611: <div class="sect2">
1.1 dsieger 9612: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9613: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9614: <p>Action files take some input parameters and may define
9615: runtime variables. They shall not define loadtime variables.
9616: There are action files that are included implicitly by the
9617: pkgsrc infrastructure, while other must be included
9618: explicitly.</p>
9619: <p>An example for action files is
9620: <code class="filename">mk/subst.mk</code>.</p>
9621: </div>
9622: </div>
1.41 asau 9623: <div class="sect1">
1.1 dsieger 9624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9625: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 9626: <p>Package <code class="filename">Makefile</code>s usually consist of
9627: a set of variable definitions, and include the file
9628: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9629: Before that, they may also include various other
9630: <code class="filename">*.mk</code> files if they need to query the
9631: availability of certain features like the type of compiler or
9632: the X11 implementation. Due to the heavy use of preprocessor
9633: directives like <code class="literal">.if</code> and
9634: <code class="literal">.for</code>, the order in which the files are loaded
9635: matters.</p>
9636: <p>This section describes at which point the various files
9637: are loaded and gives reasons for that order.</p>
1.41 asau 9638: <div class="sect2">
1.1 dsieger 9639: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9640: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 9641: </h3></div></div></div>
9642: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
9643: is to define some essential variables like
9644: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9645: <code class="varname">MACHINE_ARCH</code>.</p>
9646: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 9647: 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 9648: After that, those variables
1.1 dsieger 9649: that have not been overridden by the user are loaded from
9650: <code class="filename">mk/defaults/mk.conf</code>.</p>
9651: <p>After the user settings, the system settings and platform
9652: settings are loaded, which may override the user
9653: settings.</p>
9654: <p>Then, the tool definitions are loaded. The tool wrappers
9655: are not yet in effect. This only happens when building a
9656: package, so the proper variables must be used instead of the
9657: direct tool names.</p>
9658: <p>As the last steps, some essential variables from the
9659: wrapper and the package system flavor are loaded, as well as the
9660: variables that have been cached in earlier phases of a package
9661: build.</p>
9662: </div>
1.41 asau 9663: <div class="sect2">
1.1 dsieger 9664: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9665: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 9666: </h3></div></div></div>
9667: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9668: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9669: loaded, which fill default values for those variables that have
9670: not been defined by the package. These variables may later
9671: be used even in unrelated files.</p>
9672: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9673: provides the target <code class="literal">error-check</code> that is added
9674: as a special dependency to all other targets that use
9675: <code class="varname">DELAYED_ERROR_MSG</code> or
9676: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9677: <p>Then, the package-specific hacks from
9678: <code class="filename">hacks.mk</code> are included.</p>
9679: <p>Then, various other files follow. Most of them don't have
9680: any dependencies on what they need to have included before or
9681: after them, though some do.</p>
9682: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9683: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9684: restricts the use of these variables to all the files that have
9685: been included before. Appearances in later files will be
9686: silently ignored.</p>
9687: <p>Then, the files for the main targets are included, in the
9688: order of later execution, though the actual order should not
9689: matter.</p>
9690: <p>At last, some more files are included that don't set any
9691: interesting variables but rather just define make targets to be
9692: executed.</p>
9693: </div>
9694: </div>
9695: </div>
1.41 asau 9696: <div class="chapter">
1.1 dsieger 9697: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9698: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 9699: <div class="toc">
9700: <p><b>Table of Contents</b></p>
1.100 leot 9701: <dl class="toc">
1.108 rillig 9702: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9703: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9704: <dd><dl>
1.108 rillig 9705: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9706: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9707: </dl></dd>
9708: </dl>
9709: </div>
9710: <p>The pkgsrc infrastructure consists of a large codebase,
9711: and there are many corners where every little bit of a file is
9712: well thought out, making pkgsrc likely to fail as soon as
9713: anything is changed near those parts. To prevent most changes
9714: from breaking anything, a suite of regression tests should go
9715: along with every important part of the pkgsrc infrastructure.
9716: This chapter describes how regression tests work in pkgsrc and
9717: how you can add new tests.</p>
1.41 asau 9718: <div class="sect1">
1.1 dsieger 9719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9720: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.79 snj 9721: <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 9722: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 9723: can simply run that command, which will run all tests in the
9724: <code class="filename">regress</code> category.</p>
9725: </div>
1.41 asau 9726: <div class="sect1">
1.1 dsieger 9727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9728: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.1 dsieger 9729: <p>Every directory in the <code class="filename">regress</code>
9730: category that contains a file called <code class="filename">spec</code>
9731: is considered a regression test. This file is a shell program
1.10 hubertf 9732: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 9733: The following functions can be overridden to suit your
9734: needs.</p>
1.41 asau 9735: <div class="sect2">
1.1 dsieger 9736: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9737: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
9738: <p>These functions do not take any parameters. Although they
9739: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9740: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9741: question</a> for details.</p>
1.41 asau 9742: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9743: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 9744: <dd><p>This function prepares the environment for the
9745: test. By default it does nothing.</p></dd>
1.108 rillig 9746: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9747: <dd>
9748: <p>This function runs the actual test. By default,
1.1 dsieger 9749: it calls <code class="varname">TEST_MAKE</code> with the arguments
9750: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9751: error messages into the file
1.108 rillig 9752: <code class="varname">TEST_OUTFILE</code>.</p>
9753: <p>When defining this function, make sure that all output that
9754: needs to be checked is written to the correct output file.
9755: Example:</p>
9756: <pre class="programlisting">
9757: do_test() {
1.112 rillig 9758: echo "Example output"
1.108 rillig 9759: } 1>$TEST_OUTFILE 2>&1
9760: </pre>
9761: </dd>
9762: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9763: <dd>
9764: <p>This function is run after the test and is
1.1 dsieger 9765: typically used to compare the actual output from the one that is
9766: expected. It can make use of the various helper functions from
1.108 rillig 9767: the next section. Example:</p>
9768: <pre class="programlisting">
9769: check_result() {
1.112 rillig 9770: exit_status 0
9771: output_require "Example"
9772: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9773: output_prohibit "no such file or directory"
1.108 rillig 9774: }
9775: </pre>
9776: </dd>
9777: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 9778: <dd><p>This function cleans everything up after the
9779: test has been run. By default it does nothing.</p></dd>
9780: </dl></div>
9781: </div>
1.41 asau 9782: <div class="sect2">
1.1 dsieger 9783: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9784: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.41 asau 9785: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9786: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 9787: <dd><p>This function compares the exitcode of the
1.108 rillig 9788: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 9789: If they differ, the test will fail.</p></dd>
1.108 rillig 9790: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9791: <dd>
9792: <p>This function checks for each of its parameters
9793: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 9794: extended regular expression. If it does not, the test will
1.108 rillig 9795: fail. Example:</p>
9796: <pre class="programlisting">
9797: output_require "looks fine"
9798: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9799: </pre>
9800: </dd>
1.1 dsieger 9801: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9802: <dd><p>This function checks for each of its parameters
1.10 hubertf 9803: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 9804: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9805: If any of the regular expressions matches, the test will
9806: fail.</p></dd>
9807: </dl></div>
9808: </div>
9809: </div>
9810: </div>
1.41 asau 9811: <div class="chapter">
1.1 dsieger 9812: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9813: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 9814: <div class="toc">
9815: <p><b>Table of Contents</b></p>
1.108 rillig 9816: <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 9817: </div>
9818: <p>The pkgsrc system has already been ported to many
9819: operating systems, hardware architectures and compilers. This
9820: chapter explains the necessary steps to make pkgsrc even more
9821: portable.</p>
1.41 asau 9822: <div class="sect1">
1.1 dsieger 9823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9824: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 9825: <p>To port pkgsrc to a new operating system (called
9826: <code class="literal">MyOS</code> in this example), you need to touch the
9827: following files:</p>
1.41 asau 9828: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9829: <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>
9830: <dd><p>This file contains some basic definitions, for
9831: example the name of the C
9832: compiler.</p></dd>
9833: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
9834: <dd><p>Insert code that defines the variables
9835: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
9836: <code class="varname">LOWER_OS_VERSION</code>,
9837: <code class="varname">LOWER_VENDOR</code>,
9838: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
9839: <code class="varname">APPEND_ELF</code>, and the other variables that
9840: appear in this file.</p></dd>
9841: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9842: <dd><p>This file contains the platform-specific
9843: definitions that are used by pkgsrc. Start by copying one of the
9844: other files and edit it to your
9845: needs.</p></dd>
9846: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9847: <dd><p>This file defines the paths to all the tools
9848: that are needed by one or the other package in pkgsrc, as well
9849: as by pkgsrc itself. Find out where these tools are on your
9850: platform and add them.</p></dd>
9851: </dl></div>
9852: <p>Now, you should be able to build some basic packages, like
1.79 snj 9853: <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 9854: </div>
9855: </div>
9856: </div>
1.41 asau 9857: <div class="appendix">
9858: <div class="titlepage"><div><div><h1 class="title">
9859: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 9860: <div class="toc">
9861: <p><b>Table of Contents</b></p>
1.100 leot 9862: <dl class="toc">
1.1 dsieger 9863: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
9864: <dd><dl>
9865: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
9866: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
9867: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 9868: <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 9869: </dl></dd>
9870: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
9871: </dl>
9872: </div>
9873: <p>We checked to find a piece of software that wasn't in the packages
9874: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 9875: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 9876: present in the tree is beyond us, but it's useful for the purposes of
9877: this exercise.</p>
1.41 asau 9878: <div class="sect1">
1.1 dsieger 9879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9880: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 9881: <div class="sect2">
1.1 dsieger 9882: <div class="titlepage"><div><div><h3 class="title">
9883: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
9884: <pre class="programlisting">
9885: # $NetBSD$
9886: #
9887:
9888: DISTNAME= bison-1.25
9889: CATEGORIES= devel
9890: MASTER_SITES= ${MASTER_SITE_GNU}
9891:
1.29 dholland 9892: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 9893: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
9894: COMMENT= GNU yacc clone
9895:
9896: GNU_CONFIGURE= yes
1.46 wiz 9897: INFO_FILES= yes
1.1 dsieger 9898:
9899: .include "../../mk/bsd.pkg.mk"
9900: </pre>
9901: </div>
1.41 asau 9902: <div class="sect2">
1.1 dsieger 9903: <div class="titlepage"><div><div><h3 class="title">
9904: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
9905: <pre class="programlisting">
9906: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.79 snj 9907: 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 9908: of the NetBSD source tree is beyond me.
9909: </pre>
9910: </div>
1.41 asau 9911: <div class="sect2">
1.1 dsieger 9912: <div class="titlepage"><div><div><h3 class="title">
9913: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
9914: <pre class="programlisting">
9915: @comment $NetBSD$
9916: bin/bison
9917: man/man1/bison.1.gz
9918: share/bison.simple
9919: share/bison.hairy
9920: </pre>
9921: </div>
1.41 asau 9922: <div class="sect2">
1.1 dsieger 9923: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 9924: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 9925: </h3></div></div></div>
9926: <p>The NetBSD package system comes with
1.79 snj 9927: <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 9928: which helps to check the contents of these
9929: files. After installation it is quite easy to use, just change to the
9930: directory of the package you wish to examine and execute
1.10 hubertf 9931: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 9932: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
9933: looks fine.</pre>
9934: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 9935: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 9936: -Wall</strong></span> for a very thorough check.</p>
9937: </div>
9938: </div>
1.41 asau 9939: <div class="sect1">
1.1 dsieger 9940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9941: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
9942: <p>Create the directory where the package lives,
9943: plus any auxiliary directories:</p>
9944: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
9945: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
9946: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
9947: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
9948: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 9949: <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 9950: then continue with fetching the distfile:</p>
9951: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
9952: >> bison-1.25.tar.gz doesn't seem to exist on this system.
9953: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
9954: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9955: ftp: Error retrieving file: 500 Internal error
9956:
9957: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
9958: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9959: ftp: Error retrieving file: 500 Internal error
9960:
9961: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
9962: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9963: Successfully retrieved file.</pre>
9964: <p>Generate the checksum of the distfile into
9965: <code class="filename">distinfo</code>:</p>
9966: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
9967: <p>Now compile:</p>
9968: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
9969: >> Checksum OK for bison-1.25.tar.gz.
9970: ===> Extracting for bison-1.25
9971: ===> Patching for bison-1.25
9972: ===> Ignoring empty patch directory
9973: ===> Configuring for bison-1.25
9974: creating cache ./config.cache
9975: checking for gcc... cc
9976: checking whether we are using GNU C... yes
9977: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
9978: checking how to run the C preprocessor... cc -E
9979: checking for minix/config.h... no
9980: checking for POSIXized ISC... no
9981: checking whether cross-compiling... no
9982: checking for ANSI C header files... yes
9983: checking for string.h... yes
9984: checking for stdlib.h... yes
9985: checking for memory.h... yes
9986: checking for working const... yes
9987: checking for working alloca.h... no
9988: checking for alloca... yes
9989: checking for strerror... yes
9990: updating cache ./config.cache
9991: creating ./config.status
9992: creating Makefile
9993: ===> Building for bison-1.25
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 LR0.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 allocate.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 closure.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 conflicts.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 derives.c
9999: 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
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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.c
10009: 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
10010: 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
10011: 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
10012: 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
10013: 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
10014: 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
10015: 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
10016: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10017: rm -f bison.s1
10018: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10019: <p>Everything seems OK, so install the files:</p>
10020: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10021: >> Checksum OK for bison-1.25.tar.gz.
10022: ===> Installing for bison-1.25
10023: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10024: rm -f /usr/pkg/bin/bison
10025: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10026: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10027: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10028: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10029: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10030: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10031: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10032: ===> Registering installation for bison-1.25</pre>
10033: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10034: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10035: binary package, do this now:</p>
10036: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10037: >> Checksum OK for bison-1.25.tar.gz.
10038: ===> Building package for bison-1.25
10039: Creating package bison-1.25.tgz
10040: Registering depends:.
10041: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10042: <p>Now that you don't need the source and object files
10043: any more, clean up:</p>
10044: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10045: ===> Cleaning for bison-1.25</pre>
10046: </div>
10047: </div>
1.41 asau 10048: <div class="appendix">
10049: <div class="titlepage"><div><div><h1 class="title">
10050: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10051: <div class="toc">
10052: <p><b>Table of Contents</b></p>
1.100 leot 10053: <dl class="toc">
1.1 dsieger 10054: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10055: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10056: </dl>
10057: </div>
1.41 asau 10058: <div class="sect1">
1.1 dsieger 10059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10060: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10061: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10062: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10063: => figlet221.tar.gz doesn't seem to exist on this system.
10064: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10065: => [172219 bytes]
10066: Connected to ftp.plig.net.
10067: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10068: 331 Guest login ok, send your complete e-mail address as password.
10069: 230-You are user #5 of 500 simultaneous users allowed.
10070: 230-
10071: 230- ___ _ _ _
10072: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10073: 230- | _| _| . |_| . | | | . |_| . | _| . |
10074: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10075: 230- |_| |_| |___| |___|
10076: 230-
10077: 230-** Welcome to ftp.plig.org **
10078: 230-
10079: 230-Please note that all transfers from this FTP site are logged. If you
10080: 230-do not like this, please disconnect now.
10081: 230-
1.18 snj 10082: 230-This archive is available via
1.1 dsieger 10083: 230-
10084: 230-HTTP: http://ftp.plig.org/
10085: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10086: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10087: 230-
10088: 230-Please email comments, bug reports and requests for packages to be
10089: 230-mirrored to ftp-admin@plig.org.
10090: 230-
10091: 230-
10092: 230 Logged in anonymously.
10093: Remote system type is UNIX.
10094: Using binary mode to transfer files.
10095: 200 Type okay.
10096: 250 "/pub" is new cwd.
10097: 250-"/pub/figlet" is new cwd.
10098: 250-
10099: 250-Welcome to the figlet archive at ftp.figlet.org
10100: 250-
10101: 250- ftp://ftp.figlet.org/pub/figlet/
10102: 250-
10103: 250-The official FIGlet web page is:
10104: 250- http://www.figlet.org/
10105: 250-
10106: 250-If you have questions, please mailto:info@figlet.org. If you want to
10107: 250-contribute a font or something else, you can email us.
10108: 250
10109: 250 "/pub/figlet/program" is new cwd.
10110: 250 "/pub/figlet/program/unix" is new cwd.
10111: local: figlet221.tar.gz remote: figlet221.tar.gz
10112: 502 Unimplemented command.
10113: 227 Entering Passive Mode (195,40,6,41,246,104)
10114: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10115: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10116: 226 Transfer completed.
10117: 172219 bytes received in 00:02 (75.99 KB/s)
10118: 221 Goodbye.
10119: => Checksum OK for figlet221.tar.gz.
10120: ===> Extracting for figlet-2.2.1nb2
10121: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10122: ===> Patching for figlet-2.2.1nb2
10123: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10124: ===> Overriding tools for figlet-2.2.1nb2
10125: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10126: ===> Configuring for figlet-2.2.1nb2
10127: ===> Building for figlet-2.2.1nb2
10128: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10129: chmod a+x figlet
10130: gcc -O2 -o chkfont chkfont.c
10131: => Unwrapping files-to-be-installed.
10132: <code class="prompt">#</code>
10133: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10134: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10135: ===> Installing for figlet-2.2.1nb2
10136: install -d -o root -g wheel -m 755 /usr/pkg/bin
10137: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10138: mkdir -p /usr/pkg/share/figlet
10139: cp figlet /usr/pkg/bin
10140: cp chkfont /usr/pkg/bin
10141: chmod 555 figlist showfigfonts
10142: cp figlist /usr/pkg/bin
10143: cp showfigfonts /usr/pkg/bin
10144: cp fonts/*.flf /usr/pkg/share/figlet
10145: cp fonts/*.flc /usr/pkg/share/figlet
10146: cp figlet.6 /usr/pkg/man/man6
10147: ===> Registering installation for figlet-2.2.1nb2
10148: <code class="prompt">#</code></pre>
10149: </div>
1.41 asau 10150: <div class="sect1">
1.1 dsieger 10151: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10152: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10153: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10154: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10155: ===> Packaging figlet-2.2.1nb2
10156: ===> Building binary package for figlet-2.2.1nb2
10157: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10158: Using SrcDir value of /usr/pkg
10159: Registering depends:.
10160: <code class="prompt">#</code></pre>
10161: </div>
10162: </div>
1.41 asau 10163: <div class="appendix">
10164: <div class="titlepage"><div><div><h1 class="title">
10165: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10166: <div class="toc">
10167: <p><b>Table of Contents</b></p>
1.100 leot 10168: <dl class="toc">
1.23 wiz 10169: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10170: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10171: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10172: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10173: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10174: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10175: source packages</a></span></dt>
10176: </dl>
10177: </div>
10178: <p>As in other big projects, the directory layout of pkgsrc
10179: is quite complex for newbies. This chapter explains where you
10180: find things on the FTP server. The base directory on
1.10 hubertf 10181: <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 10182: On other servers it may be different, but inside this directory,
10183: everything should look the same, no matter on which server you
10184: are. This directory contains some subdirectories, which are
10185: explained below.</p>
1.41 asau 10186: <div class="sect1">
1.1 dsieger 10187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10188: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10189: <p>The directory <code class="filename">distfiles</code> contains lots
10190: of archive files from all pkgsrc packages, which are mirrored
10191: here. The subdirectories are called after their package names
10192: and are used when the distributed files have names that don't
10193: explicitly contain a version number or are otherwise too generic
10194: (for example <code class="filename">release.tar.gz</code>).</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-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10199: <p>This directory contains things that individual pkgsrc
10200: developers find worth publishing.</p>
10201: </div>
1.41 asau 10202: <div class="sect1">
1.1 dsieger 10203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10204: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10205: <p>This directory contains binary packages for the various
10206: platforms that are supported by pkgsrc.
10207: 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 10208: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10209: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10210: operating system for which the packages have been built. The
1.10 hubertf 10211: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10212: command, so it may differ from the one you are used to
10213: hear.</p></li>
1.23 wiz 10214: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10215: architecture of the platform for which the packages have been
1.10 hubertf 10216: built. It also includes the <code class="varname">ABI</code> (Application
10217: Binary Interface) for platforms that have several of
10218: them.</p></li>
1.23 wiz 10219: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10220: the operating system. For version numbers that change often (for
10221: example NetBSD-current), the often-changing part should be
10222: replaced with an <code class="literal">x</code>, for example
10223: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10224: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10225: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10226: for a stable branch, or <code class="literal">head</code> for packages
10227: built from the HEAD branch. The latter should only be used when
10228: the packages are updated on a regular basis. Otherwise the date
10229: from checking out pkgsrc should be appended, for example
10230: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10231: </ul></div>
10232: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10233: can quickly click through the directories on the
10234: server and find the best binary packages for their machines. Since they
10235: usually know the operating system and the hardware architecture, OPSYS
10236: and ARCH are placed first. After these choices, they can select the
10237: best combination of OSVERSION and TAG together, since it is usually the
10238: case that packages stay compatible between different version of the
10239: operating system.</p>
10240: <p>In each of these directories, there is a
10241: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10242: <code class="filename">All</code> which contains all binary packages.
10243: Besides that, there are various category directories that
10244: contain symbolic links to the real binary packages.</p>
10245: </div>
1.41 asau 10246: <div class="sect1">
1.1 dsieger 10247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10248: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10249: <p>Here are the reports from bulk builds, for those who want
10250: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10251: 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 10252: </div>
1.41 asau 10253: <div class="sect1">
1.8 rillig 10254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10255: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10256: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10257: source packages</h2></div></div></div>
1.23 wiz 10258: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10259: that is the files that define how to create binary packages from
10260: source archives.</p>
10261: <p>The directory <code class="filename">pkgsrc</code> contains a
10262: snapshot of the CVS repository, which is updated regularly. The
10263: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10264: directory, ready to be downloaded as a whole.</p>
10265: <p>In the directories for the quarterly branches, there is an
10266: additional file called
1.22 jakllsch 10267: <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 10268: which contains the state of pkgsrc when it was branched.</p>
10269: </div>
10270: </div>
1.41 asau 10271: <div class="appendix">
10272: <div class="titlepage"><div><div><h1 class="title">
10273: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10274: <div class="toc">
10275: <p><b>Table of Contents</b></p>
1.100 leot 10276: <dl class="toc">
1.1 dsieger 10277: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10278: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10279: </dl>
10280: </div>
10281: <p>This section contains information on editing the pkgsrc
10282: guide itself.</p>
1.41 asau 10283: <div class="sect1">
1.1 dsieger 10284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10285: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10286: <p>The pkgsrc guide's source code is stored in
10287: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10288: are created from it:</p>
1.41 asau 10289: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10290: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10291: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10292: <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>
10293: <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 10294: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10295: <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 10296: PostScript version of the pkgsrc guide.</p></li>
10297: </ul></div>
10298: </div>
1.41 asau 10299: <div class="sect1">
1.1 dsieger 10300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10301: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10302: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10303: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10304: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10305: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10306: documentation) installed. These are automatically installed when
1.79 snj 10307: 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 10308: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10309: right directory. All further steps will take place
10310: here.</p></li>
1.41 asau 10311: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10312: <code class="filename">files/</code>.</p></li>
1.41 asau 10313: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10314: guide for valid XML and to build the final output files. If you
10315: get any errors at this stage, you can just edit the files, as
10316: there are only symbolic links in the working directory, pointing
10317: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10318: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10319: commit)</strong></span></p></li>
1.41 asau 10320: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10321: regenerate the output files with the proper RCS
10322: Ids.</p></li>
1.41 asau 10323: <li class="step">
1.10 hubertf 10324: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10325: commit the files in both <code class="filename">pkgsrc/doc</code> and
10326: <code class="filename">htdocs</code>.</p>
1.41 asau 10327: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10328: <h3 class="title">Note</h3>
10329: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10330: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10331: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10332: directory.</p>
10333: </div>
10334: </li>
10335: </ol></div>
10336: </div>
10337: </div>
10338: </div></body>
10339: </html>
CVSweb <webmaster@jp.NetBSD.org>