Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.116
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.115 sevan 790: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
791: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
792: bourne shell and derivatives.</p>
1.1 dsieger 793: </div>
794: </div>
1.41 asau 795: <div class="part">
1.1 dsieger 796: <div class="titlepage"><div><div><h1 class="title">
797: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
798: <div class="toc">
799: <p><b>Table of Contents</b></p>
1.100 leot 800: <dl class="toc">
1.1 dsieger 801: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
802: <dd><dl>
803: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
804: <dd><dl>
1.51 asau 805: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 806: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 807: </dl></dd>
808: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
811: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
812: </dl></dd>
813: </dl></dd>
814: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
815: <dd><dl>
816: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
817: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
818: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
819: </dl></dd>
820: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
821: <dd><dl>
822: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
823: <dd><dl>
824: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
825: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
826: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
827: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
828: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
829: <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>
830: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
831: </dl></dd>
832: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
833: <dd><dl>
834: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
835: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
836: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
837: </dl></dd>
838: </dl></dd>
839: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
840: <dd><dl>
841: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
842: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 843: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 844: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 845: <dd><dl>
1.4 rillig 846: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 847: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
848: <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 849: </dl></dd>
1.4 rillig 850: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
851: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 852: </dl></dd>
853: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
854: <dd><dl>
855: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
856: <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 857: </dl></dd>
858: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
859: builds)</a></span></dt>
1.1 dsieger 860: <dd><dl>
1.71 wiz 861: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
862: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
863: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
864: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 865: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
866: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 867: </dl></dd>
868: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
869: <dd><dl>
1.23 wiz 870: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
871: <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 872: </dl></dd>
873: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
874: <dd><dl>
875: <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 876: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
877: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
878: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
879: <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>
880: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
881: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
882: <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>
883: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
884: <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 885: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 886: <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>
887: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
888: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
889: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
890: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
891: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
892: <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 893: </dl></dd>
894: </dl>
895: </div>
1.41 asau 896: <div class="chapter">
1.1 dsieger 897: <div class="titlepage"><div><div><h2 class="title">
898: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
899: <div class="toc">
900: <p><b>Table of Contents</b></p>
1.100 leot 901: <dl class="toc">
1.1 dsieger 902: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
903: <dd><dl>
1.51 asau 904: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 905: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 906: </dl></dd>
907: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
908: <dd><dl>
909: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
910: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
911: </dl></dd>
912: </dl>
913: </div>
914: <p>Before you download and extract the files, you need to decide
915: where you want to extract them. When using pkgsrc as root user, pkgsrc
916: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
917: free to install the sources and binary packages wherever you want in
918: your filesystem, provided that the pathname does not contain white-space
919: or other characters that are interpreted specially by the shell and some
920: other programs. A safe bet is to use only letters, digits, underscores
921: and dashes.</p>
1.41 asau 922: <div class="sect1">
1.1 dsieger 923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
924: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
925: <p>Before you download any pkgsrc files, you should decide
926: whether you want the <span class="emphasis"><em>current</em></span> branch or the
927: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
928: quarterly basis from the current branch and only gets modified
929: for security updates. The names of the stable branches are built
930: from the year and the quarter, for example
1.78 snj 931: <code class="literal">2014Q3</code>.</p>
1.1 dsieger 932: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 933: want to download pkgsrc. You can get it as a tar file or via CVS.
934: Both ways are described here.</p>
1.51 asau 935: <p>Note that tar archive contains CVS working copy.
936: Thus you can switch to using CVS at any later time.</p>
1.41 asau 937: <div class="sect2">
1.1 dsieger 938: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 939: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 940: <p>The primary download location for all pkgsrc files is
1.51 asau 941: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
942: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
943: (it points to the same location).
944: There are a number of subdirectories for different purposes,
945: 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>
946: <p>The tar archive for the current branch is in the directory
947: <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 948: It is autogenerated daily.</p>
1.51 asau 949: <p>To save download time we provide bzip2- and
950: xz-compressed archives which are published at
951: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
952: and
953: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
954: respectively.
955: </p>
956: <p>You can fetch the same files using FTP.</p>
1.78 snj 957: <p>The tar file for the stable branch 2014Q3 is in the
958: 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 959: <p>To download a pkgsrc stable tarball, run:</p>
960: <pre class="screen">
1.59 jnemeth 961: <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 962: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 963: stable branch to be downloaded, for example,
1.78 snj 964: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
965: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 966: or your web browser.</p>
1.12 weinem 967: <p>Then, extract it with:</p>
1.78 snj 968: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 969: <p>This will create the directory <code class="filename">pkgsrc/</code>
970: in <code class="filename">/usr/</code> and all the package source will be
971: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
972: <p>To download pkgsrc-current, run:</p>
973: <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 974: </div>
1.41 asau 975: <div class="sect2">
1.1 dsieger 976: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 977: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
978: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 979: <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 980: </pre>
981: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.78 snj 982: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.23 wiz 983: <p>This will create the directory <code class="filename">pkgsrc/</code>
984: in your <code class="filename">/usr/</code> directory and all the package source
985: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
986: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 987: <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 988: </pre>
1.78 snj 989: <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 990: <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 991: <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 992: </pre>
993: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
994: For Bourne shells, you can set it in your <code class="filename">.profile</code>
995: or better globally in <code class="filename">/etc/profile</code>:</p>
996: <pre class="programlisting">
997: # set CVS remote shell command
998: CVS_RSH=ssh
999: export CVS_RSH
1000: </pre>
1001: <p>By default, CVS doesn't do things like most people would expect it to do.
1002: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1003: in your home directory and saving the following lines to it.
1004: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1005: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1006: <pre class="programlisting">
1007: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1008: cvs -q -z2
1.2 rillig 1009: checkout -P
1.4 rillig 1010: update -dP
1011: diff -upN
1.2 rillig 1012: rdiff -u
1.23 wiz 1013: release -d
1.2 rillig 1014: </pre>
1.1 dsieger 1015: </div>
1016: </div>
1.41 asau 1017: <div class="sect1">
1.1 dsieger 1018: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1019: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1020: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1021: (which also works if you have first installed it via a tar
1022: file). It saves bandwidth and hard disk activity, compared to
1023: downloading the tar file again.</p>
1.41 asau 1024: <div class="sect2">
1.1 dsieger 1025: <div class="titlepage"><div><div><h3 class="title">
1026: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1027: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1028: <h3 class="title">Warning</h3>
1029: <p>When updating from a tar file, you first need to
1030: completely remove the old pkgsrc directory. Otherwise those
1031: files that have been removed from pkgsrc in the mean time will
1032: not be removed on your local disk, resulting in inconsistencies.
1033: When removing the old files, any changes that you have done to
1034: the pkgsrc files will be lost after updating. Therefore updating
1035: via CVS is strongly recommended.</p>
1036: </div>
1037: <p>Note that by default the distfiles and the binary packages
1038: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1039: before updating. You can also configure pkgsrc to store distfiles
1040: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1041: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1042: 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 1043: <p>To update pkgsrc from a tar file, download the tar file as
1044: explained above. Then, make sure that you have not made any
1045: changes to the files in the pkgsrc directory. Remove the pkgsrc
1046: directory and extract the new tar file. Done.</p>
1047: </div>
1.41 asau 1048: <div class="sect2">
1.1 dsieger 1049: <div class="titlepage"><div><div><h3 class="title">
1050: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1051: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1052: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1053: </pre>
1054: <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>
1055: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1056: </pre>
1.41 asau 1057: <div class="sect3">
1.1 dsieger 1058: <div class="titlepage"><div><div><h4 class="title">
1059: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1060: <p>When updating pkgsrc, the CVS program keeps track of the
1061: branch you selected. But if you, for whatever reason, want to
1062: switch from the stable branch to the current one, you can do it
1.23 wiz 1063: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1064: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1065: back to the stable branch, add the
1.78 snj 1066: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.1 dsieger 1067: </div>
1.41 asau 1068: <div class="sect3">
1.1 dsieger 1069: <div class="titlepage"><div><div><h4 class="title">
1070: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1071: <p>When you update pkgsrc, the CVS program will only touch
1072: those files that are registered in the CVS repository. That
1073: means that any packages that you created on your own will stay
1074: unmodified. If you change files that are managed by CVS, later
1075: updates will try to merge your changes with those that have been
1076: done by others. See the CVS manual, chapter
1.23 wiz 1077: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1078: </div>
1079: </div>
1080: </div>
1081: </div>
1.41 asau 1082: <div class="chapter">
1.1 dsieger 1083: <div class="titlepage"><div><div><h2 class="title">
1084: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1085: <div class="toc">
1086: <p><b>Table of Contents</b></p>
1.100 leot 1087: <dl class="toc">
1.1 dsieger 1088: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1089: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1090: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1091: </dl>
1092: </div>
1.41 asau 1093: <div class="sect1">
1.1 dsieger 1094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1095: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1096: <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 1097: </div>
1.41 asau 1098: <div class="sect1">
1.1 dsieger 1099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1100: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1101: <p>pkgsrc can be bootstrapped for use in two different modes:
1102: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1103: to privileged one all programs are installed under one particular user
1.43 asau 1104: and cannot utilise privileged operations (packages don't create
1105: special users and all special file permissions like setuid are ignored).
1106: </p>
1.1 dsieger 1107: <p>Installing the bootstrap kit from source should be as simple as:</p>
1108: <pre class="screen">
1.60 asau 1109: <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 1110: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1111: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1112: </pre>
1.43 asau 1113: <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>
1114: <p>By default, in privileged mode pkgsrc uses
1115: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1116: where programs will be installed in,
1.1 dsieger 1117: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1118: directory where pkgsrc will do its internal bookkeeping,
1119: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1120: where packages install their persistent data.
1121: In unprivileged mode pkgsrc uses
1122: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1123: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1124: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1125: </p>
1126: <p>You can change default layout using command-line arguments.
1127: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1128: </p>
1.41 asau 1129: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1130: <h3 class="title">Note</h3>
1.10 hubertf 1131: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1132: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1133: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1134: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1135: </div>
1.43 asau 1136: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1137: <h3 class="title">Note</h3>
1138: <p>It is possible to bootstrap multiple instances of pkgsrc
1139: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1140: corresponding to the installation you're working with to build
1141: and install packages.
1142: </p>
1143: </div>
1.1 dsieger 1144: </div>
1.41 asau 1145: <div class="sect1">
1.1 dsieger 1146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1147: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.111 sevan 1148: <p>For platform-specific notes consult the <code class="filename">README</code>
1149: 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 1150: </div>
1151: </div>
1.41 asau 1152: <div class="chapter">
1.1 dsieger 1153: <div class="titlepage"><div><div><h2 class="title">
1154: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1155: <div class="toc">
1156: <p><b>Table of Contents</b></p>
1.100 leot 1157: <dl class="toc">
1.1 dsieger 1158: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1159: <dd><dl>
1160: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1161: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1162: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1163: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1164: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1165: <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>
1166: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1167: </dl></dd>
1168: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1169: <dd><dl>
1170: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1171: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1172: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1173: </dl></dd>
1174: </dl>
1175: </div>
1176: <p>Basically, there are two ways of using pkgsrc. The first
1177: is to only install the package tools and to use binary packages
1.23 wiz 1178: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1179: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1180: of pkgsrc, too. Then you are able to build your own packages,
1181: and you can still use binary packages from someone else.</p>
1.41 asau 1182: <div class="sect1">
1.1 dsieger 1183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1184: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1185: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1186: server and its mirrors, there are collections of binary packages,
1187: ready to be installed. These binary packages have been built using the
1188: default settings for the directories, that is:</p>
1.41 asau 1189: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1190: <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>
1191: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1192: <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 1193: </ul></div>
1194: <p>If you cannot use these directories for whatever reasons (maybe
1195: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1196: 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 1197: <div class="sect2">
1.1 dsieger 1198: <div class="titlepage"><div><div><h3 class="title">
1199: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1200: <p>To install binary packages, you first need to know from where
1201: to get them. The first place where you should look is on the main
1.10 hubertf 1202: 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 1203: <p>This directory contains binary packages for multiple
1204: platforms. First, select your operating system. (Ignore the
1205: directories with version numbers attached to it, they just exist for
1206: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1207: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1208: <p>In this directory, you often find a file called
1209: <code class="filename">bootstrap.tar.gz</code> which contains the package
1210: management tools. If the file is missing, it is likely that your
1211: operating system already provides those tools. Download the file and
1212: extract it in the <code class="filename">/</code> directory. It will create
1213: the directories <code class="filename">/usr/pkg</code> (containing the tools
1214: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1215: (the database of installed packages).</p>
1.1 dsieger 1216: </div>
1.41 asau 1217: <div class="sect2">
1.1 dsieger 1218: <div class="titlepage"><div><div><h3 class="title">
1219: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1220: <p>In the directory from the last section, there is a
1.85 wiz 1221: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1222: binary packages that are available for the platform, excluding those
1223: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1224: medium you are using).</p>
1.9 rillig 1225: <p>To install packages directly from an FTP or HTTP server, run
1226: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1227: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1228: <pre class="screen">
1229: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85 wiz 1230: <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 1231: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1232: </pre>
1233: <p>Instead of URLs, you can also use local paths, for example if
1234: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1235: repository. If you want to install packages from multiple sources,
1236: you can separate them by a semicolon in
1237: <code class="varname">PKG_PATH</code>.</p>
1238: <p>After these preparations, installing a package is very
1239: easy:</p>
1240: <pre class="screen">
1241: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1242: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1243: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1244: </pre>
1.1 dsieger 1245: <p>Note that any prerequisite packages needed to run the
1246: package in question will be installed, too, assuming they are
1247: present where you install from.</p>
1.23 wiz 1248: <p>Adding packages might install vulnerable packages.
1249: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1250: regularly, especially after installing new packages, and verify
1251: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1252: <p>After you've installed packages, be sure to have
1253: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1254: <code class="varname">PATH</code> so you can actually start the just
1255: installed program.</p>
1256: </div>
1.41 asau 1257: <div class="sect2">
1.1 dsieger 1258: <div class="titlepage"><div><div><h3 class="title">
1259: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1260: <p>To deinstall a package, it does not matter whether it was
1261: installed from source code or from a binary package. The
1.10 hubertf 1262: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1263: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1264: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1265: name can be given with or without version number. Wildcards can
1266: also be used to deinstall a set of packages, for example
1267: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1268: so that the shell does not expand them before
1269: <code class="literal">pkg_delete</code> sees them.</p>
1270: <p>The <code class="option">-r</code> option is very powerful: it
1271: removes all the packages that require the package in question
1272: and then removes the package itself. For example:
1273:
1274: </p>
1275: <pre class="screen">
1276: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1277: </pre>
1278: <p>
1279:
1280: will remove jpeg and all the packages that used it; this allows
1281: upgrading the jpeg package.</p>
1282: </div>
1.41 asau 1283: <div class="sect2">
1.1 dsieger 1284: <div class="titlepage"><div><div><h3 class="title">
1285: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1286: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1287: installed packages or binary package files.</p>
1288: </div>
1.41 asau 1289: <div class="sect2">
1.1 dsieger 1290: <div class="titlepage"><div><div><h3 class="title">
1291: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1292: <p>
1293: The NetBSD Security-Officer and Packages Groups maintain a list of
1294: known security vulnerabilities to packages which are (or have been)
1295: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1296: 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 1297: </p>
1298: <p>
1.22 jakllsch 1299: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1300: this list can be downloaded
1301: automatically, and a security audit of all packages installed on a system
1302: can take place.
1303: </p>
1304: <p>
1.22 jakllsch 1305: There are two components to auditing. The first
1306: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1307: is for downloading
1.1 dsieger 1308: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1309: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1310: installed packages are vulnerable. If a package is vulnerable, you
1311: will see output similar to the following:
1312: </p>
1313: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1314: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1315: <p>
1.22 jakllsch 1316: You may wish to have the
1.10 hubertf 1317: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1318: file downloaded daily so that
1319: it remains current. This may be done by adding an appropriate entry
1.79 snj 1320: 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 1321: </p>
1322: <pre class="screen">
1323: # download vulnerabilities file
1324: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1325: </pre>
1326: <p>
1327: will update the vulnerability list every day at 3AM. You may wish to do
1328: this more often than once a day.
1329:
1330: In addition, you may wish to run the package audit from the daily
1331: security script. This may be accomplished by adding the following
1332: line to <code class="filename">/etc/security.local</code>:
1333: </p>
1334: <pre class="screen">
1335: /usr/sbin/pkg_admin audit
1336: </pre>
1337: <p>
1.1 dsieger 1338: </p>
1339: </div>
1.41 asau 1340: <div class="sect2">
1.1 dsieger 1341: <div class="titlepage"><div><div><h3 class="title">
1342: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1343: <p>
1.79 snj 1344: 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 1345: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1346: argument to check if your packages are up-to-date, e.g.
1347: </p>
1348: <pre class="screen">
1349: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1350: ...
1351: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1352: </pre>
1.10 hubertf 1353: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1354: package on your system and rebuild any dependencies.
1355: </p>
1356: </div>
1.41 asau 1357: <div class="sect2">
1.1 dsieger 1358: <div class="titlepage"><div><div><h3 class="title">
1359: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1360: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1361: administrative functions on the package system.</p>
1362: </div>
1363: </div>
1.41 asau 1364: <div class="sect1">
1.1 dsieger 1365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1366: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1367: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1368: directory now contains a set of packages, organized into
1369: categories. You can browse the online index of packages, or run
1.10 hubertf 1370: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1371: directory to build local <code class="filename">README.html</code> files for
1.79 snj 1372: 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 1373: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1374: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1375: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1376: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1377: different <code class="varname">LOCALBASE</code> definitions on the same
1378: system (inside a chroot is an exception). </p>
1379: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1380: 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 1381: instructions how to create your own packages.</p>
1.41 asau 1382: <div class="sect2">
1.1 dsieger 1383: <div class="titlepage"><div><div><h3 class="title">
1384: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1385: <p>To build packages from source, you need a working C
1386: compiler. On NetBSD, you need to install the
1.23 wiz 1387: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1388: sets. If you want to build X11-related packages, the
1.23 wiz 1389: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1390: sets are required, too.</p>
1391: </div>
1.41 asau 1392: <div class="sect2">
1.1 dsieger 1393: <div class="titlepage"><div><div><h3 class="title">
1394: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1395: <p>The first step for building a package is downloading the
1396: distfiles (i.e. the unmodified source). If they have not yet been
1397: downloaded, pkgsrc will fetch them automatically.</p>
1398: <p>If you have all files that you need in the
1399: <code class="filename">distfiles</code> directory,
1400: you don't need to connect. If the distfiles are on CD-ROM, you can
1401: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1402: </p>
1403: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1404: <p>
1.10 hubertf 1405: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1406: <p>By default a list of distribution sites will be randomly
1407: intermixed to prevent huge load on servers which holding popular
1408: packages (for example, SourceForge.net mirrors). Thus, every
1409: time when you need to fetch yet another distfile all the mirrors
1410: will be tried in new (random) order. You can turn this feature
1411: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1412: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1413: <p>You can overwrite some of the major distribution sites to
1414: fit to sites that are close to your own. By setting one or two
1415: variables you can modify the order in which the master sites are
1416: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1417: delimited list of domain suffixes.
1418: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1419: contains a whitespace delimited list of regular expressions. It
1420: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1421: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1422: some examples. This may save some of your bandwidth and
1423: time.</p>
1424: <p>You can change these settings either in your shell's environment, or,
1425: if you want to keep the settings, by editing the
1.10 hubertf 1426: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1427: and adding the definitions there.</p>
1428: <p>
1429: If a package depends on many other packages (such as
1.79 snj 1430: <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 1431: alternate between periods of
1432: downloading source, and compiling. To ensure you have all the source
1433: downloaded initially you can run the command:
1434: </p>
1435: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1436: <p>
1437: which will output and run a set of shell commands to fetch the
1438: necessary files into the <code class="filename">distfiles</code> directory. You can
1439: also choose to download the files manually.
1440: </p>
1441: </div>
1.41 asau 1442: <div class="sect2">
1.1 dsieger 1443: <div class="titlepage"><div><div><h3 class="title">
1444: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1445: <p>
1446: Once the software has downloaded, any patches will be applied, then it
1447: will be compiled for you. This may take some time depending on your
1448: computer, and how many other packages the software depends on and their
1449: compile time.
1450: </p>
1.41 asau 1451: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1452: <h3 class="title">Note</h3>
1453: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1454: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1455: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1456: </div>
1457: <p>For example, type</p>
1458: <pre class="screen">
1459: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1460: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1461: </pre>
1462: <p>at the shell prompt to build the various components of the
1463: package.</p>
1464: <p>The next stage is to actually install the newly compiled
1465: program onto your system. Do this by entering:
1466:
1467: </p>
1468: <pre class="screen">
1469: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1470: </pre>
1471: <p>
1472:
1473: while you are still in the directory for whatever package you
1474: are installing.</p>
1475: <p>Installing the package on your system may require you to
1476: be root. However, pkgsrc has a
1477: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1478: to only become root for the actual installation step.</p>
1479: <p>That's it, the software should now be installed and setup for use.
1480: You can now enter:
1481:
1482: </p>
1483: <pre class="screen">
1484: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1485: </pre>
1486: <p>
1487:
1488: to remove the compiled files in the work directory, as you shouldn't need
1489: them any more. If other packages were also added to your system
1490: (dependencies) to allow your program to compile, you can tidy these up
1491: also with the command:</p>
1492: <pre class="screen">
1493: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1494: </pre>
1495: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1496: 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 1497: <p>The program is installed under the default root of the
1498: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1499: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1500: variable in your environment, and it will use that value as the
1501: root of your packages tree. So, to use
1502: <code class="filename">/usr/local</code>, set
1503: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1504: Please note that you should use a directory which is dedicated to
1505: packages and not shared with other programs (i.e., do not try and
1506: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1507: to add any of your own files or directories (such as
1508: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1509: <code class="filename">pkgsrc/</code>) below the
1510: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1511: conflicts between programs and other files installed by the
1512: package system and whatever else may have been installed
1513: there.</p>
1.10 hubertf 1514: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1515: alter some configuration options at build time. Have a look at
1516: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1517: of what will be set there by default. Environment variables such
1518: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1519: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1520: set them each time you want to use pkgsrc.</p>
1.23 wiz 1521: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1522: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1523: or being installed. This may be for debugging purposes, or out of
1524: simple curiosity. A number of utility values have been added to
1525: help with this.</p>
1.23 wiz 1526: <div class="orderedlist"><ol class="orderedlist" type="1">
1527: <li class="listitem">
1.79 snj 1528: <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 1529: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1530: information will be displayed. For example,</p>
1531: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1532: <p>will show all the commands that are invoked, up to and
1.23 wiz 1533: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1534: </li>
1.23 wiz 1535: <li class="listitem">
1.79 snj 1536: <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 1537: definition, then the <code class="varname">VARNAME</code> definition
1538: should be used, in conjunction with the show-var
1.79 snj 1539: 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 1540: variable <code class="varname">LOCALBASE</code>:</p>
1541: <pre class="screen">
1542: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1543: /usr/pkg
1544: <code class="prompt">%</code>
1545: </pre>
1546: </li>
1547: </ol></div>
1548: <p>If you want to install a binary package that you've either
1549: created yourself (see next section), that you put into
1550: pkgsrc/packages manually or that is located on a remote FTP
1551: server, you can use the "bin-install" target. This target will
1.79 snj 1552: 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 1553: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1554: sites searched is kept in the variable
1555: <code class="varname">BINPKG_SITES</code>, which defaults to
1.79 snj 1556: 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 1557: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1558: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1559: details.</p>
1560: <p>A final word of warning: If you set up a system that has a
1561: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1562: set that before any packages are installed, as you cannot use
1563: several directories for the same purpose. Doing so will result in
1564: pkgsrc not being able to properly detect your installed packages,
1565: and fail miserably. Note also that precompiled binary packages are
1566: usually built with the default <code class="varname">LOCALBASE</code> of
1567: <code class="filename">/usr/pkg</code>, and that you should
1568: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1569: <code class="varname">LOCALBASE</code>.</p>
1570: </div>
1571: </div>
1572: </div>
1.41 asau 1573: <div class="chapter">
1.1 dsieger 1574: <div class="titlepage"><div><div><h2 class="title">
1575: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
1576: <div class="toc">
1577: <p><b>Table of Contents</b></p>
1.100 leot 1578: <dl class="toc">
1.1 dsieger 1579: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
1580: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 1581: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 1582: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 1583: <dd><dl>
1.4 rillig 1584: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 1585: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1586: <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 1587: </dl></dd>
1.4 rillig 1588: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
1589: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1590: </dl>
1591: </div>
1.4 rillig 1592: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1593: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1594: that file depends on the installation. On NetBSD, when you use
1.79 snj 1595: <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 1596: <code class="filename">/etc/</code>. In all other cases the default location is
1597: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1598: bootstrap program to install the binary packages.</p>
1599: <p>The format of the configuration file is that of the usual
1600: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1601: is done by setting variables in this file. Note that you can define all
1602: kinds of variables, and no special error checking (for example for
1.112 rillig 1603: spelling mistakes) takes place.</p>
1.41 asau 1604: <div class="sect1">
1.1 dsieger 1605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1606: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.112 rillig 1607: <p>The following variables apply to all
1.1 dsieger 1608: pkgsrc packages. A complete list of the variables that can be
1609: configured by the user is available in
1610: <code class="filename">mk/defaults/mk.conf</code>, together with some
1611: comments that describe each variable's intent.</p>
1.41 asau 1612: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1613: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1614: packages will be installed. The default is
1615: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1616: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1617: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1618: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1619: installed. The default is
1620: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1621: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1622: X11 is installed on the system. The default is
1.84 wiz 1623: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1624: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1625: downloaded copies of the original source distributions used
1626: for building pkgsrc packages. The default is
1627: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1628: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1629: database about installed packages is stored. The default is
1630: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 1631: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1632: If set, override the packages'
1633: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1634: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1635: Backup location(s) for distribution files and patch files
1636: if not found locally or in
1637: <code class="filename">${MASTER_SITES}</code> or
1638: <code class="filename">${PATCH_SITES}</code> respectively.
1639: The defaults are
1.25 spz 1640: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 1641: and
1642: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1643: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1644: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1645: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1646: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1647: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1648: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1649: List of acceptable licenses. License names are case-sensitive.
1650: Whenever you try to build a package whose license is not in this
1651: list, you will get an error message. If the license condition is
1652: simple enough, the error message will include specific
1653: instructions on how to change this variable.</p></li>
1.1 dsieger 1654: </ul></div>
1655: </div>
1.41 asau 1656: <div class="sect1">
1.1 dsieger 1657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1658: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1659: <p>
1.1 dsieger 1660: </p>
1.41 asau 1661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1662: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1663: directory for the binary packages. The default is
1664: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1665: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1666: The top level directory where, if defined, the separate
1667: working directories will get created, and symbolically
1668: linked to from <code class="filename">${WRKDIR}</code> (see below).
1669: This is useful for building packages on several
1670: architectures, then <code class="filename">${PKGSRCDIR}</code>
1671: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1672: is local to every architecture. (It should be noted that
1673: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1674: — it is an internal definition which refers to the
1.1 dsieger 1675: root of the pkgsrc tree. It is possible to have many
1676: pkgsrc tree instances.)</p></li>
1.23 wiz 1677: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1678: Directory for local patches that aren't part of pkgsrc.
1.108 rillig 1679: 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 1680: information.</p></li>
1.23 wiz 1681: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1682: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1683: BSD-style Makefile. If this is not set,
1684: <code class="varname">MAKECONF</code> is set to
1685: <code class="filename">/dev/null</code> to avoid picking up
1686: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 1687: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 1688: By default, dependencies are only installed, and no binary
1689: package is created for them. You can set this variable to
1.66 asau 1690: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 1691: packages after installing dependencies. Please note that the
1.84 wiz 1692: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 1693: <code class="literal">yes</code> to preserve binary packages when
1694: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 1695: </ul></div>
1696: </div>
1.41 asau 1697: <div class="sect1">
1.1 dsieger 1698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 1699: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.107 jnemeth 1700: <p>Packages have to support installation into a
1.4 rillig 1701: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1702: to be built, before the actual filesystem is touched. DESTDIR
1703: support exists in two variations:</p>
1.41 asau 1704: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1705: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1706: installation and packaging is still run as root.</p></li>
1707: <li class="listitem"><p>Full DESTDIR support can run the complete
1708: build, installation and packaging as normal user. Root
1709: privileges are only needed to add packages.</p></li>
1710: </ul></div>
1.4 rillig 1711: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1712: clean</code></strong> needs to be run as root.</p>
1.17 imil 1713: <p>Considering the <code class="filename">foo/bar</code> package,
1714: DESTDIR full support can be tested using the following commands
1715:
1716: </p>
1717: <pre class="programlisting">
1718: <code class="prompt">$</code> id
1719: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1720: <code class="prompt">$</code> mkdir $HOME/packages
1721: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1722: </pre>
1723: <p>
1724:
1725: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1726: should be needed
1727:
1728: </p>
1729: <pre class="programlisting">
1.66 asau 1730: <code class="prompt">$</code> make stage-install
1.17 imil 1731: </pre>
1732: <p>
1733:
1734: Create a package without root privileges
1735:
1736: </p>
1737: <pre class="programlisting">
1.66 asau 1738: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1739: </pre>
1740: <p>
1741:
1742: For the following command, you must be able to gain root
1.79 snj 1743: 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 1744:
1745: </p>
1746: <pre class="programlisting">
1.66 asau 1747: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1748: </pre>
1749: <p>
1750:
1751: Then, as a simple user
1752:
1753: </p>
1754: <pre class="programlisting">
1755: <code class="prompt">$</code> make clean
1756: </pre>
1757: <p>
1758:
1759: </p>
1.4 rillig 1760: </div>
1.41 asau 1761: <div class="sect1">
1.4 rillig 1762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1763: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1764: <div class="sect2">
1.1 dsieger 1765: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1766: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1767: <p>By default, pkgsrc will use GCC to build packages. This may be
1768: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1769: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1770: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1771: <dd>
1772: <p>This is a list of values specifying the chain of
1773: compilers to invoke when building packages. Valid values
1774: are:</p>
1.41 asau 1775: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1776: <li class="listitem"><p><code class="varname">ccc</code>:
1777: Compaq C Compilers (Tru64)</p></li>
1778: <li class="listitem"><p><code class="varname">ccache</code>:
1779: compiler cache (chainable)</p></li>
1780: <li class="listitem"><p><code class="varname">clang</code>:
1781: Clang C and Objective-C compiler</p></li>
1.23 wiz 1782: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1783: distributed C/C++ (chainable)</p></li>
1.66 asau 1784: <li class="listitem"><p><code class="varname">f2c</code>:
1785: Fortran 77 to C compiler (chainable)</p></li>
1786: <li class="listitem"><p><code class="varname">icc</code>:
1787: Intel C++ Compiler (Linux)</p></li>
1788: <li class="listitem"><p><code class="varname">ido</code>:
1789: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1790: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1791: GNU C/C++ Compiler</p></li>
1.66 asau 1792: <li class="listitem"><p><code class="varname">hp</code>:
1793: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1794: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1795: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1796: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1797: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1798: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1799: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1800: <li class="listitem"><p><code class="varname">xlc</code>:
1801: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 1802: </ul></div>
1803: <p>The default is
1.23 wiz 1804: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1805: <code class="varname">ccache</code> and/or
1806: <code class="varname">distcc</code> with an appropriate
1807: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1808: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1809: variable should always be terminated with a value for
1810: a real compiler. Note that only one real compiler
1.23 wiz 1811: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1812: is not allowed).</p>
1813: </dd>
1814: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1815: <dd><p>This specifies the minimum version of GCC to use
1816: when building packages. If the system GCC doesn't
1817: satisfy this requirement, then pkgsrc will build and
1818: install one of the GCC packages to use instead.</p></dd>
1.114 maya 1819: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
1820: <dd><p>Specifies which version of python to use when several
1821: options are available.</p></dd>
1822: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1823: <dd><p>Specifies the fortran compiler to use.
1824: The default is <code class="varname">g95</code>, and
1825: <code class="varname">gfortran</code> is an alternative.</p></dd>
1826: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1827: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1828: <code class="varname">gfortran</code> is used, this option specifies which
1829: version to use.</p></dd>
1.1 dsieger 1830: </dl></div>
1831: </div>
1.41 asau 1832: <div class="sect2">
1.1 dsieger 1833: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1834: <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 1835: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1836: please make sure to use the <code class="literal">+=</code> operator
1837: instead of the <code class="literal">=</code> operator:</p>
1838: <pre class="programlisting">
1839: CFLAGS+= -your -flags
1840: </pre>
1841: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1842: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1843: need to add their own flags. You may want to take a look
1.79 snj 1844: 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 1845: package if you're interested in optimization specifically
1846: for the current CPU. </p>
1.1 dsieger 1847: </div>
1.41 asau 1848: <div class="sect2">
1.1 dsieger 1849: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1850: <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 1851: <p>If you want to pass flags to the linker, both in the configure
1852: step and the build step, you can do this in two ways. Either set
1853: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1854: between the two is that <code class="varname">LIBS</code> will be appended to
1855: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1856: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1857: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1858: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1859: <code class="varname">CFLAGS</code>, if you do not wish to override these
1860: settings, use the <code class="literal">+=</code> operator:</p>
1861: <pre class="programlisting">
1862: LDFLAGS+= -your -linkerflags
1863: </pre>
1864: </div>
1865: </div>
1.41 asau 1866: <div class="sect1">
1.1 dsieger 1867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1868: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1869: <p>
1.1 dsieger 1870: </p>
1.41 asau 1871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1872: <li class="listitem">
1.1 dsieger 1873: <p><code class="varname">PKG_DEVELOPER</code>:
1874: Run some sanity checks that package developers want:
1875: </p>
1.41 asau 1876: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1877: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1878: fuzz</p></li>
1.23 wiz 1879: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1880: binaries will find their shared libs.</p></li>
1881: </ul></div>
1882: <p>
1883: </p>
1884: </li>
1.23 wiz 1885: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1886: of debugging output which is displayed whilst making and
1887: installing the package. The default value for this is 0,
1888: which will not display the commands as they are executed
1889: (normal, default, quiet operation); the value 1 will display
1890: all shell commands before their invocation, and the value 2
1891: will display both the shell commands before their invocation,
1.112 rillig 1892: as well as their actual execution progress with <span class="command"><strong>set
1893: -x</strong></span>.</p></li>
1.1 dsieger 1894: </ul></div>
1895: <p>
1896: </p>
1897: </div>
1.41 asau 1898: <div class="sect1">
1.1 dsieger 1899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1900: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1901: <p>Some packages have build time options, usually to select
1902: between different dependencies, enable optional support for big
1903: dependencies or enable experimental features.</p>
1904: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1905: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1906: show-options</strong></span>, for example:</p>
1907: <pre class="programlisting">
1908: The following options are supported by this package:
1909: ssl Enable SSL support.
1910: Exactly one of the following gecko options is required:
1911: firefox Use firefox as gecko rendering engine.
1912: mozilla Use mozilla as gecko rendering engine.
1913: At most one of the following database options may be selected:
1914: mysql Enable support for MySQL database.
1915: pgsql Enable support for PostgreSQL database.
1916:
1917: These options are enabled by default: firefox
1918: These options are currently enabled: mozilla ssl
1919: </pre>
1920: <p>The following variables can be defined in
1.10 hubertf 1921: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1922: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1923: which can be used to select or disable options for all packages
1924: that support them, and
1925: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1926: which can be used to select or disable options specifically for
1927: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1928: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1929: are disabled. A few examples:</p>
1930: <pre class="screen">
1.10 hubertf 1931: <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 1932: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1933: PKG_OPTIONS.kdebase= debug -sasl
1934: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1935: <p>It is important to note that options that were specifically
1.18 snj 1936: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1937: you do not wish to include the option. If you are unsure you can view
1938: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1939: <p>The following settings are consulted in the order given, and
1940: the last setting that selects or disables an option is
1941: used:</p>
1.23 wiz 1942: <div class="orderedlist"><ol class="orderedlist" type="1">
1943: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1944: maintainer</p></li>
1.23 wiz 1945: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1946: variables (see below)</p></li>
1.23 wiz 1947: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1948: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1949: </ol></div>
1950: <p>For groups of mutually exclusive options, the last option
1951: selected is used, all others are automatically disabled. If an
1952: option of the group is explicitly disabled, the previously
1953: selected option, if any, is used. It is an error if no option
1954: from a required group of options is selected, and building the
1955: package will fail.</p>
1956: <p>Before the options framework was introduced, build options
1957: were selected by setting a variable (often named
1958: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 1959: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 1960: transition to the options framework for the user, these legacy
1961: variables are converted to the appropriate options setting
1962: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1963: automatically. A warning is issued to prompt the user to update
1.10 hubertf 1964: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 1965: directly. Support for the legacy variables will be removed
1966: eventually.</p>
1967: </div>
1968: </div>
1.41 asau 1969: <div class="chapter">
1.1 dsieger 1970: <div class="titlepage"><div><div><h2 class="title">
1971: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
1972: <div class="toc">
1973: <p><b>Table of Contents</b></p>
1.100 leot 1974: <dl class="toc">
1.1 dsieger 1975: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
1976: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1977: </dl>
1978: </div>
1.41 asau 1979: <div class="sect1">
1.1 dsieger 1980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1981: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1982: <p>Once you have built and installed a package, you can create
1983: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.79 snj 1984: 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 1985: the same package on a group of hosts and wasting CPU time. It also
1986: provides a simple means for others to install your package, should
1987: you distribute it.</p>
1988: <p>To create a binary package, change into the appropriate
1.10 hubertf 1989: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 1990: package</strong></span>:</p>
1991: <pre class="screen">
1.112 rillig 1992: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1993: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
1994: </pre>
1.1 dsieger 1995: <p>This will build and install your package (if not already done),
1996: and then build a binary package from what was installed. You can
1.10 hubertf 1997: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 1998: it. Binary packages are created by default in
1999: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2000: 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 2001: 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 2002: <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 2003: such a binary package.</p>
2004: </div>
1.41 asau 2005: <div class="sect1">
1.1 dsieger 2006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2007: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2008: <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 2009: </div>
2010: </div>
1.41 asau 2011: <div class="chapter">
1.6 rillig 2012: <div class="titlepage"><div><div><h2 class="title">
2013: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2014: builds)</h2></div></div></div>
2015: <div class="toc">
2016: <p><b>Table of Contents</b></p>
1.100 leot 2017: <dl class="toc">
1.71 wiz 2018: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2019: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2020: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2021: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2022: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2023: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2024: </dl>
2025: </div>
1.71 wiz 2026: <p>For a number of reasons you may want to build binary packages
2027: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2028: For instance, when you have multiple machines that should run the same software,
2029: it is wasted time if they all build their packages themselves from source.
2030: Or you may want to build a list of packages you want and check them before
2031: deploying onto production system.
2032: There is a way of getting a set of binary packages:
1.112 rillig 2033: The bulk build system, or pbulk ("p" stands for "parallel").
2034: This chapter describes how to set it up.</p>
1.41 asau 2035: <div class="sect1">
1.6 rillig 2036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2037: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2038: <p>First of all, you have to decide whether you build all packages
2039: or a limited set of them. Full bulk builds usually consume a lot more resources,
2040: both space and time, than builds for some practical sets of packages.
2041: There exists a number of particularly heavy packages that are not actually
2042: interesting to a wide audience.
2043:
2044: For a limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2045: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2046: </p>
2047: <p>During bulk builds various packages are installed and deinstalled
2048: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2049: so make sure that you don't need any package during the builds.
1.112 rillig 2050: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2051: or something even more restrictive, depending on what the operating system provides,
2052: or dedicate the whole physical machine.
2053: As a useful side effect this makes sure that bulk builds cannot
2054: break anything in your system. There have been numerous cases where
1.6 rillig 2055: certain packages tried to install files outside the
2056: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2057: <code class="filename">/etc</code>.
2058: </p>
1.6 rillig 2059: </div>
1.41 asau 2060: <div class="sect1">
1.6 rillig 2061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2062: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2063: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2064: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2065: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2066: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2067: </ul></div>
1.41 asau 2068: <div class="sect2">
1.15 rillig 2069: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2070: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.112 rillig 2071: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2072: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2073: Configure network access to fetch distribution files.
1.112 rillig 2074: Create a user with name "pbulk".</p>
1.68 asau 2075: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2076: <pre class="screen">
1.72 wiz 2077: <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>
2078: <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>
2079: <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 2080: </pre>
2081: <p>Or any other way that fits (e.g., curl, wget).</p>
2082: <p>Deploy and configure pbulk tools, e.g.:</p>
2083: <pre class="screen">
2084: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2085: <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>
2086: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2087: </pre>
2088: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2089: <h3 class="title">Note</h3>
2090: <p><code class="filename">mk.conf.frag</code> is a fragment of
2091: <code class="filename">mk.conf</code> that contains settings you want to
2092: apply to packages you build. For instance,</p>
2093: <pre class="programlisting">
1.112 rillig 2094: PKG_DEVELOPER= yes # perform more checks
2095: X11_TYPE= modular # use pkgsrc X11
2096: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2097: # when building all packages)
1.68 asau 2098: </pre>
2099: </div>
2100: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2101: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2102: <pre class="programlisting">
2103: www/firefox
2104: mail/thunderbird
2105: misc/libreoffice4
2106: </pre>
1.69 asau 2107: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2108: and make final amendments, if wanted.</p>
1.68 asau 2109: <p>Start it:</p>
2110: <pre class="screen">
2111: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2112: </pre>
2113: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2114: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2115: </p>
2116: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2117: <h3 class="title">Note</h3>
2118: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2119: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2120: The script is kept small enough for better understanding.</p>
2121: </div>
2122: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2123: <h3 class="title">Note</h3>
2124: <p>The <code class="filename">pbulk.sh</code> script supports running
2125: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2126: </div>
1.6 rillig 2127: </div>
2128: </div>
1.41 asau 2129: <div class="sect1">
1.6 rillig 2130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2131: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2132: <p>A complete bulk build requires lots of disk space. Some of the
2133: disk space can be read-only, some other must be writable. Some can be on
2134: remote filesystems (such as NFS) and some should be local. Some can be
2135: temporary filesystems, others must survive a sudden reboot.</p>
2136: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2137: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2138: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2139: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2140: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2141: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2142: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2143: </ul></div>
2144: </div>
2145: <div class="sect1">
2146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2147: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2148: <p>After your pkgsrc bulk-build has completed, you may wish to
2149: create a CD-ROM set of the resulting binary packages to assist
2150: in installing packages on other machines. The
1.79 snj 2151: <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 2152: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2153: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2154: way that keeps all the dependencies for a given package on the same
2155: CD as that package.</p>
1.41 asau 2156: <div class="sect2">
1.1 dsieger 2157: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2158: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2159: <p>Complete documentation for cdpack is found in the cdpack(1)
2160: man page. The following short example assumes that the binary
2161: packages are left in
2162: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2163: sufficient disk space exists in <code class="filename">/u2</code> to
2164: hold the ISO 9660 images.</p>
2165: <pre class="screen">
2166: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2167: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2168: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2169: </pre>
2170: <p>If you wish to include a common set of files
2171: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2172: etc.) on each CD in the collection, then you need to create a
2173: directory which contains these files. e.g.</p>
2174: <pre class="screen">
2175: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2176: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2177: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2178: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2179: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2180: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2181: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2182: </pre>
2183: <p>Now create the images:</p>
2184: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2185: <p>Each image will contain <code class="filename">README</code>,
2186: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2187: in their root directories.</p>
2188: </div>
2189: </div>
2190: </div>
1.41 asau 2191: <div class="chapter">
1.1 dsieger 2192: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2193: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2194: <div class="toc">
2195: <p><b>Table of Contents</b></p>
1.100 leot 2196: <dl class="toc">
1.23 wiz 2197: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2198: <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 2199: </dl>
2200: </div>
2201: <p>The files that are installed by pkgsrc are organized in a way that
2202: is similar to what you find in the <code class="filename">/usr</code> directory
2203: of the base system. But some details are different. This is because
2204: pkgsrc initially came from FreeBSD and had adopted its file system
2205: hierarchy. Later it was largely influenced by NetBSD. But no matter
2206: which operating system you are using pkgsrc with, you can expect the
2207: same layout for pkgsrc.</p>
2208: <p>There are mainly four root directories for pkgsrc, which are all
2209: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2210: When pkgsrc has been installed as root, the default locations
2211: are:</p>
2212: <pre class="programlisting">
2213: LOCALBASE= /usr/pkg
2214: PKG_SYSCONFBASE= /usr/pkg/etc
2215: VARBASE= /var
2216: PKG_DBDIR= /var/db/pkg
2217: </pre>
2218: <p>In unprivileged mode (when pkgsrc has been installed as any other
2219: user), the default locations are:</p>
2220: <pre class="programlisting">
2221: LOCALBASE= ${HOME}/pkg
2222: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2223: VARBASE= ${HOME}/pkg/var
2224: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2225: </pre>
2226: <p>What these four directories are for, and what they look like is
2227: explained below.</p>
1.41 asau 2228: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2229: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2230: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2231: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2232: the well-known subdirectories like <code class="filename">bin</code>,
2233: <code class="filename">include</code>, <code class="filename">lib</code>,
2234: <code class="filename">share</code> and
2235: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2236: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2237: <code class="filename">/var</code> in the base system. Some programs (especially
2238: games, network daemons) need write access to it during normal
2239: operation.</p></li>
1.23 wiz 2240: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2241: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2242: 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 2243: itself.</p></li>
2244: </ul></div>
1.41 asau 2245: <div class="sect1">
1.1 dsieger 2246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2247: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2248: </h2></div></div></div>
2249: <p>The following directories exist in a typical pkgsrc installation
2250: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2251: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2252: <dt><span class="term"><code class="filename">bin</code></span></dt>
2253: <dd><p>Contains executable programs that are intended to be
2254: directly used by the end user.</p></dd>
2255: <dt><span class="term"><code class="filename">emul</code></span></dt>
2256: <dd><p>Contains files for the emulation layers of various other
2257: operating systems, especially for
2258: NetBSD.</p></dd>
2259: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2260: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2261: <dd><p>Contains
2262: the configuration files.</p></dd>
2263: <dt><span class="term"><code class="filename">include</code></span></dt>
2264: <dd><p>Contains headers for the C and C++ programming
2265: languages.</p></dd>
2266: <dt><span class="term"><code class="filename">info</code></span></dt>
2267: <dd><p>Contains GNU info files of various
2268: packages.</p></dd>
2269: <dt><span class="term"><code class="filename">lib</code></span></dt>
2270: <dd><p>Contains shared and static
2271: libraries.</p></dd>
2272: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2273: <dd><p>Contains data files that don't change after
2274: installation. Other data files belong into
2275: <code class="filename">${VARBASE}</code>.</p></dd>
2276: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2277: <dd><p>Contains programs that are not intended to be used by
2278: end users, such as helper programs or network
2279: daemons.</p></dd>
2280: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2281: <dd><p>Contains programs that are intended to be executed as
2282: CGI scripts by a web server.</p></dd>
2283: <dt><span class="term"><code class="filename">man</code> (the usual value of
2284: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2285: <dd><p>Contains brief
2286: documentation in form of manual pages.</p></dd>
2287: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2288: <dd><p>Contains programs that are intended to be used only by
2289: the super-user.</p></dd>
2290: <dt><span class="term"><code class="filename">share</code></span></dt>
2291: <dd><p>Contains platform-independent data files that don't
2292: change after installation.</p></dd>
2293: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2294: <dd><p>Contains documentation files provided by the
2295: packages.</p></dd>
2296: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2297: <dd><p>Contains example files provided by the packages. Among
2298: others, the original configuration files are saved here and copied to
2299: <code class="filename">${PKG_SYSCONFDIR}</code> during
2300: installation.</p></dd>
2301: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2302: <dd><p>Contains the original files for rc.d
2303: scripts.</p></dd>
2304: <dt><span class="term"><code class="filename">var</code> (the usual location of
2305: <code class="filename">${VARBASE}</code>)</span></dt>
2306: <dd><p>Contains files
2307: that may be modified after
2308: installation.</p></dd>
2309: </dl></div>
2310: </div>
1.41 asau 2311: <div class="sect1">
1.1 dsieger 2312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2313: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2314: </h2></div></div></div>
1.41 asau 2315: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2316: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2317: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2318: <dd><p>Contains
2319: information about the currently installed
2320: packages.</p></dd>
2321: <dt><span class="term"><code class="filename">games</code></span></dt>
2322: <dd><p>Contains highscore
2323: files.</p></dd>
2324: <dt><span class="term"><code class="filename">log</code></span></dt>
2325: <dd><p>Contains log files.</p></dd>
2326: <dt><span class="term"><code class="filename">run</code></span></dt>
2327: <dd><p>Contains informational files about daemons that are
2328: currently running.</p></dd>
2329: </dl></div>
2330: </div>
2331: </div>
1.41 asau 2332: <div class="chapter">
1.1 dsieger 2333: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2334: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2335: <div class="toc">
2336: <p><b>Table of Contents</b></p>
1.100 leot 2337: <dl class="toc">
1.6 rillig 2338: <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 2339: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2340: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2341: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2342: <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>
2343: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2344: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2345: <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>
2346: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2347: <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 2348: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2349: <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>
2350: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2351: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2352: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2353: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2354: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2355: <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 2356: </dl>
2357: </div>
2358: <p>This section contains hints, tips & tricks on special things in
2359: pkgsrc that we didn't find a better place for in the previous chapters, and
2360: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2361: <div class="sect1">
1.1 dsieger 2362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2363: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2364: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2365: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2366: <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 2367: This is a general purpose list for most issues regarding
2368: pkgsrc, regardless of platform, e.g. soliciting user help
2369: for pkgsrc configuration, unexpected build failures, using
2370: particular packages, upgrading pkgsrc installations,
2371: questions regarding the pkgsrc release branches, etc. General announcements or
2372: proposals for changes that impact the pkgsrc user community,
2373: e.g. major infrastructure changes, new features, package
2374: removals, etc., may also be posted.</p></li>
1.23 wiz 2375: <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 2376: A list where the results of pkgsrc bulk builds are sent and
2377: discussed.</p></li>
1.23 wiz 2378: <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 2379: This list is for those who are interested in getting a
2380: commit message for every change committed to pkgsrc. It is
2381: also available in digest form, meaning one daily message
2382: containing all commit messages for changes to the package
2383: source tree in that 24 hour period.</p></li>
2384: </ul></div>
2385: <p>To subscribe, do:</p>
2386: <pre class="programlisting">
2387: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2388: </pre>
2389: <p>Archives for all these mailing lists are available from
1.10 hubertf 2390: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2391: </div>
1.41 asau 2392: <div class="sect1">
1.1 dsieger 2393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2394: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2395: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2396: a number of useful utilities for both users and developers of pkgsrc. This
2397: section attempts only to make the reader aware of the utilities and when
2398: they might be useful, and not to duplicate the documentation that comes
2399: with each package.</p>
2400: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.79 snj 2401: <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 2402: Symlinks for use by buildlink.</p></li></ul></div>
2403: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2404: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2405: <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 2406: Calculates various kinds of checksums (including SHA1).</p></li>
1.79 snj 2407: <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 2408: Compatibility library for pkgsrc tools.</p></li>
1.79 snj 2409: <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 2410: non-BSD systems due to lack of native mtree.</p></li>
1.79 snj 2411: <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 2412: Up-to-date replacement for
2413: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2414: systems where pkg_install is not present.</p></li>
2415: </ul></div>
2416: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2417: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2418: <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 2419: Create a binary package from an
1.10 hubertf 2420: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2421: save the old package.</p></li>
1.79 snj 2422: <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 2423: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2424: from multiple locations. It currently supports the following
2425: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.79 snj 2426: <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 2427: the best compiler flags to optimise code for your current
1.23 wiz 2428: CPU and compiler. </p></li>
1.1 dsieger 2429: </ul></div>
2430: <p>Utilities for keeping track of installed packages, being up to date,
2431: etc:</p>
1.41 asau 2432: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2433: <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 2434: update tool similar to apt(1). Download, install, and upgrade
2435: binary packages easily.</p></li>
1.79 snj 2436: <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 2437: packages whose installed versions do not match the latest pkgsrc
2438: entries.</p></li>
1.79 snj 2439: <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 2440: dependency graphs of packages, to aid in choosing a strategy for
2441: updating.</p></li>
1.79 snj 2442: <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
2443: 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>
2444: <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 2445: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.79 snj 2446: <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 2447: does various checks on the complete pkgsrc system.</p></li>
1.79 snj 2448: <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 2449: packages you have installed.</p></li>
2450: </ul></div>
2451: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2452: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2453: <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 2454: making and maintaining patches for a package (includes pkgdiff,
2455: pkgvi, mkpatches, etc.).</p></li>
1.79 snj 2456: <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 2457: converting to pkgsrc.</p></li>
2458: </ul></div>
2459: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2460: utilities)</p>
1.41 asau 2461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2462: <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 2463: packages in a chrooted area.</p></li>
1.79 snj 2464: <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 2465: kernel version for chrooted cross builds.</p></li>
2466: </ul></div>
2467: </div>
1.41 asau 2468: <div class="sect1">
1.1 dsieger 2469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2470: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2471: <p>To install packages from source as a non-root user, download
2472: 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
2473: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2474: --unprivileged</strong></span>.</p>
2475: <p>This will install the binary part of pkgsrc to
2476: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2477: into <code class="filename">~/pkg/etc</code>.</p>
2478: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2479: </div>
1.41 asau 2480: <div class="sect1">
1.1 dsieger 2481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2482: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2483: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2484: enable this feature by adding the option
2485: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2486: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2487: distfile is found, pkgsrc will try to resume it.</p>
2488: <p>You can also
1.61 wiz 2489: use a different program than the platform default program by changing the
1.16 jnemeth 2490: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2491: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2492: by using the value manual. A value of custom disables the system defaults
2493: and dependency tracking for the fetch program. In that case you have to
2494: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2495: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2496: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2497: <p>For example, if you want to use
1.16 jnemeth 2498: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2499: like:</p>
2500: <pre class="programlisting">
1.112 rillig 2501: FETCH_USING= wget
1.1 dsieger 2502: </pre>
2503: </div>
1.41 asau 2504: <div class="sect1">
1.1 dsieger 2505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2506: <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 2507: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2508: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2509: you will have to add the following line into
1.10 hubertf 2510: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2511: <pre class="programlisting">
1.4 rillig 2512: X11_TYPE=modular
1.1 dsieger 2513: </pre>
1.41 asau 2514: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 2515: <h3 class="title">Note</h3>
1.4 rillig 2516: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
2517: </p>
1.1 dsieger 2518: </div>
2519: </div>
1.41 asau 2520: <div class="sect1">
1.1 dsieger 2521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2522: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2523: <p>If you are sitting behind a firewall which does not allow direct
2524: connections to Internet hosts (i.e. non-NAT), you may specify the
2525: relevant proxy hosts. This is done using an environment variable in the
2526: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2527: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2528: port 80 as the proxy port number. So the proxy environment variables
2529: are:</p>
2530: <pre class="programlisting">
2531: ftp_proxy=ftp://orpheus.amdahl.com:80/
2532: http_proxy=http://orpheus.amdahl.com:80/
2533: </pre>
2534: </div>
1.41 asau 2535: <div class="sect1">
1.1 dsieger 2536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2537: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2538: <p>Some fetch tools are not prepared to support HTTPS by default
2539: (for example, the one in NetBSD 6.0), or the one installed by the
2540: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2541: dependency graph).</p>
2542: <p>Usually you won't notice, because distribution files are
2543: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2544: be often enough if you are following pkgsrc-current. In that case, set
2545: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2546: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2547: with HTTPS support by default. Of course, these tools need to be
2548: installed before you can use them this way.</p>
2549: </div>
2550: <div class="sect1">
2551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2552: <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 2553: <p>This depends on which utility is used to retrieve distfiles. From
2554: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2555: the first available command from the following list:</p>
1.41 asau 2556: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2557: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2558: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2559: </ul></div>
2560: <p>On a default NetBSD installation, this will be
2561: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2562: connections first, and falls back to active connections if the server
2563: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2564: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2565: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2566: <p>Having that option present will prevent
2567: <code class="filename">/usr/bin/ftp</code> from falling back to active
2568: transfers.</p>
2569: </div>
1.41 asau 2570: <div class="sect1">
1.1 dsieger 2571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2572: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2573: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2574: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2575: 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 2576: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2577: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2578: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2579: resulting list to your machine at work/school and use it there. If you
1.79 snj 2580: 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 2581: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2582: URL:</p>
2583: <p>At home:</p>
2584: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2585: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2586: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2587: <p>At work:</p>
2588: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2589: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2590: home.</p>
2591: <p>If you have a machine running NetBSD, and you want to get
2592: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2593: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2594: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2595: directly by running:</p>
2596: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2597: <p>If you even decide to ignore
2598: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2599: by running:</p>
2600: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2601: </div>
1.41 asau 2602: <div class="sect1">
1.1 dsieger 2603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2604: <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 2605: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.79 snj 2606: <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 2607: package, you get the error from make that it doesn't know how to make
2608: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2609: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2610: the NetBSD base distribution on your machine. It is recommended to do
2611: that to format man pages.</p>
1.79 snj 2612: <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 2613: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2614: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2615: </div>
1.41 asau 2616: <div class="sect1">
1.1 dsieger 2617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2618: <a name="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 2619: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2620: when you installed your NetBSD machine. Please get and install it, by
2621: extracting it in <code class="filename">/</code>:</p>
2622: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2623: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2624: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2625: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2626: -r</strong></span>).</p>
2627: </div>
1.41 asau 2628: <div class="sect1">
1.1 dsieger 2629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2630: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2631: <p>When installing packages as non-root user and using the just-in-time
1.79 snj 2632: <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 2633: password for each required package installed. To avoid this, the sudo
2634: package can be used, which does password caching over a limited time. To
2635: use it, install sudo (either as binary package or from
1.79 snj 2636: <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 2637: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2638: <span class="emphasis"><em>after</em></span> the definition of the
2639: <code class="varname">LOCALBASE</code> variable:</p>
2640: <pre class="programlisting">
2641: .if exists(${LOCALBASE}/bin/sudo)
2642: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2643: .endif
2644: </pre>
2645: </div>
1.41 asau 2646: <div class="sect1">
1.1 dsieger 2647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2648: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2649: <p>As the system administrator, you can choose where configuration files
2650: are installed. The default settings make all these files go into
2651: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2652: be suboptimal depending on your expectations (e.g., a read-only,
2653: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2654: configuration of the provided packages).</p>
2655: <p>In order to change the defaults, you can modify the
2656: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2657: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2658: directory; some common examples include <code class="filename">/etc</code> or
2659: <code class="filename">/etc/pkg</code>.</p>
2660: <p>Furthermore, you can change this value on a per-package basis by
2661: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2662: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2663: package you would like to modify, that is, the contents of
2664: <code class="varname">PKGBASE</code>.</p>
2665: <p>Note that after changing these settings, you must rebuild and
2666: reinstall any affected packages.</p>
2667: </div>
1.41 asau 2668: <div class="sect1">
1.1 dsieger 2669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2670: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2671: <p>Please be aware that there can often be bugs in third-party software,
2672: and some of these bugs can leave a machine vulnerable to exploitation by
2673: attackers. In an effort to lessen the exposure, the NetBSD packages team
2674: maintains a database of known-exploits to packages which have at one time
2675: been included in pkgsrc. The database can be downloaded automatically, and
2676: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2677: do this, refer to the following two tools (installed as part of the
1.79 snj 2678: <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 2679: <div class="orderedlist"><ol class="orderedlist" type="1">
2680: <li class="listitem">
1.20 snj 2681: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2682: download a list of the security vulnerabilities information. This list
1.25 spz 2683: is kept up to date by the pkgsrc security team, and is distributed
2684: from the NetBSD ftp server:</p>
2685: <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 2686: </li>
1.23 wiz 2687: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2688: current machine, checking each known vulnerability. If a
1.1 dsieger 2689: vulnerable package is installed, it will be shown by output to stdout,
2690: including a description of the type of vulnerability, and a URL
2691: containing more information.</p></li>
2692: </ol></div>
1.14 jmcneill 2693: <p>Use of these tools is strongly recommended! After
1.23 wiz 2694: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 2695: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 2696: pkg_install</code></strong>.</p>
1.1 dsieger 2697: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 2698: 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 2699: check.</p>
2700: </div>
1.41 asau 2701: <div class="sect1">
1.1 dsieger 2702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2703: <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 2704: <p>When you add your own preferences to the
2705: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2706: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2707: environment variables to the <code class="filename">./configure</code>
1.79 snj 2708: 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 2709: <code class="varname">CFLAGS</code> from the environment variable by
2710: overriding them in the <code class="filename">Makefile</code>s of their
2711: package.</p>
2712: <p>Currently there is no solution to this problem. If you
2713: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2714: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2715: directory and then inspect any <code class="filename">Makefile</code> and
2716: <code class="filename">Makefile.in</code> for whether they define
2717: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2718: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2719: programmers write so bad code that it only works for the
2720: specific combination of <code class="varname">CFLAGS</code> they have
2721: chosen.</p>
2722: </div>
1.41 asau 2723: <div class="sect1">
1.1 dsieger 2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2725: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2726: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2727: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2728: case that occurs often is that people only update pkgsrc in
2729: parts, because of performance reasons. Since pkgsrc is one large
2730: system, not a collection of many small systems, there are
2731: sometimes changes that only work when the whole pkgsrc tree is
2732: updated.</p></li>
1.41 asau 2733: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2734: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2735: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2736: files.</p></li>
1.41 asau 2737: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2738: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2739: verify this.</p></li>
1.108 rillig 2740: <li class="step"><p>If you are a package developer who wants to invest
2741: 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 2742: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2743: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2744: </ol></div>
2745: </div>
1.41 asau 2746: <div class="sect1">
1.1 dsieger 2747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2748: <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 2749: <p>You have modified a file from pkgsrc, and someone else has
2750: modified that same file afterwards in the CVS repository. Both changes
2751: are in the same region of the file, so when you updated pkgsrc, the
2752: <code class="literal">cvs</code> command marked the conflicting changes in the
2753: file. Because of these markers, the file is no longer a valid
2754: <code class="filename">Makefile</code>.</p>
2755: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2756: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2757: -dP</strong></span> in that directory to download the current version.</p>
2758: </div>
2759: </div>
2760: </div>
1.41 asau 2761: <div class="part">
1.1 dsieger 2762: <div class="titlepage"><div><div><h1 class="title">
2763: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2764: <div class="partintro">
1.1 dsieger 2765: <div></div>
2766: <p>This part of the book deals with creating and
1.23 wiz 2767: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2768: guide on creating a new package. The remaining chapters are more
2769: like a reference manual for pkgsrc.</p>
2770: <div class="toc">
2771: <p><b>Table of Contents</b></p>
1.100 leot 2772: <dl class="toc">
1.6 rillig 2773: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2774: <dd><dl>
1.6 rillig 2775: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2776: <dd><dl>
1.6 rillig 2777: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 2778: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 2779: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 2780: </dl></dd>
1.6 rillig 2781: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
2782: <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>
2783: </dl></dd>
2784: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
2785: <dd><dl>
1.23 wiz 2786: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
2787: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 2788: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2789: <dd><dl>
2790: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
2791: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
2792: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
2793: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
2794: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
2795: </dl></dd>
2796: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
2797: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
2798: <dd><dl>
2799: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
2800: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
2801: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
2802: </dl></dd>
1.23 wiz 2803: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
2804: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2805: </dl></dd>
1.23 wiz 2806: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2807: <dd><dl>
2808: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 2809: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 2810: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
2811: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
2812: <dd><dl>
2813: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 2814: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
2815: <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>
2816: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2817: </dl></dd>
2818: </dl></dd>
2819: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
2820: <dd><dl>
2821: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 2822: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2823: <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 2824: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
2825: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 2826: <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 2827: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 2828: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
2829: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2830: </dl></dd>
2831: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
2832: <dd><dl>
2833: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 2834: <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 2835: <dd><dl>
2836: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 2837: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
2838: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2839: and
2840: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2841: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2842: </dl></dd>
1.23 wiz 2843: <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 2844: <dd><dl>
1.23 wiz 2845: <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 2846: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
2847: </dl></dd>
2848: </dl></dd>
2849: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
2850: <dd><dl>
2851: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
2852: <dd><dl>
2853: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
2854: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
2855: </dl></dd>
2856: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
2857: <dd><dl>
1.23 wiz 2858: <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 2859: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
2860: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
2861: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
2862: </dl></dd>
2863: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
2864: <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>
2865: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
2866: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
2867: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
2868: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
2869: <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>
2870: </dl></dd>
2871: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
2872: <dd><dl>
2873: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 2874: <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 2875: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 2876: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 2877: </dl></dd>
2878: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
2879: <dd><dl>
2880: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
2881: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
2882: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
2883: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 2884: <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 2885: <dd><dl>
2886: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
2887: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
2888: </dl></dd>
1.23 wiz 2889: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2890: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2891: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2892: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2893: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2894: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2895: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2896: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2897: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2898: <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 2899: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
2900: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
2901: </dl></dd>
2902: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
2903: <dd><dl>
2904: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
2905: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
2906: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
2907: </dl></dd>
2908: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
2909: <dd><dl>
2910: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
2911: <dd><dl>
1.108 rillig 2912: <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>
2913: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
2914: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
2915: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
2916: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
2917: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
2918: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
2919: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
2920: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
2921: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2922: <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 2923: </dl></dd>
1.108 rillig 2924: <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 2925: <dd><dl>
2926: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2927: <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 2928: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 2929: </dl></dd>
1.108 rillig 2930: <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 2931: <dd><dl>
2932: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
2933: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2934: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
2935: </dl></dd>
2936: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
2937: <dd><dl>
2938: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
2939: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
2940: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 2941: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
2942: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 2943: </dl></dd>
1.108 rillig 2944: <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 2945: <dd><dl>
2946: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
2947: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 2948: <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 2949: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
2950: </dl></dd>
1.108 rillig 2951: <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 2952: <dd><dl>
2953: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
2954: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
2955: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
2956: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
2957: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2958: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
2959: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
2960: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 2961: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 2962: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 2963: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
2964: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
2965: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
2966: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
2967: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
2968: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
2969: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
2970: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 2971: emulation</a></span></dt>
1.6 rillig 2972: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
2973: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 2974: </dl></dd>
1.6 rillig 2975: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 2976: </dl></dd>
1.6 rillig 2977: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
2978: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 2979: <dd><dl>
1.6 rillig 2980: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
2981: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
2982: <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 2983: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 2984: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 2985: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
2986: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 2987: </dl></dd>
2988: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
2989: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
2990: <dd><dl>
2991: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
2992: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
2993: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
2994: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 2995: </dl></dd>
2996: </dl>
2997: </div>
2998: </div>
1.41 asau 2999: <div class="chapter">
1.1 dsieger 3000: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3001: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3002: <div class="toc">
3003: <p><b>Table of Contents</b></p>
1.100 leot 3004: <dl class="toc">
1.6 rillig 3005: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3006: <dd><dl>
1.6 rillig 3007: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3008: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3009: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3010: </dl></dd>
1.6 rillig 3011: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3012: <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 3013: </dl>
3014: </div>
3015: <p>When you find a package that is not yet in pkgsrc, you
3016: most likely have a URL from where you can download the source
3017: code. Starting with this URL, creating a package involves only a
3018: few steps.</p>
1.23 wiz 3019: <div class="procedure"><ol class="procedure" type="1">
1.79 snj 3020: <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 3021: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3022: category in which you want to place your package. You can also create a
3023: directory of your own (maybe called <code class="filename">local</code>). In that
3024: category directory, create another directory for your package and change
3025: into it.</p></li>
1.41 asau 3026: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3027: you for a URL. Enter the URL of the distribution file (in most cases a
3028: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3029: of your package are created automatically. The distribution file is
3030: extracted automatically to fill in some details in the
3031: <code class="filename">Makefile</code> that would otherwise have to be done
3032: manually.</p></li>
1.41 asau 3033: <li class="step">
1.1 dsieger 3034: <p>Examine the extracted files to determine the dependencies of
3035: your package. Ideally, this is mentioned in some
3036: <code class="filename">README</code> file, but things may differ. For each of
3037: these dependencies, look where it exists in pkgsrc, and if there is a
3038: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3039: line to your package <code class="filename">Makefile</code> which includes that
3040: file just before the last line. If the
1.25 spz 3041: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3042: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3043: <p>If you just need binaries from a package, add a
1.1 dsieger 3044: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3045: version of the dependency and where it can be found in pkgsrc. This line
3046: should be placed in the third paragraph. If the dependency is only
3047: needed for building the package, but not when using it, use
3048: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3049: Your package may then look like this:</p>
3050: <pre class="programlisting">
3051: [...]
3052:
1.66 asau 3053: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3054: DEPENDS+= screen-[0-9]*:../../misc/screen
3055: DEPENDS+= screen>=4.0:../../misc/screen
3056:
3057: [...]
3058:
3059: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3060: .include "../../devel/glib2/buildlink3.mk"
3061: .include "../../mk/bsd.pkg.mk"
3062: </pre>
3063: </li>
1.41 asau 3064: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3065: 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 3066: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3067: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3068: -e</strong></span>, which outputs additional
3069: explanations.</p></li>
1.41 asau 3070: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3071: 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 3072: over there, you can hopefully continue here.</p></li>
1.41 asau 3073: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3074: directory from the extracted files. Besides these files, a lot of cache
3075: files and other system information has been saved in the working
3076: directory, which may become wrong after you edited the
3077: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3078: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3079: 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 3080: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3081: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3082: everything works.</p></li>
1.41 asau 3083: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3084: contains a list of the files that are installed by the package, is
1.10 hubertf 3085: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3086: >PLIST</strong></span> to generate a probably correct list. Check
3087: the file using your preferred text editor to see if the list of
3088: files looks plausible.</p></li>
1.41 asau 3089: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3090: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3091: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3092: has been registered in the database of installed files, but with an
1.10 hubertf 3093: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3094: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3095: registered with the list of files from
3096: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3097: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3098: package from the set of installed files.</p></li>
3099: </ol></div>
1.41 asau 3100: <div class="sect1">
1.1 dsieger 3101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3102: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3103: <div class="sect2">
1.1 dsieger 3104: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3105: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3106: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3107: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3108: </div>
1.41 asau 3109: <div class="sect2">
1.1 dsieger 3110: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 3111: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3112: <p>KDE3 applications should always include
1.1 dsieger 3113: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 asau 3114: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3115: </div>
1.41 asau 3116: <div class="sect2">
1.17 imil 3117: <div class="titlepage"><div><div><h3 class="title">
3118: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3119: <p>Python modules and programs packages are easily created using a
3120: set of predefined variables.</p>
3121: <p>
1.63 wiz 3122: If some Python versions are not supported by the software, set the
3123: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3124: that are not supported, e.g.
1.17 imil 3125: </p>
3126: <pre class="programlisting">
1.93 sevan 3127: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3128: </pre>
3129: <p>
1.103 wiz 3130: If the packaged software is a Python module, include one of
3131: <code class="filename">../../lang/python/egg.mk</code>,
3132: <code class="filename">../../lang/python/distutils.mk</code>, or
3133: <code class="filename">../../lang/python/extension.mk</code>.</p>
3134: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3135: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3136: if the packaged software is using setuptools, you only need
3137: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3138: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3139: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3140: so pkgsrc will use this framework.
3141: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3142: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3143: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3144: to the name of the script.</p>
3145: <p>Either way, the package directory should be called
1.23 wiz 3146: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3147: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3148: </p>
3149: <pre class="programlisting">
3150: DISTNAME= foopymodule-1.2.10
3151: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3152: </pre>
1.63 wiz 3153: <p>If it is an application, include
3154: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3155: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3156: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3157: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3158: For example:
1.17 imil 3159: </p>
3160: <pre class="programlisting">
1.35 wiz 3161: REPLACE_PYTHON= *.py
1.17 imil 3162: </pre>
1.63 wiz 3163: <p>Some Python modules have separate distributions for Python-2.x
3164: and Python-3.x support. In pkgsrc this is handled by the
3165: <code class="filename">versioned_dependencies.mk</code> file. Set
3166: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3167: packages that should be depended upon and include
3168: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3169: then the pkgsrc infrastructure will depend on the appropriate package
3170: version. For example:
3171: </p>
3172: <pre class="programlisting">
1.110 wiz 3173: PYTHON_VERSIONED_DEPENDENCIES=dateutil
1.63 wiz 3174: </pre>
3175: <p>
3176: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3177: of supported packages.</p>
1.17 imil 3178: </div>
1.1 dsieger 3179: </div>
1.41 asau 3180: <div class="sect1">
1.1 dsieger 3181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3182: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3183: <div class="sect2">
1.1 dsieger 3184: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3185: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3186: <div class="sect3">
1.1 dsieger 3187: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3188: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3189: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3190: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3191: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3192: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3193: <pre class="programlisting">
3194: <code class="prompt">$</code> mkdir www/nvu
3195: <code class="prompt">$</code> cd www/nvu
3196: </pre>
3197: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3198: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3199: <pre class="programlisting">
3200: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3201: </pre>
3202: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3203: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3204: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3205: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3206: <code class="varname">COMMENT</code> fields. Then the package
3207: <code class="filename">Makefile</code> looked like that:</p>
3208: <pre class="programlisting">
3209: # $NetBSD$
3210: #
3211:
3212: DISTNAME= nvu-1.0-sources
3213: PKGNAME= nvu-1.0
3214: CATEGORIES= www
3215: MASTER_SITES= http://cvs.nvu.com/download/
3216: EXTRACT_SUFX= .tar.bz2
3217:
3218: MAINTAINER= rillig@NetBSD.org
3219: HOMEPAGE= http://cvs.nvu.com/
3220: COMMENT= Web Authoring System
3221:
3222: # url2pkg-marker (please do not remove this line.)
3223: .include "../../mk/bsd.pkg.mk"
3224: </pre>
3225: <p>Then, I quit the editor and watched pkgsrc downloading a large
3226: source archive:</p>
3227: <pre class="programlisting">
3228: url2pkg> Running "make makesum" ...
3229: => Required installed package digest>=20010302: digest-20060826 found
3230: => Fetching nvu-1.0-sources.tar.bz2
3231: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3232: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3233: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3234: url2pkg> Running "make extract" ...
3235: => Required installed package digest>=20010302: digest-20060826 found
3236: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3237: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3238: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3239: ===> Installing dependencies for nvu-1.0
3240: ===> Overriding tools for nvu-1.0
3241: ===> Extracting for nvu-1.0
3242: url2pkg> Adjusting the Makefile.
3243:
3244: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3245:
3246: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3247: </pre>
3248: </div>
1.41 asau 3249: <div class="sect3">
1.1 dsieger 3250: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3251: <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 3252: <p>Now that the package has been extracted, let's see what's inside
3253: it. The package has a <code class="filename">README.txt</code>, but that only
3254: says something about mozilla, so it's probably useless for seeing what
3255: dependencies this package has. But since there is a GNU configure script
3256: in the package, let's hope that it will complain about everything it
3257: needs.</p>
3258: <pre class="programlisting">
3259: <code class="prompt">$</code> bmake
3260: => Required installed package digest>=20010302: digest-20060826 found
3261: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3262: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3263: ===> Patching for nvu-1.0
3264: ===> Creating toolchain wrappers for nvu-1.0
3265: ===> Configuring for nvu-1.0
3266: [...]
3267: configure: error: Perl 5.004 or higher is required.
3268: [...]
3269: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3270: [...]
3271: </pre>
3272: <p>That worked quite well. So I opened the package Makefile in my
3273: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3274: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3275: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3276: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3277: from scratch.</p>
3278: <pre class="programlisting">
3279: <code class="prompt">$</code> bmake clean
3280: ===> Cleaning for nvu-1.0
3281: <code class="prompt">$</code> bmake
3282: [...]
3283: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3284: GNU Make. You will not be able to build Mozilla without GNU Make.
3285: [...]
3286: </pre>
1.23 wiz 3287: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3288: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3289: <pre class="programlisting">
3290: [...]
3291: checking for GTK - version >= 1.2.0... no
3292: *** Could not run GTK test program, checking why...
3293: [...]
3294: </pre>
3295: <p>Now to the other dependencies. The first question is: Where is the
3296: GTK package hidden in pkgsrc?</p>
3297: <pre class="programlisting">
3298: <code class="prompt">$</code> echo ../../*/gtk*
3299: [many packages ...]
3300: <code class="prompt">$</code> echo ../../*/gtk
3301: ../../x11/gtk
3302: <code class="prompt">$</code> echo ../../*/gtk2
3303: ../../x11/gtk2
3304: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3305: ../../x11/gtk2/buildlink3.mk
3306: </pre>
3307: <p>The first try was definitely too broad. The second one had exactly
3308: one result, which is very good. But there is one pitfall with GNOME
3309: packages. Before GNOME 2 had been released, there were already many
3310: GNOME 1 packages in pkgsrc. To be able to continue to use these
3311: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3312: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3313: whether this was the case here, and indeed it was.</p>
3314: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3315: file, adding the dependency is very easy. I just inserted an
3316: <code class="literal">.include</code> line before the last line of the package
3317: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3318: <pre class="programlisting">
3319: [...]
3320: .include "../../x11/gtk2/buildlink3.mk"
3321: .include "../../mk/bsd.pkg.mk
3322: </pre>
1.10 hubertf 3323: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3324: was:</p>
3325: <pre class="programlisting">
3326: [...]
3327: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3328: checking for GTK - version >= 1.2.0... no
3329: *** Could not run GTK test program, checking why...
3330: *** The test program failed to compile or link. See the file config.log for the
3331: *** exact error that occured. This usually means GTK was incorrectly installed
3332: *** or that you have moved GTK since it was installed. In the latter case, you
3333: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3334: configure: error: Test for GTK failed.
3335: [...]
3336: </pre>
1.23 wiz 3337: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3338: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3339: told me that this package really wanted to have the GNOME 1 version of
3340: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3341: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3342: So I changed the <code class="literal">x11/gtk2</code> to
3343: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3344: and tried again.</p>
3345: <pre class="programlisting">
3346: [...]
1.59 jnemeth 3347: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3348: In file included from xpidl.c:42:
3349: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3350: In file included from xpidl.c:42:
3351: xpidl.h:132: error: parse error before "IDL_ns"
3352: [...]
3353: </pre>
3354: <p>The package still does not find all of its dependencies. Now the
3355: question is: Which package provides the
3356: <code class="filename">libIDL/IDL.h</code> header file?</p>
3357: <pre class="programlisting">
3358: <code class="prompt">$</code> echo ../../*/*idl*
3359: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3360: <code class="prompt">$</code> echo ../../*/*IDL*
3361: ../../net/libIDL
3362: </pre>
3363: <p>Let's take the one from the second try. So I included the
3364: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3365: again. But the error didn't change. After digging through some of the
3366: code, I concluded that the build process of the package was broken and
3367: couldn't have ever worked, but since the Mozilla source tree is quite
3368: large, I didn't want to fix it. So I added the following to the package
3369: <code class="filename">Makefile</code> and tried again:</p>
3370: <pre class="programlisting">
3371: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3372: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3373: </pre>
3374: <p>The latter line is needed because the package expects the library
3375: <code class="filename">libIDL.so</code>, but only
3376: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3377: wrapper to rewrite that on the fly.</p>
3378: <p>The next problem was related to a recent change of the FreeType
1.79 snj 3379: 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 3380: which patch files were relevant for this issue and copied them to the
3381: <code class="filename">patches</code> directory. Then I retried, fixed the
3382: patches so that they applied cleanly and retried again. This time,
3383: everything worked.</p>
3384: </div>
1.41 asau 3385: <div class="sect3">
1.1 dsieger 3386: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3387: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3388: <pre class="programlisting">
3389: <code class="prompt">$</code> bmake CHECK_FILES=no install
3390: [...]
3391: <code class="prompt">$</code> bmake print-PLIST >PLIST
3392: <code class="prompt">$</code> bmake deinstall
3393: <code class="prompt">$</code> bmake install
3394: </pre>
3395: </div>
3396: </div>
3397: </div>
3398: </div>
1.41 asau 3399: <div class="chapter">
1.1 dsieger 3400: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3401: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3402: <div class="toc">
3403: <p><b>Table of Contents</b></p>
1.100 leot 3404: <dl class="toc">
1.23 wiz 3405: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3406: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 3407: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3408: <dd><dl>
3409: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3410: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3411: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3412: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3413: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3414: </dl></dd>
3415: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3416: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3417: <dd><dl>
3418: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3419: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3420: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3421: </dl></dd>
1.23 wiz 3422: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3423: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3424: </dl>
3425: </div>
3426: <p>Whenever you're preparing a package, there are a number of
3427: files involved which are described in the following
3428: sections.</p>
1.41 asau 3429: <div class="sect1">
1.1 dsieger 3430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3431: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3432: </h2></div></div></div>
3433: <p>Building, installation and creation of a binary package are all
3434: controlled by the package's <code class="filename">Makefile</code>.
3435: The <code class="filename">Makefile</code> describes various things about
3436: a package, for example from where to get it, how to configure,
3437: build, and install it.</p>
3438: <p>A package <code class="filename">Makefile</code> contains several
3439: sections that describe the package.</p>
3440: <p>In the first section there are the following variables, which
3441: should appear exactly in the order given here. The order and
3442: grouping of the variables is mostly historical and has no further
3443: meaning.</p>
1.41 asau 3444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3445: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3446: distribution file to be downloaded from the package's
3447: website.</p></li>
1.23 wiz 3448: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3449: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3450: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3451: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3452: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3453: directory name together with the version number. It must match the
3454: regular expression
3455: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3456: starts with a letter or digit, and contains only letters, digits,
3457: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3458: <li class="listitem">
1.1 dsieger 3459: <p><code class="varname">CATEGORIES</code> is a list of categories
3460: which the package fits in. You can choose any of the top-level
3461: directories of pkgsrc for it.</p>
3462: <p>Currently the following values are available for
3463: <code class="varname">CATEGORIES</code>. If more than
3464: one is used, they need to be separated by spaces:</p>
3465: <pre class="programlisting">
3466: archivers cross geography meta-pkgs security
3467: audio databases graphics misc shells
3468: benchmarks devel ham multimedia sysutils
3469: biology editors inputmethod net textproc
3470: cad emulators lang news time
3471: chat finance mail parallel wm
3472: comms fonts math pkgtools www
3473: converters games mbone print x11
3474: </pre>
3475: </li>
1.23 wiz 3476: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3477: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3478: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3479: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 3480: <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 3481: </ul></div>
3482: <p>The second section contains information about separately
3483: downloaded patches, if any.
3484: </p>
1.41 asau 3485: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3486: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3487: Name(s) of additional files that contain distribution patches.
3488: There is no default. pkgsrc will look for them at
3489: <code class="varname">PATCH_SITES</code>.
3490: They will automatically be uncompressed before patching if
3491: the names end with <code class="filename">.gz</code> or
3492: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3493: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3494: Primary location(s) for distribution patch files (see
1.80 wiz 3495: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3496: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
3497: 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
3498: help find the correct files to patch. It defaults to
3499: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3500: </ul></div>
3501: <p>The third section contains the following variables.
3502: </p>
1.41 asau 3503: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3504: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3505: address of the person who feels responsible for this package,
3506: and who is most likely to look at problems or questions regarding
1.79 snj 3507: 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 3508: Other developers may contact the <code class="varname">MAINTAINER</code>
3509: before making changes to the package, but are not required to
3510: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3511: to yourself. If you really can't maintain the package for future
3512: updates, set it to
1.10 hubertf 3513: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3514: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3515: of <code class="varname">MAINTAINER</code> when you do not want other
3516: developers to update or change the package without contacting
3517: you first. A package Makefile should contain one of
3518: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3519: not both. </p></li>
1.23 wiz 3520: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3521: find more information about the package.</p></li>
1.23 wiz 3522: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3523: description of the package (should not include the package
3524: name).</p></li>
3525: </ul></div>
3526: <p>Other variables that affect the build:
3527: </p>
1.41 asau 3528: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3529: <p><code class="varname">WRKSRC</code>: The directory where the
3530: interesting distribution files of the package are found. The
3531: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3532: works for most packages.</p>
3533: <p>If a package doesn't create a subdirectory for itself
3534: (most GNU software does, for instance), but extracts itself in
3535: the current directory, you should set
3536: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3537: <p>If a package doesn't create a subdirectory with the
3538: name of <code class="varname">DISTNAME</code> but some different name,
3539: set <code class="varname">WRKSRC</code> to point to the proper name in
3540: <code class="filename">${WRKDIR}</code>, for example
3541: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.79 snj 3542: <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 3543: <p>The name of the working directory created by pkgsrc is
3544: taken from the <code class="varname">WRKDIR_BASENAME</code>
3545: variable. By default, its value is
3546: <code class="filename">work</code>. If you want to use the same
3547: pkgsrc tree for building different kinds of binary packages,
3548: you can change the variable according to your needs. Two
3549: other variables handle common cases of setting
3550: <code class="varname">WRKDIR_BASENAME</code> individually. If
3551: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3552: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3553: the host's name is attached to the directory name. If
3554: <code class="varname">OBJMACHINE</code> is defined, the platform name
3555: is attached, which might look like
3556: <code class="filename">work.i386</code> or
3557: <code class="filename">work.sparc</code>.</p>
3558: </li></ul></div>
3559: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3561: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3562: installed in compressed form by the package. For packages using
3563: BSD-style makefiles which honor MANZ, there is
3564: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3565: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3566: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3567: below).</p></li>
1.23 wiz 3568: <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 3569: </ul></div>
3570: </div>
1.41 asau 3571: <div class="sect1">
1.1 dsieger 3572: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3573: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 3574: </h2></div></div></div>
3575: <p>The <code class="filename">distinfo</code> file contains the message
3576: digest, or checksum, of each distfile needed for the package. This
3577: ensures that the distfiles retrieved from the Internet have not been
3578: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3579: a security hole. To provide maximum security, all distfiles are
3580: protected using three different message digest algorithms (SHA1,
3581: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3582: <p>The <code class="filename">distinfo</code> file also contains the
3583: checksums for all the patches found in the
1.108 rillig 3584: <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 3585: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3586: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3587: <p>Some packages have different sets of distfiles depending on
1.79 snj 3588: 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 3589: <code class="filename">distinfo</code> file and care should be taken when
3590: upgrading such a package to ensure distfile information is not
3591: lost.</p>
3592: </div>
1.41 asau 3593: <div class="sect1">
1.1 dsieger 3594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 3595: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
3596: </h2></div></div></div>
3597: <p>Some packages don't work out-of-the box on the various
3598: platforms that are supported by pkgsrc. These packages need
3599: to be patched to make them work. The patch files can be
1.1 dsieger 3600: found in the <code class="filename">patches/</code> directory.</p>
3601: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3602: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3603: extracting them, in alphabetic order.</p>
1.41 asau 3604: <div class="sect2">
1.1 dsieger 3605: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3606: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3607: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3608: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3609: problems. (To force patches to apply with fuzz you can set
3610: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3611: should contain only changes for a single file, and no file should be
3612: patched by more than one patch file. This helps to keep future
3613: modifications simple.</p>
3614: <p>Each patch file is structured as follows: In the first line,
3615: there is the RCS Id of the patch itself. The second line should be
3616: empty for aesthetic reasons. After that, there should be a comment for
3617: each change that the patch does. There are a number of standard
3618: cases:</p>
1.41 asau 3619: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3620: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3621: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3622: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3623: platform and other environment (for example, the compiler) that the
3624: patch is needed for.</p></li>
3625: </ul></div>
1.108 rillig 3626: <p>The patch should be commented so that any
1.1 dsieger 3627: developer who knows the code of the application can make some use of
3628: the patch. Special care should be taken for the upstream developers,
3629: since we generally want that they accept our patches, so we have less
3630: work in the future.</p>
3631: </div>
1.41 asau 3632: <div class="sect2">
1.1 dsieger 3633: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3634: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3635: <p>One important thing to mention is to pay attention that no RCS
3636: IDs get stored in the patch files, as these will cause problems when
3637: later checked into the NetBSD CVS tree. Use the
1.79 snj 3638: <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 3639: problems.</p>
3640: <p>For even more automation, we recommend using
1.10 hubertf 3641: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3642: whole set of patches. You just have to backup files before you
3643: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3644: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3645: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3646: you upgrade a package this way, you can easily compare the new
3647: set of patches with the previously existing one with
1.24 wiz 3648: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3649: are replaced by new files, so carefully check if you want to take all
3650: the changes.</p>
1.1 dsieger 3651: <p>When you have finished a package, remember to generate
1.10 hubertf 3652: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 3653: 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 3654: <p>When adding a patch that corrects a problem in the
3655: distfile (rather than e.g. enforcing pkgsrc's view of where
3656: man pages should go), send the patch as a bug report to the
3657: maintainer. This benefits non-pkgsrc users of the package,
3658: and usually makes it possible to remove the patch in future
3659: version.</p>
1.2 rillig 3660: <p>The file names of the patch files are usually of the form
1.24 wiz 3661: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3662: Many packages still use the previous convention
3663: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3664: but new patches should be of the form containing the filename.
1.79 snj 3665: <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 3666: automatically.</p>
1.1 dsieger 3667: </div>
1.41 asau 3668: <div class="sect2">
1.1 dsieger 3669: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3670: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3671: <p>If you want to share patches between multiple packages
3672: in pkgsrc, e.g. because they use the same distfiles, set
3673: <code class="varname">PATCHDIR</code> to the path where the patch files
3674: can be found, e.g.:</p>
3675: <pre class="programlisting">
3676: PATCHDIR= ${.CURDIR}/../xemacs/patches
3677: </pre>
3678: <p>Patch files that are distributed by the author or other
3679: maintainers can be listed in
3680: <code class="varname">PATCHFILES</code>.</p>
3681: <p>If it is desired to store any patches that should not be
3682: committed into pkgsrc, they can be kept outside the pkgsrc
3683: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3684: directory tree there is expected to have the same
1.23 wiz 3685: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3686: patches are expected to be stored inside these dirs (also
3687: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3688: example, if you want to keep a private patch for
3689: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3690: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3691: files in the named directory are expected to be patch files,
3692: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3693: applied</em></span>.</p>
3694: </div>
1.41 asau 3695: <div class="sect2">
1.1 dsieger 3696: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3697: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3698: <p>When fixing a portability issue in the code do not use
3699: preprocessor magic to check for the current operating system nor
3700: platform. Doing so hurts portability to other platforms because
3701: the OS-specific details are not abstracted appropriately.</p>
3702: <p>The general rule to follow is: instead of checking for the
3703: operating system the application is being built on, check for the
3704: specific <span class="emphasis"><em>features</em></span> you need. For example,
3705: instead of assuming that kqueue is available under NetBSD and
3706: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3707: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3708: yes, this generally involves patching the
1.10 hubertf 3709: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3710: that prevents some OSes from adopting interfaces from other OSes
3711: (e.g. Linux implementing kqueue), something that the above checks
3712: cannot take into account.</p>
3713: <p>Of course, checking for features generally involves more
3714: work on the developer's side, but the resulting changes are
3715: cleaner and there are chances they will work on many other
3716: platforms. Not to mention that there are higher chances of being
3717: later integrated into the mainstream sources. Remember:
3718: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3719: <p>Some typical examples:</p>
3720: <div class="table">
1.6 rillig 3721: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.106 tnn 3722: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3723: <colgroup>
3724: <col>
3725: <col>
3726: <col>
3727: </colgroup>
3728: <thead><tr>
3729: <th>Where</th>
3730: <th>Incorrect</th>
3731: <th>Correct</th>
3732: </tr></thead>
3733: <tbody>
3734: <tr>
3735: <td>configure script</td>
3736: <td>
3737: <pre class="programlisting">
3738: case ${target_os} in
3739: netbsd*) have_kvm=yes ;;
3740: *) have_kvm=no ;;
3741: esac
3742: </pre>
3743: </td>
3744: <td>
3745: <pre class="programlisting">
3746: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3747: </pre>
3748: </td>
3749: </tr>
3750: <tr>
3751: <td>C source file</td>
3752: <td>
3753: <pre class="programlisting">
3754: #if defined(__NetBSD__)
3755: # include <sys/event.h>
3756: #endif
3757: </pre>
3758: </td>
3759: <td>
3760: <pre class="programlisting">
3761: #if defined(HAVE_SYS_EVENT_H)
3762: # include <sys/event.h>
3763: #endif
3764: </pre>
3765: </td>
3766: </tr>
3767: <tr>
3768: <td>C source file</td>
3769: <td>
3770: <pre class="programlisting">
3771: int
3772: monitor_file(...)
3773: {
3774: #if defined(__NetBSD__)
3775: int fd = kqueue();
3776: ...
3777: #else
3778: ...
3779: #endif
3780: }
3781: </pre>
3782: </td>
3783: <td>
3784: <pre class="programlisting">
3785: int
3786: monitor_file(...)
3787: {
3788: #if defined(HAVE_KQUEUE)
3789: int fd = kqueue();
3790: ...
3791: #else
1.112 rillig 3792: ...
1.1 dsieger 3793: #endif
3794: }
3795: </pre>
3796: </td>
3797: </tr>
3798: </tbody>
3799: </table></div>
3800: </div>
3801: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 3802: 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
3803: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 3804: 2</a>). It summarizes multiple details on how to make
3805: software easier to package; all the suggestions in it were
3806: collected from our experience in pkgsrc work, so they are possibly
3807: helpful when creating patches too.</p>
3808: </div>
1.41 asau 3809: <div class="sect2">
1.1 dsieger 3810: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3811: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3812: <p>Always, always, <span class="strong"><strong>always</strong></span>
3813: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3814: improvements you do to a package to the mainstream developers.
3815: This is the only way to get their attention on portability issues
3816: and to ensure that future versions can be built out-of-the box on
3817: NetBSD. Furthermore, any user that gets newer distfiles will get
3818: the fixes straight from the packaged code.</p>
3819: <p>This generally involves cleaning up the patches
3820: (because sometimes the patches that are
1.40 wiz 3821: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3822: appropriate trackers for the projects and working with the
3823: mainstream authors to accept your changes. It is
3824: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3825: the packages in pkgsrc are kept simple and thus further changes
3826: can be done without much hassle.</p>
1.24 wiz 3827: <p>When you have done this, please add a URL to the upstream
3828: bug report to the patch comment.</p>
1.1 dsieger 3829: <p>Support the idea of free software!</p>
3830: </div>
3831: </div>
1.41 asau 3832: <div class="sect1">
1.1 dsieger 3833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3834: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 3835: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3836: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3837: <dd><p>A multi-line description of the piece of software. This should include
3838: any credits where they are due. Please bear in mind that others do not
3839: share your sense of humour (or spelling idiosyncrasies), and that others
3840: will read everything that you write here.</p></dd>
3841: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3842: <dd><p>This file governs the files that are installed on your
3843: system: all the binaries, manual pages, etc. There are other
3844: directives which may be entered in this file, to control the
3845: creation and deletion of directories, and the location of
1.10 hubertf 3846: 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 3847: information.</p></dd>
3848: </dl></div>
3849: </div>
1.41 asau 3850: <div class="sect1">
1.1 dsieger 3851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3852: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 3853: <div class="sect2">
1.1 dsieger 3854: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3855: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 3856: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3857: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 3858: <dd>
1.79 snj 3859: <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 3860: First time after package extraction and before files are
3861: moved in place, the second time after the files to install
3862: are moved in place. This can be used to do any custom
3863: procedures not possible with @exec commands in
1.79 snj 3864: <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
3865: <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 3866: Please note that you can modify variables in it easily by using
3867: <code class="varname">FILES_SUBST</code> in the package's
3868: <code class="filename">Makefile</code>:</p>
3869: <pre class="programlisting">
3870: FILES_SUBST+= SOMEVAR="somevalue"
3871: </pre>
3872: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3873: <code class="filename">INSTALL</code>. By default, substitution is
3874: performed for <code class="varname">PREFIX</code>,
3875: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3876: <code class="varname">VARBASE</code>, and a few others, type
3877: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3878: complete list.</p>
3879: </dd>
1.1 dsieger 3880: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3881: <dd><p>This script is executed before and after any files are removed. It is
3882: this script's responsibility to clean up any additional messy details
3883: around the package's installation, since all pkg_delete knows is how to
3884: delete the files created in the original distribution.
1.79 snj 3885: 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>
3886: 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 3887: The same methods to replace variables can be used as for
3888: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 3889: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3890: <dd>
3891: <p>This file is displayed after installation of the package.
3892: Useful for things like legal notices on almost-free
3893: software and hints for updating config files after
3894: installing modules for apache, PHP etc.
3895: Please note that you can modify variables in it easily by using
3896: <code class="varname">MESSAGE_SUBST</code> in the package's
3897: <code class="filename">Makefile</code>:</p>
3898: <pre class="programlisting">
3899: MESSAGE_SUBST+= SOMEVAR="somevalue"
3900: </pre>
1.23 wiz 3901: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 3902: <code class="filename">MESSAGE</code>. By default, substitution is
3903: performed for <code class="varname">PKGNAME</code>,
3904: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 3905: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 3906: <code class="varname">PKG_SYSCONFDIR</code>,
3907: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 3908: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 3909: <p>You can display a different or additional files by
3910: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3911: default is <code class="filename">MESSAGE</code>, if the file
3912: exists.</p>
3913: </dd>
3914: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 3915: <dd>
3916: <p>This file is used by the alternatives framework.
3917: It creates, configures, and destroys generic wrappers used to
3918: run programs with similar interfaces.
3919: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3920: for more information.</p>
3921: <p>Each line of the file contains two filenames, first
3922: the wrapper and then the alternative provided by the package.
3923: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3924: </dd>
1.1 dsieger 3925: </dl></div>
3926: </div>
1.41 asau 3927: <div class="sect2">
1.1 dsieger 3928: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3929: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 3930: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3931: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3932: <dd><p>This file contains arbitrary things that could
3933: also go into a <code class="filename">Makefile</code>, but its purpose is
3934: to be used by more than one package. This file should only be
3935: used when the packages that will use the file are known in
3936: advance. For other purposes it is often better to write a
3937: <code class="filename">*.mk</code> file and give it a good name that
3938: describes what it does.</p></dd>
3939: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3940: <dd><p>This file contains the dependency information
1.10 hubertf 3941: 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 3942: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3943: <dd><p>This file contains workarounds for compiler bugs
3944: and similar things. It is included automatically by the pkgsrc
3945: infrastructure, so you don't need an extra
3946: <code class="literal">.include</code> line for
3947: it.</p></dd>
3948: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3949: <dd><p>This file contains the code for the
1.10 hubertf 3950: 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 3951: selected by the user. If a package has only one or two options,
3952: it is equally acceptable to put the code directly into the
3953: <code class="filename">Makefile</code>.</p></dd>
3954: </dl></div>
3955: </div>
1.41 asau 3956: <div class="sect2">
1.1 dsieger 3957: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3958: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 3959: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3960: <dt><span class="term"><code class="filename">README*</code></span></dt>
3961: <dd><p>These files do not take place in the creation of
3962: a package and thus are purely informative to the package
3963: developer.</p></dd>
3964: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3965: <dd><p>This file contains things that need to be done
3966: to make the package even
3967: better.</p></dd>
3968: </dl></div>
3969: </div>
3970: </div>
1.41 asau 3971: <div class="sect1">
1.1 dsieger 3972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3973: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 3974: </h2></div></div></div>
1.10 hubertf 3975: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 3976: unpacked into the directory denoted by
3977: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 3978: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 3979: directory is also used to keep various timestamp files.
3980: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3981: The default is <code class="filename">${.CURDIR}/work</code>
3982: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3983: if <code class="varname">OBJMACHINE</code> is set.</p>
3984: </div>
1.41 asau 3985: <div class="sect1">
1.1 dsieger 3986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3987: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 3988: </h2></div></div></div>
3989: <p>If you have any files that you wish to be placed in the package prior
3990: to configuration or building, you could place these files here and use
1.10 hubertf 3991: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 3992: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 3993: this. Alternatively, you could simply diff the file against
3994: <code class="filename">/dev/null</code> and use the patch mechanism to manage
3995: the creation of this file.</p>
3996: <p>If you want to share files in this way with other
3997: packages, set the <code class="varname">FILESDIR</code> variable to point
3998: to the other package's <code class="filename">files</code> directory,
3999: e.g.:</p>
4000: <pre class="programlisting">
4001: FILESDIR=${.CURDIR}/../xemacs/files
4002: </pre>
4003: </div>
4004: </div>
1.41 asau 4005: <div class="chapter">
1.1 dsieger 4006: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4007: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4008: <div class="toc">
4009: <p><b>Table of Contents</b></p>
1.100 leot 4010: <dl class="toc">
1.6 rillig 4011: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4012: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4013: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4014: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4015: <dd><dl>
4016: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.108 rillig 4017: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exacty as-is</a></span></dt>
4018: <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>
4019: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4020: </dl></dd>
4021: </dl>
4022: </div>
4023: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4024: each of which forms a well-defined part of the pkgsrc system. Using
1.79 snj 4025: 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 4026: like pkgsrc requires some discipline to keep the code correct and
4027: understandable.</p>
4028: <p>The basic ingredients for <code class="filename">Makefile</code>
4029: programming are variables (which are actually macros) and shell
4030: commands. Among these shell commands may even be more complex ones
1.79 snj 4031: 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 4032: as intended it is necessary to quote all variables correctly when they
4033: are used.</p>
4034: <p>This chapter describes some patterns, that appear quite often in
4035: <code class="filename">Makefile</code>s, including the pitfalls that come along
4036: with them.</p>
1.41 asau 4037: <div class="sect1">
1.1 dsieger 4038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4039: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4041: <p>When you are creating a file as a
4042: target of a rule, always write the data to a temporary file first
4043: and finally rename that file. Otherwise there might occur an error
4044: in the middle of generating the file, and when the user runs
1.79 snj 4045: <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 4046: regenerated properly. Example:</p>
4047: <pre class="programlisting">
4048: wrong:
4049: @echo "line 1" > ${.TARGET}
4050: @echo "line 2" >> ${.TARGET}
4051: @false
4052:
4053: correct:
4054: @echo "line 1" > ${.TARGET}.tmp
4055: @echo "line 2" >> ${.TARGET}.tmp
4056: @false
4057: @mv ${.TARGET}.tmp ${.TARGET}
4058: </pre>
1.10 hubertf 4059: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4060: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4061: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4062: correct</strong></span> gives an error message twice, as expected.</p>
1.79 snj 4063: <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 4064: <code class="literal">${.TARGET}</code> in case of error, but this only
4065: happens when it is interrupted, for example by pressing
4066: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.79 snj 4067: 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 4068: </li></ul></div>
4069: </div>
1.41 asau 4070: <div class="sect1">
1.1 dsieger 4071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4072: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4073: <p><code class="filename">Makefile</code> variables contain strings that
4074: can be processed using the five operators ``='', ``+='', ``?='',
1.79 snj 4075: ``:='', 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 4076: page.</p>
4077: <p>When a variable's value is parsed from a
4078: <code class="filename">Makefile</code>, the hash character ``#'' and the
4079: backslash character ``\'' are handled specially. If a backslash is
4080: followed by a newline, any whitespace immediately in front of the
4081: backslash, the backslash, the newline, and any whitespace
4082: immediately behind the newline are replaced with a single space. A
4083: backslash character and an immediately following hash character are
4084: replaced with a single hash character. Otherwise, the backslash is
4085: passed as is. In a variable assignment, any hash character that is
4086: not preceded by a backslash starts a comment that continues upto the
4087: end of the logical line.</p>
1.108 rillig 4088: <p>The evaluation of variables either happens immediately or lazy.
4089: It happens immediately when the variable occurs
4090: on the right-hand side of the ``:='' or the ``!='' operator, in a
4091: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4092: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4093: <p>Some of the modifiers split the string into words and then
4094: operate on the words, others operate on the string as a whole. When
1.108 rillig 4095: 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 4096: <p>There are several types of variables that should be handled
4097: differently. Strings and two types of lists.</p>
1.41 asau 4098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4099: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4100: characters. Nevertheless, you should restrict yourself to only
4101: using printable characters. Examples are
4102: <code class="varname">PREFIX</code> and
4103: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4104: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4105: are never exported to any shell command. Their elements are
4106: separated by whitespace. Therefore, the elements themselves cannot
4107: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4108: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4109: Examples are <code class="varname">DEPENDS</code> and
4110: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4111: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4112: may be exported to a shell command. Their elements can contain any
4113: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4114: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4115: <code class="varname">DISTFILES</code> and
4116: <code class="varname">MASTER_SITES</code>.</p></li>
4117: </ul></div>
1.41 asau 4118: <div class="sect2">
1.1 dsieger 4119: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4120: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4121: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4122: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4123: are reserved for use by the pkgsrc infrastructure. They shall
4124: not be used by package
4125: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4126: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4127: lowercase variable names for the iteration
4128: variables.</p></li>
1.23 wiz 4129: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4130: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4131: <code class="varname">DISTFILES</code>.</p></li>
4132: </ul></div>
4133: </div>
4134: </div>
1.41 asau 4135: <div class="sect1">
1.1 dsieger 4136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4137: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.41 asau 4138: <div class="sect2">
1.1 dsieger 4139: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4140: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4141: <p>When adding a string that possibly contains whitespace or quotes to
4142: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4143: modifier.</p>
4144: <p>When adding another list to a list (example 2), it must not be
4145: quoted, since its elements are already quoted.</p>
1.1 dsieger 4146: <pre class="programlisting">
1.108 rillig 4147: STRING= foo * bar `date`
4148: LIST= # empty
4149: ANOTHER_LIST= a=b c=d
4150:
4151: LIST+= ${STRING:Q} # 1
4152: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4153: </pre>
4154: </div>
1.41 asau 4155: <div class="sect2">
1.1 dsieger 4156: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4157: <a name="echo-literal"></a>12.3.2. Echoing a string exacty as-is</h3></div></div></div>
4158: <p>Echoing a string containing special characters needs special
4159: work.</p>
1.1 dsieger 4160: <pre class="programlisting">
4161: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4162: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4163:
4164: all:
4165: echo ${STRING} # 1
1.108 rillig 4166: echo ${STRING:Q} # 2
4167: printf '%s\n' ${STRING:Q}'' # 3
4168: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4169: </pre>
4170: <p>Example 1 leads to a syntax error in the shell, as the characters
4171: are just copied.</p>
4172: <p>Example 2 quotes the string so that the shell interprets it
4173: correctly. But the echo command may additionally interpret strings with a
4174: leading dash or those containing backslashes.</p>
4175: <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
4176: interprets the format string, but not the next argument.</p>
4177: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4178: need to be quoted because the quoting has already been done
4179: when adding elements to the list.</p>
1.1 dsieger 4180: </div>
1.41 asau 4181: <div class="sect2">
1.1 dsieger 4182: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4183: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4184: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4185: GNU-style configure script (especially those that call other configure
4186: scripts), it must not have leading or trailing whitespace, since
4187: otherwise the configure script gets confused. To trim leading and
4188: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4189: following example:</p>
1.1 dsieger 4190: <pre class="programlisting">
4191: CPPFLAGS= # empty
1.108 rillig 4192: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4193: CPPFLAGS+= ${MY_CPPFLAGS}
4194:
4195: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4196:
4197: all:
4198: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4199: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4200: </pre>
1.108 rillig 4201: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4202: trailing whitespace because the <code class="code">+=</code> operator always adds a
4203: space.</p>
4204: </div>
4205: <div class="sect2">
4206: <div class="titlepage"><div><div><h3 class="title">
4207: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4208: <p>When a possibly empty variable is used in a shell program, it may
4209: lead to a syntax error.</p>
4210: <pre class="programlisting">
4211: EGFILES= # empty
4212:
4213: install-examples: # produces a syntax error in the shell
4214: for egfile in ${EGFILES}; do \
4215: echo "Installing $$egfile"; \
4216: done
4217: </pre>
4218: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
4219: <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>.
4220: To fix this syntax error, use one of the snippets below.</p>
4221: <pre class="programlisting">
4222: EMPTY= # empty
4223:
4224: install-examples:
4225: for egfile in ${EGFILES} ""; do \
4226: [ -n "$$egfile" ] || continue; \
4227: echo "Installing $$egfile"; \
1.1 dsieger 4228: done
1.108 rillig 4229: </pre>
4230: <p>In this case, an empty string is appended to the iteration list (to
4231: prevent the syntax error) and filtered out later.</p>
4232: <pre class="programlisting">
4233: EGFILES= # empty
1.1 dsieger 4234:
1.108 rillig 4235: install-examples:
4236: .for egfile in ${EGFILES}
4237: echo "Installing ${egfile}"
1.1 dsieger 4238: .endfor
4239: </pre>
1.108 rillig 4240: <p>This variant only works when <code class="varname">EGFILES</code> does not
4241: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4242: simple whitespace.</p>
4243: <p>To have a shell command test whether a make variable is empty, use
4244: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4245: </div>
4246: </div>
4247: </div>
1.41 asau 4248: <div class="chapter">
1.1 dsieger 4249: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4250: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4251: <div class="toc">
4252: <p><b>Table of Contents</b></p>
1.100 leot 4253: <dl class="toc">
1.6 rillig 4254: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4255: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4256: <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 4257: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4258: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4259: <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 4260: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4261: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4262: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4263: </dl>
4264: </div>
4265: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4266: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4267: the package (relative to the <code class="filename">${PREFIX}</code>
4268: directory it's been installed in) plus some additional statements
1.79 snj 4269: - 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 4270: This chapter addresses some issues that need attention when
4271: dealing with the <code class="filename">PLIST</code> file (or files, see
4272: below!).</p>
1.41 asau 4273: <div class="sect1">
1.1 dsieger 4274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4275: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4276: <p>Be sure to add a RCS ID line as the first thing in any
4277: <code class="filename">PLIST</code> file you write:</p>
4278: <pre class="programlisting">
4279: @comment $NetBSD$
1.111 sevan 4280: </pre>
1.1 dsieger 4281: </div>
1.41 asau 4282: <div class="sect1">
1.1 dsieger 4283: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4284: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4285: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4286: to output a PLIST that matches any new files since the package
1.10 hubertf 4287: 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 4288: more information on this target.</p>
4289: </div>
1.41 asau 4290: <div class="sect1">
1.1 dsieger 4291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4292: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4293: </h2></div></div></div>
4294: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4295: of AWK patterns and actions that are used to filter the output of
4296: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4297: scripting you like to it, but be careful with quoting.</p>
4298: <p>For example, to get all files inside the
4299: <code class="filename">libdata/foo</code> directory removed from the
4300: resulting PLIST:</p>
4301: <pre class="programlisting">
4302: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4303: </pre>
1.1 dsieger 4304: </div>
1.41 asau 4305: <div class="sect1">
1.1 dsieger 4306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4307: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4308: <p>A number of variables are substituted automatically in
4309: PLISTs when a package is installed on a system. This includes the
4310: following variables:</p>
1.41 asau 4311: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4312: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4313: <dd>
4314: <p>Some packages like emacs and perl embed information
4315: about which architecture they were built on into the
4316: pathnames where they install their files. To handle this
4317: case, PLIST will be preprocessed before actually used, and
4318: the symbol
1.23 wiz 4319: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4320: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4321: same is done if the string
4322: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4323: PLIST somewhere - use this on packages that have GNU
4324: autoconf-created configure scripts.</p>
1.41 asau 4325: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4326: <h3 class="title">Legacy note</h3>
4327: <p>There used to be a symbol
1.23 wiz 4328: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4329: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4330: -m</strong></span>, but that's no longer supported and has
4331: been removed.</p>
4332: </div>
4333: </dd>
4334: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4335: <dd>
4336: <p>Some packages want to embed the OS name and version
4337: into some paths. To do this, use these variables in the
4338: <code class="filename">PLIST</code>:
4339: </p>
1.41 asau 4340: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4341: <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>
4342: <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>
4343: <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 4344: </ul></div>
4345: </dd>
4346: </dl></div>
1.88 tnn 4347: <p>For a list of values which are replaced by
4348: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4349: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4350: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4351: <p>If you want to change other variables not listed above, you
4352: can add variables and their expansions to this variable in the
1.10 hubertf 4353: 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 4354: <pre class="programlisting">
4355: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4356: </pre>
1.23 wiz 4357: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4358: in the <code class="filename">PLIST</code> with
1.23 wiz 4359: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4360: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4361: the common case of conditionally including some
4362: <code class="filename">PLIST</code> entries. It can be done by adding
4363: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4364: setting the corresponding <code class="varname">PLIST.foo</code> variable
4365: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4366: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4367: in the <code class="filename">PLIST</code> with either
1.23 wiz 4368: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4369: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4370: For example, in <code class="filename">Makefile</code>:</p>
4371: <pre class="programlisting">
1.112 rillig 4372: PLIST_VARS+= foo
1.18 snj 4373: .if <em class="replaceable"><code>condition</code></em>
1.112 rillig 4374: PLIST.foo= yes
1.18 snj 4375: .else
1.111 sevan 4376: </pre>
1.18 snj 4377: <p>And then in <code class="filename">PLIST</code>:</p>
4378: <pre class="programlisting">
4379: @comment $NetBSD$
4380: bin/bar
4381: man/man1/bar.1
4382: ${PLIST.foo}bin/foo
4383: ${PLIST.foo}man/man1/foo.1
4384: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4385: </pre>
1.1 dsieger 4386: </div>
1.41 asau 4387: <div class="sect1">
1.1 dsieger 4388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4389: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 4390: <p>Man pages should be installed in compressed form if
4391: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4392: and uncompressed otherwise. To handle this in the
1.23 wiz 4393: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4394: appended/removed automatically for man pages according to
4395: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4396: or not, see above for details. This modification of the
4397: <code class="filename">PLIST</code> file is done on a copy of it, not
4398: <code class="filename">PLIST</code> itself.</p>
4399: </div>
1.41 asau 4400: <div class="sect1">
1.1 dsieger 4401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4402: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4403: </h2></div></div></div>
4404: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4405: in generating the binary package, set the variable
4406: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.79 snj 4407: 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 4408: important. The default for <code class="varname">PLIST_SRC</code> is
4409: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4410: </div>
1.41 asau 4411: <div class="sect1">
1.1 dsieger 4412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4413: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4414: <p>Some packages decide to install a different set of files based on
4415: the operating system being used. These differences can be
4416: automatically handled by using the following files:</p>
1.41 asau 4417: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4418: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4419: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4420: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4421: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4422: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4423: </ul></div>
4424: </div>
1.41 asau 4425: <div class="sect1">
1.1 dsieger 4426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 4427: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4428: <p>Some packages decide to generate hard-to-guess file names
4429: during installation that are hard to wire down.</p>
4430: <p>In such cases, you can set the
4431: <code class="varname">GENERATE_PLIST</code> variable to shell code
4432: terminated (with a semicolon) that will output PLIST entries which
4433: will be appended to the PLIST</p>
4434: <p>You can find one example in editors/xemacs:</p>
4435: <pre class="programlisting">
1.111 sevan 4436: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4437: </pre>
1.86 wiz 4438: <p>which will append something like
4439: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4440: <code class="filename">PLIST</code>.
4441: </p>
4442: </div>
4443: <div class="sect1">
4444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4445: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4446: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4447: multiple (and unrelated) packages install files. These
1.22 jakllsch 4448: directories were problematic because you had to add special
4449: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4450: centralized package handle them.</p>
1.22 jakllsch 4451: <p>In pkgsrc, it is now easy: Each package should create
4452: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4453: will remove any directories left empty after uninstalling a
4454: package.</p>
4455: <p>If a package needs an empty directory to work, create
4456: the directory during installation as usual, and also add an
4457: entry to the PLIST:
1.111 sevan 4458:
4459: </p>
1.1 dsieger 4460: <pre class="programlisting">
1.22 jakllsch 4461: @pkgdir path/to/empty/directory
1.111 sevan 4462: </pre>
1.22 jakllsch 4463: <p>
1.111 sevan 4464:
1.86 wiz 4465: or take a look at <code class="varname">MAKE_DIRS</code> and
4466: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4467: </p>
1.1 dsieger 4468: </div>
4469: </div>
1.41 asau 4470: <div class="chapter">
1.1 dsieger 4471: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4472: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4473: <div class="toc">
4474: <p><b>Table of Contents</b></p>
1.100 leot 4475: <dl class="toc">
1.6 rillig 4476: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 4477: <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 4478: <dd><dl>
1.6 rillig 4479: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 4480: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
4481: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4482: and
4483: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4484: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4485: </dl></dd>
1.23 wiz 4486: <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 4487: <dd><dl>
1.23 wiz 4488: <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 4489: <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 4490: </dl></dd>
4491: </dl>
4492: </div>
4493: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4494: are seen by a package's configure and build processes. This is implemented
4495: in a two step process:</p>
1.23 wiz 4496: <div class="orderedlist"><ol class="orderedlist" type="1">
4497: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4498: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4499: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4500: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4501: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4502: <code class="option">-L${LOCALBASE}/lib</code> into references to
4503: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4504: native compiler on some operating systems look like GCC, so that
4505: packages that expect GCC won't require modifications to build with
4506: those native compilers.</p></li>
4507: </ol></div>
4508: <p>This normalizes the environment in which a package is built so that the
4509: package may be built consistently despite what other software may be
4510: installed. Please note that the normal system header and library paths,
4511: e.g. <code class="filename">/usr/include</code>,
4512: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4513: designed to insulate the package build from non-system-supplied
4514: software.</p>
1.41 asau 4515: <div class="sect1">
1.1 dsieger 4516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4517: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4518: <p>The process of converting packages to use the buildlink3
1.23 wiz 4519: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4520: The things to keep in mind are:</p>
1.23 wiz 4521: <div class="orderedlist"><ol class="orderedlist" type="1">
4522: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4523: instead of the actual toolchain. Some packages are tricky,
4524: and the only way to know for sure is the check
4525: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4526: wrappers are being invoked.</p></li>
1.23 wiz 4527: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4528: the package Makefile, e.g. Java VMs, standalone shells,
4529: etc., because the code to symlink files into
4530: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4531: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4532: </p></li>
1.23 wiz 4533: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4534: <code class="filename">buildlink3.mk</code> files that you list in a
4535: package's Makefile are added as dependencies for that package.
4536: </p></li>
4537: </ol></div>
4538: <p>If a dependency on a particular package is required for its libraries and
4539: headers, then we replace:</p>
4540: <pre class="programlisting">
4541: DEPENDS+= foo>=1.1.0:../../category/foo
4542: </pre>
4543: <p>with</p>
4544: <pre class="programlisting">
4545: .include "../../category/foo/buildlink3.mk"
4546: </pre>
4547: <p>The buildlink3.mk files usually define the required dependencies.
4548: If you need a newer version of the dependency when using buildlink3.mk
4549: files, then you can define it in your Makefile; for example:</p>
4550: <pre class="programlisting">
4551: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4552: .include "../../category/foo/buildlink3.mk"
4553: </pre>
4554: <p>There are several <code class="filename">buildlink3.mk</code>
4555: files in <code class="filename">pkgsrc/mk</code>
4556: that handle special package issues:</p>
1.41 asau 4557: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4558: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4559: the native or a pkgsrc Berkeley DB implementation based on
4560: the values of <code class="varname">BDB_ACCEPTED</code> and
4561: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4562: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4563: comes with neither Curses nor NCurses, this will take care
1.79 snj 4564: 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 4565: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4566: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4567: adding a dependency on Heimdal or MIT-krb5 for packages that
4568: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4569: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4570: system-provided Motif installation or adds a dependency on
1.79 snj 4571: <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 4572: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 4573: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
4574: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 4575: which Motif version will be used.</p></li>
1.55 ryoon 4576: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4577: system-provided GNU readline or editline (libedit) installation,
1.79 snj 4578: 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>,
4579: <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 4580: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4581: If your package really needs GNU readline library, its Makefile
4582: should include <code class="filename">devel/readline/buildlink3.mk</code>
4583: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4584: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4585: variables that may be used by packages that use the
4586: Open Sound System (OSS) API.</p></li>
1.23 wiz 4587: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4588: any of the Postgres versions in the variable
4589: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4590: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4591: the file for more information.</p></li>
1.23 wiz 4592: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4593: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.79 snj 4594: 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 4595: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4596: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4597: library.</p></li>
4598: </ul></div>
4599: <p>The comments in those <code class="filename">buildlink3.mk</code>
4600: files provide a more complete
4601: description of how to use them properly.</p>
4602: </div>
1.41 asau 4603: <div class="sect1">
1.1 dsieger 4604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4605: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4606: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4607: included by Makefiles to indicate the need to compile and link
4608: against header files and libraries provided by the package. A
4609: <code class="filename">buildlink3.mk</code> file should always provide
4610: enough information to add the correct type of dependency
4611: relationship and include any other
4612: <code class="filename">buildlink3.mk</code> files that it needs to find
4613: headers and libraries that it needs in turn.</p>
4614: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.79 snj 4615: 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 4616: package is highly recommended. For most packages, the following
4617: command will generate a good starting point for
4618: <code class="filename">buildlink3.mk</code> files:</p>
4619: <pre class="screen">
4620: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4621: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4622: </pre>
1.41 asau 4623: <div class="sect2">
1.1 dsieger 4624: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4625: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4626: <p>The following real-life example
4627: <code class="filename">buildlink3.mk</code> is taken
4628: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4629: <pre class="programlisting">
1.18 snj 4630: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4631:
1.112 rillig 4632: BUILDLINK_TREE+= tiff
1.1 dsieger 4633:
1.18 snj 4634: .if !defined(TIFF_BUILDLINK3_MK)
4635: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4636:
1.112 rillig 4637: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4638: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4639: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4640:
4641: .include "../../devel/zlib/buildlink3.mk"
4642: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4643: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4644:
1.112 rillig 4645: BUILDLINK_TREE+= -tiff
1.1 dsieger 4646: </pre>
4647: <p>The header and footer manipulate
1.18 snj 4648: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4649: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4650: the dependency tree.</p>
4651: <p>The main section is protected from multiple inclusion
1.1 dsieger 4652: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4653: added. Several important variables are set in the section:</p>
1.41 asau 4654: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4655: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4656: is the actual dependency recorded in the installed
4657: package; this should always be set using
1.10 hubertf 4658: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4659: we're appending to any pre-existing list of values. This
4660: variable should be set to the first version of the
1.26 wiz 4661: package that had an backwards-incompatible API change.
1.1 dsieger 4662: </p></li>
1.23 wiz 4663: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4664: is the location of the <em class="replaceable"><code>pkg</code></em>
4665: pkgsrc directory.</p></li>
1.23 wiz 4666: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4667: (not shown above) controls whether we use
4668: <code class="varname">BUILD_DEPENDS</code> or
4669: <code class="varname">DEPENDS</code> to add the dependency on
4670: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4671: selected by setting
4672: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4673: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4674: used.</p></li>
1.23 wiz 4675: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4676: and
4677: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4678: (not shown above) are lists of subdirectories of
4679: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4680: to add to the header and library search paths. These
1.23 wiz 4681: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4682: respectively.</p></li>
1.23 wiz 4683: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4684: (not shown above) is the list of preprocessor flags to add
4685: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4686: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4687: should be avoided and instead be handled using
4688: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4689: above.</p></li>
4690: </ul></div>
4691: <p>The following variables are all optionally defined within
4692: this second section (protected against multiple inclusion) and
4693: control which package files are symlinked into
4694: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4695: transformed during the symlinking:</p>
1.41 asau 4696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4697: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4698: (not shown above) is a shell glob pattern relative to
4699: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4700: to be symlinked into
4701: <code class="filename">${BUILDLINK_DIR}</code>,
4702: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4703: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4704: (not shown above) is a shell pipeline that
4705: outputs to stdout a list of files relative to
4706: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4707: The resulting files are to be symlinked
4708: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4709: this takes the <code class="filename">+CONTENTS</code> of a
4710: <em class="replaceable"><code>pkg</code></em> and filters it through
4711: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4712: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4713: (not shown above) is a filter command that filters
4714: <code class="filename">+CONTENTS</code> input into a list of files
4715: relative to
4716: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4717: on stdout. By default,
1.1 dsieger 4718: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4719: outputs the contents of the <code class="filename">include</code>
4720: and <code class="filename">lib</code> directories in the package
1.84 wiz 4721: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4722: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4723: (not shown above) is a list of sed arguments used to
4724: transform the name of the source filename into a
1.10 hubertf 4725: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4726: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4727: </ul></div>
1.18 snj 4728: <p>This section can additionally include any
1.1 dsieger 4729: <code class="filename">buildlink3.mk</code> needed for
4730: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4731: Including these <code class="filename">buildlink3.mk</code> files
4732: means that the headers and libraries for these
4733: dependencies are also symlinked into
4734: <code class="filename">${BUILDLINK_DIR}</code>
4735: whenever the <em class="replaceable"><code>pkg</code></em>
4736: <code class="filename">buildlink3.mk</code>
1.18 snj 4737: file is included. Dependencies are only added for directly
4738: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4739: <p>When providing a <code class="filename">buildlink3.mk</code> and
4740: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4741: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4742: header files are automatically exposed when the package is
4743: use.</p>
4744: <p>In particular, if only an executable
4745: (<code class="filename">bin/foo</code>) is linked against a library, that
4746: library does not need to be propagated in the
4747: <code class="filename">buildlink3.mk</code> file.</p>
4748: <p>The following steps should help you decide if a
4749: <code class="filename">buildlink3.mk</code> file needs to be included:
4750: </p>
4751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4752: <li class="listitem"><p>Look at the installed header files: What
4753: headers do they include? The packages providing these files
4754: must be buildlinked.</p></li>
1.49 wiz 4755: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4756: libraries and look against what other libraries they link.
4757: Some of the packages providing these probably need to be
4758: buildlinked; however, it's not automatic, since e.g. GTK on
4759: some systems pulls in the X libraries, so they will show up in
4760: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4761: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4762: used as a hint.</p></li>
1.47 wiz 4763: </ul></div>
4764: <p>
4765: </p>
1.1 dsieger 4766: </div>
1.41 asau 4767: <div class="sect2">
1.1 dsieger 4768: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 4769: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 4770: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4771: and
4772: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4773: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4774: <p>These two variables differ in that one describes source
4775: compatibility (API) and the other binary compatibility (ABI).
4776: The difference is that a change in the API breaks compilation of
4777: programs while changes in the ABI stop compiled programs from
4778: running.</p>
4779: <p>Changes to the
1.27 wiz 4780: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4781: variable in a <code class="filename">buildlink3.mk</code> file happen
4782: very rarely. One possible reason is that all packages depending
4783: on this already need a newer version. In case it is bumped see
4784: the description below.</p>
4785: <p>The most common example of an ABI change is that the major
4786: version of a shared library is increased. In this case,
4787: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4788: should be adjusted to require at least the new package version.
4789: Then the packages that depend on this package need their
4790: <code class="varname">PKGREVISION</code>s increased and, if they have
4791: <code class="filename">buildlink3.mk</code> files, their
4792: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4793: adjusted, too. This is needed so pkgsrc will require the correct
4794: package dependency and not settle for an older one when building
4795: the source.</p>
1.108 rillig 4796: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.26 wiz 4797: more information about dependencies on other packages,
4798: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4799: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4800: <p>Please take careful consideration before adjusting
4801: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4802: or
4803: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4804: as we don't want to cause unneeded package deletions and
4805: rebuilds. In many cases, new versions of packages work just
4806: fine with older dependencies.</p>
4807: <p>Also it is not needed to set
1.26 wiz 4808: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4809: when it is identical to
1.1 dsieger 4810: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4811: </div>
4812: </div>
1.41 asau 4813: <div class="sect1">
1.1 dsieger 4814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4815: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4816: <p>Some packages in pkgsrc install headers and libraries that
4817: coincide with headers and libraries present in the base system.
4818: Aside from a <code class="filename">buildlink3.mk</code> file, these
4819: packages should also include a <code class="filename">builtin.mk</code>
4820: file that includes the necessary checks to decide whether using
4821: the built-in software or the pkgsrc software is
4822: appropriate.</p>
4823: <p>The only requirements of a builtin.mk file for
4824: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4825: <div class="orderedlist"><ol class="orderedlist" type="1">
4826: <li class="listitem"><p>It should set
1.1 dsieger 4827: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4828: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4829: after it is included.</p></li>
1.23 wiz 4830: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4831: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4832: which is already set before the
4833: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4834: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4835: is <span class="emphasis"><em>very</em></span> important and takes careful
4836: attention to <code class="filename">Makefile</code> coding.</p></li>
4837: </ol></div>
1.41 asau 4838: <div class="sect2">
1.1 dsieger 4839: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4840: <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 4841: <p>The following is the recommended template for builtin.mk
4842: files:</p>
4843: <pre class="programlisting">
4844: .if !defined(IS_BUILTIN.foo)
4845: #
4846: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4847: # genuinely exists in the system or not.
4848: #
4849: IS_BUILTIN.foo?= no
4850:
4851: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4852: # version can be determined.
4853: #
4854: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4855: BUILTIN_PKG.foo?= foo-1.0
4856: . endif
4857: .endif # IS_BUILTIN.foo
4858:
4859: .if !defined(USE_BUILTIN.foo)
4860: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4861: . if defined(BUILTIN_PKG.foo)
4862: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4863: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4864: USE_BUILTIN.foo!= \
4865: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4866: && ${ECHO} "yes" || ${ECHO} "no"
4867: . endif
4868: . endfor
4869: . endif
4870: .endif # USE_BUILTIN.foo
4871:
4872: CHECK_BUILTIN.foo?= no
4873: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4874: #
4875: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4876: # "yes" or "no".
4877: #
4878: .endif # CHECK_BUILTIN.foo
4879: </pre>
4880: <p>The first section sets
4881: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4882: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4883: in the base system. This should not be a base system software
4884: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 4885: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 4886: included as part of the base system. This variable is only
4887: used internally within the <code class="filename">builtin.mk</code>
4888: file.</p>
4889: <p>The second section sets
4890: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4891: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4892: system if it exists (if
4893: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4894: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 4895: within the <code class="filename">builtin.mk</code> file.</p>
4896: <p>The third section sets
4897: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4898: and is <span class="emphasis"><em>required</em></span> in all
4899: <code class="filename">builtin.mk</code> files. The code in this
4900: section must make the determination whether the built-in
4901: software is adequate to satisfy the dependencies listed in
4902: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4903: This is typically done by comparing
4904: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4905: against each of the dependencies in
4906: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4907: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4908: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4909: end of the <code class="filename">builtin.mk</code> file. Note that
4910: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4911: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 4912: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4913: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 4914: that the built-in version of the software is similar enough to
4915: be used as a replacement.</p>
4916: <p>The last section is guarded by
4917: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4918: and includes code that uses the value of
4919: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4920: set in the previous section. This typically includes, e.g.,
4921: adding additional dependency restrictions and listing additional
4922: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4923: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
4924: </div>
1.41 asau 4925: <div class="sect2">
1.1 dsieger 4926: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4927: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 4928: <p>When building packages, it's possible to choose whether to set
4929: a global preference for using either the built-in (native)
4930: version or the pkgsrc version of software to satisfy a
4931: dependency. This is controlled by setting
4932: <code class="varname">PREFER_PKGSRC</code> and
4933: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 4934: 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 4935: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4936: use the pkgsrc versions of software, while
4937: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4938: built-in versions. Preferences are determined by the most
4939: specific instance of the package in either
4940: <code class="varname">PREFER_PKGSRC</code> or
4941: <code class="varname">PREFER_NATIVE</code>. If a package is specified
4942: in neither or in both variables, then
4943: <code class="varname">PREFER_PKGSRC</code> has precedence over
4944: <code class="varname">PREFER_NATIVE</code>. For example, to require
4945: using pkgsrc versions of software for all but the most basic
4946: bits on a NetBSD system, you can set:</p>
4947: <pre class="programlisting">
4948: PREFER_PKGSRC= yes
4949: PREFER_NATIVE= getopt skey tcp_wrappers
4950: </pre>
4951: <p>A package <span class="emphasis"><em>must</em></span> have a
4952: <code class="filename">builtin.mk</code>
4953: file to be listed in <code class="varname">PREFER_NATIVE</code>,
4954: otherwise it is simply ignored in that list.</p>
4955: </div>
4956: </div>
4957: </div>
1.41 asau 4958: <div class="chapter">
1.1 dsieger 4959: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4960: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 4961: <div class="toc">
4962: <p><b>Table of Contents</b></p>
1.100 leot 4963: <dl class="toc">
1.6 rillig 4964: <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 4965: <dd><dl>
1.6 rillig 4966: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
4967: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 4968: </dl></dd>
1.6 rillig 4969: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 4970: <dd><dl>
1.23 wiz 4971: <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 4972: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
4973: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
4974: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
4975: </dl></dd>
4976: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
4977: <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>
4978: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
4979: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
4980: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
4981: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
4982: <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 4983: </dl>
4984: </div>
4985: <p>This chapter describes the framework known as
4986: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 4987: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4988: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 4989: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 4990: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 4991: provided that packages are correctly designed.</p></li>
1.23 wiz 4992: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
4993: <li class="listitem"><p>Registration of system users and groups.</p></li>
4994: <li class="listitem"><p>Registration of system shells.</p></li>
4995: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 4996: </ul></div>
4997: <p>The following sections inspect each of the above points in detail.</p>
4998: <p>You may be thinking that many of the things described here could be
4999: easily done with simple code in the package's post-installation target
5000: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5001: as the code in them is only executed when building from source. Machines
5002: using binary packages could not benefit from it at all (as the code itself
5003: could be unavailable). Therefore, the only way to achieve any of the items
5004: described above is by means of the installation scripts, which are
5005: automatically generated by pkginstall.</p>
1.41 asau 5006: <div class="sect1">
1.1 dsieger 5007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5008: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5009: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5010: of files and directories that belong to a package. The names used in it
5011: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5012: which means that it cannot register files outside this directory (absolute
5013: path names are not allowed). Despite this restriction, some packages need
5014: to install files outside this location; e.g., under
5015: <code class="filename">${VARBASE}</code> or
5016: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5017: is to create such files during installation time by using
5018: installation scripts.</p>
5019: <p>The generic installation scripts are shell scripts that can
5020: contain arbitrary code. The list of scripts to execute is taken from
5021: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5022: <code class="filename">INSTALL</code>. A similar variable exists for package
5023: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5024: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5025: commands, so they have the potential to create and manage files
5026: anywhere in the file system.</p>
5027: <p>Using these general installation files is not recommended, but
5028: may be needed in some special cases. One reason for avoiding them is
5029: that the user has to trust the packager that there is no unwanted or
5030: simply erroneous code included in the installation script. Also,
5031: previously there were many similar scripts for the same functionality,
5032: and fixing a common error involved finding and changing all of
5033: them.</p>
5034: <p>The pkginstall framework offers another, standardized way. It
5035: provides generic scripts to abstract the manipulation of such files
5036: and directories based on variables set in the package's
5037: <code class="filename">Makefile</code>. The rest of this section describes
5038: these variables.</p>
1.41 asau 5039: <div class="sect2">
1.1 dsieger 5040: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5041: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5042: <p>The following variables can be set to request the creation of
5043: directories anywhere in the file system:</p>
1.41 asau 5044: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5045: <li class="listitem">
5046: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5047: contain a list of directories that should be created and should attempt
5048: to be destroyed by the installation scripts. The difference between
5049: the two is that the latter prompts the administrator to remove any
5050: directories that may be left after deinstallation (because they were
1.108 rillig 5051: not empty), while the former does not. Example:</p>
5052: <pre class="programlisting">
5053: MAKE_DIRS+= ${VARBASE}/foo/private
5054: </pre>
5055: </li>
1.23 wiz 5056: <li class="listitem">
1.1 dsieger 5057: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5058: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5059: which directories should be created and should attempt to be destroyed
5060: by the installation scripts. Each tuple holds the following values,
5061: separated by spaces: the directory name, its owner, its group and its
5062: numerical mode. For example:</p>
5063: <pre class="programlisting">
1.108 rillig 5064: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5065: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5066: </pre>
5067: <p>The difference between the two is exactly the same as their
5068: non-<code class="varname">PERMS</code> counterparts.</p>
5069: </li>
5070: </ul></div>
5071: </div>
1.41 asau 5072: <div class="sect2">
1.1 dsieger 5073: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5074: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5075: <p>Creating non-empty files outside the installation prefix is tricky
5076: because the <code class="filename">PLIST</code> forces all files to be inside it.
5077: To overcome this problem, the only solution is to extract the file in the
5078: known place (i.e., inside the installation prefix) and copy it to the
5079: appropriate location during installation (done by the installation scripts
5080: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5081: file</em></span> in the following paragraphs, which describe the variables
5082: that can be used to automatically and consistently handle files outside the
5083: installation prefix:</p>
1.41 asau 5084: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5085: <li class="listitem">
1.1 dsieger 5086: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5087: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5088: During installation time, the master file is copied to the target one
5089: if and only if the latter does not exist. Upon deinstallation, the
5090: target file is removed provided that it was not modified by the
5091: installation.</p>
5092: <p>The difference between the two is that the latter prompts the
5093: administrator to remove any files that may be left after
5094: deinstallation (because they were not empty), while the former does
5095: not.</p>
5096: </li>
1.23 wiz 5097: <li class="listitem">
1.1 dsieger 5098: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5099: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5100: files as well as their target locations. For each of them, it also
5101: specifies their owner, their group and their numeric permissions, in
5102: this order. For example:</p>
5103: <pre class="programlisting">
1.108 rillig 5104: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5105: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5106: </pre>
5107: <p>The difference between the two is exactly the same as their
5108: non-<code class="varname">PERMS</code> counterparts.</p>
5109: </li>
5110: </ul></div>
5111: </div>
5112: </div>
1.41 asau 5113: <div class="sect1">
1.1 dsieger 5114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5115: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5116: <p>Configuration files are special in the sense that they are installed
5117: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5118: need special treatment during installation (most of which is automated by
5119: pkginstall). The main concept you must bear in mind is that files marked
5120: as configuration files are automatically copied to the right place (somewhere
5121: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5122: and only if</em></span> they didn't exist before. Similarly, they will not
5123: be removed if they have local modifications. This ensures that
5124: administrators never lose any custom changes they may have made.</p>
1.41 asau 5125: <div class="sect2">
1.1 dsieger 5126: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5127: <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 5128: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5129: specifies where configuration files shall be installed. Its contents are
5130: set based upon the following variables:</p>
1.41 asau 5131: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5132: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5133: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5134: be overridden by the user to point to his preferred location (e.g.,
5135: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5136: Packages must not use it directly.</p></li>
1.23 wiz 5137: <li class="listitem">
1.1 dsieger 5138: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5139: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5140: for the package being built shall be installed. The definition of this
5141: variable only makes sense in the package's
5142: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5143: <p>As an example, consider the Apache package,
1.79 snj 5144: <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 5145: configuration files under the
5146: <code class="filename">httpd/</code> subdirectory of
5147: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5148: Makefile.</p>
5149: </li>
1.23 wiz 5150: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5151: variable that holds this package's configuration directory (if
5152: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5153: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5154: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5155: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5156: directory where the configuration files for the package identified by
5157: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5158: </ul></div>
5159: <p>Based on the above variables, pkginstall determines the value of
5160: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5161: variable that can be used within a package to refer to its configuration
5162: directory. The algorithm used to set its value is basically the
5163: following:</p>
1.23 wiz 5164: <div class="orderedlist"><ol class="orderedlist" type="1">
5165: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5166: its value is used.</p></li>
1.23 wiz 5167: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5168: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5169: <code class="filename">Makefile</code>, the resulting value is
5170: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5171: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5172: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5173: </ol></div>
5174: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5175: 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
5176: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5177: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5178: </div>
1.41 asau 5179: <div class="sect2">
1.1 dsieger 5180: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5181: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5182: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5183: known place, you need to teach each package where it shall install its
5184: files. In some cases you will have to patch the package Makefiles to
5185: achieve it. If you are lucky, though, it may be as easy as passing an
5186: extra flag to the configuration script; this is the case of GNU Autoconf-
5187: generated files:</p>
5188: <pre class="programlisting">
5189: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5190: </pre>
5191: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5192: for</em></span> its configuration files, not where they will be originally
5193: installed (although the difference is never explicit,
5194: unfortunately).</p>
5195: </div>
1.41 asau 5196: <div class="sect2">
1.1 dsieger 5197: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5198: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5199: <p>As said before, pkginstall automatically handles configuration files.
5200: This means that <span class="strong"><strong>the packages themselves must not
5201: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5202: directly</strong></span>. Bad news is that many software installation scripts
5203: will, out of the box, mess with the contents of that directory. So what is
5204: the correct procedure to fix this issue?</p>
5205: <p>You must teach the package (usually by manually patching it) to
5206: install any configuration files under the examples hierarchy,
5207: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5208: <code class="filename">PLIST</code> registers them and the administrator always
5209: has the original copies available.</p>
5210: <p>Once the required configuration files are in place (i.e., under the
5211: examples hierarchy), the pkginstall framework can use them as master copies
5212: during the package installation to update what is in
5213: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5214: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5215: 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 5216: about their syntax and their purpose. Here is an example, taken from the
1.79 snj 5217: <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 5218: <pre class="programlisting">
5219: EGDIR= ${PREFIX}/share/doc/mutt/samples
5220: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5221: </pre>
5222: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5223: package and has no meaning outside it.</p>
5224: </div>
1.41 asau 5225: <div class="sect2">
1.1 dsieger 5226: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5227: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5228: <p>The automatic copying of config files can be toggled by setting the
5229: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5230: installation.</p>
5231: </div>
5232: </div>
1.41 asau 5233: <div class="sect1">
1.1 dsieger 5234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5235: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5236: <p>System startup scripts are special files because they must be
5237: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5238: 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 5239: can be used. However, pkginstall provides a special mechanism to handle
5240: these files.</p>
5241: <p>In order to provide system startup scripts, the package has
5242: to:</p>
1.23 wiz 5243: <div class="orderedlist"><ol class="orderedlist" type="1">
5244: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5245: the <code class="literal">.sh</code> suffix appended. Considering the
1.79 snj 5246: <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 5247: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5248: <li class="listitem">
1.1 dsieger 5249: <p>Tell pkginstall to handle it, appending the name of the script,
5250: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5251: Continuing the previous example:</p>
5252: <pre class="programlisting">
5253: RCD_SCRIPTS+= cupsd
5254: </pre>
5255: </li>
5256: </ol></div>
5257: <p>Once this is done, pkginstall will do the following steps for each
5258: script in an automated fashion:</p>
1.23 wiz 5259: <div class="orderedlist"><ol class="orderedlist" type="1">
5260: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5261: substitutions described in the <code class="filename">FILES_SUBST</code>
5262: variable.</p></li>
1.23 wiz 5263: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5264: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5265: that this master file must be explicitly registered in the
5266: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5267: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5268: from the examples hierarchy into the system-wide startup scripts
5269: directory.</p></li>
5270: </ol></div>
1.41 asau 5271: <div class="sect2">
1.1 dsieger 5272: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5273: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5274: <p>The automatic copying of config files can be toggled by setting the
5275: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5276: installation. Note that the scripts will be always copied inside the
5277: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5278: matter what the value of this variable is.</p>
5279: </div>
5280: </div>
1.41 asau 5281: <div class="sect1">
1.1 dsieger 5282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5283: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5284: <p>If a package needs to create special users and/or groups during
5285: installation, it can do so by using the pkginstall framework.</p>
5286: <p>Users can be created by adding entries to the
5287: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5288: syntax:</p>
5289: <pre class="programlisting">
5290: user:group
5291: </pre>
5292: <p>Further specification of user details may be done by setting
5293: per-user variables.
5294: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5295: numeric UID for the user.
5296: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5297: user's description or comment.
5298: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5299: user's home directory, and defaults to
5300: <code class="filename">/nonexistent</code> if not specified.
5301: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5302: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5303: not specified.</p>
5304: <p>Similarly, groups can be created by adding entries to the
5305: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5306: <pre class="programlisting">
5307: group
5308: </pre>
5309: <p>The numeric GID of the group may be set by defining
5310: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5311: <p>If a package needs to create the users and groups at an earlier
1.116 ! wiz 5312: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
! 5313: <code class="literal">configure</code>,<code class="literal">build</code>, or
! 5314: <code class="literal">pre-install</code> to indicate the phase before which the
! 5315: users and groups are created. In this case, the numeric UIDs and GIDs
! 5316: of the created users and groups are automatically hardcoded into the
! 5317: final installation scripts.</p>
1.1 dsieger 5318: </div>
1.41 asau 5319: <div class="sect1">
1.1 dsieger 5320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5321: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5322: <p>Packages that install system shells should register them in the shell
5323: database, <code class="filename">/etc/shells</code>, to make things easier to the
5324: administrator. This must be done from the installation scripts to keep
5325: binary packages working on any system. pkginstall provides an easy way to
5326: accomplish this task.</p>
5327: <p>When a package provides a shell interpreter, it has to set the
5328: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5329: add some hooks to the installation scripts to handle it. Consider the
1.79 snj 5330: 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 5331: <pre class="programlisting">
5332: PKG_SHELL= ${PREFIX}/bin/zsh
5333: </pre>
1.41 asau 5334: <div class="sect2">
1.1 dsieger 5335: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5336: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5337: <p>The automatic registration of shell interpreters can be disabled by
5338: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5339: environment variable to <code class="literal">NO</code>.</p>
5340: </div>
5341: </div>
1.41 asau 5342: <div class="sect1">
1.1 dsieger 5343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5344: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5345: <p>Packages that install X11 fonts should update the database files
5346: that index the fonts within each fonts directory. This can easily be
5347: accomplished within the pkginstall framework.</p>
5348: <p>When a package installs X11 fonts, it must list the directories in
5349: which fonts are installed in the
5350: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5351: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5352: <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 5353: installation scripts to run the appropriate commands to update the fonts
5354: database files within each of those directories. For convenience, if the
5355: directory path is relative, it is taken to be relative to the package's
1.79 snj 5356: 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 5357: <pre class="programlisting">
1.67 wiz 5358: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5359: </pre>
1.41 asau 5360: <div class="sect2">
1.1 dsieger 5361: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5362: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5363: <p>The automatic update of fonts databases can be disabled by
5364: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5365: environment variable to <code class="literal">NO</code>.</p>
5366: </div>
5367: </div>
5368: </div>
1.41 asau 5369: <div class="chapter">
1.1 dsieger 5370: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5371: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5372: <div class="toc">
5373: <p><b>Table of Contents</b></p>
1.100 leot 5374: <dl class="toc">
1.6 rillig 5375: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5376: <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 5377: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5378: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5379: </dl>
5380: </div>
5381: <p>Many packages have the ability to be built to support different
5382: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5383: in pkgsrc that provides generic handling of those options that
5384: determine different ways in which the packages can be built. It's
5385: possible for the user to specify exactly which sets of options will be
5386: built into a package or to allow a set of global default options
5387: apply.</p>
1.7 rillig 5388: <p>There are two broad classes of behaviors that one might want to
5389: control via options. One is whether some particular feature is
5390: enabled in a program that will be built anyway, often by including or
5391: not including a dependency on some other package. The other is
5392: whether or not an additional program will be built as part of the
5393: package. Generally, it is better to make a split package for such
5394: additional programs instead of using options, because it enables
5395: binary packages to be built which can then be added separately. For
5396: example, the foo package might have minimal dependencies (those
5397: packages without which foo doesn't make sense), and then the foo-gfoo
5398: package might include the GTK frontend program gfoo. This is better
5399: than including a gtk option to foo that adds gfoo, because either that
5400: option is default, in which case binary users can't get foo without
5401: gfoo, or not default, in which case they can't get gfoo. With split
5402: packages, they can install foo without having GTK, and later decide to
5403: install gfoo (pulling in GTK at that time). This is an advantage to
5404: source users too, avoiding the need for rebuilds.</p>
5405: <p>Plugins with widely varying dependencies should usually be split
5406: instead of options.</p>
5407: <p>It is often more work to maintain split packages, especially if
5408: the upstream package does not support this. The decision of split
5409: vs. option should be made based on the likelihood that users will want
5410: or object to the various pieces, the size of the dependencies that are
5411: included, and the amount of work.</p>
5412: <p>A further consideration is licensing. Non-free parts, or parts
5413: that depend on non-free dependencies (especially plugins) should
5414: almost always be split if feasible.</p>
1.41 asau 5415: <div class="sect1">
1.1 dsieger 5416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5417: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 5418: <p>Global default options are listed in
5419: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5420: that should be built into every package if that option is supported.
1.10 hubertf 5421: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5422: </div>
1.41 asau 5423: <div class="sect1">
1.1 dsieger 5424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5425: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5426: </h2></div></div></div>
5427: <p>The following example shows how
5428: <code class="filename">bsd.options.mk</code> should be used
5429: by the hypothetical ``wibble'' package, either in the package
5430: <code class="filename">Makefile</code>, or in a file,
5431: e.g. <code class="filename">options.mk</code>, that is included by the
5432: main package <code class="filename">Makefile</code>.</p>
5433: <pre class="programlisting">
5434: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5435: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5436: PKG_OPTIONS_OPTIONAL_GROUPS= database
5437: PKG_OPTIONS_GROUP.database= mysql pgsql
5438: PKG_SUGGESTED_OPTIONS= wibble-foo
5439: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5440: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5441:
5442: .include "../../mk/bsd.prefs.mk"
5443:
5444: # this package was previously named wibble2
5445: .if defined(PKG_OPTIONS.wibble2)
5446: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5447: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5448: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5449: .endif
5450:
5451: .include "../../mk/bsd.options.mk"
5452:
5453: # Package-specific option-handling
5454:
5455: ###
5456: ### FOO support
5457: ###
5458: .if !empty(PKG_OPTIONS:Mwibble-foo)
5459: CONFIGURE_ARGS+= --enable-foo
5460: .endif
5461:
5462: ###
5463: ### LDAP support
5464: ###
5465: .if !empty(PKG_OPTIONS:Mldap)
5466: . include "../../databases/openldap-client/buildlink3.mk"
5467: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5468: .endif
5469:
5470: ###
5471: ### database support
5472: ###
5473: .if !empty(PKG_OPTIONS:Mmysql)
5474: . include "../../mk/mysql.buildlink3.mk"
5475: .endif
5476: .if !empty(PKG_OPTIONS:Mpgsql)
5477: . include "../../mk/pgsql.buildlink3.mk"
5478: .endif
5479: </pre>
5480: <p>The first section contains the information about which build
5481: options are supported by the package, and any default options settings
5482: if needed.</p>
1.23 wiz 5483: <div class="orderedlist"><ol class="orderedlist" type="1">
5484: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.79 snj 5485: <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 5486: options. It should be set to
5487: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5488: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5489: at the point where the options are processed.</p></li>
1.23 wiz 5490: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5491: build options supported by the package.</p></li>
1.23 wiz 5492: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5493: list of names of groups of mutually exclusive options. The options in
5494: each group are listed in
5495: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5496: The most specific setting of any option from the group takes
5497: precedence over all other options in the group. Options from the
5498: groups will be automatically added to
5499: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5500: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5501: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5502: packages will fail if no option from the group is
5503: selected.</p></li>
1.23 wiz 5504: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5505: of names of sets of options. At least one option from each set must
5506: be selected. The options in each set are listed in
5507: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5508: Options from the sets will be automatically added to
5509: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5510: fail if no option from the set is selected.</p></li>
1.23 wiz 5511: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5512: build options which are enabled by default.</p></li>
1.23 wiz 5513: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5514: of
1.23 wiz 5515: <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 5516: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5517: their option counterparts. Pairs should be added with
1.23 wiz 5518: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5519: warning will be issued if the user uses a legacy
5520: variable.</p></li>
1.23 wiz 5521: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5522: of
1.23 wiz 5523: <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 5524: pairs that map options that have been renamed to their new
1.23 wiz 5525: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5526: the listing of global legacy options. A warning will be issued if
5527: the user uses a legacy option.</p></li>
1.23 wiz 5528: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5529: options implied by deprecated variables used. This can be used for
5530: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5531: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5532: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5533: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5534: a list of warnings about deprecated variables or options used, and
5535: what to use instead.</p></li>
5536: </ol></div>
5537: <p>A package should never modify
5538: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5539: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5540: To suggest a default set of options, use
5541: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5542: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5543: including <code class="filename">bsd.options.mk</code>. If none of
5544: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5545: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5546: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5547: happen with platform-specific options if none of them is supported on
5548: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5549: empty list and the package is otherwise treated as not using the
5550: options framework.</p>
5551: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5552: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5553: build options, properly filtered to remove unsupported and duplicate
5554: options.</p>
5555: <p>The remaining sections contain the logic that is specific to
5556: each option. The correct way to check for an option is to check
5557: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5558: <pre class="programlisting">
5559: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5560: </pre>
5561: </div>
1.41 asau 5562: <div class="sect1">
1.1 dsieger 5563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5564: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 5565: <p>Options that enable similar features in different packages (like
5566: optional support for a library) should use a common name in all
5567: packages that support it (like the name of the library). If another
5568: package already has an option with the same meaning, use the same
5569: name.</p>
5570: <p>Options that enable features specific to one package, where it's
5571: unlikely that another (unrelated) package has the same (or a similar)
5572: optional feature, should use a name prefixed with
5573: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5574: <p>If a group of related packages share an optional feature
5575: specific to that group, prefix it with the name of the
1.23 wiz 5576: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5577: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5578: <p>For new options, add a line to
5579: <code class="filename">mk/defaults/options.description</code>. Lines have two
5580: fields, separated by tab. The first field is the option name, the
5581: second its description. The description should be a whole sentence
5582: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5583: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5584: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5585: </div>
1.41 asau 5586: <div class="sect1">
1.7 rillig 5587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5588: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5589: <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 5590: different dependencies based on the options with which the package was
5591: built. For querying these options, the file
5592: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5593: typical example looks like this:</p>
5594: <pre class="programlisting">
5595: pkgbase := libpurple
5596: .include "../../mk/pkg-build-options.mk"
5597:
5598: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5599: ...
5600: .endif
5601: </pre>
5602: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5603: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5604: options of the libpurple package, which can then be queried like
5605: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5606: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5607: details.</p>
5608: </div>
1.1 dsieger 5609: </div>
1.41 asau 5610: <div class="chapter">
1.1 dsieger 5611: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5612: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 5613: <div class="toc">
5614: <p><b>Table of Contents</b></p>
1.100 leot 5615: <dl class="toc">
1.6 rillig 5616: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
5617: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
5618: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
5619: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 5620: <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 5621: <dd><dl>
5622: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
5623: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
5624: </dl></dd>
1.23 wiz 5625: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5626: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5627: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5628: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5629: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5630: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5631: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5632: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5633: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5634: <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 5635: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
5636: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 5637: </dl>
5638: </div>
1.41 asau 5639: <div class="sect1">
1.1 dsieger 5640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5641: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 5642: <p>This chapter gives a detailed description on how a package is
5643: built. Building a package is separated into different
5644: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5645: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5646: described in the following sections. Each phase is split into
1.1 dsieger 5647: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5648: containing phase, prefixed by one of <code class="varname">pre-</code>,
5649: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5650: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5651: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5652: <p>Never override the regular targets (like
5653: <code class="varname">fetch</code>), if you have to, override the
5654: <code class="varname">do-*</code> ones instead.</p>
5655: <p>The basic steps for building a program are always the same. First
5656: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5657: the local system and then extracted. After any pkgsrc-specific patches
5658: to compile properly are applied, the software can be configured, then
5659: built (usually by compiling), and finally the generated binaries, etc.
5660: can be put into place on the system.</p>
5661: <p>To get more details about what is happening at each step,
5662: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5663: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5664: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5665: </div>
1.41 asau 5666: <div class="sect1">
1.1 dsieger 5667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5668: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 5669: <p>Before outlining the process performed by the NetBSD package system in
5670: the next section, here's a brief discussion on where programs are
5671: installed, and which variables influence this.</p>
5672: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5673: where all files of the final program shall be installed. It is
5674: usually set to <code class="varname">LOCALBASE</code>
5675: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5676: for pkgs in the <code class="filename">cross</code> category. The value of
5677: <code class="varname">PREFIX</code> needs to be put
5678: into the various places in the program's source where paths to
1.108 rillig 5679: 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 5680: <p>When choosing which of these variables to use,
5681: follow the following rules:</p>
1.41 asau 5682: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5683: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5684: where the current pkg will be installed. When referring to a
5685: pkg's own installation path, use
1.23 wiz 5686: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5687: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5688: are installed. If you need to construct a -I or -L argument
5689: to the compiler to find includes and libraries installed by
1.23 wiz 5690: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5691: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5692: installed all packages in <code class="filename">/usr/local</code>. As
5693: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5694: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5695: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5696: distribution (from xsrc, etc.) is installed. When looking for
5697: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5698: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5699: <li class="listitem"><p>X11-based packages using imake must set
5700: <code class="varname">USE_IMAKE</code> to be installed correctly under
5701: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5702: <li class="listitem">
1.99 sevan 5703: <p>To determine the prefix of an
1.1 dsieger 5704: installed package, the <code class="varname">EVAL_PREFIX</code>
5705: definition can be used. It takes pairs in the format
1.79 snj 5706: <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 5707: variable <code class="varname">DIRNAME</code> will be set to the prefix
5708: of the installed package <package>, or
1.99 sevan 5709: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> if the package is not
1.1 dsieger 5710: installed.</p>
5711: <p>This is best illustrated by example.</p>
5712: <p>The following lines are taken from
5713: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
5714: <pre class="programlisting">
5715: EVAL_PREFIX+= GTKDIR=gtk+
5716: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
5717: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
5718: CONFIGURE_ARGS+= --enable-multibyte
5719: </pre>
5720: <p>Specific defaults can be defined for the packages
5721: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
5722: definition of the form:</p>
5723: <pre class="programlisting">
5724: GTKDIR_DEFAULT= ${LOCALBASE}
5725: </pre>
5726: <p>where <code class="varname">GTKDIR</code> corresponds
5727: to the first definition in
5728: the <code class="varname">EVAL_PREFIX</code> pair.</p>
5729: </li>
1.23 wiz 5730: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.79 snj 5731: 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 5732: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5733: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5734: </ul></div>
5735: </div>
1.41 asau 5736: <div class="sect1">
1.1 dsieger 5737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5738: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5739: <p>When building a package, various directories are used to store
1.1 dsieger 5740: source files, temporary files, pkgsrc-internal files, and so on. These
5741: directories are explained here.</p>
5742: <p>Some of the directory variables contain relative pathnames. There
5743: are two common base directories for these relative directories:
5744: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5745: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5746: inside the package itself.</p>
1.41 asau 5747: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5748: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5749: <dd><p>This is an absolute pathname that points to the pkgsrc
5750: root directory. Generally, you don't need
5751: it.</p></dd>
5752: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5753: <dd><p>This is an absolute pathname that points to the
5754: current package.</p></dd>
5755: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5756: <dd><p>This is a pathname relative to
5757: <code class="varname">PKGSRCDIR</code> that points to the current
5758: package.</p></dd>
5759: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5760: <dd><p>This is an absolute pathname pointing to the directory
5761: where all work takes place. The distfiles are extracted to this
5762: directory. It also contains temporary directories and log files used by
5763: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5764: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5765: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5766: <dd><p>This is an absolute pathname pointing to the directory
5767: where the distfiles are extracted. It is usually a direct subdirectory
5768: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5769: that isn't hidden. This variable may be changed by a package
5770: <code class="filename">Makefile</code>.</p></dd>
5771: </dl></div>
1.14 jmcneill 5772: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5773: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5774: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5775: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5776: If users would like to have their pkgsrc trees behave in a
5777: read-only manner, then the value of
5778: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5779: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5780: </div>
1.41 asau 5781: <div class="sect1">
1.1 dsieger 5782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5783: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 5784: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5785: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5786: phase. This will automatically run all phases that are required for this
5787: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5788: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5789: the package will be built, but not installed.</p>
5790: </div>
1.41 asau 5791: <div class="sect1">
1.1 dsieger 5792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5793: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5794: <p>The first step in building a package is to fetch the
5795: distribution files (distfiles) from the sites that are providing
5796: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5797: phase.</p>
1.41 asau 5798: <div class="sect2">
1.1 dsieger 5799: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5800: <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 5801: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5802: defines all URLs from where the distfile, whose name is
5803: derived from the <code class="varname">DISTNAME</code> variable, is
5804: fetched. The more complicated cases are described
5805: below.</p>
5806: <p>The variable <code class="varname">DISTFILES</code> specifies
5807: the list of distfiles that have to be fetched. Its value
1.66 asau 5808: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5809: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5810: so that most packages don't need to define it at all.
5811: <code class="varname">EXTRACT_SUFX</code> is
5812: <code class="literal">.tar.gz</code> by default, but can be changed
5813: freely. Note that if your package requires additional
5814: distfiles to the default one, you cannot just append the
5815: additional filenames using the <code class="literal">+=</code>
5816: operator, but you have write for example:</p>
5817: <pre class="programlisting">
1.66 asau 5818: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5819: </pre>
5820: <p>Each distfile is fetched from a list of sites, usually
5821: <code class="varname">MASTER_SITES</code>. If the package has multiple
5822: <code class="varname">DISTFILES</code> or multiple
5823: <code class="varname">PATCHFILES</code> from different sites, you can
5824: set
5825: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5826: to the list of URLs where the file
5827: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5828: (including the suffix) can be found.</p>
5829: <pre class="programlisting">
5830: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5831: DISTFILES+= foo-file.tar.gz
5832: SITES.foo-file.tar.gz= \
5833: http://www.somewhere.com/somehow/ \
5834: http://www.somewhereelse.com/mirror/somehow/
5835: </pre>
5836: <p>When actually fetching the distfiles, each item from
5837: <code class="varname">MASTER_SITES</code> or
5838: <code class="varname">SITES.*</code> gets the name of each distfile
5839: appended to it, without an intermediate slash. Therefore,
5840: all site values have to end with a slash or other separator
5841: character. This allows for example to set
5842: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5843: that gets the name of the distfile as a parameter. In this
5844: case, the definition would look like:</p>
5845: <pre class="programlisting">
5846: MASTER_SITES= http://www.example.com/download.cgi?file=
5847: </pre>
1.22 jakllsch 5848: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5849: In that case the URL is taken as is, fetched and the result
5850: stored under the name of the distfile. You can use this style
5851: for the case when the download URL style does not match the
5852: above common case. For example, if permanent download URL is a
5853: redirector to the real download URL, or the download file name
5854: is offered by an HTTP Content-Disposition header. In the
5855: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5856: created instead of the default
5857: <code class="filename">v1.0.0.tar.gz</code>.</p>
5858: <pre class="programlisting">
5859: DISTNAME= foo-1.0.0
5860: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5861: </pre>
1.1 dsieger 5862: <p>There are some predefined values for
5863: <code class="varname">MASTER_SITES</code>, which can be used in
5864: packages. The names of the variables should speak for
5865: themselves.</p>
5866: <pre class="programlisting">
5867: ${MASTER_SITE_APACHE}
5868: ${MASTER_SITE_BACKUP}
5869: ${MASTER_SITE_CYGWIN}
5870: ${MASTER_SITE_DEBIAN}
5871: ${MASTER_SITE_FREEBSD}
5872: ${MASTER_SITE_FREEBSD_LOCAL}
5873: ${MASTER_SITE_GENTOO}
5874: ${MASTER_SITE_GNOME}
5875: ${MASTER_SITE_GNU}
5876: ${MASTER_SITE_GNUSTEP}
1.66 asau 5877: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 5878: ${MASTER_SITE_IFARCHIVE}
5879: ${MASTER_SITE_KDE}
5880: ${MASTER_SITE_MOZILLA}
1.66 asau 5881: ${MASTER_SITE_MOZILLA_ALL}
5882: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 5883: ${MASTER_SITE_MYSQL}
1.66 asau 5884: ${MASTER_SITE_NETLIB}
1.1 dsieger 5885: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 5886: ${MASTER_SITE_OSDN}
1.1 dsieger 5887: ${MASTER_SITE_PERL_CPAN}
5888: ${MASTER_SITE_PGSQL}
1.66 asau 5889: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 5890: ${MASTER_SITE_R_CRAN}
5891: ${MASTER_SITE_SOURCEFORGE}
5892: ${MASTER_SITE_SUNSITE}
5893: ${MASTER_SITE_SUSE}
5894: ${MASTER_SITE_TEX_CTAN}
5895: ${MASTER_SITE_XCONTRIB}
5896: ${MASTER_SITE_XEMACS}
1.66 asau 5897: ${MASTER_SITE_XORG}
1.1 dsieger 5898: </pre>
5899: <p>Some explanations for the less self-explaining ones:
5900: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 5901: 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 5902: 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 5903: <p>If you choose one of these predefined sites, you may
5904: want to specify a subdirectory of that site. Since these
5905: macros may expand to more than one actual site, you
5906: <span class="emphasis"><em>must</em></span> use the following construct to
5907: specify a subdirectory:</p>
5908: <pre class="programlisting">
5909: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5910: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5911: </pre>
5912: <p>Note the trailing slash after the subdirectory
5913: name.</p>
5914: </div>
1.41 asau 5915: <div class="sect2">
1.1 dsieger 5916: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5917: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 5918: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5919: all the distfiles exist in a local directory
5920: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
5921: user). If the files do not exist, they are fetched using
5922: commands of the form</p>
5923: <pre class="programlisting">
5924: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5925: </pre>
5926: <p>where <code class="literal">${site}</code> varies through
5927: several possibilities in turn: first,
5928: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
5929: sites specified in either <code class="varname">SITES.file</code> if
5930: defined, else <code class="varname">MASTER_SITES</code> or
5931: <code class="varname">PATCH_SITES</code>, as applies, then finally the
5932: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
5933: all except the first and the last can be optionally sorted
5934: by the user, via setting either
5935: <code class="varname">MASTER_SORT_RANDOM</code>, and
5936: <code class="varname">MASTER_SORT_AWK</code> or
5937: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 5938: <p> The specific command and arguments used depend on the
5939: <code class="varname">FETCH_USING</code> parameter. The example above is
5940: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 5941: <p>The distfiles mirror run by the NetBSD Foundation uses the
5942: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
5943: distfiles, if they are freely distributable. Packages setting
5944: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 5945: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 5946: mirrored.</p>
5947: </div>
5948: </div>
1.41 asau 5949: <div class="sect1">
1.1 dsieger 5950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5951: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 5952: <p>After the distfile(s) are fetched, their checksum is
5953: generated and compared with the checksums stored in the
5954: distinfo file. If the checksums don't match, the build is
5955: aborted. This is to ensure the same distfile is used for
5956: building, and that the distfile wasn't changed, e.g. by some
5957: malign force, deliberately changed distfiles on the master
5958: distribution site or network lossage.</p>
5959: </div>
1.41 asau 5960: <div class="sect1">
1.1 dsieger 5961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5962: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 5963: <p>When the distfiles are present on the local system, they
5964: need to be extracted, as they usually come in the form of some
5965: compressed archive format.</p>
5966: <p>By default, all <code class="varname">DISTFILES</code> are
5967: extracted. If you only need some of them, you can set the
5968: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
5969: files.</p>
5970: <p>Extracting the files is usually done by a little
5971: program, <code class="filename">mk/extract/extract</code>, which
5972: already knows how to extract various archive formats, so most
5973: likely you will not need to change anything here. But if you
5974: need, the following variables may help you:</p>
1.41 asau 5975: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5976: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
5977: <dd><p>Use these variables to override the default
5978: options for an extract command, which are defined in
5979: <code class="filename">mk/extract/extract</code>.</p></dd>
5980: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
5981: <dd><p>This variable can be set to
1.14 jmcneill 5982: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
5983: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 5984: absolute pathname pointing to the command with which tar
1.14 jmcneill 5985: archives should be extracted. It is preferred to choose bsdtar over gtar
5986: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 5987: </dl></div>
5988: <p>If the <code class="filename">extract</code> program doesn't
5989: serve your needs, you can also override the
5990: <code class="varname">EXTRACT_CMD</code> variable, which holds the
5991: command used for extracting the files. This command is
5992: executed in the <code class="filename">${WRKSRC}</code>
5993: directory. During execution of this command, the shell
5994: variable <code class="varname">extract_file</code> holds the absolute
5995: pathname of the file that is going to be extracted.</p>
5996: <p>And if that still does not suffice, you can override the
5997: <code class="varname">do-extract</code> target in the package
5998: Makefile.</p>
5999: </div>
1.41 asau 6000: <div class="sect1">
1.1 dsieger 6001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6002: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6003: <p>After extraction, all the patches named by the
6004: <code class="varname">PATCHFILES</code>, those present in the patches
6005: subdirectory of the package as well as in
6006: $LOCALPATCHES/$PKGPATH (e.g.
6007: <code class="filename">/usr/local/patches/graphics/png</code>) are
6008: applied. Patchfiles ending in <code class="filename">.Z</code> or
6009: <code class="filename">.gz</code> are uncompressed before they are
6010: applied, files ending in <code class="filename">.orig</code> or
6011: <code class="filename">.rej</code> are ignored. Any special options to
1.79 snj 6012: <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 6013: <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 6014: <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 6015: it fail if the patches apply with some lines of fuzz. Please
6016: fix (regen) the patches so that they apply cleanly. The
6017: rationale behind this is that patches that don't apply cleanly
6018: may end up being applied in the wrong place, and cause severe
6019: harm there.</p>
6020: </div>
1.41 asau 6021: <div class="sect1">
1.1 dsieger 6022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6023: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6024: <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 6025: </p>
6026: </div>
1.41 asau 6027: <div class="sect1">
1.1 dsieger 6028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6029: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6030: <p>This phase creates wrapper programs for the compilers and
6031: linkers. The following variables can be used to tweak the
6032: wrappers.</p>
1.41 asau 6033: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6034: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6035: <dd><p>The command used to print progress
6036: messages. Does nothing by default. Set to
6037: <code class="literal">${ECHO}</code> to see the progress
6038: messages.</p></dd>
6039: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6040: <dd><p>This variable can be set to
6041: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6042: depending on whether you want additional information in the
6043: wrapper log file.</p></dd>
6044: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6045: <dd><p>This variable can be set to
6046: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6047: on whether the wrapper should use its cache, which will
6048: improve the speed. The default value is
6049: <code class="literal">yes</code>, but is forced to
6050: <code class="literal">no</code> if the platform does not support
6051: it.</p></dd>
6052: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6053: <dd><p>A list of reordering commands. A reordering
6054: command has the form
6055: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6056: It ensures that that
6057: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6058: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6059: </p></dd>
6060: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6061: <dd><p>A list of transformation commands. [TODO:
6062: investigate further]</p></dd>
6063: </dl></div>
6064: </div>
1.41 asau 6065: <div class="sect1">
1.1 dsieger 6066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6067: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6068: <p>Most pieces of software need information on the header
6069: files, system calls, and library routines which are available
6070: on the platform they run on. The process of determining this
6071: information is known as configuration, and is usually
6072: automated. In most cases, a script is supplied with the
6073: distfiles, and its invocation results in generation of header
6074: files, Makefiles, etc.</p>
6075: <p>If the package contains a configure script, this can be
6076: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6077: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6078: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6079: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6080: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6081: <pre class="programlisting">
6082: .for d in ${CONFIGURE_DIRS}
6083: cd ${WRKSRC} \
6084: && cd ${d} \
6085: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6086: .endfor
6087: </pre>
6088: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6089: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6090: <code class="varname">WRKSRC</code>. In each of these directories, the
6091: configure script is run with the environment
6092: <code class="varname">CONFIGURE_ENV</code> and arguments
6093: <code class="varname">CONFIGURE_ARGS</code>. The variables
6094: <code class="varname">CONFIGURE_ENV</code>,
6095: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6096: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6097: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6098: package.</p>
1.37 wiz 6099: <p>If the program uses the Perl way of configuration (mainly Perl
6100: modules, but not only), i.e. a file called
6101: <code class="filename">Makefile.PL</code>, it should include
6102: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6103: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6104: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6105: <p>If the program uses an <code class="filename">Imakefile</code>
6106: for configuration, the appropriate steps can be invoked by
6107: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6108: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6109: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6110: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6111: <p>If the program uses <code class="filename">cmake</code>
6112: for configuration, the appropriate steps can be invoked by
1.23 wiz 6113: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6114: You can add variables to cmake's environment by adding them to the
6115: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6116: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6117: The top directory argument is given by the
6118: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6119: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6120: <p>If there is no configure step at all, set
1.23 wiz 6121: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6122: </div>
1.41 asau 6123: <div class="sect1">
1.1 dsieger 6124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6125: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6126: <p>For building a package, a rough equivalent of the
6127: following code is executed.</p>
6128: <pre class="programlisting">
6129: .for d in ${BUILD_DIRS}
6130: cd ${WRKSRC} \
6131: && cd ${d} \
6132: && env ${MAKE_ENV} \
6133: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6134: -f ${MAKE_FILE} \
6135: ${BUILD_TARGET}
6136: .endfor
6137: </pre>
6138: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6139: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6140: <code class="varname">WRKSRC</code>. In each of these directories,
6141: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6142: <code class="varname">MAKE_ENV</code> and arguments
6143: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6144: <code class="varname">MAKE_ENV</code>,
6145: <code class="varname">BUILD_MAKE_FLAGS</code>,
6146: <code class="varname">MAKE_FILE</code> and
6147: <code class="varname">BUILD_TARGET</code> may all be changed by the
6148: package.</p>
6149: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6150: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6151: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6152: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6153: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6154: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6155: <p>If there is no build step at all, set
1.23 wiz 6156: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6157: </div>
1.41 asau 6158: <div class="sect1">
1.1 dsieger 6159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6160: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6161: <p>[TODO]</p>
6162: </div>
1.41 asau 6163: <div class="sect1">
1.1 dsieger 6164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6165: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6166: <p>Once the build stage has completed, the final step is to
6167: install the software in public directories, so users can
6168: access the programs and files.</p>
6169: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6170: equivalent of the following code is executed. Additionally,
6171: before and after this code, much magic is performed to do
6172: consistency checks, registering the package, and so on.</p>
6173: <pre class="programlisting">
6174: .for d in ${INSTALL_DIRS}
6175: cd ${WRKSRC} \
6176: && cd ${d} \
6177: && env ${MAKE_ENV} \
6178: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6179: -f ${MAKE_FILE} \
6180: ${INSTALL_TARGET}
6181: .endfor
6182: </pre>
6183: <p>The variable's meanings are analogous to the ones in the
6184: <span class="emphasis"><em>build</em></span> phase.
6185: <code class="varname">INSTALL_DIRS</code> defaults to
6186: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6187: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6188: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6189: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6190: defined.</p>
6191: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6192: variables are useful. They are all variations of the
1.79 snj 6193: <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 6194: permissions preset. <code class="varname">INSTALL</code> is the plain
6195: install command. The specialized variants, together with their
6196: intended use, are:</p>
1.41 asau 6197: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6198: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6199: <dd><p>directories that contain
6200: binaries</p></dd>
6201: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6202: <dd><p>directories that contain
6203: scripts</p></dd>
6204: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6205: <dd><p>directories that contain shared and static
6206: libraries</p></dd>
6207: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6208: <dd><p>directories that contain data
6209: files</p></dd>
6210: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6211: <dd><p>directories that contain man
6212: pages</p></dd>
1.100 leot 6213: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6214: <dd><p>directories that contain data files for games
6215: </p></dd>
1.1 dsieger 6216: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6217: <dd><p>binaries that can be stripped from debugging
6218: symbols</p></dd>
6219: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6220: <dd><p>binaries that cannot be
6221: stripped</p></dd>
6222: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6223: <dd><p>game
6224: binaries</p></dd>
6225: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6226: <dd><p>shared and static
6227: libraries</p></dd>
6228: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6229: <dd><p>data files</p></dd>
6230: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6231: <dd><p>data files for
6232: games</p></dd>
6233: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6234: <dd><p>man pages</p></dd>
6235: </dl></div>
6236: <p>Some other variables are:</p>
1.41 asau 6237: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6238: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
6239: <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>
6240: when installing binaries. Any debugging sections and symbols present in
6241: binaries will be preserved.
6242: </p></dd>
1.1 dsieger 6243: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6244: <dd><p>A list of directories relative to
6245: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6246: beginning of the <span class="emphasis"><em>install</em></span> phase.
6247: The package is supposed to create all needed directories itself
6248: before installing files to it and list all other directories here.
6249: </p></dd>
6250: </dl></div>
6251: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6252: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6253: mostly relevant for packages in the <code class="filename">regress</code>
6254: category.</p>
6255: </div>
1.41 asau 6256: <div class="sect1">
1.1 dsieger 6257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6258: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6259: <p>Once the install stage has completed, a binary package of
6260: the installed files can be built. These binary packages can be
6261: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6262: the <span class="command"><strong>make bin-install</strong></span> or by using
6263: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6264: <p>By default, the binary packages are created in
6265: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6266: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6267: one for each category in the <code class="varname">CATEGORIES</code>
6268: variable. <code class="varname">PACKAGES</code> defaults to
6269: <code class="filename">pkgsrc/packages</code>.</p>
6270: </div>
1.41 asau 6271: <div class="sect1">
1.1 dsieger 6272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6273: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6274: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6275: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6276: to clean the work directories of all dependencies too, use
1.10 hubertf 6277: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6278: </div>
1.41 asau 6279: <div class="sect1">
1.1 dsieger 6280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6281: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6282: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6283: <dt><span class="term">pre/post-*</span></dt>
6284: <dd><p>For any of the main targets described in the
6285: previous section, two auxiliary targets exist with
1.23 wiz 6286: <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 6287: prefix for the main target's name. These targets are
6288: invoked before and after the main target is called,
6289: allowing extra configuration or installation steps be
6290: performed from a package's Makefile, for example, which
6291: a program's configure script or install target
6292: omitted.</p></dd>
6293: <dt><span class="term">do-*</span></dt>
6294: <dd><p>Should one of the main targets do the wrong thing,
6295: and should there be no variable to fix this, you can
6296: redefine it with the do-* target. (Note that redefining
6297: the target itself instead of the do-* target is a bad
6298: idea, as the pre-* and post-* targets won't be called
6299: anymore, etc.) You will not usually need to do
6300: this.</p></dd>
6301: <dt><span class="term">reinstall</span></dt>
6302: <dd>
1.10 hubertf 6303: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6304: you noticed some file was not installed properly, you
6305: can repeat the installation with this target, which will
1.23 wiz 6306: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6307: <p>This is the default value of
6308: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6309: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6310: package</strong></span>, where the defaults are
1.23 wiz 6311: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6312: respectively.</p>
6313: </dd>
6314: <dt><span class="term">deinstall</span></dt>
6315: <dd>
1.79 snj 6316: <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 6317: current directory, effectively de-installing the
6318: package. The following variables can be used to tune the
6319: behaviour:</p>
1.41 asau 6320: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6321: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.79 snj 6322: <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 6323: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6324: <dd><p>Remove all packages that require (depend on)
6325: the given package. This can be used to remove any
6326: packages that may have been pulled in by a given
1.10 hubertf 6327: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6328: DEINSTALLDEPENDS=1</strong></span> is done in
6329: <code class="filename">pkgsrc/x11/kde</code>, this is
6330: likely to remove whole KDE. Works by adding
1.79 snj 6331: <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 6332: command line.</p></dd>
6333: </dl></div>
6334: </dd>
6335: <dt><span class="term">bin-install</span></dt>
6336: <dd><p>Install a binary package from local disk and via FTP
6337: from a list of sites (see the
6338: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6339: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6340: available anywhere. The arguments given to
1.10 hubertf 6341: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6342: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6343: operation, etc.</p></dd>
1.95 wiz 6344: <dt><span class="term">install-clean</span></dt>
6345: <dd><p>This target removes the state files for the "install" and later
6346: phases so that the "install" target may be re-invoked. This can be
6347: used after editing the PLIST to install the package without
6348: rebuilding it.</p></dd>
6349: <dt><span class="term">build-clean</span></dt>
6350: <dd><p>This target removes the state files for the "build" and later
6351: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6352: <dt><span class="term">update</span></dt>
6353: <dd>
6354: <p>This target causes the current package to be
6355: updated to the latest version. The package and all
6356: depending packages first get de-installed, then current
6357: versions of the corresponding packages get compiled and
6358: installed. This is similar to manually noting which
6359: packages are currently installed, then performing a
1.10 hubertf 6360: series of <span class="command"><strong>make deinstall</strong></span> and
6361: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6362: <code class="varname">UPDATE_TARGET</code> is set to) for these
6363: packages.</p>
1.23 wiz 6364: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6365: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6366: update</strong></span> was interrupted for some reason.
6367: However, in this case, make sure you don't call
1.10 hubertf 6368: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6369: list of dependent packages in <code class="varname">WRKDIR</code>.
6370: Otherwise, you lose the ability to automatically update
6371: the current package along with the dependent packages
6372: you have installed.</p>
1.10 hubertf 6373: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6374: update</strong></span> will only work as long as the package
6375: tree remains unchanged. If the source code for one of
6376: the packages to be updated has been changed, resuming
1.10 hubertf 6377: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6378: fail!</p>
6379: <p>The following variables can be used either on the
1.10 hubertf 6380: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6381: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6382: update</strong></span>:</p>
1.41 asau 6383: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6384: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6385: <dd><p>Install target to recursively use for the
6386: updated package and the dependent packages.
6387: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6388: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6389: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6390: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6391: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6392: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6393: endless loop!</p></dd>
6394: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6395: <dd><p>Don't clean up after updating. Useful if
6396: you want to leave the work sources of the updated
6397: packages around for inspection or other purposes.
6398: Be sure you eventually clean up the source tree
1.23 wiz 6399: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6400: or you may run into troubles with old source code
6401: still lying around on your next
1.10 hubertf 6402: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6403: update</strong></span>.</p></dd>
6404: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6405: <dd><p>Deinstall each package before installing
6406: (making <code class="varname">DEPENDS_TARGET</code>). This
6407: may be necessary if the
1.23 wiz 6408: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6409: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6410: update</strong></span>.</p></dd>
6411: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6412: <dd><p>Allows you to disable recursion and hardcode
6413: the target for packages. The default is
1.23 wiz 6414: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6415: facilitating a recursive update of prerequisite
6416: packages. Only set
6417: <code class="varname">DEPENDS_TARGET</code> if you want to
6418: disable recursive updates. Use
6419: <code class="varname">UPDATE_TARGET</code> instead to just
6420: set a specific target for each package to be
1.10 hubertf 6421: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6422: (see above).</p></dd>
6423: </dl></div>
6424: </dd>
6425: <dt><span class="term">clean-update</span></dt>
6426: <dd>
6427: <p>Clean the source tree for all packages that would
1.10 hubertf 6428: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6429: from the current directory. This target should not be
6430: used if the current package (or any of its depending
6431: packages) have already been de-installed (e.g., after
1.10 hubertf 6432: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6433: some packages you intended to update. As a rule of
6434: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6435: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6436: and only if you have a dirty package tree (e.g., if you
6437: used <code class="varname">NOCLEAN</code>).</p>
6438: <p>If you are unsure about whether your tree is
1.10 hubertf 6439: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6440: clean</strong></span> at the top of the tree, or use the
6441: following sequence of commands from the directory of the
6442: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6443: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6444: time, otherwise you lose all the packages you wanted to
6445: update!):</p>
6446: <pre class="screen">
6447: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6448: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6449: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6450: </pre>
6451: <p>The following variables can be used either on the
1.10 hubertf 6452: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6453: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6454: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6455: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6456: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6457: reconstruct the list of directories to update for
1.10 hubertf 6458: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6459: update</strong></span> successfully installed all
6460: packages you wanted to update. Normally, this is
1.10 hubertf 6461: done automatically on <span class="command"><strong>make
1.1 dsieger 6462: update</strong></span>, but may have been suppressed by
6463: the <code class="varname">NOCLEAN</code> variable (see
6464: above).</p></dd>
6465: </dl></div>
6466: </dd>
6467: <dt><span class="term">replace</span></dt>
6468: <dd>
6469: <p>Update the installation of the current package. This
6470: differs from update in that it does not replace dependent
1.79 snj 6471: 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 6472: target to work.</p>
6473: <p><span class="emphasis"><em>Be careful when using this
6474: target!</em></span> There are no guarantees that dependent
6475: packages will still work, in particular they will most
1.10 hubertf 6476: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6477: library package whose shared library major version changed
6478: between your installed version and the new one. For this
6479: reason, this target is not officially supported and only
6480: recommended for advanced users.</p>
6481: </dd>
6482: <dt><span class="term">info</span></dt>
1.79 snj 6483: <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 6484: package. You can use this to check which version of a
6485: package is installed.</p></dd>
6486: <dt><span class="term">index</span></dt>
6487: <dd>
6488: <p>This is a top-level command, i.e. it should be used in
6489: the <code class="filename">pkgsrc</code> directory. It creates a
6490: database of all packages in the local pkgsrc tree, including
6491: dependencies, comment, maintainer, and some other useful
6492: information. Individual entries are created by running
1.10 hubertf 6493: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6494: directories. This index file is saved as
6495: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6496: verbose format by running <span class="command"><strong>make
1.1 dsieger 6497: print-index</strong></span>. You can search in it with
1.10 hubertf 6498: <span class="command"><strong>make search
1.1 dsieger 6499: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6500: extract a list of all packages that depend on a particular
1.10 hubertf 6501: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6502: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6503: <p>Running this command takes a very long time, some
6504: hours even on fast machines!</p>
6505: </dd>
6506: <dt><span class="term">readme</span></dt>
6507: <dd>
6508: <p>This target generates a
6509: <code class="filename">README.html</code> file, which can be
1.79 snj 6510: 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 6511: contain references to any packages which are in the
6512: <code class="varname">PACKAGES</code> directory on the local
6513: host. The generated files can be made to refer to URLs
6514: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6515: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6516: wanted to generate <code class="filename">README.html</code>
6517: files which pointed to binary packages on the local
6518: machine, in the directory
6519: <code class="filename">/usr/packages</code>, set
6520: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6521: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6522: <code class="varname">${PACKAGES}</code> directory and its
6523: subdirectories will be searched for all the binary
6524: packages.</p>
6525: <p>The target can be run at the toplevel or in category
6526: directories, in which case it descends recursively.</p>
6527: </dd>
6528: <dt><span class="term">readme-all</span></dt>
6529: <dd><p>This is a top-level command, run it in
6530: <code class="filename">pkgsrc</code>. Use this target to create a
6531: file <code class="filename">README-all.html</code> which contains a
6532: list of all packages currently available in the NetBSD
6533: Packages Collection, together with the category they belong
6534: to and a short description. This file is compiled from the
6535: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6536: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6537: readme</strong></span>.</p></dd>
6538: <dt><span class="term">cdrom-readme</span></dt>
6539: <dd><p>This is very much the same as the
1.23 wiz 6540: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6541: used when generating a pkgsrc tree to be written to a
6542: CD-ROM. This target also produces
6543: <code class="filename">README.html</code> files, and can be made
6544: to refer to URLs based on
6545: <code class="varname">CDROM_PKG_URL_HOST</code> and
6546: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6547: <dt><span class="term">show-distfiles</span></dt>
6548: <dd><p>This target shows which distfiles and patchfiles
6549: are needed to build the package
6550: (<code class="varname">ALLFILES</code>, which contains all
6551: <code class="varname">DISTFILES</code> and
6552: <code class="varname">PATCHFILES</code>, but not
6553: <code class="filename">patches/*</code>).</p></dd>
6554: <dt><span class="term">show-downlevel</span></dt>
6555: <dd><p>This target shows nothing if the package is not
6556: installed. If a version of this package is installed,
6557: but is not the version provided in this version of
6558: pkgsrc, then a warning message is displayed. This target
6559: can be used to show which of your installed packages are
6560: downlevel, and so the old versions can be deleted, and
6561: the current ones added.</p></dd>
6562: <dt><span class="term">show-pkgsrc-dir</span></dt>
6563: <dd><p>This target shows the directory in the pkgsrc
6564: hierarchy from which the package can be built and
6565: installed. This may not be the same directory as the one
6566: from which the package was installed. This target is
6567: intended to be used by people who may wish to upgrade
6568: many packages on a single host, and can be invoked from
6569: the top-level pkgsrc Makefile by using the
1.23 wiz 6570: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6571: <dt><span class="term">show-installed-depends</span></dt>
6572: <dd><p>This target shows which installed packages match
6573: the current package's <code class="varname">DEPENDS</code>. Useful
6574: if out of date dependencies are causing build
6575: problems.</p></dd>
1.95 wiz 6576: <dt><span class="term">print-build-depends-list</span></dt>
6577: <dd><p>This target shows the list of packages that the current package
6578: depends on for building.</p></dd>
6579: <dt><span class="term">print-run-depends-list</span></dt>
6580: <dd><p>This target shows the list of packages that the current package
6581: depends on for running.</p></dd>
1.1 dsieger 6582: <dt><span class="term">check-shlibs</span></dt>
6583: <dd><p>After a package is installed, check all its
6584: binaries and (on ELF platforms) shared libraries to see
6585: if they find the shared libs they need. Run by default
1.10 hubertf 6586: 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 6587: <dt><span class="term">print-PLIST</span></dt>
6588: <dd>
1.23 wiz 6589: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6590: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6591: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6592: -newer work/.extract_done</strong></span>. An attempt is made
6593: to care for shared libs etc., but it is
6594: <span class="emphasis"><em>strongly</em></span> recommended to review the
6595: result before putting it into
6596: <code class="filename">PLIST</code>. On upgrades, it's useful to
6597: diff the output of this command against an already
6598: existing <code class="filename">PLIST</code> file.</p>
1.79 snj 6599: <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 6600: other methods that don't update file access times, be
6601: sure to add these files manually to your
1.23 wiz 6602: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6603: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6604: them!</p>
1.23 wiz 6605: <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 6606: information on this target.</p>
6607: </dd>
6608: <dt><span class="term">bulk-package</span></dt>
6609: <dd>
6610: <p>Used to do bulk builds. If an appropriate binary
6611: package already exists, no action is taken. If not, this
6612: target will compile, install and package it (and its
6613: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 6614: 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
6615: builds)</i></a>).
1.1 dsieger 6616: After creating the binary package, the sources, the
6617: just-installed package and its required packages are
6618: removed, preserving free disk space.</p>
6619: <p><span class="emphasis"><em>Beware that this target may deinstall
6620: all packages installed on a system!</em></span></p>
6621: </dd>
6622: <dt><span class="term">bulk-install</span></dt>
6623: <dd>
6624: <p>Used during bulk-installs to install required
6625: packages. If an up-to-date binary package is available,
1.79 snj 6626: 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 6627: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6628: but the installed binary won't be removed.</p>
6629: <p>A binary package is considered
1.23 wiz 6630: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.79 snj 6631: <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 6632: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6633: <li class="listitem"><p>None of the package's files
1.1 dsieger 6634: (<code class="filename">Makefile</code>, ...) were modified
6635: since it was built.</p></li>
1.23 wiz 6636: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6637: packages were modified since it was built.</p></li>
6638: </ul></div>
6639: <p><span class="emphasis"><em>Beware that this target may deinstall
6640: all packages installed on a system!</em></span></p>
6641: </dd>
6642: </dl></div>
6643: </div>
6644: </div>
1.41 asau 6645: <div class="chapter">
1.1 dsieger 6646: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6647: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6648: <div class="toc">
6649: <p><b>Table of Contents</b></p>
1.100 leot 6650: <dl class="toc">
1.6 rillig 6651: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
6652: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
6653: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6654: </dl>
6655: </div>
6656: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6657: by pkgsrc and also for individual packages to define what commands
6658: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
6659: or for later run-time of an installed packaged (such as
6660: <code class="varname">DEPENDS</code>).
6661: If the native system provides an adequate tool, then in many cases, a pkgsrc
6662: package will not be used.</p>
6663: <p>When building a package, the replacement tools are
6664: made available in a directory (as symlinks or wrapper scripts)
6665: that is early in the executable search path. Just like the buildlink
6666: system, this helps with consistent builds.</p>
6667: <p>A tool may be needed to help build a specific package. For example,
6668: perl, GNU make (gmake) or yacc may be needed.</p>
6669: <p>Also a tool may be needed, for example, because the native system's supplied
6670: tool may be inefficient for building a package with pkgsrc.
6671: For example, a package may need GNU awk, bison (instead of
6672: yacc) or a better sed.</p>
6673: <p>The tools used by a package can be listed by running
1.10 hubertf 6674: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6675: <div class="sect1">
1.1 dsieger 6676: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6677: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6678: <p>The default set of tools used by pkgsrc is defined in
6679: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6680: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6681: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6682: These can be seen by running:
1.10 hubertf 6683: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6684: <p>If a package needs a specific program to build
6685: then the <code class="varname">USE_TOOLS</code> variable can be used
6686: to define the tools needed.</p>
6687: </div>
1.41 asau 6688: <div class="sect1">
1.1 dsieger 6689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6690: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6691: <p>In the following examples, the :run means that it is needed at
6692: run-time (and becomes a DEPENDS).
1.1 dsieger 6693: The default is a build dependency which can be set with
6694: :build. (So in this example, it is the same as gmake:build
6695: and pkg-config:build.)</p>
6696: <pre class="programlisting">
6697: USE_TOOLS+= gmake perl:run pkg-config
6698: </pre>
6699: <p>When using the tools framework, a
6700: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6701: which contains the full path to the appropriate tool. For example,
1.23 wiz 6702: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6703: on Linux systems.</p>
6704: <p>If you always need a pkgsrc version of the
6705: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6706: </p>
6707: </div>
1.41 asau 6708: <div class="sect1">
1.1 dsieger 6709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6710: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6711: <p>When improving or porting pkgsrc to a new platform, have a look
6712: at (or create) the corresponding platform specific make file fragment under
6713: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6714: the name of the common tools. For example:</p>
6715: <pre class="programlisting">
6716: .if exists(/usr/bin/bzcat)
6717: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6718: .elif exists(/usr/bin/bzip2)
6719: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6720: .endif
6721:
6722: TOOLS_PLATFORM.true?= true # shell builtin
6723: </pre>
6724: </div>
6725: </div>
1.41 asau 6726: <div class="chapter">
1.1 dsieger 6727: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6728: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 6729: <div class="toc">
6730: <p><b>Table of Contents</b></p>
1.100 leot 6731: <dl class="toc">
1.6 rillig 6732: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 6733: <dd><dl>
1.108 rillig 6734: <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>
6735: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
6736: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
6737: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
6738: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
6739: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
6740: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
6741: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
6742: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
6743: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6744: <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 6745: </dl></dd>
1.108 rillig 6746: <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 6747: <dd><dl>
6748: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6749: <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 6750: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 6751: </dl></dd>
1.108 rillig 6752: <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 6753: <dd><dl>
6754: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
6755: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6756: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
6757: </dl></dd>
6758: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
6759: <dd><dl>
6760: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
6761: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
6762: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 6763: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
6764: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 6765: </dl></dd>
1.108 rillig 6766: <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 6767: <dd><dl>
6768: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
6769: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 6770: <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 6771: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
6772: </dl></dd>
1.108 rillig 6773: <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 6774: <dd><dl>
6775: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
6776: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
6777: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
6778: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
6779: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6780: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
6781: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
6782: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 6783: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 6784: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 6785: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
6786: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
6787: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
6788: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
6789: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
6790: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
6791: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
6792: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 6793: emulation</a></span></dt>
1.6 rillig 6794: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
6795: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6796: </dl></dd>
1.6 rillig 6797: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6798: </dl>
6799: </div>
1.41 asau 6800: <div class="sect1">
1.1 dsieger 6801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6802: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 6803: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6804: different platforms. As a result, it is important to ensure,
6805: where possible, that packages in pkgsrc are portable. This
6806: chapter mentions some particular details you should pay
6807: attention to while working on pkgsrc.</p>
1.41 asau 6808: <div class="sect2">
1.1 dsieger 6809: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6810: <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 6811: </h3></div></div></div>
6812: <p>The pkgsrc user can configure pkgsrc by overriding several
6813: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6814: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6815: want to use those variables in the preprocessor directives of
1.79 snj 6816: <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 6817: <code class="literal">.for</code>), you need to include the file
6818: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6819: loads the user preferences.</p>
6820: <p>But note that some variables may not be completely defined
6821: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6822: included, as they may contain references to variables that are
1.108 rillig 6823: not yet defined. In shell commands (the lines in
6824: <code class="filename">Makefile</code> that are indented with a tab) this
6825: is no problem, since variables are only expanded when they are
6826: used. But in the preprocessor directives mentioned above and in
6827: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6828: dependencies</code>) the variables are expanded at load
6829: time.</p>
1.41 asau 6830: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6831: <h3 class="title">Note</h3>
1.108 rillig 6832: <p>To check whether a variable can be used at load time,
6833: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6834: </div>
6835: </div>
1.41 asau 6836: <div class="sect2">
1.1 dsieger 6837: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6838: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6839: <p>Occasionally, packages require interaction from the user,
6840: and this can be in a number of ways:</p>
1.41 asau 6841: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6842: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 6843: interaction such as entering username/password or accepting a
6844: license on a web page.</p></li>
1.23 wiz 6845: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 6846: passwords.</p></li>
1.23 wiz 6847: <li class="listitem"><p>help to configure the package before it is built</p></li>
6848: <li class="listitem"><p>help during the build process</p></li>
6849: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 6850: </ul></div>
1.108 rillig 6851: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6852: variable to define which stages need interaction. This should be
6853: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 6854: <pre class="programlisting">
6855: INTERACTIVE_STAGE= configure install
1.111 sevan 6856: </pre>
1.1 dsieger 6857: <p>The user can then decide to skip this package by setting the
1.108 rillig 6858: <code class="varname">BATCH</code> variable. Packages that require interaction
6859: are also excluded from bulk builds.</p>
1.1 dsieger 6860: </div>
1.41 asau 6861: <div class="sect2">
1.1 dsieger 6862: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6863: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 6864: <p>Authors of software can choose the licence under which software
6865: can be copied. The Free Software Foundation has declared some
6866: licenses "Free", and the Open Source Initiative has a definition of
6867: "Open Source".</p>
6868: <p>By default, pkgsrc allows packages with Free or Open Source
6869: licenses to be built. To allow packages with other licenses to be
6870: built as well, the pkgsrc user needs to add these licenses to the
6871: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6872: that this variable only affects which packages may be
6873: <span class="emphasis"><em>built</em></span>, while the license terms often also
6874: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 6875: <p>One might want to only install packages with a BSD license,
1.108 rillig 6876: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 6877: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 6878: user can override the default by setting the
6879: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 6880: of "+=". The licenses accepted by default are defined in the
6881: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6882: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 6883: <p>The license tag mechanism is intended to address
6884: copyright-related issues surrounding building, installing and
6885: using a package, and not to address redistribution issues (see
6886: <code class="varname">RESTRICTED</code> and
1.111 sevan 6887: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 6888: Packages with redistribution restrictions should set these
6889: tags.</p>
1.1 dsieger 6890: <p>Denoting that a package may be copied according to a
6891: particular license is done by placing the license in
6892: <code class="filename">pkgsrc/licenses</code> and setting the
6893: <code class="varname">LICENSE</code> variable to a string identifying the
1.79 snj 6894: 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 6895: <pre class="programlisting">
6896: LICENSE= xv-license
1.111 sevan 6897: </pre>
1.1 dsieger 6898: <p>When trying to build, the user will get a notice that the
6899: package is covered by a license which has not been placed in the
6900: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
6901: <pre class="programlisting">
6902: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6903: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6904: ===> To view the license, enter "/usr/bin/make show-license".
6905: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6906: ===> ACCEPTABLE_LICENSES+=xv-license
6907: *** Error code 1
1.111 sevan 6908: </pre>
1.10 hubertf 6909: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 6910: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 6911: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 6912: convey to pkgsrc that it should not in the future fail because of
6913: that license:</p>
6914: <pre class="programlisting">
6915: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 6916: </pre>
6917: <p>The use of <code class="varname">LICENSE=shareware</code>,
6918: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
6919: is deprecated because it does not crisply refer to a particular
6920: license text. Another problem with such usage is that it does not
6921: enable a user to tell pkgsrc to proceed for a single package
6922: without also telling pkgsrc to proceed for all packages with that
6923: tag.</p>
6924: <div class="sect3">
6925: <div class="titlepage"><div><div><h4 class="title">
6926: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 6927: <p>When adding a package with a new license, the following steps
6928: are required:</p>
6929: <div class="orderedlist"><ol class="orderedlist" type="1">
6930: <li class="listitem">
1.111 sevan 6931: <p>Check whether the license qualifies as Free or Open
6932: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
6933: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
6934: Open Source Initiative</a>. If this is the case, the filename in
6935: <code class="filename">pkgsrc/licenses/</code> does not need the
6936: <code class="filename">-license</code> suffix, and the license name should be
6937: added to:</p>
1.48 rodent 6938: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6939: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
6940: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
6941: </ul></div>
6942: </li>
6943: <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>
6944: </ol></div>
1.111 sevan 6945: </div>
6946: <div class="sect3">
6947: <div class="titlepage"><div><div><h4 class="title">
6948: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 6949: <p>When the license changes (in a way other than formatting),
1.111 sevan 6950: make sure that the new license has a different name (e.g.,
1.1 dsieger 6951: append the version number if it exists, or the date). Just
6952: because a user told pkgsrc to build programs under a previous
6953: version of a license does not mean that pkgsrc should build
6954: programs under the new licenses. The higher-level point is that
6955: pkgsrc does not evaluate licenses for reasonableness; the only
6956: test is a mechanistic test of whether a particular text has been
1.111 sevan 6957: approved by either of two bodies (FSF or OSI).</p>
6958: </div>
1.1 dsieger 6959: </div>
1.41 asau 6960: <div class="sect2">
1.1 dsieger 6961: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6962: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 6963: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 6964: By declaring the restrictions, package tools can
1.1 dsieger 6965: automatically refrain from e.g. placing binary packages on FTP
6966: sites.</p>
1.111 sevan 6967: <p>There are four possible restrictions, which are
1.1 dsieger 6968: the cross product of sources (distfiles) and binaries not being
6969: placed on FTP sites and CD-ROMs. Because this is rarely the exact
6970: language in any license, and because non-Free licenses tend to be
6971: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 6972: CD-ROM.
6973:
6974: "FTP" means making the source or binary file available over the
6975: Internet at no charge.
6976:
6977: "CD-ROM" means making the source or binary available on some kind of
6978: media, together with other source and binary packages, which is sold
6979: for a distribution charge.
1.1 dsieger 6980: </p>
6981: <p>In order to encode these restrictions, the package system
6982: defines five make variables that can be set to note these
6983: restrictions:</p>
1.41 asau 6984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6985: <li class="listitem">
1.1 dsieger 6986: <p><code class="varname">RESTRICTED</code></p>
6987: <p>This variable should be set whenever a restriction
6988: exists (regardless of its kind). Set this variable to a
6989: string containing the reason for the restriction. It should
6990: be understood that those wanting to understand the restriction
6991: will have to read the license, and perhaps seek advice of
6992: counsel.</p>
6993: </li>
1.23 wiz 6994: <li class="listitem">
1.1 dsieger 6995: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
6996: <p>Binaries may not be placed on CD-ROM containing other
6997: binary packages, for which a distribution charge may be made.
6998: In this case, set this variable to
6999: <code class="varname">${RESTRICTED}</code>.</p>
7000: </li>
1.23 wiz 7001: <li class="listitem">
1.1 dsieger 7002: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7003: <p>Binaries may not made available on the Internet without
7004: charge. In this case, set this variable to
7005: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7006: binary packages will not be included on ftp.NetBSD.org.</p>
7007: </li>
1.23 wiz 7008: <li class="listitem">
1.1 dsieger 7009: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7010: <p>Distfiles may not be placed on CD-ROM, together with
7011: other distfiles, for which a fee may be charged. In this
7012: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7013: </p>
7014: </li>
1.23 wiz 7015: <li class="listitem">
1.1 dsieger 7016: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7017: <p>Distfiles may not made available via FTP at no charge.
7018: In this case, set this variable to
7019: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7020: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7021: </li>
7022: </ul></div>
1.111 sevan 7023: <p>Please note that packages will be removed from pkgsrc when the
7024: distfiles are not distributable and cannot be obtained for a period
7025: of one full quarter branch. Packages with manual/interactive fetch
7026: must have a maintainer and it is his/her responsibility to ensure
7027: this.</p>
1.1 dsieger 7028: </div>
1.41 asau 7029: <div class="sect2">
1.1 dsieger 7030: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7031: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7032: <p>Your package may depend on some other package being present
7033: - and there are various ways of expressing this dependency.
7034: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7035: <code class="varname">DEPENDS</code> definitions, the
7036: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7037: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7038: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7039: 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 7040: <p>The basic difference between the two variables is as
7041: follows: The <code class="varname">DEPENDS</code> definition registers
7042: that pre-requisite in the binary package so it will be pulled in
7043: when the binary package is later installed, whilst the
7044: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7045: dependency that is only needed for building the package.</p>
7046: <p>This means that if you only need a package present whilst
7047: you are building, it should be noted as a
7048: <code class="varname">BUILD_DEPENDS</code>.</p>
7049: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7050: <code class="varname">DEPENDS</code> definition is:</p>
7051: <pre class="programlisting">
7052: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7053: </pre>
1.23 wiz 7054: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7055: may include any of the wildcard version numbers recognized by
1.79 snj 7056: <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 7057: <div class="orderedlist"><ol class="orderedlist" type="1">
7058: <li class="listitem">
1.1 dsieger 7059: <p>If your package needs another package's binaries or
1.54 wiz 7060: libraries to build and run, and if that package has a
1.1 dsieger 7061: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7062: <pre class="programlisting">
7063: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7064: </pre>
1.1 dsieger 7065: </li>
1.23 wiz 7066: <li class="listitem">
1.54 wiz 7067: <p>If your package needs another package's binaries or
7068: libraries only for building, and if that package has a
7069: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7070: <pre class="programlisting">
7071: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7072: </pre>
1.54 wiz 7073: <p>but set
7074: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7075: to make it a build dependency only. This case is rather
7076: rare.</p>
7077: </li>
7078: <li class="listitem">
1.25 spz 7079: <p>If your package needs binaries from another package to build,
7080: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7081: <pre class="programlisting">
1.25 spz 7082: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.111 sevan 7083: </pre>
1.1 dsieger 7084: </li>
1.25 spz 7085: <li class="listitem"><p>If your package needs a library with which to link and
7086: there is no <code class="filename">buildlink3.mk</code> file
7087: available, create one. Using
7088: <code class="varname">DEPENDS</code> won't be sufficient because the
7089: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7090: <li class="listitem">
1.25 spz 7091: <p>If your package needs some executable to be able to run
7092: correctly and if there's no
7093: <code class="filename">buildlink3.mk</code> file, this is specified
7094: using the <code class="varname">DEPENDS</code> variable. The
1.79 snj 7095: <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 7096: be able to execute the latex binary from the teTeX package
7097: when it runs, and that is specified:</p>
1.1 dsieger 7098: <pre class="programlisting">
1.25 spz 7099: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.111 sevan 7100: </pre>
1.25 spz 7101: </li>
7102: <li class="listitem">
7103: <p>You can use wildcards in package dependencies. Note that
7104: such wildcard dependencies are retained when creating binary
7105: packages. The dependency is checked when installing the binary
7106: package and any package which matches the pattern will be
7107: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7108: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7109: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7110: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7111: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7112: <p>Wildcards can also be used to specify that a package
7113: will only build against a certain minimum version of a
7114: pre-requisite:</p>
7115: <pre class="programlisting">
1.25 spz 7116: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7117: </pre>
1.25 spz 7118: <p>This means that the package will build using version 6.0
7119: of ImageMagick or newer. Such a dependency may be warranted
7120: if, for example, the command line options of an executable
7121: have changed.</p>
7122: <p>If you need to depend on minimum versions of libraries,
7123: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7124: <p>For security fixes, please update the package
1.108 rillig 7125: 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 7126: information.</p>
7127: </li>
7128: </ol></div>
7129: <p>If your package needs files from another package to build,
7130: add the relevant distribution files to
7131: <code class="varname">DISTFILES</code>, so they will be extracted
1.79 snj 7132: 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 7133: (It relies on the jpeg sources being present in source form
7134: during the build.)</p>
7135: </div>
1.41 asau 7136: <div class="sect2">
1.1 dsieger 7137: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7138: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7139: <p>Your package may conflict with other packages a user might
7140: already have installed on his system, e.g. if your package
7141: installs the same set of files as another package in the pkgsrc
1.80 wiz 7142: tree or has the same <code class="varname">PKGNAME</code>.</p>
7143: <p>These cases are handled automatically by the packaging tools
7144: at package installation time and do not need to be handled
7145: manually.</p>
7146: <p>In case the conflicts can not be recognized automatically
7147: (e.g., packages using the same config file location but no other
7148: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7149: space-separated list of packages (including version string) your
7150: package conflicts with.</p>
1.80 wiz 7151: <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>
7152: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7153: use the same config file, you would set in
7154: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7155: <pre class="programlisting">
1.80 wiz 7156: CONFLICTS= baz-[0-9]*
1.111 sevan 7157: </pre>
1.80 wiz 7158: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7159: <pre class="programlisting">
1.80 wiz 7160: CONFLICTS= bar-[0-9]*
1.111 sevan 7161: </pre>
1.1 dsieger 7162: </div>
1.41 asau 7163: <div class="sect2">
1.1 dsieger 7164: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7165: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7166: <p>There are several reasons why a package might be
7167: instructed to not build under certain circumstances. If the
7168: package builds and runs on most platforms, the exceptions
1.83 dholland 7169: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7170: the package builds and runs on a small handful of platforms,
7171: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7172: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7173: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7174: (OS-version-platform) that can use glob-style
7175: wildcards.</p>
7176: <p>If a package is not appropriate for some platforms (as
1.114 maya 7177: opposed to merely broken), a different set of variables should be
1.83 dholland 7178: used as this affects failure reporting and statistics.
7179: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7180: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7181: the package is appropriate for only a small handful of platforms
7182: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7183: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7184: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7185: (OS-version-platform) that can use glob-style
7186: wildcards.</p>
7187: <p>Some packages are tightly bound to a specific version of an
1.79 snj 7188: 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 7189: backwards compatible with other versions of the OS, and should be
7190: uploaded to a version specific directory on the FTP server. Mark
7191: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7192: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7193: the package system internals, but may be used in the
7194: future.</p>
7195: <p>If the package should be skipped (for example, because it
7196: provides functionality already provided by the system), set
7197: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7198: the package should fail because some preconditions are not met,
7199: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7200: message.</p>
7201: </div>
1.41 asau 7202: <div class="sect2">
1.1 dsieger 7203: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7204: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7205: <p>To ensure that a package may not be deleted, once it has been
7206: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7207: be set in the package Makefile. This will be carried into any
7208: binary package that is made from this pkgsrc entry. A
1.23 wiz 7209: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.79 snj 7210: 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 7211: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7212: </div>
1.41 asau 7213: <div class="sect2">
1.1 dsieger 7214: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7215: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7216: <p>When a vulnerability is found, this should be noted in
7217: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7218: and after committing that file, ask pkgsrc-security@NetBSD.org to
7219: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7220: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7221: <code class="varname">PKGREVISION</code> should be increased (this is of
7222: course not necessary if the problem is fixed by using a newer
7223: release of the software), and the pattern in the
7224: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7225: <p>Also, if the fix should be applied to the stable pkgsrc
7226: branch, be sure to submit a pullup request!</p>
7227: <p>Binary packages already on ftp.NetBSD.org will be handled
7228: semi-automatically by a weekly cron job.</p>
7229: </div>
1.41 asau 7230: <div class="sect2">
1.1 dsieger 7231: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7232: <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 7233: <p>When making fixes to an existing package it can be useful
7234: to change the version number in <code class="varname">PKGNAME</code>. To
7235: avoid conflicting with future versions by the original author, a
1.23 wiz 7236: <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 7237: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7238: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7239: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7240: <pre class="programlisting">
7241: DISTNAME= foo-17.42
7242: PKGREVISION= 9
1.111 sevan 7243: </pre>
1.1 dsieger 7244: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7245: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7246: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7247: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7248: <code class="varname">PKGNAME_NOREV</code>.</p>
7249: <p>When a new release of the package is released, the
7250: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7251: minor release of the above package, things should be like:</p>
7252: <pre class="programlisting">
7253: DISTNAME= foo-17.43
1.111 sevan 7254: </pre>
1.1 dsieger 7255: <p><code class="varname">PKGREVISION</code> should be incremented for any
7256: non-trivial change in the resulting binary package. Without a
7257: <code class="varname">PKGREVISION</code> bump, someone with the previous
7258: version installed has no way of knowing that their package is out
7259: of date. Thus, changes without increasing
7260: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7261: trivial that no reasonable person would want to upgrade", and this
7262: is the rough test for when increasing
7263: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7264: changes that do not merit increasing
7265: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7266: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7267: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7268: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7269: or comments in Makefile.</p></li>
1.23 wiz 7270: <li class="listitem"><p>
1.1 dsieger 7271: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7272: <li class="listitem"><p>
1.1 dsieger 7273: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7274: <li class="listitem"><p>
1.1 dsieger 7275: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7276: </ul></div>
7277: <p>Examples of changes that do merit an increase to
7278: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7279: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7280: <li class="listitem"><p>
1.1 dsieger 7281: Security fixes</p></li>
1.23 wiz 7282: <li class="listitem"><p>
1.1 dsieger 7283: Changes or additions to a patch file</p></li>
1.23 wiz 7284: <li class="listitem"><p>
1.1 dsieger 7285: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 7286: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 7287: </ul></div>
7288: <p>PKGREVISION must also be incremented when dependencies have ABI
7289: changes.</p>
7290: </div>
1.41 asau 7291: <div class="sect2">
1.1 dsieger 7292: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7293: <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 7294: <p>When you want to replace the same text in multiple files
7295: or when the replacement text varies, patches alone cannot help.
7296: This is where the SUBST framework comes in. It provides an
7297: easy-to-use interface for replacing text in files.
7298: Example:</p>
7299: <pre class="programlisting">
7300: SUBST_CLASSES+= fix-paths
7301: SUBST_STAGE.fix-paths= pre-configure
7302: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7303: SUBST_FILES.fix-paths= src/*.c
7304: SUBST_FILES.fix-paths+= scripts/*.sh
7305: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7306: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 sevan 7307: </pre>
1.1 dsieger 7308: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7309: that are used to identify the different SUBST blocks that are
7310: defined. The SUBST framework is heavily used by pkgsrc, so it is
7311: important to always use the <code class="literal">+=</code> operator with
7312: this variable. Otherwise some substitutions may be
7313: skipped.</p>
7314: <p>The remaining variables of each SUBST block are
7315: parameterized with the identifier from the first line
7316: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7317: parameters to a function call.</p>
7318: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7319: which the replacement will take place. All combinations of
7320: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7321: <code class="literal">post-</code> together with a phase name are
7322: possible, though only few are actually used. Most commonly used
7323: are <code class="literal">post-patch</code> and
7324: <code class="literal">pre-configure</code>. Of these two,
7325: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7326: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7327: have the state after applying the patches but before making any
7328: other changes. This is especially useful when you are debugging
7329: a package in order to create new patches for it. Similarly,
7330: <code class="literal">post-build</code> is preferred over
7331: <code class="literal">pre-install</code>, because the install phase should
7332: generally be kept as simple as possible. When you use
7333: <code class="literal">post-build</code>, you have the same files in the
7334: working directory that will be installed later, so you can check
7335: if the substitution has succeeded.</p>
7336: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7337: that is printed just before the substitution is done.</p>
7338: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7339: globbing patterns that specifies the files in which the
7340: substitution will take place. The patterns are interpreted
7341: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7342: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.79 snj 7343: <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 7344: command should be prefixed with <code class="literal">-e</code>, so that
7345: all SUBST blocks look uniform.</p>
7346: <p>There are some more variables, but they are so seldomly
7347: used that they are only documented in the
7348: <code class="filename">mk/subst.mk</code> file.</p>
7349: </div>
7350: </div>
1.41 asau 7351: <div class="sect1">
1.1 dsieger 7352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7353: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7354: <div class="sect2">
1.1 dsieger 7355: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7356: <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 7357: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7358: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7359: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7360: with the name of each file to download as an argument, expecting
7361: it to output the URL of the directory from which to download
1.79 snj 7362: 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 7363: example of this usage.</p>
7364: <p>If the download can't be automated, because the user must
7365: submit personal information to apply for a password, or must pay
7366: for the source, or whatever, you can set
7367: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7368: displayed to the user before aborting the build. Example:</p>
7369: <pre class="programlisting">
7370: FETCH_MESSAGE= "Please download the files"
7371: FETCH_MESSAGE+= " "${DISTFILES:Q}
7372: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7373: </pre>
1.1 dsieger 7374: </div>
1.41 asau 7375: <div class="sect2">
1.1 dsieger 7376: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7377: <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 7378: <p>Sometimes authors of a software package make some
7379: modifications after the software was released, and they put up a
7380: new distfile without changing the package's version number. If a
7381: package is already in pkgsrc at that time, the checksum will
7382: no longer match. The contents of the new distfile should be
7383: compared against the old one before changing anything, to make
7384: sure the distfile was really updated on purpose, and that
7385: no trojan horse or so crept in.
7386: Please mention that the distfiles were compared and what was found
1.53 rodent 7387: in your commit message.</p>
1.109 wiz 7388: <p>Then, the correct way to work around this is to set
7389: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7390: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7391: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7392: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7393: <code class="varname">PATCHFILES</code> for this package will be put in that
1.109 wiz 7394: 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 7395: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7396: including the <code class="filename">nbX</code> suffix) or a date stamp can
7397: be appended, like
7398: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53 rodent 7399: <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>
7400: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7401: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7402: path in the filenames.
1.53 rodent 7403: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7404: Furthermore, a mail to the package's authors seems appropriate
7405: telling them that changing distfiles after releases without
7406: changing the file names is not good practice.</p>
7407: </div>
1.88 tnn 7408: <div class="sect2">
7409: <div class="titlepage"><div><div><h3 class="title">
7410: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 7411: <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:
7412: </p>
1.88 tnn 7413: <div class="sect3">
7414: <div class="titlepage"><div><div><h4 class="title">
7415: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
7416: <p>
7417: 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.
7418: </p>
7419: <pre class="programlisting">
7420: DISTNAME= exampleproject-1.0
1.90 tnn 7421: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7422: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7423: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7424: EXTRACT_SUFX= .zip
7425: </pre>
7426: </div>
7427: <div class="sect3">
7428: <div class="titlepage"><div><div><h4 class="title">
7429: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
7430: <p>
7431: 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.
7432: </p>
7433: <pre class="programlisting">
7434: DISTNAME= example-1.0
1.107 jnemeth 7435: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7436: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7437: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7438: </pre>
1.88 tnn 7439: </div>
7440: <div class="sect3">
7441: <div class="titlepage"><div><div><h4 class="title">
7442: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
7443: <p>
7444: 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.
7445: </p>
7446: <pre class="programlisting">
7447: DISTNAME= offensive-1.6
1.90 tnn 7448: PKGNAME= ${DISTNAME:S/offensive/proper/}
7449: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7450: GITHUB_PROJECT= exampleproject
7451: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7452: EXTRACT_SUFX= .zip
1.111 sevan 7453: </pre>
1.88 tnn 7454: </div>
7455: </div>
1.1 dsieger 7456: </div>
1.41 asau 7457: <div class="sect1">
1.1 dsieger 7458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7459: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7460: <div class="sect2">
1.1 dsieger 7461: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7462: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7463: <p>pkgsrc supports many different machines, with different
7464: object formats like a.out and ELF, and varying abilities to do
7465: shared library and dynamic loading at all. To accompany this,
7466: varying commands and options have to be passed to the
7467: compiler, linker, etc. to get the Right Thing, which can be
7468: pretty annoying especially if you don't have all the machines
7469: at your hand to test things. The
1.79 snj 7470: <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 7471: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7472: both static and dynamic libraries from a set of source files,
7473: thus being platform-independent.</p>
7474: <p>Here's how to use libtool in a package in seven simple
7475: steps:</p>
1.23 wiz 7476: <div class="orderedlist"><ol class="orderedlist" type="1">
7477: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7478: Makefile.</p></li>
1.23 wiz 7479: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7480: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7481: add it to the definition of <code class="varname">CC</code>, if only
7482: libraries are being built in a given Makefile. This one command
7483: will build both PIC and non-PIC library objects, so you need not
7484: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7485: <li class="listitem">
1.1 dsieger 7486: <p>For the linking of the library, remove any
1.23 wiz 7487: <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
7488: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7489: <pre class="programlisting">
7490: ${LIBTOOL} --mode=link \
7491: ${CC} -o ${.TARGET:.a=.la} \
7492: ${OBJS:.o=.lo} \
7493: -rpath ${PREFIX}/lib \
7494: -version-info major:minor
1.111 sevan 7495: </pre>
1.1 dsieger 7496: <p>Note that the library is changed to have a
7497: <code class="filename">.la</code> extension, and the objects are
7498: changed to have a <code class="filename">.lo</code>
7499: extension. Change <code class="varname">OBJS</code> as
7500: necessary. This automatically creates all of the
7501: <code class="filename">.a</code>,
7502: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7503: necessary) in the build directory. Be sure to include
1.23 wiz 7504: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7505: minor are zero, as libtool will otherwise strip off the
7506: shared library version.</p>
7507: <p>From the libtool manual:</p>
7508: <pre class="programlisting">
7509: So, libtool library versions are described by three integers:
7510:
7511: CURRENT
7512: The most recent interface number that this library implements.
7513:
7514: REVISION
7515: The implementation number of the CURRENT interface.
7516:
7517: AGE
7518: The difference between the newest and oldest interfaces that
7519: this library implements. In other words, the library implements
7520: all the interface numbers in the range from number `CURRENT -
7521: AGE' to `CURRENT'.
7522:
7523: If two libraries have identical CURRENT and AGE numbers, then the
7524: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 7525: </pre>
1.23 wiz 7526: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7527: different results for a.out and ELF (excluding symlinks)
7528: in only one case. An ELF library of the form
1.23 wiz 7529: <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 7530: will have a symlink of
1.23 wiz 7531: <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 7532: on an a.out platform. This is handled
7533: automatically.</p>
1.23 wiz 7534: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7535: directory of the library being built.</p>
7536: <p>In the <code class="filename">PLIST</code>, include only the
7537: <code class="filename">.la</code> file, the other files will be
7538: added automatically.</p>
7539: </li>
1.23 wiz 7540: <li class="listitem">
1.1 dsieger 7541: <p>When linking shared object (<code class="filename">.so</code>)
1.79 snj 7542: 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 7543: shared libraries, use <span class="quote">“<span class="quote">-module
7544: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7545: tacked on.</p>
7546: <p>The <code class="filename">PLIST</code> file gets the
7547: <code class="filename">foo.so</code> entry.</p>
7548: </li>
1.23 wiz 7549: <li class="listitem">
1.1 dsieger 7550: <p>When linking programs that depend on these libraries
7551: <span class="emphasis"><em>before</em></span> they are installed, preface
1.79 snj 7552: 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 7553: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7554: libraries (static or shared), but please be aware that
7555: libtool will not allow you to specify a relative path in
1.23 wiz 7556: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7557: expects you to change that argument to be the
7558: <code class="filename">.la</code> file. e.g.</p>
7559: <pre class="programlisting">
7560: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 7561: </pre>
1.1 dsieger 7562: <p>should be changed to:</p>
7563: <pre class="programlisting">
7564: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 7565: </pre>
1.1 dsieger 7566: <p>and it will do the right thing with the libraries.</p>
7567: </li>
1.23 wiz 7568: <li class="listitem">
1.79 snj 7569: <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>
7570: 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 7571: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7572: <code class="filename">.la</code>. e.g.</p>
7573: <pre class="programlisting">
1.22 jakllsch 7574: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 7575: </pre>
1.1 dsieger 7576: <p>This will install the static <code class="filename">.a</code>,
7577: shared library, any needed symlinks, and run
1.79 snj 7578: <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 7579: </li>
1.23 wiz 7580: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7581: the <code class="filename">.la</code>
7582: file (this is a change from previous behaviour).</p></li>
7583: </ol></div>
7584: </div>
1.41 asau 7585: <div class="sect2">
1.1 dsieger 7586: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7587: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7588: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7589: package Makefile. This will override the package's own libtool
7590: in most cases. For older libtool using packages, libtool is
7591: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7592: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7593: configure; find work*/ -name libtool</strong></span>.</p>
7594: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7595: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7596: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7597: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7598: package's libtool script(s), set it as appropriate.</p>
7599: <p>If you do not need <code class="filename">*.a</code> static
7600: libraries built and installed, then use
7601: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7602: <p>If your package makes use of the platform-independent library
7603: for loading dynamic shared objects, that comes with libtool
7604: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7605: <p>Some packages use libtool incorrectly so that the package
7606: may not work or build in some circumstances. Some of the more
7607: common errors are:</p>
1.41 asau 7608: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7609: <li class="listitem">
1.1 dsieger 7610: <p>The inclusion of a shared object (-module) as a dependent library in an
7611: executable or library. This in itself isn't a problem if one of two things
7612: has been done:</p>
1.23 wiz 7613: <div class="orderedlist"><ol class="orderedlist" type="1">
7614: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7615: <code class="filename">libfoo.la</code>, not
7616: <code class="filename">foo.la</code></p></li>
1.23 wiz 7617: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7618: </ol></div>
7619: </li>
1.23 wiz 7620: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7621: The function lt_dlinit() should be called and the macro
7622: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7623: executables.</p></li>
7624: </ul></div>
7625: </div>
1.41 asau 7626: <div class="sect2">
1.1 dsieger 7627: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7628: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7629: <p>If a package needs GNU autoconf or automake to be executed
7630: to regenerate the configure script and Makefile.in makefile
7631: templates, then they should be executed in a pre-configure
7632: target.</p>
7633: <p>For packages that need only autoconf:</p>
7634: <pre class="programlisting">
7635: AUTOCONF_REQD= 2.50 # if default version is not good enough
7636: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7637: ...
7638:
7639: pre-configure:
7640: cd ${WRKSRC} && autoconf
7641:
7642: ...
1.111 sevan 7643: </pre>
1.1 dsieger 7644: <p>and for packages that need automake and autoconf:</p>
7645: <pre class="programlisting">
7646: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7647: USE_TOOLS+= automake # use "automake14" for automake-1.4
7648: ...
7649:
7650: pre-configure:
7651: set -e; cd ${WRKSRC}; \
7652: aclocal; autoheader; automake -a --foreign -i; autoconf
7653:
7654: ...
1.111 sevan 7655: </pre>
1.1 dsieger 7656: <p>Packages which use GNU Automake will almost certainly
7657: require GNU Make.</p>
7658: <p>There are times when the configure process makes
7659: additional changes to the generated files, which then causes
7660: the build process to try to re-execute the automake sequence.
7661: This is prevented by touching various files in the configure
7662: stage. If this causes problems with your package you can set
7663: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7664: Makefile.</p>
7665: </div>
7666: </div>
1.41 asau 7667: <div class="sect1">
1.1 dsieger 7668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7669: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 7670: <div class="sect2">
1.1 dsieger 7671: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7672: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7673: <p>Compilers for the C, C++, and Fortran languages comes with
7674: the NetBSD base system. By default, pkgsrc assumes that a package
7675: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 7676: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7677: <p>To declare which language's compiler a package needs, set
7678: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7679: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7680: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7681: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7682: written in C++, usually need a C compiler for the configure
7683: phase.</p>
7684: </div>
1.41 asau 7685: <div class="sect2">
1.1 dsieger 7686: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7687: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 7688: <p>If a program is written in Java, use the Java framework in
7689: pkgsrc. The package must include
7690: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7691: provides the following variables:</p>
1.41 asau 7692: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7693: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7694: dependency on the JDK is added. If
1.23 wiz 7695: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7696: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7697: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7698: JDK.</p></li>
1.23 wiz 7699: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7700: a package needs a Java2 implementation. The supported values
1.23 wiz 7701: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7702: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7703: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7704: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7705: above. This variable is not set by default.</p></li>
1.24 wiz 7706: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7707: automatically set to the runtime location of the used Java
7708: implementation dependency. It may be used to set
7709: <code class="varname">JAVA_HOME</code> to a good value if the program
7710: needs this variable to be defined.
7711: </p></li>
1.1 dsieger 7712: </ul></div>
7713: </div>
1.41 asau 7714: <div class="sect2">
1.1 dsieger 7715: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7716: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7717: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7718: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7719: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7720: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7721: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7722: that you want adjusted. Every occurrence of
7723: <code class="filename">*/bin/perl</code> in a she-bang line will be
7724: replaced with the full path to the perl executable.</p>
1.1 dsieger 7725: <p>If a particular version of perl is needed, set the
7726: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7727: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 7728: <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 7729: about handling perl modules.</p>
7730: </div>
1.41 asau 7731: <div class="sect2">
1.1 dsieger 7732: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 7733: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
7734: <p><code class="varname">REPLACE_SH</code>,
7735: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7736: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7737: hash bangs in files. Please use the appropriate one, prefering
7738: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7739: Each should contain a list of scripts, relative to
7740: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7741: occurrence of the matching shell in a she-bang line will be
7742: replaced with the full path to the shell executable.
1.40 wiz 7743: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7744: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7745: </div>
1.41 asau 7746: <div class="sect2">
1.40 wiz 7747: <div class="titlepage"><div><div><h3 class="title">
7748: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7749: <p>Currently, there is no special handling for other languages
7750: in pkgsrc. If a compiler package provides a
7751: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7752: just add a (build) dependency on the appropriate compiler
7753: package.</p>
7754: </div>
7755: </div>
1.41 asau 7756: <div class="sect1">
1.1 dsieger 7757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7758: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7759: <p>The most common failures when building a package are that
7760: some platforms do not provide certain header files, functions or
7761: libraries, or they provide the functions in a library that the
7762: original package author didn't know. To work around this, you
7763: can rewrite the source code in most cases so that it does not
7764: use the missing functions or provides a replacement function.</p>
1.41 asau 7765: <div class="sect2">
1.1 dsieger 7766: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7767: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7768: <p>If a package already comes with a GNU configure script, the
7769: preferred way to fix the build failure is to change the
7770: configure script, not the code. In the other cases, you can
7771: utilize the C preprocessor, which defines certain macros
7772: depending on the operating system and hardware architecture it
7773: compiles for. These macros can be queried using for example
7774: <code class="varname">#if defined(__i386)</code>. Almost every operating
7775: system, hardware architecture and compiler has its own macro.
7776: For example, if the macros <code class="varname">__GNUC__</code>,
7777: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7778: are all defined, you know that you are using NetBSD on an i386
7779: compatible CPU, and your compiler is GCC.</p>
7780: <p>The list of the following macros for hardware and
7781: operating system depends on the compiler that is used. For
7782: example, if you want to conditionally compile code on Solaris,
7783: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7784: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7785: <div class="sect3">
1.1 dsieger 7786: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7787: <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 7788: <p>To distinguish between 4.4 BSD-derived systems and the
7789: rest of the world, you should use the following code.</p>
7790: <pre class="programlisting">
7791: #include <sys/param.h>
7792: #if (defined(BSD) && BSD >= 199306)
7793: /* BSD-specific code goes here */
7794: #else
7795: /* non-BSD-specific code goes here */
7796: #endif
7797: </pre>
7798: <p>If this distinction is not fine enough, you can also test
7799: for the following macros.</p>
7800: <pre class="programlisting">
1.45 obache 7801: Cygwin __CYGWIN__
7802: DragonFly __DragonFly__
1.1 dsieger 7803: FreeBSD __FreeBSD__
1.45 obache 7804: Haiku __HAIKU__
1.1 dsieger 7805: Interix __INTERIX
7806: IRIX __sgi (TODO: get a definite source for this)
7807: Linux linux, __linux, __linux__
1.83 dholland 7808: Mac OS X __APPLE__
1.45 obache 7809: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7810: Minix3 __minix
1.1 dsieger 7811: NetBSD __NetBSD__
7812: OpenBSD __OpenBSD__
7813: Solaris sun, __sun
7814: </pre>
7815: </div>
1.41 asau 7816: <div class="sect3">
1.1 dsieger 7817: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7818: <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 7819: <pre class="programlisting">
7820: i386 i386, __i386, __i386__
7821: MIPS __mips
7822: SPARC sparc, __sparc
7823: </pre>
7824: </div>
1.41 asau 7825: <div class="sect3">
1.1 dsieger 7826: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7827: <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 7828: <pre class="programlisting">
7829: GCC __GNUC__ (major version), __GNUC_MINOR__
7830: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7831: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7832: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7833: </pre>
7834: </div>
7835: </div>
1.41 asau 7836: <div class="sect2">
1.1 dsieger 7837: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7838: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 7839: <p>Some source files trigger bugs in the compiler, based on
7840: combinations of compiler version and architecture and almost
7841: always relation to optimisation being enabled. Common symptoms
7842: are gcc internal errors or never finishing compiling a
7843: file.</p>
7844: <p>Typically, a workaround involves testing the
7845: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7846: optimisation for that combination of file,
1.87 tnn 7847: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7848: <p>This used to be a big problem in the past, but is rarely
7849: needed now as compiler technology has matured. If you still need
7850: to add a compiler specific workaround, please do so in the file
7851: <code class="filename">hacks.mk</code> and describe the symptom and
7852: compiler version as detailed as possible.</p>
1.1 dsieger 7853: </div>
1.41 asau 7854: <div class="sect2">
1.1 dsieger 7855: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 7856: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
7857: </h3></div></div></div>
1.1 dsieger 7858: <p>This error message often means that a package did not
7859: link to a shared library it needs. The following functions are
7860: known to cause this error message over and over.</p>
7861: <div class="informaltable">
1.106 tnn 7862: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 7863: <colgroup>
7864: <col>
7865: <col>
7866: <col>
7867: </colgroup>
7868: <thead><tr>
7869: <th>Function</th>
7870: <th>Library</th>
7871: <th>Affected platforms</th>
7872: </tr></thead>
7873: <tbody>
7874: <tr>
7875: <td>accept, bind, connect</td>
7876: <td>-lsocket</td>
7877: <td>Solaris</td>
7878: </tr>
7879: <tr>
7880: <td>crypt</td>
7881: <td>-lcrypt</td>
7882: <td>DragonFly, NetBSD</td>
7883: </tr>
7884: <tr>
7885: <td>dlopen, dlsym</td>
7886: <td>-ldl</td>
7887: <td>Linux</td>
7888: </tr>
7889: <tr>
7890: <td>gethost*</td>
7891: <td>-lnsl</td>
7892: <td>Solaris</td>
7893: </tr>
7894: <tr>
7895: <td>inet_aton</td>
7896: <td>-lresolv</td>
7897: <td>Solaris</td>
7898: </tr>
7899: <tr>
7900: <td>nanosleep, sem_*, timer_*</td>
7901: <td>-lrt</td>
7902: <td>Solaris</td>
7903: </tr>
7904: <tr>
7905: <td>openpty</td>
7906: <td>-lutil</td>
7907: <td>Linux</td>
7908: </tr>
7909: </tbody>
7910: </table>
7911: </div>
7912: <p>To fix these linker errors, it is often sufficient to say
7913: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
7914: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 7915: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 7916: bmake</strong></span>.</p>
1.41 asau 7917: <div class="sect3">
1.1 dsieger 7918: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7919: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 7920: <p>When you are using the SunPro compiler, there is another
7921: possibility. That compiler cannot handle the following code:</p>
7922: <pre class="programlisting">
7923: extern int extern_func(int);
7924:
7925: static inline int
7926: inline_func(int x)
7927: {
7928: return extern_func(x);
7929: }
7930:
7931: int main(void)
7932: {
7933: return 0;
7934: }
7935: </pre>
7936: <p>It generates the code for <code class="function">inline_func</code> even if
7937: that function is never used. This code then refers to
7938: <code class="function">extern_func</code>, which can usually not be resolved. To
7939: solve this problem you can try to tell the package to disable inlining
7940: of functions.</p>
7941: </div>
7942: </div>
1.41 asau 7943: <div class="sect2">
1.1 dsieger 7944: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7945: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 7946: <p>Sometimes packages fail to build because the compiler runs
7947: into an operating system specific soft limit. With the
7948: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 7949: to unlimit the resources. Currently, the allowed values are any combination of
7950: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
7951: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 7952: Setting this variable is similar to running the shell builtin
1.10 hubertf 7953: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 7954: segment size or maximum stack size of a process, respectively, to
7955: their hard limits.</p>
7956: </div>
7957: </div>
1.41 asau 7958: <div class="sect1">
1.1 dsieger 7959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7960: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 7961: <div class="sect2">
1.1 dsieger 7962: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7963: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 7964: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 7965: with some operating systems cannot create more than one
7966: directory at a time. As such, you should call
7967: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
7968: <pre class="programlisting">
7969: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7970: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 7971: </pre>
1.23 wiz 7972: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
7973: dir2</code></span>”</span> to the
1.1 dsieger 7974: <code class="varname">INSTALLATION_DIRS</code> variable, which will
7975: automatically do the right thing.</p>
7976: </div>
1.41 asau 7977: <div class="sect2">
1.1 dsieger 7978: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7979: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 7980: <p>In general, documentation should be installed into
7981: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7982: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
7983: includes the version number of the package).</p>
7984: <p>Many modern packages using GNU autoconf allow to set the
7985: directory where HTML documentation is installed with the
1.23 wiz 7986: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 7987: is needed because otherwise the documentation ends up in
7988: <code class="filename">${PREFIX}/share/doc/html</code> or other
7989: places.</p>
7990: <p>An exception to the above is that library API documentation
1.79 snj 7991: 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 7992: browsers (devhelp) should be left at their default location, which
7993: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
7994: documentation can be recognized from files ending in
7995: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
7996: (It is also acceptable to install such files in
7997: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7998: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
7999: <code class="filename">.devhelp*</code> file must be directly in that
8000: directory then, no additional subdirectory level is allowed in
8001: this case. This is usually achieved by using
1.23 wiz 8002: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8003: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8004: though.)</p>
8005: </div>
1.41 asau 8006: <div class="sect2">
1.1 dsieger 8007: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8008: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8009: <p>Certain packages, most of them in the games category, install
8010: a score file that allows all users on the system to record their
8011: highscores. In order for this to work, the binaries need to be
8012: installed setgid and the score files owned by the appropriate
1.35 wiz 8013: group and/or owner (traditionally the "games" user/group). Set
8014: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8015: following variables, documented in more detail in
8016: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8017: behaviour: <code class="varname">GAMEDATAMODE</code>,
8018: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8019: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8020: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8021: <code class="varname">GAMEDATA_PERMS</code> and
8022: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8023: <p>An example that illustrates some of the variables described above is
8024: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8025: used to properly set directory permissions of the directory where the
8026: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8027: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8028: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8029: binary:</p>
8030: <pre class="programlisting">
1.112 rillig 8031: USE_GAMESGROUP= yes
1.100 leot 8032:
1.112 rillig 8033: BUILD_DEFS+= VARBASE
1.100 leot 8034:
1.112 rillig 8035: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8036: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8037: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8038: </pre>
1.100 leot 8039: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8040: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8041: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8042: needed to be accessed by setgid games and
8043: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8044: <p>A package should therefore never hard code file ownership or
1.100 leot 8045: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8046: or alternatively on <code class="varname">INSTALL_GAME</code>,
8047: <code class="varname">INSTALL_GAME_DATA</code> and
8048: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8049: </div>
1.41 asau 8050: <div class="sect2">
1.1 dsieger 8051: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8052: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8053: <p><code class="varname">DESTDIR</code> support means that a package
8054: installs into a staging directory, not the final location of the
8055: files. Then a binary package is created which can be used for
8056: installation as usual. There are two ways: Either the package must
1.23 wiz 8057: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8058: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8059: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8060: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8061: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8062: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8063: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8064: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8065: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8066: the inclusion.</p></li>
1.23 wiz 8067: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8068: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8069: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8070: automatically. Many manual rules and pre/post-install often are
8071: incorrect; fix them.</p></li>
1.23 wiz 8072: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8073: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8074: <li class="listitem"><p>In general, packages should support
1.4 rillig 8075: <code class="varname">UNPRIVILEGED</code> to be able to use
8076: DESTDIR.</p></li>
8077: </ul></div>
8078: </div>
1.41 asau 8079: <div class="sect2">
1.4 rillig 8080: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8081: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8082: <p>Your package may also contain scripts with hardcoded paths to
8083: other interpreters besides (or as well as) perl. To correct the
8084: full pathname to the script interpreter, you need to set the
8085: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8086: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8087: <pre class="programlisting">
8088: REPLACE_INTERPRETER+= tcl
8089: REPLACE.tcl.old= .*/bin/tclsh
8090: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8091: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8092: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8093: </pre>
1.41 asau 8094: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8095: <h3 class="title">Note</h3>
8096: <p>Before March 2006, these variables were called
8097: <code class="varname">_REPLACE.*</code> and
8098: <code class="varname">_REPLACE_FILES.*</code>.</p>
8099: </div>
8100: </div>
1.41 asau 8101: <div class="sect2">
1.1 dsieger 8102: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8103: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8104: <p>Makefiles of packages providing perl5 modules should include
8105: the Makefile fragment
8106: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8107: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8108: configuration for such modules as well as various hooks to tune
8109: this configuration. See comments in this file for
8110: details.</p>
8111: <p>Perl5 modules will install into different places depending
8112: on the version of perl used during the build process. To
8113: address this, pkgsrc will append lines to the
8114: <code class="filename">PLIST</code> corresponding to the files listed in
8115: the installed <code class="filename">.packlist</code> file generated by
8116: most perl5 modules. This is invoked by defining
8117: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8118: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8119: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8120: e.g.:</p>
1.1 dsieger 8121: <pre class="programlisting">
1.47 wiz 8122: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8123: </pre>
1.47 wiz 8124: <p>The perl5 config variables
8125: <code class="varname">installarchlib</code>,
8126: <code class="varname">installscript</code>,
8127: <code class="varname">installvendorbin</code>,
8128: <code class="varname">installvendorscript</code>,
8129: <code class="varname">installvendorarch</code>,
8130: <code class="varname">installvendorlib</code>,
8131: <code class="varname">installvendorman1dir</code>, and
8132: <code class="varname">installvendorman3dir</code> represent those
8133: locations in which components of perl5 modules may be installed,
8134: provided as variable with uppercase and prefixed with
8135: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8136: and may be used by perl5 packages that don't have a packlist.
8137: These variables are also substituted for in the
8138: <code class="filename">PLIST</code> as uppercase prefixed with
8139: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8140: </div>
1.41 asau 8141: <div class="sect2">
1.1 dsieger 8142: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8143: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8144: <p>Some packages install info files or use the
1.23 wiz 8145: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8146: commands. <code class="varname">INFO_FILES</code> should be defined in
8147: the package Makefile so that <code class="filename">INSTALL</code> and
8148: <code class="filename">DEINSTALL</code> scripts will be generated to
8149: handle registration of the info files in the Info directory
1.23 wiz 8150: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8151: files registration is either provided by the system, or by a
8152: special purpose package automatically added as dependency if
8153: needed.</p>
8154: <p><code class="varname">PKGINFODIR</code> is the directory under
8155: <code class="filename">${PREFIX}</code> where info files are primarily
8156: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8157: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8158: <p>The info files for the package should be listed in the
8159: package <code class="filename">PLIST</code>; however any split info files
8160: need not be listed.</p>
1.23 wiz 8161: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8162: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8163: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8164: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8165: should be noted with the <code class="varname">TEXINFO_REQD</code>
8166: variable in the package <code class="filename">Makefile</code>. By
8167: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8168: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8169: does not match the required minimum, a build dependency on the
1.79 snj 8170: <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 8171: be added automatically.</p>
8172: <p>The build and installation process of the software provided
8173: by the package should not use the
1.10 hubertf 8174: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8175: info files is the task of the package
8176: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8177: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8178: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8179: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8180: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8181: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8182: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8183: no effect except the logging of a message. The script overriding
1.10 hubertf 8184: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8185: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8186: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8187: </div>
1.41 asau 8188: <div class="sect2">
1.1 dsieger 8189: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8190: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8191: <p>All packages that install manual pages should install them
8192: into the same directory, so that there is one common place to look
8193: for them. In pkgsrc, this place is
8194: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8195: should be used in packages. The default for
8196: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8197: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8198: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8199: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8200: <h3 class="title">Note</h3>
8201: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8202: is far from complete.</p>
8203: </div>
8204: <p>The <code class="filename">PLIST</code> files can just use
8205: <code class="filename">man/</code> as the top level directory for the man
8206: page file entries, and the pkgsrc framework will convert as
8207: needed. In all other places, the correct
8208: <code class="varname">PKGMANDIR</code> must be used.</p>
8209: <p>Packages that are
8210: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8211: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8212: <code class="filename">./configure</code>
8213: --mandir switch to set where the man pages should be installed.
8214: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8215: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8216: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8217: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8218: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8219: Or if the <code class="filename">./configure</code> script uses
8220: a non-standard use of --mandir, you can set
8221: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8222: <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 8223: information on installation of compressed manual pages.</p>
8224: </div>
1.41 asau 8225: <div class="sect2">
1.1 dsieger 8226: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8227: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8228: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8229: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8230: you need to take some extra steps to make sure they get registered
8231: in the database:</p>
1.23 wiz 8232: <div class="orderedlist"><ol class="orderedlist" type="1">
8233: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8234: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8235: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8236: deinstallation time, and tells the package where to install
1.7 rillig 8237: GConf data files using some standard configure arguments. It
1.1 dsieger 8238: also disallows any access to the database directly from the
8239: package.</p></li>
1.23 wiz 8240: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8241: <code class="filename">.schemas</code> files under
8242: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8243: installed under <code class="filename">${PREFIX}/etc</code>, you will
8244: need to manually patch the package.</p></li>
1.23 wiz 8245: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8246: directory, as they will be handled automatically. See
1.84 wiz 8247: <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 8248: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8249: your <code class="filename">Makefile</code> with a list of all
8250: <code class="filename">.schemas</code> files installed by the package, if
8251: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8252: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8253: your <code class="filename">Makefile</code> with a
8254: list of all <code class="filename">.entries</code> files installed by the
8255: package, if any. Names must not contain any directories in
8256: them.</p></li>
8257: </ol></div>
8258: </div>
1.41 asau 8259: <div class="sect2">
1.1 dsieger 8260: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8261: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8262: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8263: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8264: get registered in the database:</p>
1.23 wiz 8265: <div class="orderedlist"><ol class="orderedlist" type="1">
8266: <li class="listitem"><p>Include
1.18 snj 8267: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8268: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8269: takes care of rebuilding the scrollkeeper database at
8270: installation and deinstallation time, and disallows any access
8271: to it directly from the package.</p></li>
1.23 wiz 8272: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8273: <code class="filename">libdata/scrollkeeper</code> directory, as they
8274: will be handled automatically.</p></li>
1.23 wiz 8275: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8276: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8277: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8278: </ol></div>
8279: </div>
1.41 asau 8280: <div class="sect2">
1.1 dsieger 8281: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8282: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8283: <p>If a package installs font files, you will need to rebuild
8284: the fonts database in the directory where they get installed at
8285: installation and deinstallation time. This can be automatically
8286: done by using the pkginstall framework.</p>
8287: <p>You can list the directories where fonts are installed in the
8288: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8289: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8290: <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 8291: Also make sure that the database file
8292: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8293: <p>Note that you should not create new directories for fonts;
8294: instead use the standard ones to avoid that the user needs to
8295: manually configure his X server to find them.</p>
8296: </div>
1.41 asau 8297: <div class="sect2">
1.1 dsieger 8298: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8299: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8300: <p>If a package installs GTK2 immodules or loaders, you need to
8301: take some extra steps to get them registered in the GTK2 database
8302: properly:</p>
1.23 wiz 8303: <div class="orderedlist"><ol class="orderedlist" type="1">
8304: <li class="listitem"><p>Include
1.1 dsieger 8305: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8306: <code class="filename">buildlink3.mk</code> file. This takes care of
8307: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8308: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8309: your package installs GTK2 immodules.</p></li>
1.23 wiz 8310: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8311: GTK2 loaders.</p></li>
1.23 wiz 8312: <li class="listitem">
1.1 dsieger 8313: <p>Patch the package to not touch any of the GTK2
8314: databases directly. These are:</p>
1.41 asau 8315: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8316: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8317: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8318: </ul></div>
8319: </li>
1.23 wiz 8320: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8321: any entries under the <code class="filename">libdata/gtk-2.0</code>
8322: directory, as they will be handled automatically.</p></li>
8323: </ol></div>
8324: </div>
1.41 asau 8325: <div class="sect2">
1.1 dsieger 8326: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8327: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8328: <p>If a package installs SGML or XML data files that need to be
8329: registered in system-wide catalogs (like DTDs, sub-catalogs,
8330: etc.), you need to take some extra steps:</p>
1.23 wiz 8331: <div class="orderedlist"><ol class="orderedlist" type="1">
8332: <li class="listitem"><p>Include
1.1 dsieger 8333: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8334: your <code class="filename">Makefile</code>, which takes care of
8335: registering those files in system-wide catalogs at
8336: installation and deinstallation time.</p></li>
1.23 wiz 8337: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8338: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8339: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8340: any XML catalogs installed by the package.</p></li>
1.23 wiz 8341: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8342: to be added to the SGML catalog. These come in groups of
8343: three strings; see xmlcatmgr(1) for more information
8344: (specifically, arguments recognized by the 'add' action).
8345: Note that you will normally not use this variable.</p></li>
1.23 wiz 8346: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8347: to be added to the XML catalog. These come in groups of three
8348: strings; see xmlcatmgr(1) for more information (specifically,
8349: arguments recognized by the 'add' action). Note that you will
8350: normally not use this variable.</p></li>
8351: </ol></div>
8352: </div>
1.41 asau 8353: <div class="sect2">
1.1 dsieger 8354: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8355: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8356: <p>If a package provides extensions to the MIME database by
8357: installing <code class="filename">.xml</code> files inside
8358: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8359: need to take some extra steps to ensure that the database is kept
8360: consistent with respect to these new files:</p>
1.23 wiz 8361: <div class="orderedlist"><ol class="orderedlist" type="1">
8362: <li class="listitem"><p>Include
1.1 dsieger 8363: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8364: (avoid using the <code class="filename">buildlink3.mk</code> file from
8365: this same directory, which is reserved for inclusion from
8366: other <code class="filename">buildlink3.mk</code> files). It takes
8367: care of rebuilding the MIME database at installation and
8368: deinstallation time, and disallows any access to it directly
8369: from the package.</p></li>
1.23 wiz 8370: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8371: <code class="filename">share/mime</code> directory,
8372: <span class="emphasis"><em>except</em></span> for files saved under
8373: <code class="filename">share/mime/packages</code>. The former are
8374: handled automatically by
8375: the update-mime-database program, but the latter are
8376: package-dependent and must be removed by the package that
8377: installed them in the first place.</p></li>
1.23 wiz 8378: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8379: from the PLIST. They will be handled by the shared-mime-info
8380: package.</p></li>
8381: </ol></div>
8382: </div>
1.41 asau 8383: <div class="sect2">
1.1 dsieger 8384: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8385: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8386: <p>If a package uses intltool during its build, add
8387: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8388: which forces it to use the intltool package provided by pkgsrc,
8389: instead of the one bundled with the distribution file.</p>
8390: <p>This tracks intltool's build-time dependencies and uses the
8391: latest available version; this way, the package benefits of any
8392: bug fixes that may have appeared since it was released.</p>
8393: </div>
1.41 asau 8394: <div class="sect2">
1.1 dsieger 8395: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8396: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8397: <p>If a package contains a rc.d script, it won't be copied into
8398: the startup directory by default, but you can enable it, by adding
8399: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8400: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8401: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8402: it will automatically remove the scripts when the package is
8403: deinstalled.</p>
8404: </div>
1.41 asau 8405: <div class="sect2">
1.1 dsieger 8406: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8407: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8408: <p>If a package installs TeX packages into the texmf tree,
8409: the <code class="filename">ls-R</code> database of the tree needs to be
8410: updated.</p>
1.41 asau 8411: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8412: <h3 class="title">Note</h3>
1.22 jakllsch 8413: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8414: packages should install files
1.22 jakllsch 8415: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8416: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8417: </div>
1.23 wiz 8418: <div class="orderedlist"><ol class="orderedlist" type="1">
8419: <li class="listitem"><p>Include
1.22 jakllsch 8420: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8421: takes care of rebuilding the <code class="filename">ls-R</code>
8422: database at installation and deinstallation time.</p></li>
1.23 wiz 8423: <li class="listitem">
1.1 dsieger 8424: <p>If your package installs files into a texmf
8425: tree other than the one
1.22 jakllsch 8426: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8427: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8428: trees that need database update.</p>
8429: <p>If your package also installs font map files that need
1.10 hubertf 8430: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8431: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8432: set <code class="varname">TEX_MAP_FILES</code> and/or
8433: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8434: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8435: be run automatically at installation/deinstallation to
8436: enable/disable font map files for TeX output
8437: drivers.</p>
8438: </li>
1.23 wiz 8439: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8440: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8441: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8442: </ol></div>
8443: </div>
1.41 asau 8444: <div class="sect2">
1.1 dsieger 8445: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8446: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 8447: emulation</h3></div></div></div>
8448: <p>There are some packages that provide libraries and
8449: executables for running binaries from a one operating system
8450: on a different one (if the latter supports it). One example
8451: is running Linux binaries on NetBSD.</p>
1.79 snj 8452: <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 8453: helps in extracting and packaging Linux rpm packages.</p>
8454: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8455: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8456: if all libraries for each installed executable can be found by
8457: the dynamic linker. Since the standard dynamic linker is run,
8458: this fails for emulation packages, because the libraries used
8459: by the emulation are not in the standard directories.</p>
8460: </div>
1.41 asau 8461: <div class="sect2">
1.1 dsieger 8462: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8463: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8464: <p>If a package installs images under the
8465: <code class="filename">share/icons/hicolor</code> and/or updates the
8466: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8467: database, you need to take some extra steps to make sure that the
8468: shared theme directory is handled appropriately and that the cache
8469: database is rebuilt:</p>
1.23 wiz 8470: <div class="orderedlist"><ol class="orderedlist" type="1">
8471: <li class="listitem"><p>Include
1.1 dsieger 8472: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8473: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8474: entry that refers to the theme cache.</p></li>
1.23 wiz 8475: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8476: directories from the <code class="filename">share/icons/hicolor</code>
8477: hierarchy because they will be handled automatically.</p></li>
8478: </ol></div>
8479: <p>The best way to verify that the PLIST is correct with
8480: respect to the last two points is to regenerate it using
1.10 hubertf 8481: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8482: </div>
1.41 asau 8483: <div class="sect2">
1.1 dsieger 8484: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8485: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8486: <p>If a package installs <code class="filename">.desktop</code> files
8487: under <code class="filename">share/applications</code> and these include
1.53 rodent 8488: MIME information (MimeType key), you need to take extra steps to
8489: ensure that they are registered into the MIME database:</p>
1.23 wiz 8490: <div class="orderedlist"><ol class="orderedlist" type="1">
8491: <li class="listitem"><p>Include
1.1 dsieger 8492: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8493: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8494: <code class="filename">share/applications/mimeinfo.cache</code> file.
8495: It will be handled automatically.</p></li>
8496: </ol></div>
8497: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8498: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8499: print-PLIST</strong></span>.</p>
8500: </div>
8501: </div>
1.41 asau 8502: <div class="sect1">
1.1 dsieger 8503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8504: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8505: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8506: immediately. In this case, one can plainly mark a package as broken. For
8507: this, one just sets the variable <code class="varname">BROKEN</code> to the
8508: reason why the package is broken (similar to the
8509: <code class="varname">RESTRICTED</code> variable). A user trying to build
8510: the package will immediately be shown this message, and the build
8511: will not be even tried.</p>
8512: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8513: intervals.</p>
8514: </div>
8515: </div>
1.41 asau 8516: <div class="chapter">
1.1 dsieger 8517: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8518: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 8519: <p>To check out all the gotchas when building a package, here are
8520: the steps that I do in order to get a package working. Please note
8521: this is basically the same as what was explained in the previous
8522: sections, only with some debugging aids.</p>
1.41 asau 8523: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8524: <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>
8525: <li class="listitem">
1.79 snj 8526: <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 8527: create a directory for a new package, change into it, then run
1.10 hubertf 8528: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8529: <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>
8530: <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>
8531: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8532: </li>
1.23 wiz 8533: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8534: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8535: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8536: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8537: configure step to the package's
8538: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8539: <li class="listitem">
1.1 dsieger 8540: <p>Make the package compile, doing multiple rounds of</p>
8541: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8542: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8543: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8544: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8545: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8546: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8547: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8548: <p>Doing this step as non-root user will ensure that no files
8549: are modified that shouldn't be, especially during the build
1.10 hubertf 8550: phase. <span class="command"><strong>mkpatches</strong></span>,
8551: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.79 snj 8552: 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 8553: package.</p>
8554: </li>
1.23 wiz 8555: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
8556: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
8557: <li class="listitem">
1.1 dsieger 8558: <p>Generate a <code class="filename">PLIST</code>:</p>
8559: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8560: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8561: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8562: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8563: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8564: <p>You usually need to be <code class="username">root</code> to do
8565: this. Look if there are any files left:</p>
8566: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8567: <p>If this reveals any files that are missing in
8568: <code class="filename">PLIST</code>, add them.</p>
8569: </li>
1.23 wiz 8570: <li class="listitem">
1.1 dsieger 8571: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8572: package again and make a binary package:</p>
8573: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8574: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8575: </li>
1.23 wiz 8576: <li class="listitem">
1.1 dsieger 8577: <p>Delete the installed package:</p>
8578: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8579: </li>
1.23 wiz 8580: <li class="listitem">
1.10 hubertf 8581: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8582: command, which shouldn't find anything now:</p>
8583: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8584: </li>
1.23 wiz 8585: <li class="listitem">
1.1 dsieger 8586: <p>Reinstall the binary package:</p>
8587: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8588: </li>
1.23 wiz 8589: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8590: <li class="listitem">
1.79 snj 8591: <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 8592: reports:</p>
8593: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8594: </li>
1.23 wiz 8595: <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 8596: </ul></div>
8597: </div>
1.41 asau 8598: <div class="chapter">
1.1 dsieger 8599: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8600: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8601: <div class="toc">
8602: <p><b>Table of Contents</b></p>
1.100 leot 8603: <dl class="toc">
1.6 rillig 8604: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
8605: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8606: <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 8607: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 8608: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 8609: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
8610: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8611: </dl>
8612: </div>
1.41 asau 8613: <div class="sect1">
1.1 dsieger 8614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8615: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8616: <p>Our policy is that we accept binaries only from pkgsrc
8617: developers to guarantee that the packages don't contain any
8618: trojan horses etc. This is not to annoy anyone but rather to
8619: protect our users! You're still free to put up your home-made
8620: binary packages and tell the world where to get them. NetBSD
8621: developers doing bulk builds and wanting to upload them please
1.66 asau 8622: 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
8623: builds)</i></a>.</p>
1.1 dsieger 8624: </div>
1.41 asau 8625: <div class="sect1">
1.1 dsieger 8626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8627: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8628: <p>First, check that your package is complete, compiles and
1.10 hubertf 8629: 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 8630: 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 8631: archive that contains all files that make up the package.
8632: Finally, send this package to the pkgsrc bug tracking system,
1.79 snj 8633: 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 8634: that, go to the web page
1.10 hubertf 8635: <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 8636: which contains some instructions and a link to a form where you
8637: can submit packages. The
1.79 snj 8638: <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 8639: also available as a substitute for either of the above two tools.
8640: </p>
1.1 dsieger 8641: <p>In the form of the problem report, the category should be
1.23 wiz 8642: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8643: and version number, and the description field should contain a
8644: short description of your package (contents of the COMMENT
8645: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8646: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8647: <p>If you want to submit several packages, please send a
8648: separate PR for each one, it's easier for us to track things
8649: that way.</p>
8650: <p>Alternatively, you can also import new packages into
1.23 wiz 8651: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8652: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8653: for details.</p>
8654: </div>
1.41 asau 8655: <div class="sect1">
1.1 dsieger 8656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8657: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8658: <p>Please note all package additions, updates, moves, and
8659: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8660: important to keep this file up to date and conforming to the
8661: existing format, because it will be used by scripts to
1.10 hubertf 8662: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8663: sites. Additionally, check the
8664: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
8665: for the package you updated or removed, in case it was mentioned
8666: there.</p>
8667: <p>When the <code class="varname">PKGREVISION</code> of a package is
8668: bumped, the change should appear in
8669: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
8670: related or otherwise relevant. Mass bumps that result from a
8671: dependency being updated should not be mentioned. In all other
8672: cases it's the developer's decision.</p>
8673: <p>There is a make target that helps in creating proper
1.10 hubertf 8674: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 8675: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8676: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
8677: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
8678: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 8679: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8680: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 8681: For new packages, or package moves or removals, set the
8682: <code class="varname">CTYPE</code> variable on the command line to "Added",
8683: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 8684: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 8685: not the same as your NetBSD login name. The target also automatically
8686: removes possibly existing entries for the package in the
8687: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 8688: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 8689: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
8690: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8691: makes the cvs commands use the main repository.
8692: </p>
1.1 dsieger 8693: </div>
1.41 asau 8694: <div class="sect1">
1.1 dsieger 8695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 8696: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 8697: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 8698: access to the pkgsrc repository.</p>
8699: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8700: Start by adding the directory and then files in the directory. Don't
8701: forget to add the new package to the category's
8702: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8703: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8704: <pre class="programlisting">
8705: <code class="prompt">$</code> cd .../pkgsrc/category
8706: <code class="prompt">$</code> cvs add pkgname
8707: <code class="prompt">$</code> cd pkgname
8708: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8709: <code class="prompt">$</code> cvs add patches/p*
8710: <code class="prompt">$</code> cvs status | less
1.34 wiz 8711: <code class="prompt">$</code> cvs commit
1.33 wiz 8712: <code class="prompt">$</code> cd ..
8713: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 8714: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 8715: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 8716: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 8717: </pre>
1.1 dsieger 8718: <p>The commit message of the initial import should include part of the
8719: <code class="filename">DESCR</code> file, so people reading the mailing lists know
8720: what the package is/does.</p>
1.33 wiz 8721: <p>Also mention the new package in
8722: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8723: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8724: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 8725: </div>
1.41 asau 8726: <div class="sect1">
1.1 dsieger 8727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8728: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 8729: <p>Please always put a concise, appropriate and relevant summary of the
8730: changes between old and new versions into the commit log when updating
8731: a package. There are various reasons for this:</p>
1.41 asau 8732: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8733: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 8734: or its information may be overwritten by newer information.</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 use either cvs or anoncvs.</p></li>
1.23 wiz 8737: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8738: repository is very useful for people who read the pkgsrc-changes mailing
8739: list, so that they can make tactical decisions about when to upgrade
8740: the package.</p></li>
8741: </ul></div>
8742: <p>Please also recognize that, just because a new version of a package
8743: has been released, it should not automatically be upgraded in the CVS
8744: repository. We prefer to be conservative in the packages that are
8745: included in pkgsrc - development or beta packages are not really the
8746: best thing for most places in which pkgsrc is used. Please use your
8747: judgement about what should go into pkgsrc, and bear in mind that
8748: stability is to be preferred above new and possibly untested features.</p>
8749: </div>
1.41 asau 8750: <div class="sect1">
1.1 dsieger 8751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 8752: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
8753: <p>Renaming packages is not recommended.</p>
8754: <p>When renaming packages, be sure to fix any references to old name
8755: in other Makefiles, options, buildlink files, etc.</p>
8756: <p>Also When renaming a package, please define
8757: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8758: pattern(s) of the previous package name.
8759: This may be repeated for multiple renames.
8760: The new package would be an exact replacement.
8761: </p>
1.23 wiz 8762: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 8763: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8764: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8765: not be an exact replacement but is a suggestion for the replaced
8766: functionality.</p>
8767: </div>
1.41 asau 8768: <div class="sect1">
1.20 snj 8769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8770: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
8771: <p>It is preferred that packages are not renamed or moved, but if needed
8772: please follow these steps.
8773: </p>
1.23 wiz 8774: <div class="orderedlist"><ol class="orderedlist" type="1">
8775: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8776: <li class="listitem">
1.1 dsieger 8777: <p>Remove all CVS dirs.</p>
8778: <p>Alternatively to the first two steps you can also do:</p>
8779: <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>
8780: <p>and use that for further work.</p>
8781: </li>
1.23 wiz 8782: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8783: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8784: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8785: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 8786: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8787: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8788: for doing an update using pkgsrc building; for example, it can
1.79 snj 8789: 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 8790: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8791: new <code class="varname">PKGPATH</code> for that moved package. Note that
8792: it may have multiple matches, so the tool should also check on the
8793: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8794: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8795: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 8796: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 8797: place.</p></li>
1.23 wiz 8798: <li class="listitem">
1.1 dsieger 8799: <p>Check if any package depends on it:
8800: </p>
8801: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8802: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8803: </li>
1.23 wiz 8804: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8805: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8806: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8807: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8808: <li class="listitem">
1.1 dsieger 8809: <p>Commit the changed and removed files:</p>
8810: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
8811: <p>(and any packages from step 5, of course).</p>
8812: </li>
8813: </ol></div>
8814: </div>
8815: </div>
1.41 asau 8816: <div class="chapter">
1.1 dsieger 8817: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8818: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 8819: <p>This section contains the answers to questions that may
8820: arise when you are writing a package. If you don't find your
8821: question answered here, first have a look in the other chapters,
8822: and if you still don't have the answer, ask on the
8823: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 8824: <div class="qandaset">
1.116 ! wiz 8825: <a name="idm81083920"></a><dl>
1.6 rillig 8826: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 8827: MAKEFLAGS, .MAKEFLAGS and
8828: MAKE_FLAGS?</a>
8829: </dt>
1.6 rillig 8830: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 8831: MAKE, GMAKE and
8832: MAKE_PROGRAM?</a>
8833: </dt>
1.6 rillig 8834: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 8835: CC, PKG_CC and
8836: PKGSRC_COMPILER?</a>
8837: </dt>
1.6 rillig 8838: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 8839: BUILDLINK_LDFLAGS,
8840: BUILDLINK_LDADD and
8841: BUILDLINK_LIBS?</a>
8842: </dt>
1.6 rillig 8843: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 8844: VARNAME=BUILDLINK_PREFIX.foo
8845: say it's empty?</a>
8846: </dt>
1.6 rillig 8847: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 8848: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
8849: don't understand the := inside
8850: it.</a>
8851: </dt>
1.6 rillig 8852: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 8853: developers?</a>
8854: </dt>
1.6 rillig 8855: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 8856: documentation?</a>
8857: </dt>
1.6 rillig 8858: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 8859: do?</a>
8860: </dt>
8861: </dl>
1.41 asau 8862: <table border="0" style="width: 100%;">
8863: <colgroup>
1.1 dsieger 8864: <col align="left" width="1%">
1.23 wiz 8865: <col>
1.41 asau 8866: </colgroup>
1.1 dsieger 8867: <tbody>
1.41 asau 8868: <tr class="question">
1.1 dsieger 8869: <td align="left" valign="top">
1.116 ! wiz 8870: <a name="devfaq.makeflags"></a><a name="idm81083536"></a><p><b>22.1.</b></p>
1.1 dsieger 8871: </td>
8872: <td align="left" valign="top"><p>What is the difference between
8873: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
8874: <code class="varname">MAKE_FLAGS</code>?</p></td>
8875: </tr>
8876: <tr class="answer">
8877: <td align="left" valign="top"></td>
8878: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.79 snj 8879: 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 8880: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
8881: the <code class="varname">MAKE_PROGRAM</code> when building the
8882: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
8883: </tr>
1.41 asau 8884: <tr class="question">
1.1 dsieger 8885: <td align="left" valign="top">
1.116 ! wiz 8886: <a name="devfaq.make"></a><a name="idm81079440"></a><p><b>22.2.</b></p>
1.1 dsieger 8887: </td>
8888: <td align="left" valign="top"><p>What is the difference between
8889: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
8890: <code class="varname">MAKE_PROGRAM</code>?</p></td>
8891: </tr>
8892: <tr class="answer">
8893: <td align="left" valign="top"></td>
8894: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.79 snj 8895: <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 8896: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
8897: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
8898: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
8899: Make program that is used for building the
8900: package.</p></td>
8901: </tr>
1.41 asau 8902: <tr class="question">
1.1 dsieger 8903: <td align="left" valign="top">
1.116 ! wiz 8904: <a name="devfaq.cc"></a><a name="idm81075088"></a><p><b>22.3.</b></p>
1.1 dsieger 8905: </td>
8906: <td align="left" valign="top"><p>What is the difference between
8907: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
8908: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
8909: </tr>
8910: <tr class="answer">
8911: <td align="left" valign="top"></td>
8912: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
8913: compiler, which can be configured by the pkgsrc user.
8914: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
8915: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
8916: path to a compiler, but the type of compiler that should be
8917: used. See <code class="filename">mk/compiler.mk</code> for more
8918: information about the latter variable.</p></td>
8919: </tr>
1.41 asau 8920: <tr class="question">
1.1 dsieger 8921: <td align="left" valign="top">
1.116 ! wiz 8922: <a name="devfaq.bl3flags"></a><a name="idm81070864"></a><p><b>22.4.</b></p>
1.1 dsieger 8923: </td>
8924: <td align="left" valign="top"><p>What is the difference between
8925: <code class="varname">BUILDLINK_LDFLAGS</code>,
8926: <code class="varname">BUILDLINK_LDADD</code> and
8927: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
8928: </tr>
8929: <tr class="answer">
8930: <td align="left" valign="top"></td>
8931: <td align="left" valign="top"><p>[FIXME]</p></td>
8932: </tr>
1.41 asau 8933: <tr class="question">
1.1 dsieger 8934: <td align="left" valign="top">
1.116 ! wiz 8935: <a name="devfaq.bl3prefix"></a><a name="idm81068688"></a><p><b>22.5.</b></p>
1.1 dsieger 8936: </td>
1.10 hubertf 8937: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 8938: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
8939: say it's empty?</p></td>
8940: </tr>
8941: <tr class="answer">
8942: <td align="left" valign="top"></td>
8943: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 8944: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
8945: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 8946: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 8947: command.</p></td>
8948: </tr>
1.41 asau 8949: <tr class="question">
1.1 dsieger 8950: <td align="left" valign="top">
1.116 ! wiz 8951: <a name="devfaq.master_sites"></a><a name="idm81065616"></a><p><b>22.6.</b></p>
1.1 dsieger 8952: </td>
8953: <td align="left" valign="top"><p>What does
1.108 rillig 8954: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
8955: don't understand the <code class="code">:=</code> inside
1.1 dsieger 8956: it.</p></td>
8957: </tr>
8958: <tr class="answer">
8959: <td align="left" valign="top"></td>
1.108 rillig 8960: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
8961: assignment operator, although it looks like it.
1.1 dsieger 8962: Instead, it is a degenerate form of
1.108 rillig 8963: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
8964: 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
8965: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 8966: case of <code class="varname">MASTER_SITE_*</code>,
8967: <em class="replaceable"><code>old_string</code></em> is the empty string and
8968: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 8969: <code class="code">package/</code>. That's where the
8970: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 8971: together.</p></td>
8972: </tr>
1.41 asau 8973: <tr class="question">
1.1 dsieger 8974: <td align="left" valign="top">
1.116 ! wiz 8975: <a name="devfaq.mailinglists"></a><a name="idm81058704"></a><p><b>22.7.</b></p>
1.1 dsieger 8976: </td>
8977: <td align="left" valign="top"><p>Which mailing lists are there for package
8978: developers?</p></td>
8979: </tr>
8980: <tr class="answer">
8981: <td align="left" valign="top"></td>
1.41 asau 8982: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 8983: <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 8984: <dd><p>This is a list for technical discussions related
8985: to pkgsrc development, e.g. soliciting feedback for changes to
8986: pkgsrc infrastructure, proposed new features, questions related
8987: to porting pkgsrc to a new platform, advice for maintaining a
8988: package, patches that affect many packages, help requests moved
8989: from pkgsrc-users when an infrastructure bug is found,
8990: etc.</p></dd>
1.10 hubertf 8991: <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 8992: <dd><p>All bug reports in category "pkg" sent with
1.79 snj 8993: <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 8994: directly; use one of the other mailing
8995: lists.</p></dd>
8996: </dl></div></td>
8997: </tr>
1.41 asau 8998: <tr class="question">
1.1 dsieger 8999: <td align="left" valign="top">
1.116 ! wiz 9000: <a name="devfaq.documentation"></a><a name="idm81054864"></a><p><b>22.8.</b></p>
1.1 dsieger 9001: </td>
9002: <td align="left" valign="top"><p>Where is the pkgsrc
9003: documentation?</p></td>
9004: </tr>
9005: <tr class="answer">
9006: <td align="left" valign="top"></td>
9007: <td align="left" valign="top">
9008: <p>There are many places where you can find
9009: documentation about pkgsrc:</p>
1.41 asau 9010: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9011: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9012: of chapters that explain large parts of pkgsrc, but some
9013: chapters tend to be outdated. Which ones they are is hard to
9014: say.</p></li>
1.23 wiz 9015: <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 9016: about certain features, announcements of new parts of the pkgsrc
9017: infrastructure and sometimes even announcements that a certain
9018: feature has been marked as obsolete. The benefit here is that
9019: each message has a date appended to it.</p></li>
1.23 wiz 9020: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9021: <code class="filename">mk/</code> directory start with a comment that
9022: describes the purpose of the file and how it can be used by the
9023: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9024: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9025: help</strong></span>.</p></li>
1.23 wiz 9026: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9027: information, but they tend to be highly abbreviated, especially
9028: for actions that occur often. Some contain a detailed
9029: description of what has changed, but they are geared towards the
9030: other pkgsrc developers, not towards an average pkgsrc user.
9031: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9032: don't know what has been before, these messages may not be worth
9033: too much to you.</p></li>
1.23 wiz 9034: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9035: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9036: mind of the developer who wrote the code. To get this
1.10 hubertf 9037: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9038: to see who has written it and ask on the
9039: <code class="literal">tech-pkg</code> mailing list, so that others can
9040: find your questions later (see above). To be sure that the
9041: developer in charge reads the mail, you may CC him or
9042: her.</p></li>
9043: </ul></div>
9044: </td>
9045: </tr>
1.41 asau 9046: <tr class="question">
1.1 dsieger 9047: <td align="left" valign="top">
1.116 ! wiz 9048: <a name="devfaq.too-much-time"></a><a name="idm81048336"></a><p><b>22.9.</b></p>
1.1 dsieger 9049: </td>
9050: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9051: do?</p></td>
9052: </tr>
9053: <tr class="answer">
9054: <td align="left" valign="top"></td>
9055: <td align="left" valign="top">
9056: <p>This is not really an FAQ yet, but here's the answer
9057: anyway.</p>
1.41 asau 9058: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9059: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.79 snj 9060: <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 9061: will tell you about newer versions of installed packages that are
9062: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9063: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9064: — it contains a list of suggested new packages and a list of
1.1 dsieger 9065: cleanups and enhancements for pkgsrc that would be nice to
9066: have.</p></li>
1.23 wiz 9067: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9068: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9069: mailing list.</p></li>
9070: </ul></div>
9071: </td>
9072: </tr>
9073: </tbody>
9074: </table>
9075: </div>
9076: </div>
1.41 asau 9077: <div class="chapter">
1.1 dsieger 9078: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9079: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9080: <div class="toc">
9081: <p><b>Table of Contents</b></p>
1.100 leot 9082: <dl class="toc">
1.6 rillig 9083: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9084: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9085: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9086: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9087: </dl>
9088: </div>
1.10 hubertf 9089: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9090: site</a>:</p>
9091: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9092: environment, an intuitive and attractive desktop for users, and the
9093: GNOME development platform, an extensive framework for building
9094: applications that integrate into the rest of the desktop.</p></blockquote></div>
9095: <p>pkgsrc provides a seamless way to automatically build and install
9096: a complete GNOME environment <span class="emphasis"><em>under many different
9097: platforms</em></span>. We can say with confidence that pkgsrc is one of
9098: the most advanced build and packaging systems for GNOME due to its
9099: included technologies buildlink3, the wrappers and tools framework and
9100: automatic configuration file management. Lots of efforts are put into
9101: achieving a completely clean deinstallation of installed software
9102: components.</p>
1.10 hubertf 9103: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9104: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9105: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9106: pkgsrc as its preferred packaging system, contributing lots of
9107: portability fixes to make GNOME build and install under it.</p>
9108: <p>This chapter is aimed at pkgsrc developers and other people
9109: interested in helping our GNOME porting and packaging efforts. It
9110: provides instructions on how to manage the existing packages and some
9111: important information regarding their internals.</p>
1.41 asau 9112: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9113: <h3 class="title">We need your help!</h3>
9114: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9115: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9116: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9117: work</a> list! There is still a long way to go to get a
9118: fully-functional GNOME desktop under NetBSD and we need your help to
9119: achieve it!</p>
9120: </div>
1.41 asau 9121: <div class="sect1">
1.1 dsieger 9122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9123: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9124: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9125: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 9126: <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 9127: the core GNOME desktop environment. It only includes the necessary
9128: bits to get it to boot correctly, although it may lack important
9129: functionality for daily operation. The idea behind this package is
9130: to let end users build their own configurations on top of this one,
9131: first installing this meta package to achieve a functional setup and
9132: then adding individual applications.</p></li>
1.79 snj 9133: <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 9134: complete installation of the GNOME platform and desktop as defined
9135: by the GNOME project; this is based on the components distributed in
9136: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9137: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9138: official FTP server. Developer-only tools found in those
9139: directories are not installed unless required by some other
9140: component to work properly. Similarly, packages from the bindings
9141: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9142: in unless required as a dependency for an end-user component. This
1.79 snj 9143: 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>
9144: <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 9145: Installs all the tools required to build a GNOME component when
9146: fetched from the CVS repository. These are required to let the
1.10 hubertf 9147: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9148: </ul></div>
9149: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9150: sorted in a way that eases updates: a package may depend on other
9151: packages listed before it but not on any listed after it. It is very
9152: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9153: change it to alphabetical sorting!</em></span></p>
9154: </div>
1.41 asau 9155: <div class="sect1">
1.1 dsieger 9156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9157: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9158: <p>Almost all GNOME applications are written in C and use a common
9159: set of tools as their build system. Things get different with the new
9160: bindings to other languages (such as Python), but the following will
9161: give you a general idea on the minimum required tools:</p>
1.41 asau 9162: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9163: <li class="listitem">
1.1 dsieger 9164: <p>Almost all GNOME applications use the GNU Autotools as their
9165: build system. As a general rule you will need to tell this to your
9166: package:</p>
9167: <pre class="programlisting">
9168: GNU_CONFIGURE=yes
9169: USE_LIBTOOL=yes
9170: USE_TOOLS+=gmake
9171: </pre>
9172: </li>
1.23 wiz 9173: <li class="listitem">
1.1 dsieger 9174: <p>If the package uses pkg-config to detect dependencies, add this
9175: tool to the list of required utilities:</p>
1.111 sevan 9176: <pre class="programlisting">
9177: USE_TOOLS+=pkg-config
9178: </pre>
1.79 snj 9179: <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 9180: the end of the build process to ensure that you did not miss to
9181: specify any dependency in your package and that the version
9182: requirements are all correct.</p>
9183: </li>
1.23 wiz 9184: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9185: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9186: to handle dependencies and to force the package to use the latest
9187: available version.</p></li>
1.23 wiz 9188: <li class="listitem">
1.1 dsieger 9189: <p>If the package uses gtk-doc (a documentation generation
9190: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9191: tool is rather big and the distfile should come with pregenerated
9192: documentation anyway; if it does not, it is a bug that you ought to
9193: report. For such packages you should disable gtk-doc (unless it is
9194: the default):</p>
1.111 sevan 9195: <pre class="programlisting">
9196: CONFIGURE_ARGS+=--disable-gtk-doc
9197: </pre>
1.1 dsieger 9198: <p>The default location of installed HTML files
9199: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9200: and should not be changed unless the package insists on installing
9201: them somewhere else. Otherwise programs as
1.10 hubertf 9202: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9203: do that with an entry similar to:</p>
1.111 sevan 9204: <pre class="programlisting">
9205: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9206: </pre>
1.1 dsieger 9207: </li>
9208: </ul></div>
9209: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9210: files under the installation prefix to maintain databases. In this
9211: context, shared means that those exact same directories and files are
9212: used among several different packages, leading to conflicts in the
9213: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9214: handle the most common cases, so you have to forget about using
9215: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9216: omitting shared files from them. If you find yourself doing those,
9217: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9218: <p>The following table lists the common situations that result in
9219: using shared directories or files. For each of them, the appropriate
9220: solution is given. After applying the solution be sure to
9221: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9222: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9223: <div class="table">
1.6 rillig 9224: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9225: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9226: <colgroup>
9227: <col>
9228: <col>
9229: </colgroup>
9230: <thead><tr>
9231: <th>If the package...</th>
9232: <th>Then...</th>
9233: </tr></thead>
9234: <tbody>
9235: <tr>
9236: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9237: <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 9238: </tr>
9239: <tr>
9240: <td>Installs icons under the
9241: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9242: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9243: <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 9244: </tr>
9245: <tr>
9246: <td>Installs files under
9247: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9248: <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 9249: </tr>
9250: <tr>
9251: <td>Installs <code class="filename">.desktop</code> files under
9252: <code class="filename">share/applications</code> and these include MIME
9253: information.</td>
1.10 hubertf 9254: <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 9255: </tr>
9256: </tbody>
9257: </table></div>
9258: </div>
9259: <br class="table-break">
9260: </div>
1.41 asau 9261: <div class="sect1">
1.1 dsieger 9262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9263: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9264: <p>When seeing GNOME as a whole, there are two kinds of
9265: updates:</p>
1.41 asau 9266: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9267: <dt><span class="term">Major update</span></dt>
9268: <dd>
9269: <p>Given that there is still a very long way for GNOME 3 (if it
9270: ever appears), we consider a major update one that goes from a
9271: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9272: where <code class="literal">Y</code> is even and greater than
9273: <code class="literal">X</code>. These are hard to achieve because they
9274: introduce lots of changes in the components' code and almost all
9275: GNOME distfiles are updated to newer versions. Some of them can
9276: even break API and ABI compatibility with the previous major
9277: version series. As a result, the update needs to be done all at
9278: once to minimize breakage.</p>
9279: <p>A major update typically consists of around 80 package
9280: updates and the addition of some new ones.</p>
9281: </dd>
9282: <dt><span class="term">Minor update</span></dt>
9283: <dd>
9284: <p>We consider a minor update one that goes from a
9285: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9286: one where <code class="literal">Y</code> is greater than
9287: <code class="literal">X</code>. These are easy to achieve because they do
9288: not update all GNOME components, can be done in an incremental way
9289: and do not break API nor ABI compatibility.</p>
9290: <p>A minor update typically consists of around 50 package
9291: updates, although the numbers here may vary a lot.</p>
9292: </dd>
9293: </dl></div>
9294: <p>In order to update the GNOME components in pkgsrc to a new stable
9295: release (either major or minor), the following steps should be
9296: followed:</p>
1.23 wiz 9297: <div class="orderedlist"><ol class="orderedlist" type="1">
9298: <li class="listitem">
1.1 dsieger 9299: <p>Get a list of all the tarballs that form the new release by
9300: using the following commands. These will leave the full list of the
1.18 snj 9301: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9302: file:</p>
9303: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9304: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9305: awk '{ print $9 }' >list.txt</code></strong>
9306: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9307: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9308: awk '{ print $9 }' >>list.txt</code></strong></pre>
9309: </li>
1.23 wiz 9310: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9311: bump their version to the release you are updating them to. The
9312: three meta packages should be always consistent with versioning.
9313: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9314: in them.</p></li>
1.23 wiz 9315: <li class="listitem">
1.1 dsieger 9316: <p>For each meta package, update all its
9317: <code class="varname">DEPENDS</code> lines to match the latest versions as
9318: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9319: newer version (even if found in the FTP) because the meta packages
9320: are supposed to list the exact versions that form a specific GNOME
9321: release. Exceptions are permitted here if a newer version solves a
9322: serious issue in the overall desktop experience; these typically
9323: come in the form of a revision bump in pkgsrc, not in newer versions
9324: from the developers.</p>
9325: <p>Packages not listed in the <code class="filename">list.txt</code> file
9326: should be updated to the latest version available (if found in
9327: pkgsrc). This is the case, for example, of the dependencies on the
1.79 snj 9328: 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 9329: </li>
1.23 wiz 9330: <li class="listitem">
1.1 dsieger 9331: <p>Generate a patch from the modified meta packages and extract the
9332: list of "new" lines. This will provide you an outline on what
9333: packages need to be updated in pkgsrc and in what order:</p>
9334: <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>
9335: </li>
1.23 wiz 9336: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9337: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9338: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9339: of <code class="filename">todo.txt</code> and update the packages listed in
9340: it in order. For major desktop updates none of these should be
9341: committed until the entire set is completed because there are chances
9342: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9343: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9344: the tree one by one with appropriate log messages. At the end,
9345: commit the three meta package updates and all the corresponding
9346: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9347: <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>
9348: </ol></div>
9349: </div>
1.41 asau 9350: <div class="sect1">
1.1 dsieger 9351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9352: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9353: <p>GNOME is a very big component in pkgsrc which approaches 100
9354: packages. Please, it is very important that you always, always,
9355: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9356: 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 9357: their attention on portability issues and to ensure that future versions
9358: can be built out-of-the box on NetBSD. The less custom patches in
9359: pkgsrc, the easier further updates are. Those developers in charge of
9360: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9361: <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 9362: Bugzilla</a>. Not all components use these to track bugs, but most
9363: of them do. Do not be short on your reports: always provide detailed
9364: explanations of the current failure, how it can be improved to achieve
9365: maximum portability and, if at all possible, provide a patch against CVS
9366: head. The more verbose you are, the higher chances of your patch being
9367: accepted.</p>
9368: <p>Also, please avoid using preprocessor magic to fix portability
9369: issues. While the FreeBSD GNOME people are doing a great job in porting
9370: GNOME to their operating system, the official GNOME sources are now
9371: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9372: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 9373: 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 9374: details.</p>
9375: </div>
9376: </div>
9377: </div>
1.41 asau 9378: <div class="part">
1.1 dsieger 9379: <div class="titlepage"><div><div><h1 class="title">
9380: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9381: <div class="partintro">
1.1 dsieger 9382: <div></div>
9383: <p>This part of the guide deals with everything
9384: from the infrastructure that is behind the interfaces described
9385: in the developer's guide. A casual package maintainer should not
9386: need anything from this part.</p>
9387: <div class="toc">
9388: <p><b>Table of Contents</b></p>
1.100 leot 9389: <dl class="toc">
1.6 rillig 9390: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9391: <dd><dl>
1.6 rillig 9392: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9393: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9394: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9395: <dd><dl>
1.6 rillig 9396: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9397: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9398: </dl></dd>
1.6 rillig 9399: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9400: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9401: <dd><dl>
1.6 rillig 9402: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9403: <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 9404: </dl></dd>
1.6 rillig 9405: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9406: <dd><dl>
1.23 wiz 9407: <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>
9408: <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 9409: </dl></dd>
9410: </dl></dd>
1.6 rillig 9411: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 9412: <dd><dl>
1.108 rillig 9413: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9414: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9415: <dd><dl>
1.108 rillig 9416: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9417: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9418: </dl></dd>
9419: </dl></dd>
1.6 rillig 9420: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 9421: <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 9422: </dl>
9423: </div>
9424: </div>
1.41 asau 9425: <div class="chapter">
1.1 dsieger 9426: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9427: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9428: <div class="toc">
9429: <p><b>Table of Contents</b></p>
1.100 leot 9430: <dl class="toc">
1.6 rillig 9431: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9432: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9433: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9434: <dd><dl>
1.6 rillig 9435: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9436: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9437: </dl></dd>
1.6 rillig 9438: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9439: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9440: <dd><dl>
1.6 rillig 9441: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9442: <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 9443: </dl></dd>
1.6 rillig 9444: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9445: <dd><dl>
1.23 wiz 9446: <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>
9447: <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 9448: </dl></dd>
9449: </dl>
9450: </div>
9451: <p>The pkgsrc infrastructure consists of many small Makefile
9452: fragments. Each such fragment needs a properly specified
9453: interface. This chapter explains how such an interface looks
9454: like.</p>
1.41 asau 9455: <div class="sect1">
1.1 dsieger 9456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9457: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9458: <p>Whenever a variable is defined in the pkgsrc
9459: infrastructure, the location and the way of definition provide
9460: much information about the intended use of that variable.
9461: Additionally, more documentation may be found in a header
9462: comment or in this pkgsrc guide.</p>
9463: <p>A special file is
9464: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9465: variables that are intended to be user-defined. They are either
9466: defined using the <code class="literal">?=</code> operator or they are
9467: left undefined because defining them to anything would
1.23 wiz 9468: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9469: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9470: file.</p>
9471: <p>Outside this file, the following conventions apply:
9472: Variables that are defined using the <code class="literal">?=</code>
9473: operator may be overridden by a package.</p>
9474: <p>Variables that are defined using the <code class="literal">=</code>
9475: operator may be used read-only at run-time.</p>
9476: <p>Variables whose name starts with an underscore must not be
9477: accessed outside the pkgsrc infrastructure at all. They may
9478: change without further notice.</p>
1.41 asau 9479: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9480: <h3 class="title">Note</h3>
9481: <p>These conventions are currently not applied
9482: consistently to the complete pkgsrc
9483: infrastructure.</p>
9484: </div>
9485: </div>
1.41 asau 9486: <div class="sect1">
1.1 dsieger 9487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9488: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9489: <p>All variables that contain lists of things should default
9490: to being empty. Two examples that do not follow this rule are
9491: <code class="varname">USE_LANGUAGES</code> and
9492: <code class="varname">DISTFILES</code>. These variables cannot simply be
9493: modified using the <code class="literal">+=</code> operator in package
9494: <code class="filename">Makefile</code>s (or other files included by
9495: them), since there is no guarantee whether the variable is
9496: already set or not, and what its value is. In the case of
1.23 wiz 9497: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9498: the default value and just define it as in the following
9499: example.</p>
9500: <pre class="programlisting">
9501: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9502: </pre>
9503: <p>Because of the selection of this default value, the same
9504: value appears in many package Makefiles. Similarly for
9505: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9506: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9507: doesn't stand out. Nevertheless it is mentioned in many
9508: files.</p>
9509: </div>
1.41 asau 9510: <div class="sect1">
1.1 dsieger 9511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9512: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 9513: <div class="sect2">
1.1 dsieger 9514: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9515: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 9516: <p>Variable evaluation takes place either at load time or at
9517: runtime, depending on the context in which they occur. The
9518: contexts where variables are evaluated at load time are:</p>
1.41 asau 9519: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9520: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9521: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9522: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9523: <code class="literal">.for</code>,</p></li>
1.23 wiz 9524: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9525: </ul></div>
9526: <p>A special exception are references to the iteration
9527: variables of <code class="literal">.for</code> loops, which are expanded
9528: inline, no matter in which context they appear.</p>
9529: <p>As the values of variables may change during load time,
9530: care must be taken not to evaluate them by accident. Typical
9531: examples for variables that should not be evaluated at load time
9532: are <code class="varname">DEPENDS</code> and
9533: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9534: clear, here is an example:</p>
9535: <pre class="programlisting">
9536: CONFIGURE_ARGS= # none
9537: CFLAGS= -O
9538: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9539:
9540: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9541:
9542: CFLAGS+= -Wall
1.111 sevan 9543: </pre>
1.1 dsieger 9544: <p>This code shows how the use of the <code class="literal">:=</code>
9545: operator can quickly lead to unexpected results. The first
9546: paragraph is fairly common code. The second paragraph evaluates
9547: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9548: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9549: <code class="literal">-Wall</code> is appended to the
9550: <code class="varname">CFLAGS</code>, but this addition will not appear in
9551: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9552: paragraphs from above typically occur in completely unrelated
9553: files.</p>
9554: </div>
1.41 asau 9555: <div class="sect2">
1.1 dsieger 9556: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9557: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9558: <p>After all the files have been loaded, the values of the
9559: variables cannot be changed anymore. Variables that are used in
9560: the shell commands are expanded at this point.</p>
9561: </div>
9562: </div>
1.41 asau 9563: <div class="sect1">
1.1 dsieger 9564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9565: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9566: <p>There are many ways in which the definition and use of a
1.108 rillig 9567: variable can be restricted in order to detect bugs and violations
9568: of the (mostly unwritten) policies. A package can be checked with
9569: <code class="literal">pkglint -Wall</code> to see whether it meets these
9570: rules.</p>
1.1 dsieger 9571: </div>
1.41 asau 9572: <div class="sect1">
1.1 dsieger 9573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9574: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9575: <p>Most of the <code class="filename">.mk</code> files fall into one
9576: of the following classes. Cases where a file falls into more
9577: than one class should be avoided as it often leads to subtle
9578: bugs.</p>
1.41 asau 9579: <div class="sect2">
1.1 dsieger 9580: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9581: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9582: <p>In a traditional imperative programming language some of
9583: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9584: procedures. They take some input parameters and—after
9585: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9586: variables in <code class="filename">Makefile</code>s have global scope
9587: care must be taken not to use parameter names that have already
9588: another meaning. For example, <code class="varname">PKGNAME</code> is a
9589: bad choice for a parameter name.</p>
9590: <p>Procedures are completely evaluated at preprocessing time.
9591: That is, when calling a procedure all input parameters must be
9592: completely resolvable. For example,
9593: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9594: parameter since it is very likely that further text will be
9595: added after calling the procedure, which would effectively apply
9596: the procedure to only a part of the variable. Also, references
1.108 rillig 9597: to other variables will be modified after calling the
1.1 dsieger 9598: procedure.</p>
9599: <p>A procedure can declare its output parameters either as
9600: suitable for use in preprocessing directives or as only
9601: available at runtime. The latter alternative is for variables
9602: that contain references to other runtime variables.</p>
9603: <p>Procedures shall be written such that it is possible to
9604: call the procedure more than once. That is, the file must not
9605: contain multiple-inclusion guards.</p>
9606: <p>Examples for procedures are
9607: <code class="filename">mk/bsd.options.mk</code> and
9608: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9609: that the parameters are evaluated at load time, they should be
9610: assigned using the <code class="literal">:=</code> operator, which should
9611: be used only for this purpose.</p>
9612: </div>
1.41 asau 9613: <div class="sect2">
1.1 dsieger 9614: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9615: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9616: <p>Action files take some input parameters and may define
9617: runtime variables. They shall not define loadtime variables.
9618: There are action files that are included implicitly by the
9619: pkgsrc infrastructure, while other must be included
9620: explicitly.</p>
9621: <p>An example for action files is
9622: <code class="filename">mk/subst.mk</code>.</p>
9623: </div>
9624: </div>
1.41 asau 9625: <div class="sect1">
1.1 dsieger 9626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9627: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 9628: <p>Package <code class="filename">Makefile</code>s usually consist of
9629: a set of variable definitions, and include the file
9630: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9631: Before that, they may also include various other
9632: <code class="filename">*.mk</code> files if they need to query the
9633: availability of certain features like the type of compiler or
9634: the X11 implementation. Due to the heavy use of preprocessor
9635: directives like <code class="literal">.if</code> and
9636: <code class="literal">.for</code>, the order in which the files are loaded
9637: matters.</p>
9638: <p>This section describes at which point the various files
9639: are loaded and gives reasons for that order.</p>
1.41 asau 9640: <div class="sect2">
1.1 dsieger 9641: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9642: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 9643: </h3></div></div></div>
9644: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
9645: is to define some essential variables like
9646: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9647: <code class="varname">MACHINE_ARCH</code>.</p>
9648: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 9649: 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 9650: After that, those variables
1.1 dsieger 9651: that have not been overridden by the user are loaded from
9652: <code class="filename">mk/defaults/mk.conf</code>.</p>
9653: <p>After the user settings, the system settings and platform
9654: settings are loaded, which may override the user
9655: settings.</p>
9656: <p>Then, the tool definitions are loaded. The tool wrappers
9657: are not yet in effect. This only happens when building a
9658: package, so the proper variables must be used instead of the
9659: direct tool names.</p>
9660: <p>As the last steps, some essential variables from the
9661: wrapper and the package system flavor are loaded, as well as the
9662: variables that have been cached in earlier phases of a package
9663: build.</p>
9664: </div>
1.41 asau 9665: <div class="sect2">
1.1 dsieger 9666: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9667: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 9668: </h3></div></div></div>
9669: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9670: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9671: loaded, which fill default values for those variables that have
9672: not been defined by the package. These variables may later
9673: be used even in unrelated files.</p>
9674: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9675: provides the target <code class="literal">error-check</code> that is added
9676: as a special dependency to all other targets that use
9677: <code class="varname">DELAYED_ERROR_MSG</code> or
9678: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9679: <p>Then, the package-specific hacks from
9680: <code class="filename">hacks.mk</code> are included.</p>
9681: <p>Then, various other files follow. Most of them don't have
9682: any dependencies on what they need to have included before or
9683: after them, though some do.</p>
9684: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9685: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9686: restricts the use of these variables to all the files that have
9687: been included before. Appearances in later files will be
9688: silently ignored.</p>
9689: <p>Then, the files for the main targets are included, in the
9690: order of later execution, though the actual order should not
9691: matter.</p>
9692: <p>At last, some more files are included that don't set any
9693: interesting variables but rather just define make targets to be
9694: executed.</p>
9695: </div>
9696: </div>
9697: </div>
1.41 asau 9698: <div class="chapter">
1.1 dsieger 9699: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9700: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 9701: <div class="toc">
9702: <p><b>Table of Contents</b></p>
1.100 leot 9703: <dl class="toc">
1.108 rillig 9704: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9705: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9706: <dd><dl>
1.108 rillig 9707: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9708: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9709: </dl></dd>
9710: </dl>
9711: </div>
9712: <p>The pkgsrc infrastructure consists of a large codebase,
9713: and there are many corners where every little bit of a file is
9714: well thought out, making pkgsrc likely to fail as soon as
9715: anything is changed near those parts. To prevent most changes
9716: from breaking anything, a suite of regression tests should go
9717: along with every important part of the pkgsrc infrastructure.
9718: This chapter describes how regression tests work in pkgsrc and
9719: how you can add new tests.</p>
1.41 asau 9720: <div class="sect1">
1.1 dsieger 9721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9722: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.79 snj 9723: <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 9724: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 9725: can simply run that command, which will run all tests in the
9726: <code class="filename">regress</code> category.</p>
9727: </div>
1.41 asau 9728: <div class="sect1">
1.1 dsieger 9729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9730: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.1 dsieger 9731: <p>Every directory in the <code class="filename">regress</code>
9732: category that contains a file called <code class="filename">spec</code>
9733: is considered a regression test. This file is a shell program
1.10 hubertf 9734: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 9735: The following functions can be overridden to suit your
9736: needs.</p>
1.41 asau 9737: <div class="sect2">
1.1 dsieger 9738: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9739: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
9740: <p>These functions do not take any parameters. Although they
9741: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9742: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9743: question</a> for details.</p>
1.41 asau 9744: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9745: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 9746: <dd><p>This function prepares the environment for the
9747: test. By default it does nothing.</p></dd>
1.108 rillig 9748: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9749: <dd>
9750: <p>This function runs the actual test. By default,
1.1 dsieger 9751: it calls <code class="varname">TEST_MAKE</code> with the arguments
9752: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9753: error messages into the file
1.108 rillig 9754: <code class="varname">TEST_OUTFILE</code>.</p>
9755: <p>When defining this function, make sure that all output that
9756: needs to be checked is written to the correct output file.
9757: Example:</p>
9758: <pre class="programlisting">
9759: do_test() {
1.112 rillig 9760: echo "Example output"
1.108 rillig 9761: } 1>$TEST_OUTFILE 2>&1
9762: </pre>
9763: </dd>
9764: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9765: <dd>
9766: <p>This function is run after the test and is
1.1 dsieger 9767: typically used to compare the actual output from the one that is
9768: expected. It can make use of the various helper functions from
1.108 rillig 9769: the next section. Example:</p>
9770: <pre class="programlisting">
9771: check_result() {
1.112 rillig 9772: exit_status 0
9773: output_require "Example"
9774: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9775: output_prohibit "no such file or directory"
1.108 rillig 9776: }
9777: </pre>
9778: </dd>
9779: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 9780: <dd><p>This function cleans everything up after the
9781: test has been run. By default it does nothing.</p></dd>
9782: </dl></div>
9783: </div>
1.41 asau 9784: <div class="sect2">
1.1 dsieger 9785: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9786: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.41 asau 9787: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9788: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 9789: <dd><p>This function compares the exitcode of the
1.108 rillig 9790: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 9791: If they differ, the test will fail.</p></dd>
1.108 rillig 9792: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9793: <dd>
9794: <p>This function checks for each of its parameters
9795: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 9796: extended regular expression. If it does not, the test will
1.108 rillig 9797: fail. Example:</p>
9798: <pre class="programlisting">
9799: output_require "looks fine"
9800: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9801: </pre>
9802: </dd>
1.1 dsieger 9803: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9804: <dd><p>This function checks for each of its parameters
1.10 hubertf 9805: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 9806: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9807: If any of the regular expressions matches, the test will
9808: fail.</p></dd>
9809: </dl></div>
9810: </div>
9811: </div>
9812: </div>
1.41 asau 9813: <div class="chapter">
1.1 dsieger 9814: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9815: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 9816: <div class="toc">
9817: <p><b>Table of Contents</b></p>
1.108 rillig 9818: <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 9819: </div>
9820: <p>The pkgsrc system has already been ported to many
9821: operating systems, hardware architectures and compilers. This
9822: chapter explains the necessary steps to make pkgsrc even more
9823: portable.</p>
1.41 asau 9824: <div class="sect1">
1.1 dsieger 9825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9826: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 9827: <p>To port pkgsrc to a new operating system (called
9828: <code class="literal">MyOS</code> in this example), you need to touch the
9829: following files:</p>
1.41 asau 9830: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9831: <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>
9832: <dd><p>This file contains some basic definitions, for
9833: example the name of the C
9834: compiler.</p></dd>
9835: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
9836: <dd><p>Insert code that defines the variables
9837: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
9838: <code class="varname">LOWER_OS_VERSION</code>,
9839: <code class="varname">LOWER_VENDOR</code>,
9840: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
9841: <code class="varname">APPEND_ELF</code>, and the other variables that
9842: appear in this file.</p></dd>
9843: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9844: <dd><p>This file contains the platform-specific
9845: definitions that are used by pkgsrc. Start by copying one of the
9846: other files and edit it to your
9847: needs.</p></dd>
9848: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9849: <dd><p>This file defines the paths to all the tools
9850: that are needed by one or the other package in pkgsrc, as well
9851: as by pkgsrc itself. Find out where these tools are on your
9852: platform and add them.</p></dd>
9853: </dl></div>
9854: <p>Now, you should be able to build some basic packages, like
1.79 snj 9855: <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 9856: </div>
9857: </div>
9858: </div>
1.41 asau 9859: <div class="appendix">
9860: <div class="titlepage"><div><div><h1 class="title">
9861: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 9862: <div class="toc">
9863: <p><b>Table of Contents</b></p>
1.100 leot 9864: <dl class="toc">
1.1 dsieger 9865: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
9866: <dd><dl>
9867: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
9868: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
9869: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 9870: <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 9871: </dl></dd>
9872: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
9873: </dl>
9874: </div>
9875: <p>We checked to find a piece of software that wasn't in the packages
9876: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 9877: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 9878: present in the tree is beyond us, but it's useful for the purposes of
9879: this exercise.</p>
1.41 asau 9880: <div class="sect1">
1.1 dsieger 9881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9882: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 9883: <div class="sect2">
1.1 dsieger 9884: <div class="titlepage"><div><div><h3 class="title">
9885: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
9886: <pre class="programlisting">
9887: # $NetBSD$
9888: #
9889:
9890: DISTNAME= bison-1.25
9891: CATEGORIES= devel
9892: MASTER_SITES= ${MASTER_SITE_GNU}
9893:
1.29 dholland 9894: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 9895: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
9896: COMMENT= GNU yacc clone
9897:
9898: GNU_CONFIGURE= yes
1.46 wiz 9899: INFO_FILES= yes
1.1 dsieger 9900:
9901: .include "../../mk/bsd.pkg.mk"
9902: </pre>
9903: </div>
1.41 asau 9904: <div class="sect2">
1.1 dsieger 9905: <div class="titlepage"><div><div><h3 class="title">
9906: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
9907: <pre class="programlisting">
9908: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.79 snj 9909: 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 9910: of the NetBSD source tree is beyond me.
9911: </pre>
9912: </div>
1.41 asau 9913: <div class="sect2">
1.1 dsieger 9914: <div class="titlepage"><div><div><h3 class="title">
9915: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
9916: <pre class="programlisting">
9917: @comment $NetBSD$
9918: bin/bison
9919: man/man1/bison.1.gz
9920: share/bison.simple
9921: share/bison.hairy
9922: </pre>
9923: </div>
1.41 asau 9924: <div class="sect2">
1.1 dsieger 9925: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 9926: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 9927: </h3></div></div></div>
9928: <p>The NetBSD package system comes with
1.79 snj 9929: <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 9930: which helps to check the contents of these
9931: files. After installation it is quite easy to use, just change to the
9932: directory of the package you wish to examine and execute
1.10 hubertf 9933: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 9934: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
9935: looks fine.</pre>
9936: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 9937: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 9938: -Wall</strong></span> for a very thorough check.</p>
9939: </div>
9940: </div>
1.41 asau 9941: <div class="sect1">
1.1 dsieger 9942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9943: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
9944: <p>Create the directory where the package lives,
9945: plus any auxiliary directories:</p>
9946: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
9947: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
9948: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
9949: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
9950: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 9951: <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 9952: then continue with fetching the distfile:</p>
9953: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
9954: >> bison-1.25.tar.gz doesn't seem to exist on this system.
9955: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
9956: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9957: ftp: Error retrieving file: 500 Internal error
9958:
9959: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
9960: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9961: ftp: Error retrieving file: 500 Internal error
9962:
9963: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
9964: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9965: Successfully retrieved file.</pre>
9966: <p>Generate the checksum of the distfile into
9967: <code class="filename">distinfo</code>:</p>
9968: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
9969: <p>Now compile:</p>
9970: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
9971: >> Checksum OK for bison-1.25.tar.gz.
9972: ===> Extracting for bison-1.25
9973: ===> Patching for bison-1.25
9974: ===> Ignoring empty patch directory
9975: ===> Configuring for bison-1.25
9976: creating cache ./config.cache
9977: checking for gcc... cc
9978: checking whether we are using GNU C... yes
9979: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
9980: checking how to run the C preprocessor... cc -E
9981: checking for minix/config.h... no
9982: checking for POSIXized ISC... no
9983: checking whether cross-compiling... no
9984: checking for ANSI C header files... yes
9985: checking for string.h... yes
9986: checking for stdlib.h... yes
9987: checking for memory.h... yes
9988: checking for working const... yes
9989: checking for working alloca.h... no
9990: checking for alloca... yes
9991: checking for strerror... yes
9992: updating cache ./config.cache
9993: creating ./config.status
9994: creating Makefile
9995: ===> Building for bison-1.25
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 LR0.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 allocate.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 closure.c
9999: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.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 derives.c
10001: 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
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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.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 reduce.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 symtab.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 warshall.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 version.c
10015: 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
10016: 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
10017: 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
10018: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10019: rm -f bison.s1
10020: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10021: <p>Everything seems OK, so install the files:</p>
10022: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10023: >> Checksum OK for bison-1.25.tar.gz.
10024: ===> Installing for bison-1.25
10025: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10026: rm -f /usr/pkg/bin/bison
10027: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10028: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10029: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10030: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10031: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10032: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10033: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10034: ===> Registering installation for bison-1.25</pre>
10035: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10036: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10037: binary package, do this now:</p>
10038: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10039: >> Checksum OK for bison-1.25.tar.gz.
10040: ===> Building package for bison-1.25
10041: Creating package bison-1.25.tgz
10042: Registering depends:.
10043: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10044: <p>Now that you don't need the source and object files
10045: any more, clean up:</p>
10046: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10047: ===> Cleaning for bison-1.25</pre>
10048: </div>
10049: </div>
1.41 asau 10050: <div class="appendix">
10051: <div class="titlepage"><div><div><h1 class="title">
10052: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10053: <div class="toc">
10054: <p><b>Table of Contents</b></p>
1.100 leot 10055: <dl class="toc">
1.1 dsieger 10056: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10057: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10058: </dl>
10059: </div>
1.41 asau 10060: <div class="sect1">
1.1 dsieger 10061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10062: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10063: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10064: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10065: => figlet221.tar.gz doesn't seem to exist on this system.
10066: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10067: => [172219 bytes]
10068: Connected to ftp.plig.net.
10069: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10070: 331 Guest login ok, send your complete e-mail address as password.
10071: 230-You are user #5 of 500 simultaneous users allowed.
10072: 230-
10073: 230- ___ _ _ _
10074: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10075: 230- | _| _| . |_| . | | | . |_| . | _| . |
10076: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10077: 230- |_| |_| |___| |___|
10078: 230-
10079: 230-** Welcome to ftp.plig.org **
10080: 230-
10081: 230-Please note that all transfers from this FTP site are logged. If you
10082: 230-do not like this, please disconnect now.
10083: 230-
1.18 snj 10084: 230-This archive is available via
1.1 dsieger 10085: 230-
10086: 230-HTTP: http://ftp.plig.org/
10087: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10088: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10089: 230-
10090: 230-Please email comments, bug reports and requests for packages to be
10091: 230-mirrored to ftp-admin@plig.org.
10092: 230-
10093: 230-
10094: 230 Logged in anonymously.
10095: Remote system type is UNIX.
10096: Using binary mode to transfer files.
10097: 200 Type okay.
10098: 250 "/pub" is new cwd.
10099: 250-"/pub/figlet" is new cwd.
10100: 250-
10101: 250-Welcome to the figlet archive at ftp.figlet.org
10102: 250-
10103: 250- ftp://ftp.figlet.org/pub/figlet/
10104: 250-
10105: 250-The official FIGlet web page is:
10106: 250- http://www.figlet.org/
10107: 250-
10108: 250-If you have questions, please mailto:info@figlet.org. If you want to
10109: 250-contribute a font or something else, you can email us.
10110: 250
10111: 250 "/pub/figlet/program" is new cwd.
10112: 250 "/pub/figlet/program/unix" is new cwd.
10113: local: figlet221.tar.gz remote: figlet221.tar.gz
10114: 502 Unimplemented command.
10115: 227 Entering Passive Mode (195,40,6,41,246,104)
10116: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10117: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10118: 226 Transfer completed.
10119: 172219 bytes received in 00:02 (75.99 KB/s)
10120: 221 Goodbye.
10121: => Checksum OK for figlet221.tar.gz.
10122: ===> Extracting for figlet-2.2.1nb2
10123: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10124: ===> Patching for figlet-2.2.1nb2
10125: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10126: ===> Overriding tools for figlet-2.2.1nb2
10127: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10128: ===> Configuring for figlet-2.2.1nb2
10129: ===> Building for figlet-2.2.1nb2
10130: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10131: chmod a+x figlet
10132: gcc -O2 -o chkfont chkfont.c
10133: => Unwrapping files-to-be-installed.
10134: <code class="prompt">#</code>
10135: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10136: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10137: ===> Installing for figlet-2.2.1nb2
10138: install -d -o root -g wheel -m 755 /usr/pkg/bin
10139: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10140: mkdir -p /usr/pkg/share/figlet
10141: cp figlet /usr/pkg/bin
10142: cp chkfont /usr/pkg/bin
10143: chmod 555 figlist showfigfonts
10144: cp figlist /usr/pkg/bin
10145: cp showfigfonts /usr/pkg/bin
10146: cp fonts/*.flf /usr/pkg/share/figlet
10147: cp fonts/*.flc /usr/pkg/share/figlet
10148: cp figlet.6 /usr/pkg/man/man6
10149: ===> Registering installation for figlet-2.2.1nb2
10150: <code class="prompt">#</code></pre>
10151: </div>
1.41 asau 10152: <div class="sect1">
1.1 dsieger 10153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10154: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10155: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10156: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10157: ===> Packaging figlet-2.2.1nb2
10158: ===> Building binary package for figlet-2.2.1nb2
10159: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10160: Using SrcDir value of /usr/pkg
10161: Registering depends:.
10162: <code class="prompt">#</code></pre>
10163: </div>
10164: </div>
1.41 asau 10165: <div class="appendix">
10166: <div class="titlepage"><div><div><h1 class="title">
10167: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10168: <div class="toc">
10169: <p><b>Table of Contents</b></p>
1.100 leot 10170: <dl class="toc">
1.23 wiz 10171: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10172: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10173: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10174: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10175: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10176: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10177: source packages</a></span></dt>
10178: </dl>
10179: </div>
10180: <p>As in other big projects, the directory layout of pkgsrc
10181: is quite complex for newbies. This chapter explains where you
10182: find things on the FTP server. The base directory on
1.10 hubertf 10183: <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 10184: On other servers it may be different, but inside this directory,
10185: everything should look the same, no matter on which server you
10186: are. This directory contains some subdirectories, which are
10187: explained below.</p>
1.41 asau 10188: <div class="sect1">
1.1 dsieger 10189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10190: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10191: <p>The directory <code class="filename">distfiles</code> contains lots
10192: of archive files from all pkgsrc packages, which are mirrored
10193: here. The subdirectories are called after their package names
10194: and are used when the distributed files have names that don't
10195: explicitly contain a version number or are otherwise too generic
10196: (for example <code class="filename">release.tar.gz</code>).</p>
10197: </div>
1.41 asau 10198: <div class="sect1">
1.1 dsieger 10199: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10200: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10201: <p>This directory contains things that individual pkgsrc
10202: developers find worth publishing.</p>
10203: </div>
1.41 asau 10204: <div class="sect1">
1.1 dsieger 10205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10206: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10207: <p>This directory contains binary packages for the various
10208: platforms that are supported by pkgsrc.
10209: 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 10210: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10211: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10212: operating system for which the packages have been built. The
1.10 hubertf 10213: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10214: command, so it may differ from the one you are used to
10215: hear.</p></li>
1.23 wiz 10216: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10217: architecture of the platform for which the packages have been
1.10 hubertf 10218: built. It also includes the <code class="varname">ABI</code> (Application
10219: Binary Interface) for platforms that have several of
10220: them.</p></li>
1.23 wiz 10221: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10222: the operating system. For version numbers that change often (for
10223: example NetBSD-current), the often-changing part should be
10224: replaced with an <code class="literal">x</code>, for example
10225: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10226: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10227: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10228: for a stable branch, or <code class="literal">head</code> for packages
10229: built from the HEAD branch. The latter should only be used when
10230: the packages are updated on a regular basis. Otherwise the date
10231: from checking out pkgsrc should be appended, for example
10232: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10233: </ul></div>
10234: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10235: can quickly click through the directories on the
10236: server and find the best binary packages for their machines. Since they
10237: usually know the operating system and the hardware architecture, OPSYS
10238: and ARCH are placed first. After these choices, they can select the
10239: best combination of OSVERSION and TAG together, since it is usually the
10240: case that packages stay compatible between different version of the
10241: operating system.</p>
10242: <p>In each of these directories, there is a
10243: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10244: <code class="filename">All</code> which contains all binary packages.
10245: Besides that, there are various category directories that
10246: contain symbolic links to the real binary packages.</p>
10247: </div>
1.41 asau 10248: <div class="sect1">
1.1 dsieger 10249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10250: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10251: <p>Here are the reports from bulk builds, for those who want
10252: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10253: 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 10254: </div>
1.41 asau 10255: <div class="sect1">
1.8 rillig 10256: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10257: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10258: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10259: source packages</h2></div></div></div>
1.23 wiz 10260: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10261: that is the files that define how to create binary packages from
10262: source archives.</p>
10263: <p>The directory <code class="filename">pkgsrc</code> contains a
10264: snapshot of the CVS repository, which is updated regularly. The
10265: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10266: directory, ready to be downloaded as a whole.</p>
10267: <p>In the directories for the quarterly branches, there is an
10268: additional file called
1.22 jakllsch 10269: <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 10270: which contains the state of pkgsrc when it was branched.</p>
10271: </div>
10272: </div>
1.41 asau 10273: <div class="appendix">
10274: <div class="titlepage"><div><div><h1 class="title">
10275: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10276: <div class="toc">
10277: <p><b>Table of Contents</b></p>
1.100 leot 10278: <dl class="toc">
1.1 dsieger 10279: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10280: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10281: </dl>
10282: </div>
10283: <p>This section contains information on editing the pkgsrc
10284: guide itself.</p>
1.41 asau 10285: <div class="sect1">
1.1 dsieger 10286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10287: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10288: <p>The pkgsrc guide's source code is stored in
10289: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10290: are created from it:</p>
1.41 asau 10291: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10292: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10293: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10294: <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>
10295: <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 10296: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10297: <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 10298: PostScript version of the pkgsrc guide.</p></li>
10299: </ul></div>
10300: </div>
1.41 asau 10301: <div class="sect1">
1.1 dsieger 10302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10303: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10304: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10305: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10306: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10307: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10308: documentation) installed. These are automatically installed when
1.79 snj 10309: 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 10310: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10311: right directory. All further steps will take place
10312: here.</p></li>
1.41 asau 10313: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10314: <code class="filename">files/</code>.</p></li>
1.41 asau 10315: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10316: guide for valid XML and to build the final output files. If you
10317: get any errors at this stage, you can just edit the files, as
10318: there are only symbolic links in the working directory, pointing
10319: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10320: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10321: commit)</strong></span></p></li>
1.41 asau 10322: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10323: regenerate the output files with the proper RCS
10324: Ids.</p></li>
1.41 asau 10325: <li class="step">
1.10 hubertf 10326: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10327: commit the files in both <code class="filename">pkgsrc/doc</code> and
10328: <code class="filename">htdocs</code>.</p>
1.41 asau 10329: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10330: <h3 class="title">Note</h3>
10331: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10332: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10333: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10334: directory.</p>
10335: </div>
10336: </li>
10337: </ol></div>
10338: </div>
10339: </div>
10340: </div></body>
10341: </html>
CVSweb <webmaster@jp.NetBSD.org>