Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.122
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: </dl></dd>
81: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
82: <dd><dl>
83: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
84: <dd><dl>
85: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
86: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
88: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
89: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
90: <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>
91: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
92: </dl></dd>
93: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
94: <dd><dl>
95: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
96: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
97: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
98: </dl></dd>
99: </dl></dd>
100: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
101: <dd><dl>
102: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
103: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 104: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 105: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 106: <dd><dl>
1.4 rillig 107: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 108: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
109: <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 110: </dl></dd>
1.4 rillig 111: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
112: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 113: </dl></dd>
114: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
115: <dd><dl>
116: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
117: <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 118: </dl></dd>
119: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
120: builds)</a></span></dt>
1.1 dsieger 121: <dd><dl>
1.71 wiz 122: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
123: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
124: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
125: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 126: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
127: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 128: </dl></dd>
129: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
130: <dd><dl>
1.23 wiz 131: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
132: <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 133: </dl></dd>
134: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
135: <dd><dl>
136: <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 137: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
138: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
139: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
140: <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>
141: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
142: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
143: <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>
144: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
145: <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 146: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 147: <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>
148: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
149: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
150: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
151: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
152: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
153: <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 154: </dl></dd>
155: </dl></dd>
156: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
157: <dd><dl>
1.6 rillig 158: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 159: <dd><dl>
1.6 rillig 160: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 161: <dd><dl>
1.6 rillig 162: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121 sevan 163: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 & KDE4 applications</a></span></dt>
1.17 imil 164: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 165: </dl></dd>
1.6 rillig 166: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
167: <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>
168: </dl></dd>
169: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
170: <dd><dl>
1.23 wiz 171: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
172: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 173: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 174: <dd><dl>
175: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
176: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
177: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
178: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
179: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
180: </dl></dd>
181: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
182: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
183: <dd><dl>
184: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
185: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
186: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
187: </dl></dd>
1.23 wiz 188: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
189: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 190: </dl></dd>
1.23 wiz 191: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 192: <dd><dl>
193: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 194: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 195: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
196: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
197: <dd><dl>
198: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117 sevan 199: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108 rillig 200: <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>
201: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 202: </dl></dd>
203: </dl></dd>
204: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
205: <dd><dl>
206: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 207: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
208: <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 209: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
210: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 211: <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 212: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 213: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
214: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 215: </dl></dd>
216: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
217: <dd><dl>
218: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 219: <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 220: <dd><dl>
221: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 222: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
223: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
224: and
225: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
226: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 227: </dl></dd>
1.23 wiz 228: <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 229: <dd><dl>
1.23 wiz 230: <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 231: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
232: </dl></dd>
233: </dl></dd>
234: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
235: <dd><dl>
236: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
237: <dd><dl>
238: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
239: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
240: </dl></dd>
241: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
242: <dd><dl>
1.23 wiz 243: <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 244: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
245: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
246: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
247: </dl></dd>
248: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
249: <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>
250: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
251: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
252: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
253: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
254: <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>
255: </dl></dd>
256: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
257: <dd><dl>
258: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 259: <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 260: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 261: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 262: </dl></dd>
263: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
264: <dd><dl>
265: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
266: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
267: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
268: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 269: <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 270: <dd><dl>
271: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
272: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
273: </dl></dd>
1.23 wiz 274: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
275: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
276: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
277: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
279: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
280: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
281: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
282: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
283: <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 284: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
285: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
286: </dl></dd>
287: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
290: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
291: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
292: </dl></dd>
293: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
294: <dd><dl>
295: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
296: <dd><dl>
1.108 rillig 297: <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>
298: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
299: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
300: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
301: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
302: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
303: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
304: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
305: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
306: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
307: <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 308: </dl></dd>
1.108 rillig 309: <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 310: <dd><dl>
311: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
312: <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 313: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 314: </dl></dd>
1.108 rillig 315: <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 316: <dd><dl>
317: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
318: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
319: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
320: </dl></dd>
321: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
322: <dd><dl>
323: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
324: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
325: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 326: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
327: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 328: </dl></dd>
1.108 rillig 329: <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 330: <dd><dl>
331: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
332: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 333: <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 334: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
335: </dl></dd>
1.108 rillig 336: <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 337: <dd><dl>
338: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
339: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
340: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
341: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
342: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
343: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
344: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
345: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 346: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 347: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 348: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
349: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
350: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
351: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
352: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
353: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
354: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
355: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 356: emulation</a></span></dt>
1.6 rillig 357: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
358: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 359: </dl></dd>
1.6 rillig 360: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 361: </dl></dd>
1.6 rillig 362: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
363: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 364: <dd><dl>
1.6 rillig 365: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
366: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
367: <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 368: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 369: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 370: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
371: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 372: </dl></dd>
373: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
374: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
375: <dd><dl>
376: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
377: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
378: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
379: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 380: </dl></dd>
381: </dl></dd>
382: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
383: <dd><dl>
1.6 rillig 384: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 385: <dd><dl>
1.6 rillig 386: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
387: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
388: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 389: <dd><dl>
1.6 rillig 390: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
391: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 392: </dl></dd>
1.6 rillig 393: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
394: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 395: <dd><dl>
1.6 rillig 396: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
397: <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 398: </dl></dd>
1.6 rillig 399: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 400: <dd><dl>
1.23 wiz 401: <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>
402: <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 403: </dl></dd>
404: </dl></dd>
1.6 rillig 405: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 406: <dd><dl>
1.108 rillig 407: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
408: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 409: <dd><dl>
1.108 rillig 410: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
411: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 412: </dl></dd>
413: </dl></dd>
1.6 rillig 414: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 415: <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 416: </dl></dd>
417: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
418: <dd><dl>
419: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
420: <dd><dl>
421: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
422: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
423: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 424: <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 425: </dl></dd>
426: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
427: </dl></dd>
428: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
429: <dd><dl>
430: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
431: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
432: </dl></dd>
433: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
434: <dd><dl>
1.23 wiz 435: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
436: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
437: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
438: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
439: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
440: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 441: source packages</a></span></dt>
442: </dl></dd>
443: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
444: <dd><dl>
445: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
446: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
447: </dl></dd>
448: </dl>
449: </div>
450: <div class="list-of-tables">
451: <p><b>List of Tables</b></p>
452: <dl>
453: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
454: </dt>
1.6 rillig 455: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 456: </dt>
1.6 rillig 457: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 458: </dt>
459: </dl>
460: </div>
1.41 asau 461: <div class="chapter">
462: <div class="titlepage"><div><div><h1 class="title">
463: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 464: <div class="toc">
465: <p><b>Table of Contents</b></p>
1.100 leot 466: <dl class="toc">
1.1 dsieger 467: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
468: <dd><dl>
469: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
470: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
471: </dl></dd>
472: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
473: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
474: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
475: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
476: </dl>
477: </div>
1.41 asau 478: <div class="sect1">
1.1 dsieger 479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
480: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
481: <p>There is a lot of software freely available for Unix-based
482: systems, which is usually available in form of the source code. Before
483: such software can be used, it needs to be configured to the local
484: system, compiled and installed, and this is exactly what The NetBSD
485: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
486: to handle binary packages, so that not every user has to build the
487: packages for himself, which is a time-costly task.</p>
488: <p>pkgsrc currently contains several thousand packages,
489: including:</p>
1.41 asau 490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 491: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 492: web server</p></li>
1.120 sevan 493: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 494: web browser</p></li>
1.120 sevan 495: <li class="listitem"><p><a href="http://cdn.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 496: Desktop Environment</p></li>
1.120 sevan 497: <li class="listitem"><p><a href="http://cdn.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 498: Desktop Environment</p></li>
499: </ul></div>
1.108 rillig 500: <p>… just to name a few.</p>
1.1 dsieger 501: <p>pkgsrc has built-in support for handling varying dependencies,
502: such as pthreads and X11, and extended features such as IPv6 support on
503: a range of platforms.</p>
1.41 asau 504: <div class="sect2">
1.1 dsieger 505: <div class="titlepage"><div><div><h3 class="title">
506: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
507: <p>
508: pkgsrc provides the following key features:
509: </p>
1.41 asau 510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 511: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 512: and installation of binary packages. The source and latest
513: patches are retrieved from a master or mirror download site, checksum
514: verified, then built on your system. Support for binary-only
515: distributions is available for both native platforms and NetBSD
516: emulated platforms.</p></li>
1.23 wiz 517: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 518: including binaries, libraries, man pages and other
519: documentation.</p></li>
1.104 sevan 520: <li class="listitem"><p>Tracking of package dependencies automatically, including when
521: performing updates, to ensure required packages are installed. The
522: configuration files of various packages are handled automatically during
523: updates, so local changes are preserved.</p></li>
1.23 wiz 524: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 525: consists of highly portable code. This allows the greatest speed of
1.25 spz 526: development when porting to a new platform. This portability also
1.1 dsieger 527: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
528: platforms</em></span>.</p></li>
1.23 wiz 529: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 530: international encryption requirements and build-time options for a
531: large number of packages are all set in a simple, central
532: configuration file.</p></li>
1.23 wiz 533: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 534: freely available under a BSD license, so you may extend and adapt
535: pkgsrc to your needs. Support for local packages and patches is
536: available right out of the box, so you can configure it specifically
537: for your environment.</p></li>
538: </ul></div>
539: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 541: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 542: — That means, if a package contains bugs, it's better to find
1.1 dsieger 543: them and to complain about them rather than to just install the package
544: and hope that it works. There are numerous checks in pkgsrc that try to
1.120 sevan 545: find such bugs: Static analysis tools (<a href="http://cdn.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 546: of shell scripts), and post-installation checks (installed files,
547: references to shared libraries, script interpreters).</p></li>
1.23 wiz 548: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 549: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 550: pkgsrc has been ported to many operating systems. Care is taken that
551: packages behave the same on all platforms.</p></li>
552: </ul></div>
553: </div>
1.41 asau 554: <div class="sect2">
1.1 dsieger 555: <div class="titlepage"><div><div><h3 class="title">
556: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
557: <p>pkgsrc consists of both a source distribution and a binary
558: distribution for these operating systems. After retrieving the required
559: source or binaries, you can be up and running with pkgsrc in just
560: minutes!</p>
561: <p>pkgsrc was derived from FreeBSD's ports system, and
562: initially developed for NetBSD only. Since then, pkgsrc has
563: grown a lot, and now supports the following platforms:</p>
564: <div class="table">
565: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 566: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 567: <colgroup>
568: <col>
569: <col>
1.92 sevan 570: <col>
1.1 dsieger 571: </colgroup>
572: <thead><tr>
573: <th>Platform</th>
574: <th>Date Support Added</th>
1.92 sevan 575: <th>Notes</th>
1.1 dsieger 576: </tr></thead>
577: <tbody>
578: <tr>
1.10 hubertf 579: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 580: <td align="center">Aug 1997</td>
1.92 sevan 581: <td class="auto-generated"> </td>
1.1 dsieger 582: </tr>
583: <tr>
1.10 hubertf 584: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 585: <td align="center">Mar 1999</td>
1.93 sevan 586: <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 587: </tr>
588: <tr>
1.10 hubertf 589: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 590: <td align="center">Jun 1999</td>
1.93 sevan 591: <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 592: </tr>
593: <tr>
594: <td>
1.118 sevan 595: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 596: </td>
597: <td align="center">Oct 2001</td>
1.93 sevan 598: <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 599: </tr>
600: <tr>
1.10 hubertf 601: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 602: <td align="center">Nov 2002</td>
1.93 sevan 603: <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 604: </tr>
605: <tr>
1.10 hubertf 606: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 607: <td align="center">Nov 2002</td>
1.93 sevan 608: <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 609: </tr>
610: <tr>
1.10 hubertf 611: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 612: <td align="center">Dec 2002</td>
1.92 sevan 613: <td>
1.93 sevan 614: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
615: <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 616: </td>
1.1 dsieger 617: </tr>
618: <tr>
619: <td>BSD/OS</td>
620: <td align="center">Dec 2003</td>
1.92 sevan 621: <td class="auto-generated"> </td>
1.1 dsieger 622: </tr>
623: <tr>
1.10 hubertf 624: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 625: <td align="center">Dec 2003</td>
1.93 sevan 626: <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 627: </tr>
628: <tr>
629: <td>
1.10 hubertf 630: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 631: (Microsoft Windows Services for Unix)
632: </td>
633: <td align="center">Mar 2004</td>
1.93 sevan 634: <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 635: </tr>
636: <tr>
1.10 hubertf 637: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 638: <td align="center">Oct 2004</td>
1.92 sevan 639: <td class="auto-generated"> </td>
1.1 dsieger 640: </tr>
641: <tr>
1.10 hubertf 642: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 643: <td align="center">Nov 2004</td>
1.93 sevan 644: <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 645: </tr>
646: <tr>
1.10 hubertf 647: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 648: <td align="center">Apr 2007</td>
1.93 sevan 649: <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 650: </tr>
1.23 wiz 651: <tr>
652: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
653: <td align="center">Sep 2010</td>
1.93 sevan 654: <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 655: </tr>
1.45 obache 656: <tr>
657: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 658: <td align="center">Jan 2011</td>
1.92 sevan 659: <td class="auto-generated"> </td>
1.45 obache 660: </tr>
661: <tr>
662: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
663: <td align="center">Nov 2011</td>
1.93 sevan 664: <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 665: </tr>
666: <tr>
667: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
668: <td align="center">Mar 2013</td>
1.93 sevan 669: <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 670: </tr>
1.58 ryoon 671: <tr>
672: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
673: <td align="center">Jul 2013</td>
1.93 sevan 674: <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 675: </tr>
1.104 sevan 676: <tr>
677: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
678: <td align="center">Jun 2014</td>
679: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
680: </tr>
1.1 dsieger 681: </tbody>
682: </table></div>
683: </div>
684: <br class="table-break">
685: </div>
686: </div>
1.41 asau 687: <div class="sect1">
1.1 dsieger 688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
689: <a name="overview"></a>1.2. Overview</h2></div></div></div>
690: <p>This document is divided into three parts. The first,
1.10 hubertf 691: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 692: describes how one can use one of the packages in the Package
693: Collection, either by installing a precompiled binary package,
694: or by building one's own copy using the NetBSD package system.
1.10 hubertf 695: 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 696: package so it can be easily built by other NetBSD users without
697: knowing about the package's building details. The third part,
1.10 hubertf 698: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 699: is intended for those who want to understand how pkgsrc is
700: implemented.</p>
701: <p>This document is available in various formats:
1.10 hubertf 702: <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 703: </div>
1.41 asau 704: <div class="sect1">
1.1 dsieger 705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
706: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 707: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
708: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 709: terminology used within this document.</p>
1.41 asau 710: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 711: <dt><span class="term">Package</span></dt>
712: <dd><p>A set of files and building instructions
713: that describe what's necessary
714: to build a certain piece of software using
715: pkgsrc. Packages are traditionally stored under
716: <code class="filename">/usr/pkgsrc</code>.</p></dd>
717: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 718: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 719: is part of the NetBSD operating system and can be bootstrapped
720: to run on non-NetBSD operating systems as well. It handles
721: building (compiling), installing, and removing of
722: packages.</p></dd>
723: <dt><span class="term">Distfile</span></dt>
724: <dd><p>This term describes the file or files that are
725: provided by the author of the piece of software to
726: distribute his work. All the changes necessary to build on
727: NetBSD are reflected in the corresponding package. Usually
728: the distfile is in the form of a compressed tar-archive,
729: but other types are possible, too. Distfiles are usually
730: stored below
731: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
732: <dt><span class="term">Port</span></dt>
733: <dd><p>This is the term used by FreeBSD and OpenBSD people
734: for what we call a package.
1.23 wiz 735: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 736: architecture.</p></dd>
737: <dt><span class="term">Precompiled/binary package</span></dt>
738: <dd>
739: <p>A set of binaries built with pkgsrc from a distfile
740: and stuffed together in a single <code class="filename">.tgz</code>
741: file so it can be installed on machines of the same
742: machine architecture without the need to
743: recompile. Packages are usually generated in
744: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 745: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 746: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 747: especially in the context of precompiled packages.</p>
748: </dd>
749: <dt><span class="term">Program</span></dt>
750: <dd><p>The piece of software to be installed which will be
751: constructed from all the files in the distfile by the
752: actions defined in the corresponding package.</p></dd>
753: </dl></div>
1.41 asau 754: <div class="sect2">
1.1 dsieger 755: <div class="titlepage"><div><div><h3 class="title">
756: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 757: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 758: <dt><span class="term">pkgsrc users</span></dt>
759: <dd>
760: <p>The
761: pkgsrc users are people who use the packages provided by pkgsrc.
762: Typically they are system administrators. The people using the
1.23 wiz 763: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
764: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 765: <p>There are two kinds of pkgsrc users: Some only want to
766: install pre-built binary packages. Others build the pkgsrc
767: packages from source, either for installing them directly or for
1.10 hubertf 768: 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 769: documentation.</p>
770: </dd>
771: <dt><span class="term">package maintainers</span></dt>
772: <dd><p>A
1.10 hubertf 773: 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 774: <dt><span class="term">infrastructure developers</span></dt>
775: <dd><p>These people are involved in all those files
776: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 777: 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 778: too.</p></dd>
779: </dl></div>
780: </div>
781: </div>
1.41 asau 782: <div class="sect1">
1.1 dsieger 783: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
784: <a name="typography"></a>1.4. Typography</h2></div></div></div>
785: <p>When giving examples for commands, shell prompts are used to
786: show if the command should/can be issued as root, or if
1.23 wiz 787: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 788: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
789: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
790: bourne shell and derivatives.</p>
1.1 dsieger 791: </div>
792: </div>
1.41 asau 793: <div class="part">
1.1 dsieger 794: <div class="titlepage"><div><div><h1 class="title">
795: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
796: <div class="toc">
797: <p><b>Table of Contents</b></p>
1.100 leot 798: <dl class="toc">
1.1 dsieger 799: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
800: <dd><dl>
801: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
802: <dd><dl>
1.51 asau 803: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 804: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 805: </dl></dd>
806: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
807: <dd><dl>
808: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
809: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
810: </dl></dd>
811: </dl></dd>
812: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
813: <dd><dl>
814: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
815: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
816: </dl></dd>
817: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
818: <dd><dl>
819: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
820: <dd><dl>
821: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
822: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
823: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
824: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
825: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
826: <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>
827: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
828: </dl></dd>
829: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
830: <dd><dl>
831: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
832: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
833: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
834: </dl></dd>
835: </dl></dd>
836: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
837: <dd><dl>
838: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
839: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 840: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 841: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 842: <dd><dl>
1.4 rillig 843: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 844: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
845: <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 846: </dl></dd>
1.4 rillig 847: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
848: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 849: </dl></dd>
850: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
851: <dd><dl>
852: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
853: <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 854: </dl></dd>
855: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
856: builds)</a></span></dt>
1.1 dsieger 857: <dd><dl>
1.71 wiz 858: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
859: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
860: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
861: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 862: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
863: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 864: </dl></dd>
865: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
866: <dd><dl>
1.23 wiz 867: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
868: <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 869: </dl></dd>
870: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
871: <dd><dl>
872: <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 873: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
874: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
875: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
876: <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>
877: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
878: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
879: <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>
880: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
881: <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 882: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 883: <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>
884: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
885: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
886: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
887: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
888: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
889: <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 890: </dl></dd>
891: </dl>
892: </div>
1.41 asau 893: <div class="chapter">
1.1 dsieger 894: <div class="titlepage"><div><div><h2 class="title">
895: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
896: <div class="toc">
897: <p><b>Table of Contents</b></p>
1.100 leot 898: <dl class="toc">
1.1 dsieger 899: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
900: <dd><dl>
1.51 asau 901: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 902: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 903: </dl></dd>
904: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
905: <dd><dl>
906: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
907: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
908: </dl></dd>
909: </dl>
910: </div>
911: <p>Before you download and extract the files, you need to decide
912: where you want to extract them. When using pkgsrc as root user, pkgsrc
913: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
914: free to install the sources and binary packages wherever you want in
915: your filesystem, provided that the pathname does not contain white-space
916: or other characters that are interpreted specially by the shell and some
917: other programs. A safe bet is to use only letters, digits, underscores
918: and dashes.</p>
1.41 asau 919: <div class="sect1">
1.1 dsieger 920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
921: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
922: <p>Before you download any pkgsrc files, you should decide
923: whether you want the <span class="emphasis"><em>current</em></span> branch or the
924: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
925: quarterly basis from the current branch and only gets modified
926: for security updates. The names of the stable branches are built
927: from the year and the quarter, for example
1.118 sevan 928: <code class="literal">2016Q4</code>.</p>
1.1 dsieger 929: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 930: want to download pkgsrc. You can get it as a tar file or via CVS.
931: Both ways are described here.</p>
1.51 asau 932: <p>Note that tar archive contains CVS working copy.
933: Thus you can switch to using CVS at any later time.</p>
1.41 asau 934: <div class="sect2">
1.1 dsieger 935: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 936: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 937: <p>The primary download location for all pkgsrc files is
1.51 asau 938: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
939: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
940: (it points to the same location).
941: There are a number of subdirectories for different purposes,
942: 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>
943: <p>The tar archive for the current branch is in the directory
944: <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.118 sevan 945: It is autogenerated weekly.</p>
1.51 asau 946: <p>To save download time we provide bzip2- and
947: xz-compressed archives which are published at
948: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
949: and
950: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
951: respectively.
952: </p>
953: <p>You can fetch the same files using FTP.</p>
1.118 sevan 954: <p>The tar file for the stable branch 2016Q4 is in the
955: directory <code class="filename">pkgsrc-2016Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2016Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.12 weinem 956: <p>To download a pkgsrc stable tarball, run:</p>
957: <pre class="screen">
1.59 jnemeth 958: <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 959: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 960: stable branch to be downloaded, for example,
1.118 sevan 961: <span class="quote">“<span class="quote">pkgsrc-2016Q4</span>”</span>.</p>
1.78 snj 962: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 963: or your web browser.</p>
1.12 weinem 964: <p>Then, extract it with:</p>
1.78 snj 965: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 966: <p>This will create the directory <code class="filename">pkgsrc/</code>
967: in <code class="filename">/usr/</code> and all the package source will be
968: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
969: <p>To download pkgsrc-current, run:</p>
970: <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 971: </div>
1.41 asau 972: <div class="sect2">
1.1 dsieger 973: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 974: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
975: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 976: <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 977: </pre>
978: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.118 sevan 979: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2016Q4</span>”</span></p>
1.23 wiz 980: <p>This will create the directory <code class="filename">pkgsrc/</code>
981: in your <code class="filename">/usr/</code> directory and all the package source
982: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
983: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 984: <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 985: </pre>
1.78 snj 986: <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 987: <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 988: <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 989: </pre>
990: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
991: For Bourne shells, you can set it in your <code class="filename">.profile</code>
992: or better globally in <code class="filename">/etc/profile</code>:</p>
993: <pre class="programlisting">
994: # set CVS remote shell command
995: CVS_RSH=ssh
996: export CVS_RSH
997: </pre>
998: <p>By default, CVS doesn't do things like most people would expect it to do.
999: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1000: in your home directory and saving the following lines to it.
1001: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1002: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1003: <pre class="programlisting">
1004: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1005: cvs -q -z2
1.2 rillig 1006: checkout -P
1.4 rillig 1007: update -dP
1008: diff -upN
1.2 rillig 1009: rdiff -u
1.23 wiz 1010: release -d
1.2 rillig 1011: </pre>
1.1 dsieger 1012: </div>
1013: </div>
1.41 asau 1014: <div class="sect1">
1.1 dsieger 1015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1016: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1017: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1018: (which also works if you have first installed it via a tar
1019: file). It saves bandwidth and hard disk activity, compared to
1020: downloading the tar file again.</p>
1.41 asau 1021: <div class="sect2">
1.1 dsieger 1022: <div class="titlepage"><div><div><h3 class="title">
1023: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1024: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1025: <h3 class="title">Warning</h3>
1026: <p>When updating from a tar file, you first need to
1027: completely remove the old pkgsrc directory. Otherwise those
1028: files that have been removed from pkgsrc in the mean time will
1029: not be removed on your local disk, resulting in inconsistencies.
1030: When removing the old files, any changes that you have done to
1031: the pkgsrc files will be lost after updating. Therefore updating
1032: via CVS is strongly recommended.</p>
1033: </div>
1034: <p>Note that by default the distfiles and the binary packages
1035: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1036: before updating. You can also configure pkgsrc to store distfiles
1037: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1038: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1039: 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 1040: <p>To update pkgsrc from a tar file, download the tar file as
1041: explained above. Then, make sure that you have not made any
1042: changes to the files in the pkgsrc directory. Remove the pkgsrc
1043: directory and extract the new tar file. Done.</p>
1044: </div>
1.41 asau 1045: <div class="sect2">
1.1 dsieger 1046: <div class="titlepage"><div><div><h3 class="title">
1047: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1048: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1049: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1050: </pre>
1051: <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>
1052: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1053: </pre>
1.41 asau 1054: <div class="sect3">
1.1 dsieger 1055: <div class="titlepage"><div><div><h4 class="title">
1056: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1057: <p>When updating pkgsrc, the CVS program keeps track of the
1058: branch you selected. But if you, for whatever reason, want to
1059: switch from the stable branch to the current one, you can do it
1.23 wiz 1060: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1061: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1062: back to the stable branch, add the
1.118 sevan 1063: <span class="quote">“<span class="quote">-rpkgsrc-2016Q4</span>”</span> option.</p>
1.1 dsieger 1064: </div>
1.41 asau 1065: <div class="sect3">
1.1 dsieger 1066: <div class="titlepage"><div><div><h4 class="title">
1067: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1068: <p>When you update pkgsrc, the CVS program will only touch
1069: those files that are registered in the CVS repository. That
1070: means that any packages that you created on your own will stay
1071: unmodified. If you change files that are managed by CVS, later
1072: updates will try to merge your changes with those that have been
1073: done by others. See the CVS manual, chapter
1.23 wiz 1074: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1075: </div>
1076: </div>
1077: </div>
1078: </div>
1.41 asau 1079: <div class="chapter">
1.1 dsieger 1080: <div class="titlepage"><div><div><h2 class="title">
1081: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1082: <div class="toc">
1083: <p><b>Table of Contents</b></p>
1.100 leot 1084: <dl class="toc">
1.1 dsieger 1085: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1086: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1087: </dl>
1088: </div>
1.41 asau 1089: <div class="sect1">
1.1 dsieger 1090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1091: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1092: <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 1093: </div>
1.41 asau 1094: <div class="sect1">
1.1 dsieger 1095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1096: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1097: <p>pkgsrc can be bootstrapped for use in two different modes:
1098: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1099: to privileged one all programs are installed under one particular user
1.43 asau 1100: and cannot utilise privileged operations (packages don't create
1101: special users and all special file permissions like setuid are ignored).
1102: </p>
1.1 dsieger 1103: <p>Installing the bootstrap kit from source should be as simple as:</p>
1104: <pre class="screen">
1.60 asau 1105: <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 1106: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1107: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1108: </pre>
1.43 asau 1109: <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>
1110: <p>By default, in privileged mode pkgsrc uses
1111: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1112: where programs will be installed in,
1.118 sevan 1113: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1114: directory where pkgsrc will do its internal bookkeeping,
1115: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1116: where packages install their persistent data.
1117: In unprivileged mode pkgsrc uses
1118: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1119: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1120: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1121: </p>
1122: <p>You can change default layout using command-line arguments.
1123: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1124: </p>
1.41 asau 1125: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1126: <h3 class="title">Note</h3>
1.10 hubertf 1127: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1128: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1129: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1130: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1131: </div>
1.43 asau 1132: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1133: <h3 class="title">Note</h3>
1134: <p>It is possible to bootstrap multiple instances of pkgsrc
1135: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1136: corresponding to the installation you're working with to build
1137: and install packages.
1138: </p>
1139: </div>
1.1 dsieger 1140: </div>
1141: </div>
1.41 asau 1142: <div class="chapter">
1.1 dsieger 1143: <div class="titlepage"><div><div><h2 class="title">
1144: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1145: <div class="toc">
1146: <p><b>Table of Contents</b></p>
1.100 leot 1147: <dl class="toc">
1.1 dsieger 1148: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1149: <dd><dl>
1150: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1151: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1152: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1153: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1154: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1155: <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>
1156: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1157: </dl></dd>
1158: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1159: <dd><dl>
1160: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1161: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1162: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1163: </dl></dd>
1164: </dl>
1165: </div>
1166: <p>Basically, there are two ways of using pkgsrc. The first
1167: is to only install the package tools and to use binary packages
1.23 wiz 1168: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1169: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1170: of pkgsrc, too. Then you are able to build your own packages,
1171: and you can still use binary packages from someone else.</p>
1.41 asau 1172: <div class="sect1">
1.1 dsieger 1173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1174: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1175: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1176: server and its mirrors, there are collections of binary packages,
1177: ready to be installed. These binary packages have been built using the
1178: default settings for the directories, that is:</p>
1.41 asau 1179: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1180: <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>
1181: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1182: <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 1183: </ul></div>
1184: <p>If you cannot use these directories for whatever reasons (maybe
1185: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1186: 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 1187: <div class="sect2">
1.1 dsieger 1188: <div class="titlepage"><div><div><h3 class="title">
1189: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1190: <p>To install binary packages, you first need to know from where
1191: to get them. The first place where you should look is on the main
1.10 hubertf 1192: 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 1193: <p>This directory contains binary packages for multiple
1194: platforms. First, select your operating system. (Ignore the
1195: directories with version numbers attached to it, they just exist for
1196: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1197: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1198: <p>In this directory, you often find a file called
1199: <code class="filename">bootstrap.tar.gz</code> which contains the package
1200: management tools. If the file is missing, it is likely that your
1201: operating system already provides those tools. Download the file and
1202: extract it in the <code class="filename">/</code> directory. It will create
1203: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1204: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1205: </div>
1.41 asau 1206: <div class="sect2">
1.1 dsieger 1207: <div class="titlepage"><div><div><h3 class="title">
1208: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1209: <p>In the directory from the last section, there is a
1.85 wiz 1210: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1211: binary packages that are available for the platform, excluding those
1212: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1213: medium you are using).</p>
1.9 rillig 1214: <p>To install packages directly from an FTP or HTTP server, run
1215: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1216: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1217: <pre class="screen">
1218: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85 wiz 1219: <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 1220: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1221: </pre>
1222: <p>Instead of URLs, you can also use local paths, for example if
1223: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1224: repository. If you want to install packages from multiple sources,
1225: you can separate them by a semicolon in
1226: <code class="varname">PKG_PATH</code>.</p>
1227: <p>After these preparations, installing a package is very
1228: easy:</p>
1229: <pre class="screen">
1.118 sevan 1230: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1.9 rillig 1231: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1.118 sevan 1232: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9 rillig 1233: </pre>
1.1 dsieger 1234: <p>Note that any prerequisite packages needed to run the
1235: package in question will be installed, too, assuming they are
1236: present where you install from.</p>
1.23 wiz 1237: <p>Adding packages might install vulnerable packages.
1238: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1239: regularly, especially after installing new packages, and verify
1240: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1241: <p>After you've installed packages, be sure to have
1242: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1243: <code class="varname">PATH</code> so you can actually start the just
1244: installed program.</p>
1245: </div>
1.41 asau 1246: <div class="sect2">
1.1 dsieger 1247: <div class="titlepage"><div><div><h3 class="title">
1248: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1249: <p>To deinstall a package, it does not matter whether it was
1250: installed from source code or from a binary package. The
1.10 hubertf 1251: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1252: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1253: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1254: name can be given with or without version number. Wildcards can
1255: also be used to deinstall a set of packages, for example
1256: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1257: so that the shell does not expand them before
1258: <code class="literal">pkg_delete</code> sees them.</p>
1259: <p>The <code class="option">-r</code> option is very powerful: it
1260: removes all the packages that require the package in question
1261: and then removes the package itself. For example:
1262:
1263: </p>
1264: <pre class="screen">
1265: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1266: </pre>
1267: <p>
1268:
1269: will remove jpeg and all the packages that used it; this allows
1270: upgrading the jpeg package.</p>
1271: </div>
1.41 asau 1272: <div class="sect2">
1.1 dsieger 1273: <div class="titlepage"><div><div><h3 class="title">
1274: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1275: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1276: installed packages or binary package files.</p>
1277: </div>
1.41 asau 1278: <div class="sect2">
1.1 dsieger 1279: <div class="titlepage"><div><div><h3 class="title">
1280: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1281: <p>
1282: The NetBSD Security-Officer and Packages Groups maintain a list of
1283: known security vulnerabilities to packages which are (or have been)
1284: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1285: 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 1286: </p>
1287: <p>
1.22 jakllsch 1288: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1289: this list can be downloaded
1290: automatically, and a security audit of all packages installed on a system
1291: can take place.
1292: </p>
1293: <p>
1.22 jakllsch 1294: There are two components to auditing. The first
1295: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1296: is for downloading
1.1 dsieger 1297: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1298: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1299: installed packages are vulnerable. If a package is vulnerable, you
1300: will see output similar to the following:
1301: </p>
1302: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1303: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1304: <p>
1.22 jakllsch 1305: You may wish to have the
1.10 hubertf 1306: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1307: file downloaded daily so that
1308: it remains current. This may be done by adding an appropriate entry
1.120 sevan 1309: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1310: </p>
1311: <pre class="screen">
1.121 sevan 1312: # Download vulnerabilities file
1.118 sevan 1313: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1314: # Audit the installed packages and email results to root
1315: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1316: root >/dev/null 2>&1
1.22 jakllsch 1317: </pre>
1318: <p>
1.118 sevan 1319: will update the vulnerability list every day at 3AM, followed by an audit
1320: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1321:
1.118 sevan 1322: On NetBSD this may be accomplished instead by adding the following
1323: line to <code class="filename">/etc/daily.conf</code>:
1324: </p>
1325: <pre class="screen">
1326: fetch_pkg_vulnerabilities=YES
1327: </pre>
1328: <p>
1329: to fetch the vulnerability list from the daily security script. The system
1330: is set to audit the packages by default but can be set explicitly, if
1331: desired (not required), by adding the follwing line to
1332: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1333: </p>
1334: <pre class="screen">
1.118 sevan 1335: check_pkg_vulnerabilities=YES
1.22 jakllsch 1336: </pre>
1337: <p>
1.120 sevan 1338: see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1339: </p>
1340: </div>
1.41 asau 1341: <div class="sect2">
1.1 dsieger 1342: <div class="titlepage"><div><div><h3 class="title">
1343: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1344: <p>
1.120 sevan 1345: Install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1346: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1347: argument to check if your packages are up-to-date, e.g.
1348: </p>
1349: <pre class="screen">
1350: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1351: ...
1352: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1353: </pre>
1.10 hubertf 1354: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1355: package on your system and rebuild any dependencies.
1356: </p>
1357: </div>
1.41 asau 1358: <div class="sect2">
1.1 dsieger 1359: <div class="titlepage"><div><div><h3 class="title">
1360: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1361: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1362: administrative functions on the package system.</p>
1363: </div>
1364: </div>
1.41 asau 1365: <div class="sect1">
1.1 dsieger 1366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1367: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1368: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1369: directory now contains a set of packages, organized into
1370: categories. You can browse the online index of packages, or run
1.10 hubertf 1371: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1372: directory to build local <code class="filename">README.html</code> files for
1.120 sevan 1373: all packages, viewable with any web browser such as <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1374: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1375: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1376: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1377: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1378: different <code class="varname">LOCALBASE</code> definitions on the same
1379: system (inside a chroot is an exception). </p>
1380: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1381: 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 1382: instructions how to create your own packages.</p>
1.41 asau 1383: <div class="sect2">
1.1 dsieger 1384: <div class="titlepage"><div><div><h3 class="title">
1385: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1386: <p>To build packages from source, you need a working C
1387: compiler. On NetBSD, you need to install the
1.23 wiz 1388: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1389: sets. If you want to build X11-related packages, the
1.23 wiz 1390: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1391: sets are required, too.</p>
1392: </div>
1.41 asau 1393: <div class="sect2">
1.1 dsieger 1394: <div class="titlepage"><div><div><h3 class="title">
1395: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1396: <p>The first step for building a package is downloading the
1397: distfiles (i.e. the unmodified source). If they have not yet been
1398: downloaded, pkgsrc will fetch them automatically.</p>
1399: <p>If you have all files that you need in the
1400: <code class="filename">distfiles</code> directory,
1401: you don't need to connect. If the distfiles are on CD-ROM, you can
1402: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1403: </p>
1404: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1405: <p>
1.10 hubertf 1406: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1407: <p>By default a list of distribution sites will be randomly
1408: intermixed to prevent huge load on servers which holding popular
1409: packages (for example, SourceForge.net mirrors). Thus, every
1410: time when you need to fetch yet another distfile all the mirrors
1411: will be tried in new (random) order. You can turn this feature
1412: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1413: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1414: <p>You can overwrite some of the major distribution sites to
1415: fit to sites that are close to your own. By setting one or two
1416: variables you can modify the order in which the master sites are
1417: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1418: delimited list of domain suffixes.
1419: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1420: contains a whitespace delimited list of regular expressions. It
1421: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1422: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1423: some examples. This may save some of your bandwidth and
1424: time.</p>
1425: <p>You can change these settings either in your shell's environment, or,
1426: if you want to keep the settings, by editing the
1.10 hubertf 1427: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1428: and adding the definitions there.</p>
1429: <p>
1430: If a package depends on many other packages (such as
1.120 sevan 1431: <a href="http://cdn.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 1432: alternate between periods of
1433: downloading source, and compiling. To ensure you have all the source
1434: downloaded initially you can run the command:
1435: </p>
1436: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1437: <p>
1438: which will output and run a set of shell commands to fetch the
1439: necessary files into the <code class="filename">distfiles</code> directory. You can
1440: also choose to download the files manually.
1441: </p>
1442: </div>
1.41 asau 1443: <div class="sect2">
1.1 dsieger 1444: <div class="titlepage"><div><div><h3 class="title">
1445: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1446: <p>
1447: Once the software has downloaded, any patches will be applied, then it
1448: will be compiled for you. This may take some time depending on your
1449: computer, and how many other packages the software depends on and their
1450: compile time.
1451: </p>
1.41 asau 1452: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1453: <h3 class="title">Note</h3>
1454: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1455: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1456: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1457: </div>
1458: <p>For example, type</p>
1459: <pre class="screen">
1460: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1461: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1462: </pre>
1463: <p>at the shell prompt to build the various components of the
1464: package.</p>
1465: <p>The next stage is to actually install the newly compiled
1466: program onto your system. Do this by entering:
1467:
1468: </p>
1469: <pre class="screen">
1470: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1471: </pre>
1472: <p>
1473:
1474: while you are still in the directory for whatever package you
1475: are installing.</p>
1476: <p>Installing the package on your system may require you to
1477: be root. However, pkgsrc has a
1478: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1479: to only become root for the actual installation step.</p>
1480: <p>That's it, the software should now be installed and setup for use.
1481: You can now enter:
1482:
1483: </p>
1484: <pre class="screen">
1485: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1486: </pre>
1487: <p>
1488:
1489: to remove the compiled files in the work directory, as you shouldn't need
1490: them any more. If other packages were also added to your system
1491: (dependencies) to allow your program to compile, you can tidy these up
1492: also with the command:</p>
1493: <pre class="screen">
1494: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1495: </pre>
1496: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1497: 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 1498: <p>The program is installed under the default root of the
1499: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1500: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1501: variable in your environment, and it will use that value as the
1502: root of your packages tree. So, to use
1503: <code class="filename">/usr/local</code>, set
1504: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1505: Please note that you should use a directory which is dedicated to
1506: packages and not shared with other programs (i.e., do not try and
1507: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1508: to add any of your own files or directories (such as
1509: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1510: <code class="filename">pkgsrc/</code>) below the
1511: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1512: conflicts between programs and other files installed by the
1513: package system and whatever else may have been installed
1514: there.</p>
1.10 hubertf 1515: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1516: alter some configuration options at build time. Have a look at
1517: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1518: of what will be set there by default. Environment variables such
1519: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1520: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1521: set them each time you want to use pkgsrc.</p>
1.23 wiz 1522: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1523: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1524: or being installed. This may be for debugging purposes, or out of
1525: simple curiosity. A number of utility values have been added to
1526: help with this.</p>
1.23 wiz 1527: <div class="orderedlist"><ol class="orderedlist" type="1">
1528: <li class="listitem">
1.120 sevan 1529: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1530: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1531: information will be displayed. For example,</p>
1532: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1533: <p>will show all the commands that are invoked, up to and
1.23 wiz 1534: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1535: </li>
1.23 wiz 1536: <li class="listitem">
1.120 sevan 1537: <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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1538: definition, then the <code class="varname">VARNAME</code> definition
1539: should be used, in conjunction with the show-var
1.120 sevan 1540: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1541: variable <code class="varname">LOCALBASE</code>:</p>
1542: <pre class="screen">
1543: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1544: /usr/pkg
1545: <code class="prompt">%</code>
1546: </pre>
1547: </li>
1548: </ol></div>
1549: <p>If you want to install a binary package that you've either
1550: created yourself (see next section), that you put into
1551: pkgsrc/packages manually or that is located on a remote FTP
1552: server, you can use the "bin-install" target. This target will
1.120 sevan 1553: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1554: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1555: sites searched is kept in the variable
1556: <code class="varname">BINPKG_SITES</code>, which defaults to
1.120 sevan 1557: 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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1558: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1559: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1560: details.</p>
1561: <p>A final word of warning: If you set up a system that has a
1562: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1563: set that before any packages are installed, as you cannot use
1564: several directories for the same purpose. Doing so will result in
1565: pkgsrc not being able to properly detect your installed packages,
1566: and fail miserably. Note also that precompiled binary packages are
1567: usually built with the default <code class="varname">LOCALBASE</code> of
1568: <code class="filename">/usr/pkg</code>, and that you should
1569: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1570: <code class="varname">LOCALBASE</code>.</p>
1571: </div>
1572: </div>
1573: </div>
1.41 asau 1574: <div class="chapter">
1.1 dsieger 1575: <div class="titlepage"><div><div><h2 class="title">
1576: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
1577: <div class="toc">
1578: <p><b>Table of Contents</b></p>
1.100 leot 1579: <dl class="toc">
1.1 dsieger 1580: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
1581: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 1582: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 1583: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 1584: <dd><dl>
1.4 rillig 1585: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 1586: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1587: <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 1588: </dl></dd>
1.4 rillig 1589: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
1590: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1591: </dl>
1592: </div>
1.4 rillig 1593: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1594: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1595: that file depends on the installation. On NetBSD, when you use
1.120 sevan 1596: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 1597: <code class="filename">/etc/</code>. In all other cases the default location is
1598: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1599: bootstrap program to install the binary packages.</p>
1600: <p>The format of the configuration file is that of the usual
1601: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1602: is done by setting variables in this file. Note that you can define all
1603: kinds of variables, and no special error checking (for example for
1.112 rillig 1604: spelling mistakes) takes place.</p>
1.41 asau 1605: <div class="sect1">
1.1 dsieger 1606: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1607: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.112 rillig 1608: <p>The following variables apply to all
1.1 dsieger 1609: pkgsrc packages. A complete list of the variables that can be
1610: configured by the user is available in
1611: <code class="filename">mk/defaults/mk.conf</code>, together with some
1612: comments that describe each variable's intent.</p>
1.41 asau 1613: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1614: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1615: packages will be installed. The default is
1616: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1617: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1618: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1619: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1620: installed. The default is
1621: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1622: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1623: X11 is installed on the system. The default is
1.84 wiz 1624: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1625: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1626: downloaded copies of the original source distributions used
1627: for building pkgsrc packages. The default is
1628: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1629: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1630: database about installed packages is stored. The default is
1.118 sevan 1631: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1632: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1633: If set, override the packages'
1634: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1635: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1636: Backup location(s) for distribution files and patch files
1637: if not found locally or in
1638: <code class="filename">${MASTER_SITES}</code> or
1639: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1640: The defaults is
1641: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1642: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1643: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1644: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1645: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1646: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1647: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1648: List of acceptable licenses. License names are case-sensitive.
1649: Whenever you try to build a package whose license is not in this
1650: list, you will get an error message. If the license condition is
1651: simple enough, the error message will include specific
1652: instructions on how to change this variable.</p></li>
1.1 dsieger 1653: </ul></div>
1654: </div>
1.41 asau 1655: <div class="sect1">
1.1 dsieger 1656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1657: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1658: <p>
1.1 dsieger 1659: </p>
1.41 asau 1660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1661: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1662: directory for the binary packages. The default is
1663: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1664: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1665: The top level directory where, if defined, the separate
1666: working directories will get created, and symbolically
1667: linked to from <code class="filename">${WRKDIR}</code> (see below).
1668: This is useful for building packages on several
1669: architectures, then <code class="filename">${PKGSRCDIR}</code>
1670: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1671: is local to every architecture. (It should be noted that
1672: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1673: — it is an internal definition which refers to the
1.1 dsieger 1674: root of the pkgsrc tree. It is possible to have many
1675: pkgsrc tree instances.)</p></li>
1.23 wiz 1676: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1677: Directory for local patches that aren't part of pkgsrc.
1.108 rillig 1678: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1679: information.</p></li>
1.23 wiz 1680: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1681: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1682: BSD-style Makefile. If this is not set,
1683: <code class="varname">MAKECONF</code> is set to
1684: <code class="filename">/dev/null</code> to avoid picking up
1685: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 1686: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 1687: By default, dependencies are only installed, and no binary
1688: package is created for them. You can set this variable to
1.66 asau 1689: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 1690: packages after installing dependencies. Please note that the
1.84 wiz 1691: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 1692: <code class="literal">yes</code> to preserve binary packages when
1693: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 1694: </ul></div>
1695: </div>
1.41 asau 1696: <div class="sect1">
1.1 dsieger 1697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 1698: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.107 jnemeth 1699: <p>Packages have to support installation into a
1.4 rillig 1700: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1701: to be built, before the actual filesystem is touched. DESTDIR
1702: support exists in two variations:</p>
1.41 asau 1703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1704: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1705: installation and packaging is still run as root.</p></li>
1706: <li class="listitem"><p>Full DESTDIR support can run the complete
1707: build, installation and packaging as normal user. Root
1708: privileges are only needed to add packages.</p></li>
1709: </ul></div>
1.4 rillig 1710: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1711: clean</code></strong> needs to be run as root.</p>
1.17 imil 1712: <p>Considering the <code class="filename">foo/bar</code> package,
1713: DESTDIR full support can be tested using the following commands
1714:
1715: </p>
1716: <pre class="programlisting">
1717: <code class="prompt">$</code> id
1718: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1719: <code class="prompt">$</code> mkdir $HOME/packages
1720: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1721: </pre>
1722: <p>
1723:
1724: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1725: should be needed
1726:
1727: </p>
1728: <pre class="programlisting">
1.66 asau 1729: <code class="prompt">$</code> make stage-install
1.17 imil 1730: </pre>
1731: <p>
1732:
1733: Create a package without root privileges
1734:
1735: </p>
1736: <pre class="programlisting">
1.66 asau 1737: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1738: </pre>
1739: <p>
1740:
1741: For the following command, you must be able to gain root
1.120 sevan 1742: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1743:
1744: </p>
1745: <pre class="programlisting">
1.66 asau 1746: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1747: </pre>
1748: <p>
1749:
1750: Then, as a simple user
1751:
1752: </p>
1753: <pre class="programlisting">
1754: <code class="prompt">$</code> make clean
1755: </pre>
1756: <p>
1757:
1758: </p>
1.4 rillig 1759: </div>
1.41 asau 1760: <div class="sect1">
1.4 rillig 1761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1762: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1763: <div class="sect2">
1.1 dsieger 1764: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1765: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1766: <p>By default, pkgsrc will use GCC to build packages. This may be
1767: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1768: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1769: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1770: <dd>
1771: <p>This is a list of values specifying the chain of
1772: compilers to invoke when building packages. Valid values
1773: are:</p>
1.41 asau 1774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1775: <li class="listitem"><p><code class="varname">ccc</code>:
1776: Compaq C Compilers (Tru64)</p></li>
1777: <li class="listitem"><p><code class="varname">ccache</code>:
1778: compiler cache (chainable)</p></li>
1779: <li class="listitem"><p><code class="varname">clang</code>:
1780: Clang C and Objective-C compiler</p></li>
1.23 wiz 1781: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1782: distributed C/C++ (chainable)</p></li>
1.66 asau 1783: <li class="listitem"><p><code class="varname">f2c</code>:
1784: Fortran 77 to C compiler (chainable)</p></li>
1785: <li class="listitem"><p><code class="varname">icc</code>:
1786: Intel C++ Compiler (Linux)</p></li>
1787: <li class="listitem"><p><code class="varname">ido</code>:
1788: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1789: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1790: GNU C/C++ Compiler</p></li>
1.66 asau 1791: <li class="listitem"><p><code class="varname">hp</code>:
1792: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1793: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1794: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1795: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1796: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1797: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1798: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1799: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1800: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1801: </ul></div>
1802: <p>The default is
1.23 wiz 1803: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1804: <code class="varname">ccache</code> and/or
1805: <code class="varname">distcc</code> with an appropriate
1806: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1807: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1808: variable should always be terminated with a value for
1809: a real compiler. Note that only one real compiler
1.23 wiz 1810: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1811: is not allowed).</p>
1812: </dd>
1813: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1814: <dd><p>This specifies the minimum version of GCC to use
1815: when building packages. If the system GCC doesn't
1816: satisfy this requirement, then pkgsrc will build and
1817: install one of the GCC packages to use instead.</p></dd>
1.114 maya 1818: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
1819: <dd><p>Specifies which version of python to use when several
1820: options are available.</p></dd>
1821: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1822: <dd><p>Specifies the fortran compiler to use.
1823: The default is <code class="varname">g95</code>, and
1824: <code class="varname">gfortran</code> is an alternative.</p></dd>
1825: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1826: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1827: <code class="varname">gfortran</code> is used, this option specifies which
1828: version to use.</p></dd>
1.1 dsieger 1829: </dl></div>
1830: </div>
1.41 asau 1831: <div class="sect2">
1.1 dsieger 1832: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1833: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1834: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1835: please make sure to use the <code class="literal">+=</code> operator
1836: instead of the <code class="literal">=</code> operator:</p>
1837: <pre class="programlisting">
1838: CFLAGS+= -your -flags
1839: </pre>
1840: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1841: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1842: need to add their own flags. You may want to take a look
1.120 sevan 1843: at the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 1844: package if you're interested in optimization specifically
1845: for the current CPU. </p>
1.1 dsieger 1846: </div>
1.41 asau 1847: <div class="sect2">
1.1 dsieger 1848: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1849: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1850: <p>If you want to pass flags to the linker, both in the configure
1851: step and the build step, you can do this in two ways. Either set
1852: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1853: between the two is that <code class="varname">LIBS</code> will be appended to
1854: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1855: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1856: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1857: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1858: <code class="varname">CFLAGS</code>, if you do not wish to override these
1859: settings, use the <code class="literal">+=</code> operator:</p>
1860: <pre class="programlisting">
1861: LDFLAGS+= -your -linkerflags
1862: </pre>
1863: </div>
1864: </div>
1.41 asau 1865: <div class="sect1">
1.1 dsieger 1866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1867: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1868: <p>
1.1 dsieger 1869: </p>
1.41 asau 1870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1871: <li class="listitem">
1.1 dsieger 1872: <p><code class="varname">PKG_DEVELOPER</code>:
1873: Run some sanity checks that package developers want:
1874: </p>
1.41 asau 1875: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1876: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1877: fuzz</p></li>
1.23 wiz 1878: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1879: binaries will find their shared libs.</p></li>
1880: </ul></div>
1881: <p>
1882: </p>
1883: </li>
1.23 wiz 1884: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1885: of debugging output which is displayed whilst making and
1886: installing the package. The default value for this is 0,
1887: which will not display the commands as they are executed
1888: (normal, default, quiet operation); the value 1 will display
1889: all shell commands before their invocation, and the value 2
1890: will display both the shell commands before their invocation,
1.112 rillig 1891: as well as their actual execution progress with <span class="command"><strong>set
1892: -x</strong></span>.</p></li>
1.1 dsieger 1893: </ul></div>
1894: <p>
1895: </p>
1896: </div>
1.41 asau 1897: <div class="sect1">
1.1 dsieger 1898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1899: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1900: <p>Some packages have build time options, usually to select
1901: between different dependencies, enable optional support for big
1902: dependencies or enable experimental features.</p>
1903: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1904: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1905: show-options</strong></span>, for example:</p>
1906: <pre class="programlisting">
1907: The following options are supported by this package:
1908: ssl Enable SSL support.
1909: Exactly one of the following gecko options is required:
1910: firefox Use firefox as gecko rendering engine.
1911: mozilla Use mozilla as gecko rendering engine.
1912: At most one of the following database options may be selected:
1913: mysql Enable support for MySQL database.
1914: pgsql Enable support for PostgreSQL database.
1915:
1916: These options are enabled by default: firefox
1917: These options are currently enabled: mozilla ssl
1918: </pre>
1919: <p>The following variables can be defined in
1.10 hubertf 1920: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1921: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1922: which can be used to select or disable options for all packages
1923: that support them, and
1924: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1925: which can be used to select or disable options specifically for
1926: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1927: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1928: are disabled. A few examples:</p>
1929: <pre class="screen">
1.10 hubertf 1930: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 1931: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1932: PKG_OPTIONS.kdebase= debug -sasl
1933: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1934: <p>It is important to note that options that were specifically
1.18 snj 1935: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1936: you do not wish to include the option. If you are unsure you can view
1937: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1938: <p>The following settings are consulted in the order given, and
1939: the last setting that selects or disables an option is
1940: used:</p>
1.23 wiz 1941: <div class="orderedlist"><ol class="orderedlist" type="1">
1942: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1943: maintainer</p></li>
1.23 wiz 1944: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1945: variables (see below)</p></li>
1.23 wiz 1946: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1947: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1948: </ol></div>
1949: <p>For groups of mutually exclusive options, the last option
1950: selected is used, all others are automatically disabled. If an
1951: option of the group is explicitly disabled, the previously
1952: selected option, if any, is used. It is an error if no option
1953: from a required group of options is selected, and building the
1954: package will fail.</p>
1955: <p>Before the options framework was introduced, build options
1956: were selected by setting a variable (often named
1957: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 1958: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 1959: transition to the options framework for the user, these legacy
1960: variables are converted to the appropriate options setting
1961: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1962: automatically. A warning is issued to prompt the user to update
1.10 hubertf 1963: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 1964: directly. Support for the legacy variables will be removed
1965: eventually.</p>
1966: </div>
1967: </div>
1.41 asau 1968: <div class="chapter">
1.1 dsieger 1969: <div class="titlepage"><div><div><h2 class="title">
1970: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
1971: <div class="toc">
1972: <p><b>Table of Contents</b></p>
1.100 leot 1973: <dl class="toc">
1.1 dsieger 1974: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
1975: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1976: </dl>
1977: </div>
1.41 asau 1978: <div class="sect1">
1.1 dsieger 1979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1980: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1981: <p>Once you have built and installed a package, you can create
1982: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.120 sevan 1983: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 1984: the same package on a group of hosts and wasting CPU time. It also
1985: provides a simple means for others to install your package, should
1986: you distribute it.</p>
1987: <p>To create a binary package, change into the appropriate
1.10 hubertf 1988: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 1989: package</strong></span>:</p>
1990: <pre class="screen">
1.112 rillig 1991: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1992: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
1993: </pre>
1.1 dsieger 1994: <p>This will build and install your package (if not already done),
1995: and then build a binary package from what was installed. You can
1.10 hubertf 1996: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 1997: it. Binary packages are created by default in
1998: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 1999: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.120 sevan 2000: continuation of the above <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.10 hubertf 2001: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2002: such a binary package.</p>
2003: </div>
1.41 asau 2004: <div class="sect1">
1.1 dsieger 2005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2006: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2007: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.6 rillig 2008: </div>
2009: </div>
1.41 asau 2010: <div class="chapter">
1.6 rillig 2011: <div class="titlepage"><div><div><h2 class="title">
2012: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2013: builds)</h2></div></div></div>
2014: <div class="toc">
2015: <p><b>Table of Contents</b></p>
1.100 leot 2016: <dl class="toc">
1.71 wiz 2017: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2018: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2019: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2020: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2021: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2022: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2023: </dl>
2024: </div>
1.71 wiz 2025: <p>For a number of reasons you may want to build binary packages
2026: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2027: For instance, when you have multiple machines that should run the same software,
2028: it is wasted time if they all build their packages themselves from source.
2029: Or you may want to build a list of packages you want and check them before
2030: deploying onto production system.
2031: There is a way of getting a set of binary packages:
1.112 rillig 2032: The bulk build system, or pbulk ("p" stands for "parallel").
2033: This chapter describes how to set it up.</p>
1.41 asau 2034: <div class="sect1">
1.6 rillig 2035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2036: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2037: <p>First of all, you have to decide whether you build all packages
2038: or a limited set of them. Full bulk builds usually consume a lot more resources,
2039: both space and time, than builds for some practical sets of packages.
2040: There exists a number of particularly heavy packages that are not actually
2041: interesting to a wide audience.
2042:
2043: For a limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2044: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2045: </p>
2046: <p>During bulk builds various packages are installed and deinstalled
2047: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2048: so make sure that you don't need any package during the builds.
1.112 rillig 2049: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2050: or something even more restrictive, depending on what the operating system provides,
2051: or dedicate the whole physical machine.
2052: As a useful side effect this makes sure that bulk builds cannot
2053: break anything in your system. There have been numerous cases where
1.6 rillig 2054: certain packages tried to install files outside the
2055: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2056: <code class="filename">/etc</code>.
2057: </p>
1.6 rillig 2058: </div>
1.41 asau 2059: <div class="sect1">
1.6 rillig 2060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2061: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2062: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2063: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2064: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2065: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2066: </ul></div>
1.41 asau 2067: <div class="sect2">
1.15 rillig 2068: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2069: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.112 rillig 2070: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2071: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2072: Configure network access to fetch distribution files.
1.112 rillig 2073: Create a user with name "pbulk".</p>
1.68 asau 2074: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2075: <pre class="screen">
1.72 wiz 2076: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && ftp -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2077: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2078: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68 asau 2079: </pre>
2080: <p>Or any other way that fits (e.g., curl, wget).</p>
2081: <p>Deploy and configure pbulk tools, e.g.:</p>
2082: <pre class="screen">
1.118 sevan 2083: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.68 asau 2084: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
2085: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2086: </pre>
2087: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2088: <h3 class="title">Note</h3>
2089: <p><code class="filename">mk.conf.frag</code> is a fragment of
2090: <code class="filename">mk.conf</code> that contains settings you want to
2091: apply to packages you build. For instance,</p>
2092: <pre class="programlisting">
1.112 rillig 2093: PKG_DEVELOPER= yes # perform more checks
2094: X11_TYPE= modular # use pkgsrc X11
2095: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2096: # when building all packages)
1.68 asau 2097: </pre>
2098: </div>
2099: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2100: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2101: <pre class="programlisting">
2102: www/firefox
2103: mail/thunderbird
2104: misc/libreoffice4
2105: </pre>
1.69 asau 2106: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2107: and make final amendments, if wanted.</p>
1.68 asau 2108: <p>Start it:</p>
2109: <pre class="screen">
2110: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2111: </pre>
2112: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2113: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2114: </p>
2115: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2116: <h3 class="title">Note</h3>
2117: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2118: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2119: The script is kept small enough for better understanding.</p>
2120: </div>
2121: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2122: <h3 class="title">Note</h3>
2123: <p>The <code class="filename">pbulk.sh</code> script supports running
2124: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2125: </div>
1.6 rillig 2126: </div>
2127: </div>
1.41 asau 2128: <div class="sect1">
1.6 rillig 2129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2130: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2131: <p>A complete bulk build requires lots of disk space. Some of the
2132: disk space can be read-only, some other must be writable. Some can be on
2133: remote filesystems (such as NFS) and some should be local. Some can be
2134: temporary filesystems, others must survive a sudden reboot.</p>
2135: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2136: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2137: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2138: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2139: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2140: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2141: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2142: </ul></div>
2143: </div>
2144: <div class="sect1">
2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2146: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2147: <p>After your pkgsrc bulk-build has completed, you may wish to
2148: create a CD-ROM set of the resulting binary packages to assist
2149: in installing packages on other machines. The
1.120 sevan 2150: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1 dsieger 2151: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2152: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2153: way that keeps all the dependencies for a given package on the same
2154: CD as that package.</p>
1.41 asau 2155: <div class="sect2">
1.1 dsieger 2156: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2157: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2158: <p>Complete documentation for cdpack is found in the cdpack(1)
2159: man page. The following short example assumes that the binary
2160: packages are left in
2161: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2162: sufficient disk space exists in <code class="filename">/u2</code> to
2163: hold the ISO 9660 images.</p>
2164: <pre class="screen">
2165: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2166: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2167: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2168: </pre>
2169: <p>If you wish to include a common set of files
2170: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2171: etc.) on each CD in the collection, then you need to create a
2172: directory which contains these files. e.g.</p>
2173: <pre class="screen">
2174: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2175: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2176: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2177: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2178: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2179: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2180: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2181: </pre>
2182: <p>Now create the images:</p>
2183: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2184: <p>Each image will contain <code class="filename">README</code>,
2185: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2186: in their root directories.</p>
2187: </div>
2188: </div>
2189: </div>
1.41 asau 2190: <div class="chapter">
1.1 dsieger 2191: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2192: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2193: <div class="toc">
2194: <p><b>Table of Contents</b></p>
1.100 leot 2195: <dl class="toc">
1.23 wiz 2196: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2197: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 2198: </dl>
2199: </div>
2200: <p>The files that are installed by pkgsrc are organized in a way that
2201: is similar to what you find in the <code class="filename">/usr</code> directory
2202: of the base system. But some details are different. This is because
2203: pkgsrc initially came from FreeBSD and had adopted its file system
2204: hierarchy. Later it was largely influenced by NetBSD. But no matter
2205: which operating system you are using pkgsrc with, you can expect the
2206: same layout for pkgsrc.</p>
2207: <p>There are mainly four root directories for pkgsrc, which are all
2208: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2209: When pkgsrc has been installed as root, the default locations
2210: are:</p>
2211: <pre class="programlisting">
2212: LOCALBASE= /usr/pkg
2213: PKG_SYSCONFBASE= /usr/pkg/etc
2214: VARBASE= /var
1.119 sevan 2215: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2216: </pre>
2217: <p>In unprivileged mode (when pkgsrc has been installed as any other
2218: user), the default locations are:</p>
2219: <pre class="programlisting">
2220: LOCALBASE= ${HOME}/pkg
2221: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2222: VARBASE= ${HOME}/pkg/var
1.119 sevan 2223: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2224: </pre>
2225: <p>What these four directories are for, and what they look like is
2226: explained below.</p>
1.41 asau 2227: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2228: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2229: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2230: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2231: the well-known subdirectories like <code class="filename">bin</code>,
2232: <code class="filename">include</code>, <code class="filename">lib</code>,
2233: <code class="filename">share</code> and
2234: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2235: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2236: <code class="filename">/var</code> in the base system. Some programs (especially
2237: games, network daemons) need write access to it during normal
2238: operation.</p></li>
1.23 wiz 2239: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2240: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2241: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 2242: itself.</p></li>
2243: </ul></div>
1.41 asau 2244: <div class="sect1">
1.1 dsieger 2245: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2246: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2247: </h2></div></div></div>
2248: <p>The following directories exist in a typical pkgsrc installation
2249: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2250: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2251: <dt><span class="term"><code class="filename">bin</code></span></dt>
2252: <dd><p>Contains executable programs that are intended to be
2253: directly used by the end user.</p></dd>
2254: <dt><span class="term"><code class="filename">emul</code></span></dt>
2255: <dd><p>Contains files for the emulation layers of various other
2256: operating systems, especially for
2257: NetBSD.</p></dd>
2258: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2259: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2260: <dd><p>Contains
2261: the configuration files.</p></dd>
2262: <dt><span class="term"><code class="filename">include</code></span></dt>
2263: <dd><p>Contains headers for the C and C++ programming
2264: languages.</p></dd>
2265: <dt><span class="term"><code class="filename">info</code></span></dt>
2266: <dd><p>Contains GNU info files of various
2267: packages.</p></dd>
2268: <dt><span class="term"><code class="filename">lib</code></span></dt>
2269: <dd><p>Contains shared and static
2270: libraries.</p></dd>
2271: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2272: <dd><p>Contains data files that don't change after
2273: installation. Other data files belong into
2274: <code class="filename">${VARBASE}</code>.</p></dd>
2275: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2276: <dd><p>Contains programs that are not intended to be used by
2277: end users, such as helper programs or network
2278: daemons.</p></dd>
2279: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2280: <dd><p>Contains programs that are intended to be executed as
2281: CGI scripts by a web server.</p></dd>
2282: <dt><span class="term"><code class="filename">man</code> (the usual value of
2283: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2284: <dd><p>Contains brief
2285: documentation in form of manual pages.</p></dd>
2286: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2287: <dd><p>Contains programs that are intended to be used only by
2288: the super-user.</p></dd>
2289: <dt><span class="term"><code class="filename">share</code></span></dt>
2290: <dd><p>Contains platform-independent data files that don't
2291: change after installation.</p></dd>
2292: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2293: <dd><p>Contains documentation files provided by the
2294: packages.</p></dd>
2295: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2296: <dd><p>Contains example files provided by the packages. Among
2297: others, the original configuration files are saved here and copied to
2298: <code class="filename">${PKG_SYSCONFDIR}</code> during
2299: installation.</p></dd>
2300: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2301: <dd><p>Contains the original files for rc.d
2302: scripts.</p></dd>
2303: <dt><span class="term"><code class="filename">var</code> (the usual location of
2304: <code class="filename">${VARBASE}</code>)</span></dt>
2305: <dd><p>Contains files
2306: that may be modified after
2307: installation.</p></dd>
2308: </dl></div>
2309: </div>
1.41 asau 2310: <div class="sect1">
1.1 dsieger 2311: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2312: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2313: </h2></div></div></div>
1.41 asau 2314: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2315: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2316: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2317: <dd><p>Contains
2318: information about the currently installed
2319: packages.</p></dd>
2320: <dt><span class="term"><code class="filename">games</code></span></dt>
2321: <dd><p>Contains highscore
2322: files.</p></dd>
2323: <dt><span class="term"><code class="filename">log</code></span></dt>
2324: <dd><p>Contains log files.</p></dd>
2325: <dt><span class="term"><code class="filename">run</code></span></dt>
2326: <dd><p>Contains informational files about daemons that are
2327: currently running.</p></dd>
2328: </dl></div>
2329: </div>
2330: </div>
1.41 asau 2331: <div class="chapter">
1.1 dsieger 2332: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2333: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2334: <div class="toc">
2335: <p><b>Table of Contents</b></p>
1.100 leot 2336: <dl class="toc">
1.6 rillig 2337: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 2338: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2339: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2340: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2341: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2342: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2343: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2344: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2345: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2346: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2347: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2348: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
2349: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2350: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2351: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2352: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2353: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2354: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 2355: </dl>
2356: </div>
2357: <p>This section contains hints, tips & tricks on special things in
2358: pkgsrc that we didn't find a better place for in the previous chapters, and
2359: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2360: <div class="sect1">
1.1 dsieger 2361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2362: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2363: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2365: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 2366: This is a general purpose list for most issues regarding
2367: pkgsrc, regardless of platform, e.g. soliciting user help
2368: for pkgsrc configuration, unexpected build failures, using
2369: particular packages, upgrading pkgsrc installations,
2370: questions regarding the pkgsrc release branches, etc. General announcements or
2371: proposals for changes that impact the pkgsrc user community,
2372: e.g. major infrastructure changes, new features, package
2373: removals, etc., may also be posted.</p></li>
1.23 wiz 2374: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2375: A list where the results of pkgsrc bulk builds are sent and
2376: discussed.</p></li>
1.23 wiz 2377: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2378: This list is for those who are interested in getting a
2379: commit message for every change committed to pkgsrc. It is
2380: also available in digest form, meaning one daily message
2381: containing all commit messages for changes to the package
2382: source tree in that 24 hour period.</p></li>
2383: </ul></div>
2384: <p>To subscribe, do:</p>
2385: <pre class="programlisting">
2386: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2387: </pre>
2388: <p>Archives for all these mailing lists are available from
1.10 hubertf 2389: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2390: </div>
1.41 asau 2391: <div class="sect1">
1.1 dsieger 2392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2393: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2394: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2395: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2396: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2397: they might be useful, and not to duplicate the documentation that comes
2398: with each package.</p>
2399: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.120 sevan 2400: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 2401: Symlinks for use by buildlink.</p></li></ul></div>
2402: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2403: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2404: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121 sevan 2405: Calculates various kinds of checksums (including SHA3).</p></li>
1.120 sevan 2406: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 2407: Compatibility library for pkgsrc tools.</p></li>
1.120 sevan 2408: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 2409: non-BSD systems due to lack of native mtree.</p></li>
1.120 sevan 2410: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 2411: Up-to-date replacement for
2412: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2413: systems where pkg_install is not present.</p></li>
2414: </ul></div>
2415: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2416: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2417: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2418: Create a binary package from an
1.10 hubertf 2419: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2420: save the old package.</p></li>
1.120 sevan 2421: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 2422: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2423: from multiple locations. It currently supports the following
2424: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.120 sevan 2425: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 2426: the best compiler flags to optimise code for your current
1.23 wiz 2427: CPU and compiler. </p></li>
1.1 dsieger 2428: </ul></div>
2429: <p>Utilities for keeping track of installed packages, being up to date,
2430: etc:</p>
1.41 asau 2431: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2432: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65 wiz 2433: update tool similar to apt(1). Download, install, and upgrade
2434: binary packages easily.</p></li>
1.120 sevan 2435: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 2436: packages whose installed versions do not match the latest pkgsrc
2437: entries.</p></li>
1.120 sevan 2438: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 2439: dependency graphs of packages, to aid in choosing a strategy for
2440: updating.</p></li>
1.120 sevan 2441: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2442: graphs from the output of <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2443: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 2444: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.120 sevan 2445: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 2446: does various checks on the complete pkgsrc system.</p></li>
1.120 sevan 2447: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 2448: packages you have installed.</p></li>
2449: </ul></div>
2450: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2451: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2452: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 2453: making and maintaining patches for a package (includes pkgdiff,
2454: pkgvi, mkpatches, etc.).</p></li>
1.120 sevan 2455: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1 dsieger 2456: converting to pkgsrc.</p></li>
2457: </ul></div>
2458: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2459: utilities)</p>
1.41 asau 2460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2461: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 2462: packages in a chrooted area.</p></li>
1.120 sevan 2463: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 2464: kernel version for chrooted cross builds.</p></li>
2465: </ul></div>
2466: </div>
1.41 asau 2467: <div class="sect1">
1.1 dsieger 2468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2469: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2470: <p>To install packages from source as a non-root user, download
2471: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
2472: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2473: --unprivileged</strong></span>.</p>
2474: <p>This will install the binary part of pkgsrc to
2475: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2476: into <code class="filename">~/pkg/etc</code>.</p>
2477: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2478: </div>
1.41 asau 2479: <div class="sect1">
1.1 dsieger 2480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2481: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2482: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2483: enable this feature by adding the option
2484: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2485: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2486: distfile is found, pkgsrc will try to resume it.</p>
2487: <p>You can also
1.61 wiz 2488: use a different program than the platform default program by changing the
1.16 jnemeth 2489: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2490: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2491: by using the value manual. A value of custom disables the system defaults
2492: and dependency tracking for the fetch program. In that case you have to
2493: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2494: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2495: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2496: <p>For example, if you want to use
1.16 jnemeth 2497: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2498: like:</p>
2499: <pre class="programlisting">
1.112 rillig 2500: FETCH_USING= wget
1.1 dsieger 2501: </pre>
2502: </div>
1.41 asau 2503: <div class="sect1">
1.1 dsieger 2504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2505: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 2506: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2507: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2508: you will have to add the following line into
1.10 hubertf 2509: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2510: <pre class="programlisting">
1.4 rillig 2511: X11_TYPE=modular
1.1 dsieger 2512: </pre>
2513: </div>
1.41 asau 2514: <div class="sect1">
1.1 dsieger 2515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2516: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2517: <p>If you are sitting behind a firewall which does not allow direct
2518: connections to Internet hosts (i.e. non-NAT), you may specify the
2519: relevant proxy hosts. This is done using an environment variable in the
2520: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2521: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2522: port 80 as the proxy port number. So the proxy environment variables
2523: are:</p>
2524: <pre class="programlisting">
2525: ftp_proxy=ftp://orpheus.amdahl.com:80/
2526: http_proxy=http://orpheus.amdahl.com:80/
2527: </pre>
2528: </div>
1.41 asau 2529: <div class="sect1">
1.1 dsieger 2530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2531: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2532: <p>Some fetch tools are not prepared to support HTTPS by default
2533: (for example, the one in NetBSD 6.0), or the one installed by the
2534: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2535: dependency graph).</p>
2536: <p>Usually you won't notice, because distribution files are
2537: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2538: be often enough if you are following pkgsrc-current. In that case, set
2539: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2540: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2541: with HTTPS support by default. Of course, these tools need to be
2542: installed before you can use them this way.</p>
2543: </div>
2544: <div class="sect1">
2545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2546: <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 2547: <p>This depends on which utility is used to retrieve distfiles. From
2548: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2549: the first available command from the following list:</p>
1.41 asau 2550: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2551: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2552: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2553: </ul></div>
2554: <p>On a default NetBSD installation, this will be
2555: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2556: connections first, and falls back to active connections if the server
2557: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2558: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2559: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2560: <p>Having that option present will prevent
2561: <code class="filename">/usr/bin/ftp</code> from falling back to active
2562: transfers.</p>
2563: </div>
1.41 asau 2564: <div class="sect1">
1.1 dsieger 2565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2566: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2567: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2568: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2569: 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 2570: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2571: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2572: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2573: resulting list to your machine at work/school and use it there. If you
1.120 sevan 2574: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 2575: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2576: URL:</p>
2577: <p>At home:</p>
2578: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2579: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2580: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2581: <p>At work:</p>
2582: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2583: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2584: home.</p>
2585: <p>If you have a machine running NetBSD, and you want to get
2586: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2587: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2588: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2589: directly by running:</p>
2590: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2591: <p>If you even decide to ignore
2592: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2593: by running:</p>
2594: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2595: </div>
1.41 asau 2596: <div class="sect1">
1.1 dsieger 2597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2598: <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 2599: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.120 sevan 2600: <p>When compiling the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1 dsieger 2601: package, you get the error from make that it doesn't know how to make
2602: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2603: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2604: the NetBSD base distribution on your machine. It is recommended to do
2605: that to format man pages.</p>
1.120 sevan 2606: <p>In the case of the <a href="http://cdn.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 2607: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2608: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2609: </div>
1.41 asau 2610: <div class="sect1">
1.1 dsieger 2611: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2612: <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 2613: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2614: when you installed your NetBSD machine. Please get and install it, by
2615: extracting it in <code class="filename">/</code>:</p>
2616: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2617: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2618: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2619: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2620: -r</strong></span>).</p>
2621: </div>
1.41 asau 2622: <div class="sect1">
1.1 dsieger 2623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2624: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2625: <p>When installing packages as non-root user and using the just-in-time
1.120 sevan 2626: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.0.2"><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 2627: password for each required package installed. To avoid this, the sudo
2628: package can be used, which does password caching over a limited time. To
2629: use it, install sudo (either as binary package or from
1.120 sevan 2630: <a href="http://cdn.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 2631: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2632: <span class="emphasis"><em>after</em></span> the definition of the
2633: <code class="varname">LOCALBASE</code> variable:</p>
2634: <pre class="programlisting">
2635: .if exists(${LOCALBASE}/bin/sudo)
2636: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2637: .endif
2638: </pre>
2639: </div>
1.41 asau 2640: <div class="sect1">
1.1 dsieger 2641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2642: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2643: <p>As the system administrator, you can choose where configuration files
2644: are installed. The default settings make all these files go into
2645: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2646: be suboptimal depending on your expectations (e.g., a read-only,
2647: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2648: configuration of the provided packages).</p>
2649: <p>In order to change the defaults, you can modify the
2650: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2651: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2652: directory; some common examples include <code class="filename">/etc</code> or
2653: <code class="filename">/etc/pkg</code>.</p>
2654: <p>Furthermore, you can change this value on a per-package basis by
2655: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2656: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2657: package you would like to modify, that is, the contents of
2658: <code class="varname">PKGBASE</code>.</p>
2659: <p>Note that after changing these settings, you must rebuild and
2660: reinstall any affected packages.</p>
2661: </div>
1.41 asau 2662: <div class="sect1">
1.1 dsieger 2663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2664: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2665: <p>Please be aware that there can often be bugs in third-party software,
2666: and some of these bugs can leave a machine vulnerable to exploitation by
2667: attackers. In an effort to lessen the exposure, the NetBSD packages team
2668: maintains a database of known-exploits to packages which have at one time
2669: been included in pkgsrc. The database can be downloaded automatically, and
2670: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2671: do this, refer to the following two tools (installed as part of the
1.120 sevan 2672: <a href="http://cdn.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 2673: <div class="orderedlist"><ol class="orderedlist" type="1">
2674: <li class="listitem">
1.20 snj 2675: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2676: download a list of the security vulnerabilities information. This list
1.25 spz 2677: is kept up to date by the pkgsrc security team, and is distributed
2678: from the NetBSD ftp server:</p>
2679: <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 2680: </li>
1.23 wiz 2681: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2682: current machine, checking each known vulnerability. If a
1.1 dsieger 2683: vulnerable package is installed, it will be shown by output to stdout,
2684: including a description of the type of vulnerability, and a URL
2685: containing more information.</p></li>
2686: </ol></div>
1.121 sevan 2687: <p>Use of these tools is strongly recommended!
2688: See <a class="xref" href="#vulnerabilities" title="4.1.5. Checking for security vulnerabilities in installed packages">Section 4.1.5, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
2689: reporting.</p>
2690: <p>If this database is installed, pkgsrc builds will use it to
2691: perform a security check before building any package.</p>
1.1 dsieger 2692: </div>
1.41 asau 2693: <div class="sect1">
1.1 dsieger 2694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2695: <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 2696: <p>When you add your own preferences to the
2697: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2698: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2699: environment variables to the <code class="filename">./configure</code>
1.120 sevan 2700: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 2701: <code class="varname">CFLAGS</code> from the environment variable by
2702: overriding them in the <code class="filename">Makefile</code>s of their
2703: package.</p>
2704: <p>Currently there is no solution to this problem. If you
2705: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2706: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2707: directory and then inspect any <code class="filename">Makefile</code> and
2708: <code class="filename">Makefile.in</code> for whether they define
2709: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2710: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2711: programmers write so bad code that it only works for the
2712: specific combination of <code class="varname">CFLAGS</code> they have
2713: chosen.</p>
2714: </div>
1.41 asau 2715: <div class="sect1">
1.1 dsieger 2716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2717: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2718: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2719: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2720: case that occurs often is that people only update pkgsrc in
2721: parts, because of performance reasons. Since pkgsrc is one large
2722: system, not a collection of many small systems, there are
2723: sometimes changes that only work when the whole pkgsrc tree is
2724: updated.</p></li>
1.41 asau 2725: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2726: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2727: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2728: files.</p></li>
1.41 asau 2729: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2730: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2731: verify this.</p></li>
1.108 rillig 2732: <li class="step"><p>If you are a package developer who wants to invest
2733: 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 2734: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2735: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2736: </ol></div>
2737: </div>
1.41 asau 2738: <div class="sect1">
1.1 dsieger 2739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2740: <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 2741: <p>You have modified a file from pkgsrc, and someone else has
2742: modified that same file afterwards in the CVS repository. Both changes
2743: are in the same region of the file, so when you updated pkgsrc, the
2744: <code class="literal">cvs</code> command marked the conflicting changes in the
2745: file. Because of these markers, the file is no longer a valid
2746: <code class="filename">Makefile</code>.</p>
2747: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2748: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2749: -dP</strong></span> in that directory to download the current version.</p>
2750: </div>
2751: </div>
2752: </div>
1.41 asau 2753: <div class="part">
1.1 dsieger 2754: <div class="titlepage"><div><div><h1 class="title">
2755: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2756: <div class="partintro">
1.1 dsieger 2757: <div></div>
2758: <p>This part of the book deals with creating and
1.23 wiz 2759: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2760: guide on creating a new package. The remaining chapters are more
2761: like a reference manual for pkgsrc.</p>
2762: <div class="toc">
2763: <p><b>Table of Contents</b></p>
1.100 leot 2764: <dl class="toc">
1.6 rillig 2765: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2766: <dd><dl>
1.6 rillig 2767: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2768: <dd><dl>
1.6 rillig 2769: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121 sevan 2770: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 & KDE4 applications</a></span></dt>
1.17 imil 2771: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 2772: </dl></dd>
1.6 rillig 2773: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
2774: <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>
2775: </dl></dd>
2776: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
2777: <dd><dl>
1.23 wiz 2778: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
2779: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 2780: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2781: <dd><dl>
2782: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
2783: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
2784: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
2785: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
2786: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
2787: </dl></dd>
2788: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
2789: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
2790: <dd><dl>
2791: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
2792: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
2793: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
2794: </dl></dd>
1.23 wiz 2795: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
2796: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2797: </dl></dd>
1.23 wiz 2798: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2799: <dd><dl>
2800: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 2801: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 2802: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
2803: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
2804: <dd><dl>
2805: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117 sevan 2806: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108 rillig 2807: <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>
2808: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2809: </dl></dd>
2810: </dl></dd>
2811: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
2812: <dd><dl>
2813: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 2814: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2815: <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 2816: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
2817: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 2818: <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 2819: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 2820: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
2821: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2822: </dl></dd>
2823: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
2824: <dd><dl>
2825: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 2826: <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 2827: <dd><dl>
2828: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 2829: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
2830: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2831: and
2832: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2833: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2834: </dl></dd>
1.23 wiz 2835: <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 2836: <dd><dl>
1.23 wiz 2837: <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 2838: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
2839: </dl></dd>
2840: </dl></dd>
2841: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
2842: <dd><dl>
2843: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
2844: <dd><dl>
2845: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
2846: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
2847: </dl></dd>
2848: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
2849: <dd><dl>
1.23 wiz 2850: <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 2851: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
2852: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
2853: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
2854: </dl></dd>
2855: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
2856: <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>
2857: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
2858: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
2859: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
2860: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
2861: <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>
2862: </dl></dd>
2863: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
2864: <dd><dl>
2865: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 2866: <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 2867: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 2868: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 2869: </dl></dd>
2870: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
2871: <dd><dl>
2872: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
2873: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
2874: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
2875: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 2876: <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 2877: <dd><dl>
2878: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
2879: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
2880: </dl></dd>
1.23 wiz 2881: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2882: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2883: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2884: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2885: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2886: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2887: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2888: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2889: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2890: <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 2891: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
2892: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
2893: </dl></dd>
2894: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
2895: <dd><dl>
2896: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
2897: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
2898: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
2899: </dl></dd>
2900: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
2901: <dd><dl>
2902: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
2903: <dd><dl>
1.108 rillig 2904: <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>
2905: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
2906: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
2907: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
2908: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
2909: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
2910: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
2911: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
2912: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
2913: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2914: <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 2915: </dl></dd>
1.108 rillig 2916: <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 2917: <dd><dl>
2918: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2919: <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 2920: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 2921: </dl></dd>
1.108 rillig 2922: <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 2923: <dd><dl>
2924: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
2925: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2926: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
2927: </dl></dd>
2928: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
2929: <dd><dl>
2930: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
2931: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
2932: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 2933: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
2934: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 2935: </dl></dd>
1.108 rillig 2936: <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 2937: <dd><dl>
2938: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
2939: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 2940: <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 2941: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
2942: </dl></dd>
1.108 rillig 2943: <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 2944: <dd><dl>
2945: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
2946: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
2947: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
2948: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
2949: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2950: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
2951: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
2952: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 2953: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 2954: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 2955: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
2956: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
2957: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
2958: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
2959: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
2960: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
2961: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
2962: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 2963: emulation</a></span></dt>
1.6 rillig 2964: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
2965: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 2966: </dl></dd>
1.6 rillig 2967: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 2968: </dl></dd>
1.6 rillig 2969: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
2970: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 2971: <dd><dl>
1.6 rillig 2972: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
2973: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
2974: <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 2975: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 2976: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 2977: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
2978: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 2979: </dl></dd>
2980: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
2981: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
2982: <dd><dl>
2983: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
2984: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
2985: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
2986: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 2987: </dl></dd>
2988: </dl>
2989: </div>
2990: </div>
1.41 asau 2991: <div class="chapter">
1.1 dsieger 2992: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2993: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 2994: <div class="toc">
2995: <p><b>Table of Contents</b></p>
1.100 leot 2996: <dl class="toc">
1.6 rillig 2997: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2998: <dd><dl>
1.6 rillig 2999: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121 sevan 3000: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 & KDE4 applications</a></span></dt>
1.17 imil 3001: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3002: </dl></dd>
1.6 rillig 3003: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3004: <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 3005: </dl>
3006: </div>
3007: <p>When you find a package that is not yet in pkgsrc, you
3008: most likely have a URL from where you can download the source
3009: code. Starting with this URL, creating a package involves only a
3010: few steps.</p>
1.23 wiz 3011: <div class="procedure"><ol class="procedure" type="1">
1.120 sevan 3012: <li class="step"><p>First, install the packages <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.41 asau 3013: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3014: category in which you want to place your package. You can also create a
3015: directory of your own (maybe called <code class="filename">local</code>). In that
3016: category directory, create another directory for your package and change
3017: into it.</p></li>
1.41 asau 3018: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3019: you for a URL. Enter the URL of the distribution file (in most cases a
3020: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3021: of your package are created automatically. The distribution file is
3022: extracted automatically to fill in some details in the
3023: <code class="filename">Makefile</code> that would otherwise have to be done
3024: manually.</p></li>
1.41 asau 3025: <li class="step">
1.1 dsieger 3026: <p>Examine the extracted files to determine the dependencies of
3027: your package. Ideally, this is mentioned in some
3028: <code class="filename">README</code> file, but things may differ. For each of
3029: these dependencies, look where it exists in pkgsrc, and if there is a
3030: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3031: line to your package <code class="filename">Makefile</code> which includes that
3032: file just before the last line. If the
1.25 spz 3033: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3034: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3035: <p>If you just need binaries from a package, add a
1.1 dsieger 3036: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3037: version of the dependency and where it can be found in pkgsrc. This line
3038: should be placed in the third paragraph. If the dependency is only
3039: needed for building the package, but not when using it, use
3040: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3041: Your package may then look like this:</p>
3042: <pre class="programlisting">
3043: [...]
3044:
1.66 asau 3045: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3046: DEPENDS+= screen-[0-9]*:../../misc/screen
3047: DEPENDS+= screen>=4.0:../../misc/screen
3048:
3049: [...]
3050:
3051: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3052: .include "../../devel/glib2/buildlink3.mk"
3053: .include "../../mk/bsd.pkg.mk"
3054: </pre>
3055: </li>
1.41 asau 3056: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3057: 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 3058: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3059: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3060: -e</strong></span>, which outputs additional
3061: explanations.</p></li>
1.41 asau 3062: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3063: 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 3064: over there, you can hopefully continue here.</p></li>
1.41 asau 3065: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3066: directory from the extracted files. Besides these files, a lot of cache
3067: files and other system information has been saved in the working
3068: directory, which may become wrong after you edited the
3069: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3070: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3071: 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 3072: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3073: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3074: everything works.</p></li>
1.41 asau 3075: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3076: contains a list of the files that are installed by the package, is
1.10 hubertf 3077: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3078: >PLIST</strong></span> to generate a probably correct list. Check
3079: the file using your preferred text editor to see if the list of
3080: files looks plausible.</p></li>
1.41 asau 3081: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3082: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3083: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3084: has been registered in the database of installed files, but with an
1.10 hubertf 3085: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3086: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3087: registered with the list of files from
3088: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3089: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3090: package from the set of installed files.</p></li>
3091: </ol></div>
1.41 asau 3092: <div class="sect1">
1.1 dsieger 3093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3094: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3095: <div class="sect2">
1.1 dsieger 3096: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3097: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3098: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3099: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3100: </div>
1.41 asau 3101: <div class="sect2">
1.1 dsieger 3102: <div class="titlepage"><div><div><h3 class="title">
1.121 sevan 3103: <a name="creating.kde-app"></a>10.1.2. KDE3 & KDE4 applications</h3></div></div></div>
1.66 asau 3104: <p>KDE3 applications should always include
1.1 dsieger 3105: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.121 sevan 3106: settings that are typical of KDE3 packages and KDE4 applications should
3107: always include <code class="filename">meta-pkgs/kde4/kde4.mk</code>, respectively.</p>
1.1 dsieger 3108: </div>
1.41 asau 3109: <div class="sect2">
1.17 imil 3110: <div class="titlepage"><div><div><h3 class="title">
3111: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3112: <p>Python modules and programs packages are easily created using a
3113: set of predefined variables.</p>
3114: <p>
1.63 wiz 3115: If some Python versions are not supported by the software, set the
3116: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3117: that are not supported, e.g.
1.17 imil 3118: </p>
3119: <pre class="programlisting">
1.93 sevan 3120: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3121: </pre>
3122: <p>
1.103 wiz 3123: If the packaged software is a Python module, include one of
3124: <code class="filename">../../lang/python/egg.mk</code>,
3125: <code class="filename">../../lang/python/distutils.mk</code>, or
3126: <code class="filename">../../lang/python/extension.mk</code>.</p>
3127: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3128: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3129: if the packaged software is using setuptools, you only need
3130: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3131: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3132: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3133: so pkgsrc will use this framework.
3134: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3135: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3136: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3137: to the name of the script.</p>
3138: <p>Either way, the package directory should be called
1.23 wiz 3139: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3140: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3141: </p>
3142: <pre class="programlisting">
3143: DISTNAME= foopymodule-1.2.10
3144: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3145: </pre>
1.63 wiz 3146: <p>If it is an application, include
3147: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3148: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3149: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3150: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3151: For example:
1.17 imil 3152: </p>
3153: <pre class="programlisting">
1.35 wiz 3154: REPLACE_PYTHON= *.py
1.17 imil 3155: </pre>
1.63 wiz 3156: <p>Some Python modules have separate distributions for Python-2.x
3157: and Python-3.x support. In pkgsrc this is handled by the
3158: <code class="filename">versioned_dependencies.mk</code> file. Set
3159: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3160: packages that should be depended upon and include
3161: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3162: then the pkgsrc infrastructure will depend on the appropriate package
3163: version. For example:
3164: </p>
3165: <pre class="programlisting">
1.110 wiz 3166: PYTHON_VERSIONED_DEPENDENCIES=dateutil
1.63 wiz 3167: </pre>
3168: <p>
3169: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3170: of supported packages.</p>
1.17 imil 3171: </div>
1.1 dsieger 3172: </div>
1.41 asau 3173: <div class="sect1">
1.1 dsieger 3174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3175: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3176: <div class="sect2">
1.1 dsieger 3177: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3178: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3179: <div class="sect3">
1.1 dsieger 3180: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3181: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3182: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3183: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3184: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3185: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3186: <pre class="programlisting">
3187: <code class="prompt">$</code> mkdir www/nvu
3188: <code class="prompt">$</code> cd www/nvu
3189: </pre>
3190: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3191: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3192: <pre class="programlisting">
3193: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3194: </pre>
3195: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3196: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3197: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3198: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3199: <code class="varname">COMMENT</code> fields. Then the package
3200: <code class="filename">Makefile</code> looked like that:</p>
3201: <pre class="programlisting">
1.121 sevan 3202: # $NetBSD $
1.1 dsieger 3203: #
3204:
3205: DISTNAME= nvu-1.0-sources
3206: PKGNAME= nvu-1.0
3207: CATEGORIES= www
3208: MASTER_SITES= http://cvs.nvu.com/download/
3209: EXTRACT_SUFX= .tar.bz2
3210:
3211: MAINTAINER= rillig@NetBSD.org
3212: HOMEPAGE= http://cvs.nvu.com/
3213: COMMENT= Web Authoring System
3214:
3215: # url2pkg-marker (please do not remove this line.)
3216: .include "../../mk/bsd.pkg.mk"
3217: </pre>
1.121 sevan 3218: <p>On the first line of output above, an artificial space has been added betweeen NetBSD and $,
3219: this is a workaround to prevent CVS expanding to the filename of the
3220: guide.</p>
1.1 dsieger 3221: <p>Then, I quit the editor and watched pkgsrc downloading a large
3222: source archive:</p>
3223: <pre class="programlisting">
3224: url2pkg> Running "make makesum" ...
3225: => Required installed package digest>=20010302: digest-20060826 found
3226: => Fetching nvu-1.0-sources.tar.bz2
3227: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3228: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3229: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3230: url2pkg> Running "make extract" ...
3231: => Required installed package digest>=20010302: digest-20060826 found
3232: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3233: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3234: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3235: ===> Installing dependencies for nvu-1.0
3236: ===> Overriding tools for nvu-1.0
3237: ===> Extracting for nvu-1.0
3238: url2pkg> Adjusting the Makefile.
3239:
3240: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3241:
3242: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3243: </pre>
3244: </div>
1.41 asau 3245: <div class="sect3">
1.1 dsieger 3246: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3247: <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 3248: <p>Now that the package has been extracted, let's see what's inside
3249: it. The package has a <code class="filename">README.txt</code>, but that only
3250: says something about mozilla, so it's probably useless for seeing what
3251: dependencies this package has. But since there is a GNU configure script
3252: in the package, let's hope that it will complain about everything it
3253: needs.</p>
3254: <pre class="programlisting">
3255: <code class="prompt">$</code> bmake
3256: => Required installed package digest>=20010302: digest-20060826 found
3257: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3258: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3259: ===> Patching for nvu-1.0
3260: ===> Creating toolchain wrappers for nvu-1.0
3261: ===> Configuring for nvu-1.0
3262: [...]
3263: configure: error: Perl 5.004 or higher is required.
3264: [...]
3265: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3266: [...]
3267: </pre>
3268: <p>That worked quite well. So I opened the package Makefile in my
3269: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3270: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3271: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3272: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3273: from scratch.</p>
3274: <pre class="programlisting">
3275: <code class="prompt">$</code> bmake clean
3276: ===> Cleaning for nvu-1.0
3277: <code class="prompt">$</code> bmake
3278: [...]
3279: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3280: GNU Make. You will not be able to build Mozilla without GNU Make.
3281: [...]
3282: </pre>
1.23 wiz 3283: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3284: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3285: <pre class="programlisting">
3286: [...]
3287: checking for GTK - version >= 1.2.0... no
3288: *** Could not run GTK test program, checking why...
3289: [...]
3290: </pre>
3291: <p>Now to the other dependencies. The first question is: Where is the
3292: GTK package hidden in pkgsrc?</p>
3293: <pre class="programlisting">
3294: <code class="prompt">$</code> echo ../../*/gtk*
3295: [many packages ...]
3296: <code class="prompt">$</code> echo ../../*/gtk
3297: ../../x11/gtk
3298: <code class="prompt">$</code> echo ../../*/gtk2
3299: ../../x11/gtk2
3300: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3301: ../../x11/gtk2/buildlink3.mk
3302: </pre>
3303: <p>The first try was definitely too broad. The second one had exactly
3304: one result, which is very good. But there is one pitfall with GNOME
3305: packages. Before GNOME 2 had been released, there were already many
3306: GNOME 1 packages in pkgsrc. To be able to continue to use these
3307: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3308: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3309: whether this was the case here, and indeed it was.</p>
3310: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3311: file, adding the dependency is very easy. I just inserted an
3312: <code class="literal">.include</code> line before the last line of the package
3313: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3314: <pre class="programlisting">
3315: [...]
3316: .include "../../x11/gtk2/buildlink3.mk"
3317: .include "../../mk/bsd.pkg.mk
3318: </pre>
1.10 hubertf 3319: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3320: was:</p>
3321: <pre class="programlisting">
3322: [...]
3323: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3324: checking for GTK - version >= 1.2.0... no
3325: *** Could not run GTK test program, checking why...
3326: *** The test program failed to compile or link. See the file config.log for the
3327: *** exact error that occured. This usually means GTK was incorrectly installed
3328: *** or that you have moved GTK since it was installed. In the latter case, you
3329: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3330: configure: error: Test for GTK failed.
3331: [...]
3332: </pre>
1.23 wiz 3333: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3334: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3335: told me that this package really wanted to have the GNOME 1 version of
3336: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3337: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3338: So I changed the <code class="literal">x11/gtk2</code> to
3339: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3340: and tried again.</p>
3341: <pre class="programlisting">
3342: [...]
1.59 jnemeth 3343: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3344: In file included from xpidl.c:42:
3345: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3346: In file included from xpidl.c:42:
3347: xpidl.h:132: error: parse error before "IDL_ns"
3348: [...]
3349: </pre>
3350: <p>The package still does not find all of its dependencies. Now the
3351: question is: Which package provides the
3352: <code class="filename">libIDL/IDL.h</code> header file?</p>
3353: <pre class="programlisting">
3354: <code class="prompt">$</code> echo ../../*/*idl*
3355: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3356: <code class="prompt">$</code> echo ../../*/*IDL*
3357: ../../net/libIDL
3358: </pre>
3359: <p>Let's take the one from the second try. So I included the
3360: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3361: again. But the error didn't change. After digging through some of the
3362: code, I concluded that the build process of the package was broken and
3363: couldn't have ever worked, but since the Mozilla source tree is quite
3364: large, I didn't want to fix it. So I added the following to the package
3365: <code class="filename">Makefile</code> and tried again:</p>
3366: <pre class="programlisting">
3367: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3368: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3369: </pre>
3370: <p>The latter line is needed because the package expects the library
3371: <code class="filename">libIDL.so</code>, but only
3372: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3373: wrapper to rewrite that on the fly.</p>
3374: <p>The next problem was related to a recent change of the FreeType
1.120 sevan 3375: interface. I looked up in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.1 dsieger 3376: which patch files were relevant for this issue and copied them to the
3377: <code class="filename">patches</code> directory. Then I retried, fixed the
3378: patches so that they applied cleanly and retried again. This time,
3379: everything worked.</p>
3380: </div>
1.41 asau 3381: <div class="sect3">
1.1 dsieger 3382: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3383: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3384: <pre class="programlisting">
3385: <code class="prompt">$</code> bmake CHECK_FILES=no install
3386: [...]
3387: <code class="prompt">$</code> bmake print-PLIST >PLIST
3388: <code class="prompt">$</code> bmake deinstall
3389: <code class="prompt">$</code> bmake install
3390: </pre>
3391: </div>
3392: </div>
3393: </div>
3394: </div>
1.41 asau 3395: <div class="chapter">
1.1 dsieger 3396: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3397: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3398: <div class="toc">
3399: <p><b>Table of Contents</b></p>
1.100 leot 3400: <dl class="toc">
1.23 wiz 3401: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3402: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 3403: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3404: <dd><dl>
3405: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3406: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3407: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3408: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3409: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3410: </dl></dd>
3411: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3412: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3413: <dd><dl>
3414: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3415: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3416: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3417: </dl></dd>
1.23 wiz 3418: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3419: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3420: </dl>
3421: </div>
3422: <p>Whenever you're preparing a package, there are a number of
3423: files involved which are described in the following
3424: sections.</p>
1.41 asau 3425: <div class="sect1">
1.1 dsieger 3426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3427: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3428: </h2></div></div></div>
3429: <p>Building, installation and creation of a binary package are all
3430: controlled by the package's <code class="filename">Makefile</code>.
3431: The <code class="filename">Makefile</code> describes various things about
3432: a package, for example from where to get it, how to configure,
3433: build, and install it.</p>
3434: <p>A package <code class="filename">Makefile</code> contains several
3435: sections that describe the package.</p>
3436: <p>In the first section there are the following variables, which
3437: should appear exactly in the order given here. The order and
3438: grouping of the variables is mostly historical and has no further
3439: meaning.</p>
1.41 asau 3440: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3441: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3442: distribution file to be downloaded from the package's
3443: website.</p></li>
1.23 wiz 3444: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3445: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3446: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3447: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3448: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3449: directory name together with the version number. It must match the
3450: regular expression
3451: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3452: starts with a letter or digit, and contains only letters, digits,
3453: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3454: <li class="listitem">
1.1 dsieger 3455: <p><code class="varname">CATEGORIES</code> is a list of categories
3456: which the package fits in. You can choose any of the top-level
3457: directories of pkgsrc for it.</p>
3458: <p>Currently the following values are available for
3459: <code class="varname">CATEGORIES</code>. If more than
3460: one is used, they need to be separated by spaces:</p>
3461: <pre class="programlisting">
3462: archivers cross geography meta-pkgs security
3463: audio databases graphics misc shells
3464: benchmarks devel ham multimedia sysutils
3465: biology editors inputmethod net textproc
3466: cad emulators lang news time
3467: chat finance mail parallel wm
3468: comms fonts math pkgtools www
3469: converters games mbone print x11
3470: </pre>
3471: </li>
1.23 wiz 3472: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3473: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3474: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3475: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 3476: <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 3477: </ul></div>
3478: <p>The second section contains information about separately
3479: downloaded patches, if any.
3480: </p>
1.41 asau 3481: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3482: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3483: Name(s) of additional files that contain distribution patches.
3484: There is no default. pkgsrc will look for them at
3485: <code class="varname">PATCH_SITES</code>.
3486: They will automatically be uncompressed before patching if
3487: the names end with <code class="filename">.gz</code> or
3488: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3489: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3490: Primary location(s) for distribution patch files (see
1.80 wiz 3491: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3492: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.120 sevan 3493: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.80 wiz 3494: help find the correct files to patch. It defaults to
3495: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3496: </ul></div>
3497: <p>The third section contains the following variables.
3498: </p>
1.41 asau 3499: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3500: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3501: address of the person who feels responsible for this package,
3502: and who is most likely to look at problems or questions regarding
1.120 sevan 3503: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14 jmcneill 3504: Other developers may contact the <code class="varname">MAINTAINER</code>
3505: before making changes to the package, but are not required to
3506: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3507: to yourself. If you really can't maintain the package for future
3508: updates, set it to
1.10 hubertf 3509: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3510: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3511: of <code class="varname">MAINTAINER</code> when you do not want other
3512: developers to update or change the package without contacting
3513: you first. A package Makefile should contain one of
3514: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3515: not both. </p></li>
1.23 wiz 3516: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3517: find more information about the package.</p></li>
1.23 wiz 3518: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3519: description of the package (should not include the package
3520: name).</p></li>
1.122 ! leot 3521: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
! 3522: applicable for the package. See <a class="xref" href="#handling-licenses" title="19.1.3. Handling licenses">Section 19.1.3, “Handling licenses”</a> for further details.</p></li>
1.1 dsieger 3523: </ul></div>
3524: <p>Other variables that affect the build:
3525: </p>
1.41 asau 3526: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3527: <p><code class="varname">WRKSRC</code>: The directory where the
3528: interesting distribution files of the package are found. The
3529: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3530: works for most packages.</p>
3531: <p>If a package doesn't create a subdirectory for itself
3532: (most GNU software does, for instance), but extracts itself in
3533: the current directory, you should set
3534: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3535: <p>If a package doesn't create a subdirectory with the
3536: name of <code class="varname">DISTNAME</code> but some different name,
3537: set <code class="varname">WRKSRC</code> to point to the proper name in
3538: <code class="filename">${WRKDIR}</code>, for example
3539: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.120 sevan 3540: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="http://cdn.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 3541: <p>The name of the working directory created by pkgsrc is
3542: taken from the <code class="varname">WRKDIR_BASENAME</code>
3543: variable. By default, its value is
3544: <code class="filename">work</code>. If you want to use the same
3545: pkgsrc tree for building different kinds of binary packages,
3546: you can change the variable according to your needs. Two
3547: other variables handle common cases of setting
3548: <code class="varname">WRKDIR_BASENAME</code> individually. If
3549: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3550: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3551: the host's name is attached to the directory name. If
3552: <code class="varname">OBJMACHINE</code> is defined, the platform name
3553: is attached, which might look like
3554: <code class="filename">work.i386</code> or
3555: <code class="filename">work.sparc</code>.</p>
3556: </li></ul></div>
3557: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3558: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3559: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3560: installed in compressed form by the package. For packages using
3561: BSD-style makefiles which honor MANZ, there is
3562: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3563: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3564: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3565: below).</p></li>
1.23 wiz 3566: <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 3567: </ul></div>
3568: </div>
1.41 asau 3569: <div class="sect1">
1.1 dsieger 3570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3571: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 3572: </h2></div></div></div>
3573: <p>The <code class="filename">distinfo</code> file contains the message
3574: digest, or checksum, of each distfile needed for the package. This
3575: ensures that the distfiles retrieved from the Internet have not been
3576: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3577: a security hole. To provide maximum security, all distfiles are
3578: protected using three different message digest algorithms (SHA1,
3579: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3580: <p>The <code class="filename">distinfo</code> file also contains the
3581: checksums for all the patches found in the
1.108 rillig 3582: <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 3583: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3584: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3585: <p>Some packages have different sets of distfiles depending on
1.120 sevan 3586: the platform, for example <a href="http://cdn.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 3587: <code class="filename">distinfo</code> file and care should be taken when
3588: upgrading such a package to ensure distfile information is not
3589: lost.</p>
3590: </div>
1.41 asau 3591: <div class="sect1">
1.1 dsieger 3592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 3593: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
3594: </h2></div></div></div>
3595: <p>Some packages don't work out-of-the box on the various
3596: platforms that are supported by pkgsrc. These packages need
3597: to be patched to make them work. The patch files can be
1.1 dsieger 3598: found in the <code class="filename">patches/</code> directory.</p>
3599: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3600: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3601: extracting them, in alphabetic order.</p>
1.41 asau 3602: <div class="sect2">
1.1 dsieger 3603: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3604: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3605: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3606: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3607: problems. (To force patches to apply with fuzz you can set
3608: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3609: should contain only changes for a single file, and no file should be
3610: patched by more than one patch file. This helps to keep future
3611: modifications simple.</p>
3612: <p>Each patch file is structured as follows: In the first line,
3613: there is the RCS Id of the patch itself. The second line should be
3614: empty for aesthetic reasons. After that, there should be a comment for
3615: each change that the patch does. There are a number of standard
3616: cases:</p>
1.41 asau 3617: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3618: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3619: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3620: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3621: platform and other environment (for example, the compiler) that the
3622: patch is needed for.</p></li>
3623: </ul></div>
1.108 rillig 3624: <p>The patch should be commented so that any
1.1 dsieger 3625: developer who knows the code of the application can make some use of
3626: the patch. Special care should be taken for the upstream developers,
3627: since we generally want that they accept our patches, so we have less
3628: work in the future.</p>
3629: </div>
1.41 asau 3630: <div class="sect2">
1.1 dsieger 3631: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3632: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3633: <p>One important thing to mention is to pay attention that no RCS
3634: IDs get stored in the patch files, as these will cause problems when
3635: later checked into the NetBSD CVS tree. Use the
1.120 sevan 3636: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="http://cdn.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 3637: problems.</p>
3638: <p>For even more automation, we recommend using
1.10 hubertf 3639: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3640: whole set of patches. You just have to backup files before you
3641: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3642: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3643: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3644: you upgrade a package this way, you can easily compare the new
3645: set of patches with the previously existing one with
1.24 wiz 3646: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3647: are replaced by new files, so carefully check if you want to take all
3648: the changes.</p>
1.1 dsieger 3649: <p>When you have finished a package, remember to generate
1.10 hubertf 3650: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 3651: 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 3652: <p>When adding a patch that corrects a problem in the
3653: distfile (rather than e.g. enforcing pkgsrc's view of where
3654: man pages should go), send the patch as a bug report to the
3655: maintainer. This benefits non-pkgsrc users of the package,
3656: and usually makes it possible to remove the patch in future
3657: version.</p>
1.2 rillig 3658: <p>The file names of the patch files are usually of the form
1.24 wiz 3659: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3660: Many packages still use the previous convention
3661: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3662: but new patches should be of the form containing the filename.
1.120 sevan 3663: <span class="command"><strong>mkpatches</strong></span> included in <a href="http://cdn.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 3664: automatically.</p>
1.1 dsieger 3665: </div>
1.41 asau 3666: <div class="sect2">
1.1 dsieger 3667: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3668: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3669: <p>If you want to share patches between multiple packages
3670: in pkgsrc, e.g. because they use the same distfiles, set
3671: <code class="varname">PATCHDIR</code> to the path where the patch files
3672: can be found, e.g.:</p>
3673: <pre class="programlisting">
3674: PATCHDIR= ${.CURDIR}/../xemacs/patches
3675: </pre>
3676: <p>Patch files that are distributed by the author or other
3677: maintainers can be listed in
3678: <code class="varname">PATCHFILES</code>.</p>
3679: <p>If it is desired to store any patches that should not be
3680: committed into pkgsrc, they can be kept outside the pkgsrc
3681: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3682: directory tree there is expected to have the same
1.23 wiz 3683: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3684: patches are expected to be stored inside these dirs (also
3685: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3686: example, if you want to keep a private patch for
3687: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3688: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3689: files in the named directory are expected to be patch files,
3690: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3691: applied</em></span>.</p>
3692: </div>
1.41 asau 3693: <div class="sect2">
1.1 dsieger 3694: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3695: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3696: <p>When fixing a portability issue in the code do not use
3697: preprocessor magic to check for the current operating system nor
3698: platform. Doing so hurts portability to other platforms because
3699: the OS-specific details are not abstracted appropriately.</p>
3700: <p>The general rule to follow is: instead of checking for the
3701: operating system the application is being built on, check for the
3702: specific <span class="emphasis"><em>features</em></span> you need. For example,
3703: instead of assuming that kqueue is available under NetBSD and
3704: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3705: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3706: yes, this generally involves patching the
1.10 hubertf 3707: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3708: that prevents some OSes from adopting interfaces from other OSes
3709: (e.g. Linux implementing kqueue), something that the above checks
3710: cannot take into account.</p>
3711: <p>Of course, checking for features generally involves more
3712: work on the developer's side, but the resulting changes are
3713: cleaner and there are chances they will work on many other
3714: platforms. Not to mention that there are higher chances of being
3715: later integrated into the mainstream sources. Remember:
3716: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3717: <p>Some typical examples:</p>
3718: <div class="table">
1.6 rillig 3719: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.106 tnn 3720: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3721: <colgroup>
3722: <col>
3723: <col>
3724: <col>
3725: </colgroup>
3726: <thead><tr>
3727: <th>Where</th>
3728: <th>Incorrect</th>
3729: <th>Correct</th>
3730: </tr></thead>
3731: <tbody>
3732: <tr>
3733: <td>configure script</td>
3734: <td>
3735: <pre class="programlisting">
3736: case ${target_os} in
3737: netbsd*) have_kvm=yes ;;
3738: *) have_kvm=no ;;
3739: esac
3740: </pre>
3741: </td>
3742: <td>
3743: <pre class="programlisting">
3744: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3745: </pre>
3746: </td>
3747: </tr>
3748: <tr>
3749: <td>C source file</td>
3750: <td>
3751: <pre class="programlisting">
3752: #if defined(__NetBSD__)
3753: # include <sys/event.h>
3754: #endif
3755: </pre>
3756: </td>
3757: <td>
3758: <pre class="programlisting">
3759: #if defined(HAVE_SYS_EVENT_H)
3760: # include <sys/event.h>
3761: #endif
3762: </pre>
3763: </td>
3764: </tr>
3765: <tr>
3766: <td>C source file</td>
3767: <td>
3768: <pre class="programlisting">
3769: int
3770: monitor_file(...)
3771: {
3772: #if defined(__NetBSD__)
3773: int fd = kqueue();
3774: ...
3775: #else
3776: ...
3777: #endif
3778: }
3779: </pre>
3780: </td>
3781: <td>
3782: <pre class="programlisting">
3783: int
3784: monitor_file(...)
3785: {
3786: #if defined(HAVE_KQUEUE)
3787: int fd = kqueue();
3788: ...
3789: #else
1.112 rillig 3790: ...
1.1 dsieger 3791: #endif
3792: }
3793: </pre>
3794: </td>
3795: </tr>
3796: </tbody>
3797: </table></div>
3798: </div>
3799: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 3800: 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
3801: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 3802: 2</a>). It summarizes multiple details on how to make
3803: software easier to package; all the suggestions in it were
3804: collected from our experience in pkgsrc work, so they are possibly
3805: helpful when creating patches too.</p>
3806: </div>
1.41 asau 3807: <div class="sect2">
1.1 dsieger 3808: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3809: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3810: <p>Always, always, <span class="strong"><strong>always</strong></span>
3811: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3812: improvements you do to a package to the mainstream developers.
3813: This is the only way to get their attention on portability issues
3814: and to ensure that future versions can be built out-of-the box on
3815: NetBSD. Furthermore, any user that gets newer distfiles will get
3816: the fixes straight from the packaged code.</p>
3817: <p>This generally involves cleaning up the patches
3818: (because sometimes the patches that are
1.40 wiz 3819: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3820: appropriate trackers for the projects and working with the
3821: mainstream authors to accept your changes. It is
3822: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3823: the packages in pkgsrc are kept simple and thus further changes
3824: can be done without much hassle.</p>
1.24 wiz 3825: <p>When you have done this, please add a URL to the upstream
3826: bug report to the patch comment.</p>
1.1 dsieger 3827: <p>Support the idea of free software!</p>
3828: </div>
3829: </div>
1.41 asau 3830: <div class="sect1">
1.1 dsieger 3831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3832: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 3833: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3834: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3835: <dd><p>A multi-line description of the piece of software. This should include
3836: any credits where they are due. Please bear in mind that others do not
3837: share your sense of humour (or spelling idiosyncrasies), and that others
3838: will read everything that you write here.</p></dd>
3839: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3840: <dd><p>This file governs the files that are installed on your
3841: system: all the binaries, manual pages, etc. There are other
3842: directives which may be entered in this file, to control the
3843: creation and deletion of directories, and the location of
1.10 hubertf 3844: 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 3845: information.</p></dd>
3846: </dl></div>
3847: </div>
1.41 asau 3848: <div class="sect1">
1.1 dsieger 3849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3850: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 3851: <div class="sect2">
1.1 dsieger 3852: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3853: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 3854: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3855: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 3856: <dd>
1.120 sevan 3857: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 3858: First time after package extraction and before files are
3859: moved in place, the second time after the files to install
3860: are moved in place. This can be used to do any custom
3861: procedures not possible with @exec commands in
1.120 sevan 3862: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3863: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.0.2"><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 3864: Please note that you can modify variables in it easily by using
3865: <code class="varname">FILES_SUBST</code> in the package's
3866: <code class="filename">Makefile</code>:</p>
3867: <pre class="programlisting">
3868: FILES_SUBST+= SOMEVAR="somevalue"
3869: </pre>
3870: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3871: <code class="filename">INSTALL</code>. By default, substitution is
3872: performed for <code class="varname">PREFIX</code>,
3873: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3874: <code class="varname">VARBASE</code>, and a few others, type
3875: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3876: complete list.</p>
3877: </dd>
1.1 dsieger 3878: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3879: <dd><p>This script is executed before and after any files are removed. It is
3880: this script's responsibility to clean up any additional messy details
3881: around the package's installation, since all pkg_delete knows is how to
3882: delete the files created in the original distribution.
1.120 sevan 3883: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3884: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28 wiz 3885: The same methods to replace variables can be used as for
3886: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 3887: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3888: <dd>
3889: <p>This file is displayed after installation of the package.
3890: Useful for things like legal notices on almost-free
3891: software and hints for updating config files after
3892: installing modules for apache, PHP etc.
3893: Please note that you can modify variables in it easily by using
3894: <code class="varname">MESSAGE_SUBST</code> in the package's
3895: <code class="filename">Makefile</code>:</p>
3896: <pre class="programlisting">
3897: MESSAGE_SUBST+= SOMEVAR="somevalue"
3898: </pre>
1.23 wiz 3899: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 3900: <code class="filename">MESSAGE</code>. By default, substitution is
3901: performed for <code class="varname">PKGNAME</code>,
3902: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 3903: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 3904: <code class="varname">PKG_SYSCONFDIR</code>,
3905: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 3906: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 3907: <p>You can display a different or additional files by
3908: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3909: default is <code class="filename">MESSAGE</code>, if the file
3910: exists.</p>
3911: </dd>
3912: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 3913: <dd>
3914: <p>This file is used by the alternatives framework.
3915: It creates, configures, and destroys generic wrappers used to
3916: run programs with similar interfaces.
3917: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3918: for more information.</p>
3919: <p>Each line of the file contains two filenames, first
3920: the wrapper and then the alternative provided by the package.
3921: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3922: </dd>
1.1 dsieger 3923: </dl></div>
3924: </div>
1.41 asau 3925: <div class="sect2">
1.1 dsieger 3926: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3927: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 3928: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3929: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3930: <dd><p>This file contains arbitrary things that could
3931: also go into a <code class="filename">Makefile</code>, but its purpose is
3932: to be used by more than one package. This file should only be
3933: used when the packages that will use the file are known in
3934: advance. For other purposes it is often better to write a
3935: <code class="filename">*.mk</code> file and give it a good name that
3936: describes what it does.</p></dd>
3937: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3938: <dd><p>This file contains the dependency information
1.10 hubertf 3939: 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 3940: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3941: <dd><p>This file contains workarounds for compiler bugs
3942: and similar things. It is included automatically by the pkgsrc
3943: infrastructure, so you don't need an extra
3944: <code class="literal">.include</code> line for
3945: it.</p></dd>
3946: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3947: <dd><p>This file contains the code for the
1.10 hubertf 3948: 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 3949: selected by the user. If a package has only one or two options,
3950: it is equally acceptable to put the code directly into the
3951: <code class="filename">Makefile</code>.</p></dd>
3952: </dl></div>
3953: </div>
1.41 asau 3954: <div class="sect2">
1.1 dsieger 3955: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3956: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 3957: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3958: <dt><span class="term"><code class="filename">README*</code></span></dt>
3959: <dd><p>These files do not take place in the creation of
3960: a package and thus are purely informative to the package
3961: developer.</p></dd>
3962: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3963: <dd><p>This file contains things that need to be done
3964: to make the package even
3965: better.</p></dd>
3966: </dl></div>
3967: </div>
3968: </div>
1.41 asau 3969: <div class="sect1">
1.1 dsieger 3970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3971: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 3972: </h2></div></div></div>
1.10 hubertf 3973: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 3974: unpacked into the directory denoted by
3975: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 3976: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 3977: directory is also used to keep various timestamp files.
3978: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3979: The default is <code class="filename">${.CURDIR}/work</code>
3980: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3981: if <code class="varname">OBJMACHINE</code> is set.</p>
3982: </div>
1.41 asau 3983: <div class="sect1">
1.1 dsieger 3984: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3985: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 3986: </h2></div></div></div>
3987: <p>If you have any files that you wish to be placed in the package prior
3988: to configuration or building, you could place these files here and use
1.10 hubertf 3989: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 3990: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 3991: this. Alternatively, you could simply diff the file against
3992: <code class="filename">/dev/null</code> and use the patch mechanism to manage
3993: the creation of this file.</p>
3994: <p>If you want to share files in this way with other
3995: packages, set the <code class="varname">FILESDIR</code> variable to point
3996: to the other package's <code class="filename">files</code> directory,
3997: e.g.:</p>
3998: <pre class="programlisting">
3999: FILESDIR=${.CURDIR}/../xemacs/files
4000: </pre>
4001: </div>
4002: </div>
1.41 asau 4003: <div class="chapter">
1.1 dsieger 4004: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4005: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4006: <div class="toc">
4007: <p><b>Table of Contents</b></p>
1.100 leot 4008: <dl class="toc">
1.6 rillig 4009: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4010: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4011: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4012: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4013: <dd><dl>
4014: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117 sevan 4015: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108 rillig 4016: <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>
4017: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4018: </dl></dd>
4019: </dl>
4020: </div>
4021: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4022: each of which forms a well-defined part of the pkgsrc system. Using
1.120 sevan 4023: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1 dsieger 4024: like pkgsrc requires some discipline to keep the code correct and
4025: understandable.</p>
4026: <p>The basic ingredients for <code class="filename">Makefile</code>
4027: programming are variables (which are actually macros) and shell
4028: commands. Among these shell commands may even be more complex ones
1.120 sevan 4029: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1 dsieger 4030: as intended it is necessary to quote all variables correctly when they
4031: are used.</p>
4032: <p>This chapter describes some patterns, that appear quite often in
4033: <code class="filename">Makefile</code>s, including the pitfalls that come along
4034: with them.</p>
1.41 asau 4035: <div class="sect1">
1.1 dsieger 4036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4037: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4038: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4039: <p>When you are creating a file as a
4040: target of a rule, always write the data to a temporary file first
4041: and finally rename that file. Otherwise there might occur an error
4042: in the middle of generating the file, and when the user runs
1.120 sevan 4043: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><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 4044: regenerated properly. Example:</p>
4045: <pre class="programlisting">
4046: wrong:
4047: @echo "line 1" > ${.TARGET}
4048: @echo "line 2" >> ${.TARGET}
4049: @false
4050:
4051: correct:
4052: @echo "line 1" > ${.TARGET}.tmp
4053: @echo "line 2" >> ${.TARGET}.tmp
4054: @false
4055: @mv ${.TARGET}.tmp ${.TARGET}
4056: </pre>
1.10 hubertf 4057: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4058: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4059: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4060: correct</strong></span> gives an error message twice, as expected.</p>
1.120 sevan 4061: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1 dsieger 4062: <code class="literal">${.TARGET}</code> in case of error, but this only
4063: happens when it is interrupted, for example by pressing
4064: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.120 sevan 4065: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1 dsieger 4066: </li></ul></div>
4067: </div>
1.41 asau 4068: <div class="sect1">
1.1 dsieger 4069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4070: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4071: <p><code class="filename">Makefile</code> variables contain strings that
4072: can be processed using the five operators ``='', ``+='', ``?='',
1.120 sevan 4073: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1 dsieger 4074: page.</p>
4075: <p>When a variable's value is parsed from a
4076: <code class="filename">Makefile</code>, the hash character ``#'' and the
4077: backslash character ``\'' are handled specially. If a backslash is
4078: followed by a newline, any whitespace immediately in front of the
4079: backslash, the backslash, the newline, and any whitespace
4080: immediately behind the newline are replaced with a single space. A
4081: backslash character and an immediately following hash character are
4082: replaced with a single hash character. Otherwise, the backslash is
4083: passed as is. In a variable assignment, any hash character that is
4084: not preceded by a backslash starts a comment that continues upto the
4085: end of the logical line.</p>
1.108 rillig 4086: <p>The evaluation of variables either happens immediately or lazy.
4087: It happens immediately when the variable occurs
4088: on the right-hand side of the ``:='' or the ``!='' operator, in a
4089: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4090: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4091: <p>Some of the modifiers split the string into words and then
4092: operate on the words, others operate on the string as a whole. When
1.120 sevan 4093: 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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.1 dsieger 4094: <p>There are several types of variables that should be handled
4095: differently. Strings and two types of lists.</p>
1.41 asau 4096: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4097: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4098: characters. Nevertheless, you should restrict yourself to only
4099: using printable characters. Examples are
4100: <code class="varname">PREFIX</code> and
4101: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4102: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4103: are never exported to any shell command. Their elements are
4104: separated by whitespace. Therefore, the elements themselves cannot
4105: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4106: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4107: Examples are <code class="varname">DEPENDS</code> and
4108: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4109: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4110: may be exported to a shell command. Their elements can contain any
4111: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4112: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4113: <code class="varname">DISTFILES</code> and
4114: <code class="varname">MASTER_SITES</code>.</p></li>
4115: </ul></div>
1.41 asau 4116: <div class="sect2">
1.1 dsieger 4117: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4118: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4119: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4120: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4121: are reserved for use by the pkgsrc infrastructure. They shall
4122: not be used by package
4123: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4124: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4125: lowercase variable names for the iteration
4126: variables.</p></li>
1.23 wiz 4127: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4128: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4129: <code class="varname">DISTFILES</code>.</p></li>
4130: </ul></div>
4131: </div>
4132: </div>
1.41 asau 4133: <div class="sect1">
1.1 dsieger 4134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4135: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.41 asau 4136: <div class="sect2">
1.1 dsieger 4137: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4138: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4139: <p>When adding a string that possibly contains whitespace or quotes to
4140: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4141: modifier.</p>
4142: <p>When adding another list to a list (example 2), it must not be
4143: quoted, since its elements are already quoted.</p>
1.1 dsieger 4144: <pre class="programlisting">
1.108 rillig 4145: STRING= foo * bar `date`
4146: LIST= # empty
4147: ANOTHER_LIST= a=b c=d
4148:
4149: LIST+= ${STRING:Q} # 1
4150: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4151: </pre>
4152: </div>
1.41 asau 4153: <div class="sect2">
1.1 dsieger 4154: <div class="titlepage"><div><div><h3 class="title">
1.117 sevan 4155: <a name="echo-literal"></a>12.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108 rillig 4156: <p>Echoing a string containing special characters needs special
4157: work.</p>
1.1 dsieger 4158: <pre class="programlisting">
4159: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4160: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4161:
4162: all:
4163: echo ${STRING} # 1
1.108 rillig 4164: echo ${STRING:Q} # 2
4165: printf '%s\n' ${STRING:Q}'' # 3
4166: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4167: </pre>
4168: <p>Example 1 leads to a syntax error in the shell, as the characters
4169: are just copied.</p>
4170: <p>Example 2 quotes the string so that the shell interprets it
4171: correctly. But the echo command may additionally interpret strings with a
4172: leading dash or those containing backslashes.</p>
1.120 sevan 4173: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.108 rillig 4174: interprets the format string, but not the next argument.</p>
4175: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4176: need to be quoted because the quoting has already been done
4177: when adding elements to the list.</p>
1.1 dsieger 4178: </div>
1.41 asau 4179: <div class="sect2">
1.1 dsieger 4180: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4181: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4182: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4183: GNU-style configure script (especially those that call other configure
4184: scripts), it must not have leading or trailing whitespace, since
4185: otherwise the configure script gets confused. To trim leading and
4186: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4187: following example:</p>
1.1 dsieger 4188: <pre class="programlisting">
4189: CPPFLAGS= # empty
1.108 rillig 4190: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4191: CPPFLAGS+= ${MY_CPPFLAGS}
4192:
4193: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4194:
4195: all:
4196: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4197: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4198: </pre>
1.108 rillig 4199: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4200: trailing whitespace because the <code class="code">+=</code> operator always adds a
4201: space.</p>
4202: </div>
4203: <div class="sect2">
4204: <div class="titlepage"><div><div><h3 class="title">
4205: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4206: <p>When a possibly empty variable is used in a shell program, it may
4207: lead to a syntax error.</p>
4208: <pre class="programlisting">
4209: EGFILES= # empty
4210:
4211: install-examples: # produces a syntax error in the shell
4212: for egfile in ${EGFILES}; do \
4213: echo "Installing $$egfile"; \
4214: done
4215: </pre>
4216: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.120 sevan 4217: <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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.108 rillig 4218: To fix this syntax error, use one of the snippets below.</p>
4219: <pre class="programlisting">
4220: EMPTY= # empty
4221:
4222: install-examples:
4223: for egfile in ${EGFILES} ""; do \
4224: [ -n "$$egfile" ] || continue; \
4225: echo "Installing $$egfile"; \
1.1 dsieger 4226: done
1.108 rillig 4227: </pre>
4228: <p>In this case, an empty string is appended to the iteration list (to
4229: prevent the syntax error) and filtered out later.</p>
4230: <pre class="programlisting">
4231: EGFILES= # empty
1.1 dsieger 4232:
1.108 rillig 4233: install-examples:
4234: .for egfile in ${EGFILES}
4235: echo "Installing ${egfile}"
1.1 dsieger 4236: .endfor
4237: </pre>
1.108 rillig 4238: <p>This variant only works when <code class="varname">EGFILES</code> does not
4239: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4240: simple whitespace.</p>
4241: <p>To have a shell command test whether a make variable is empty, use
4242: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4243: </div>
4244: </div>
4245: </div>
1.41 asau 4246: <div class="chapter">
1.1 dsieger 4247: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4248: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4249: <div class="toc">
4250: <p><b>Table of Contents</b></p>
1.100 leot 4251: <dl class="toc">
1.6 rillig 4252: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4253: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4254: <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 4255: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4256: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4257: <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 4258: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4259: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4260: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4261: </dl>
4262: </div>
4263: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4264: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4265: the package (relative to the <code class="filename">${PREFIX}</code>
4266: directory it's been installed in) plus some additional statements
1.120 sevan 4267: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 4268: This chapter addresses some issues that need attention when
4269: dealing with the <code class="filename">PLIST</code> file (or files, see
4270: below!).</p>
1.41 asau 4271: <div class="sect1">
1.1 dsieger 4272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4273: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4274: <p>Be sure to add a RCS ID line as the first thing in any
4275: <code class="filename">PLIST</code> file you write:</p>
4276: <pre class="programlisting">
1.121 sevan 4277: @comment $NetBSD $
1.111 sevan 4278: </pre>
1.121 sevan 4279: <p>An artificial space has been added betweeen NetBSD and $, this is a
4280: workaround here to prevent CVS expanding to the filename of the guide. When
4281: adding the RCS ID the space should be ommited.</p>
1.1 dsieger 4282: </div>
1.41 asau 4283: <div class="sect1">
1.1 dsieger 4284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4285: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4286: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4287: to output a PLIST that matches any new files since the package
1.10 hubertf 4288: 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 4289: more information on this target.</p>
4290: </div>
1.41 asau 4291: <div class="sect1">
1.1 dsieger 4292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4293: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4294: </h2></div></div></div>
4295: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4296: of AWK patterns and actions that are used to filter the output of
4297: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4298: scripting you like to it, but be careful with quoting.</p>
4299: <p>For example, to get all files inside the
4300: <code class="filename">libdata/foo</code> directory removed from the
4301: resulting PLIST:</p>
4302: <pre class="programlisting">
4303: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4304: </pre>
1.1 dsieger 4305: </div>
1.41 asau 4306: <div class="sect1">
1.1 dsieger 4307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4308: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4309: <p>A number of variables are substituted automatically in
4310: PLISTs when a package is installed on a system. This includes the
4311: following variables:</p>
1.41 asau 4312: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4313: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4314: <dd>
4315: <p>Some packages like emacs and perl embed information
4316: about which architecture they were built on into the
4317: pathnames where they install their files. To handle this
4318: case, PLIST will be preprocessed before actually used, and
4319: the symbol
1.23 wiz 4320: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4321: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4322: same is done if the string
4323: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4324: PLIST somewhere - use this on packages that have GNU
4325: autoconf-created configure scripts.</p>
1.41 asau 4326: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4327: <h3 class="title">Legacy note</h3>
4328: <p>There used to be a symbol
1.23 wiz 4329: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4330: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4331: -m</strong></span>, but that's no longer supported and has
4332: been removed.</p>
4333: </div>
4334: </dd>
4335: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4336: <dd>
4337: <p>Some packages want to embed the OS name and version
4338: into some paths. To do this, use these variables in the
4339: <code class="filename">PLIST</code>:
4340: </p>
1.41 asau 4341: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4342: <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>
4343: <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>
4344: <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 4345: </ul></div>
4346: </dd>
4347: </dl></div>
1.88 tnn 4348: <p>For a list of values which are replaced by
4349: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4350: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4351: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4352: <p>If you want to change other variables not listed above, you
4353: can add variables and their expansions to this variable in the
1.10 hubertf 4354: 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 4355: <pre class="programlisting">
4356: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4357: </pre>
1.23 wiz 4358: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4359: in the <code class="filename">PLIST</code> with
1.23 wiz 4360: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4361: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4362: the common case of conditionally including some
4363: <code class="filename">PLIST</code> entries. It can be done by adding
4364: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4365: setting the corresponding <code class="varname">PLIST.foo</code> variable
4366: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4367: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4368: in the <code class="filename">PLIST</code> with either
1.23 wiz 4369: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4370: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4371: For example, in <code class="filename">Makefile</code>:</p>
4372: <pre class="programlisting">
1.112 rillig 4373: PLIST_VARS+= foo
1.18 snj 4374: .if <em class="replaceable"><code>condition</code></em>
1.112 rillig 4375: PLIST.foo= yes
1.18 snj 4376: .else
1.111 sevan 4377: </pre>
1.18 snj 4378: <p>And then in <code class="filename">PLIST</code>:</p>
4379: <pre class="programlisting">
1.121 sevan 4380: @comment $NetBSD $
1.18 snj 4381: bin/bar
4382: man/man1/bar.1
4383: ${PLIST.foo}bin/foo
4384: ${PLIST.foo}man/man1/foo.1
4385: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4386: </pre>
1.121 sevan 4387: <p>An artificial space has been added betweeen NetBSD and $, this is a
4388: workaround here to prevent CVS expanding to the filename of the guide. When
4389: adding the RCS ID the space should be ommited.</p>
1.1 dsieger 4390: </div>
1.41 asau 4391: <div class="sect1">
1.1 dsieger 4392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4393: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 4394: <p>Man pages should be installed in compressed form if
4395: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4396: and uncompressed otherwise. To handle this in the
1.23 wiz 4397: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4398: appended/removed automatically for man pages according to
4399: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4400: or not, see above for details. This modification of the
4401: <code class="filename">PLIST</code> file is done on a copy of it, not
4402: <code class="filename">PLIST</code> itself.</p>
4403: </div>
1.41 asau 4404: <div class="sect1">
1.1 dsieger 4405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4406: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4407: </h2></div></div></div>
4408: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4409: in generating the binary package, set the variable
4410: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.120 sevan 4411: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1 dsieger 4412: important. The default for <code class="varname">PLIST_SRC</code> is
4413: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4414: </div>
1.41 asau 4415: <div class="sect1">
1.1 dsieger 4416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4417: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4418: <p>Some packages decide to install a different set of files based on
4419: the operating system being used. These differences can be
4420: automatically handled by using the following files:</p>
1.41 asau 4421: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4422: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4423: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4424: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4425: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4426: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4427: </ul></div>
4428: </div>
1.41 asau 4429: <div class="sect1">
1.1 dsieger 4430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 4431: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4432: <p>Some packages decide to generate hard-to-guess file names
4433: during installation that are hard to wire down.</p>
4434: <p>In such cases, you can set the
4435: <code class="varname">GENERATE_PLIST</code> variable to shell code
4436: terminated (with a semicolon) that will output PLIST entries which
4437: will be appended to the PLIST</p>
4438: <p>You can find one example in editors/xemacs:</p>
4439: <pre class="programlisting">
1.111 sevan 4440: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4441: </pre>
1.86 wiz 4442: <p>which will append something like
4443: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4444: <code class="filename">PLIST</code>.
4445: </p>
4446: </div>
4447: <div class="sect1">
4448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4449: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4450: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4451: multiple (and unrelated) packages install files. These
1.22 jakllsch 4452: directories were problematic because you had to add special
4453: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4454: centralized package handle them.</p>
1.22 jakllsch 4455: <p>In pkgsrc, it is now easy: Each package should create
4456: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4457: will remove any directories left empty after uninstalling a
4458: package.</p>
4459: <p>If a package needs an empty directory to work, create
4460: the directory during installation as usual, and also add an
4461: entry to the PLIST:
1.111 sevan 4462:
4463: </p>
1.1 dsieger 4464: <pre class="programlisting">
1.22 jakllsch 4465: @pkgdir path/to/empty/directory
1.111 sevan 4466: </pre>
1.22 jakllsch 4467: <p>
1.111 sevan 4468:
1.86 wiz 4469: or take a look at <code class="varname">MAKE_DIRS</code> and
4470: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4471: </p>
1.1 dsieger 4472: </div>
4473: </div>
1.41 asau 4474: <div class="chapter">
1.1 dsieger 4475: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4476: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4477: <div class="toc">
4478: <p><b>Table of Contents</b></p>
1.100 leot 4479: <dl class="toc">
1.6 rillig 4480: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 4481: <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 4482: <dd><dl>
1.6 rillig 4483: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 4484: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
4485: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4486: and
4487: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4488: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4489: </dl></dd>
1.23 wiz 4490: <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 4491: <dd><dl>
1.23 wiz 4492: <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 4493: <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 4494: </dl></dd>
4495: </dl>
4496: </div>
4497: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4498: are seen by a package's configure and build processes. This is implemented
4499: in a two step process:</p>
1.23 wiz 4500: <div class="orderedlist"><ol class="orderedlist" type="1">
4501: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4502: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4503: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4504: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4505: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4506: <code class="option">-L${LOCALBASE}/lib</code> into references to
4507: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4508: native compiler on some operating systems look like GCC, so that
4509: packages that expect GCC won't require modifications to build with
4510: those native compilers.</p></li>
4511: </ol></div>
4512: <p>This normalizes the environment in which a package is built so that the
4513: package may be built consistently despite what other software may be
4514: installed. Please note that the normal system header and library paths,
4515: e.g. <code class="filename">/usr/include</code>,
4516: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4517: designed to insulate the package build from non-system-supplied
4518: software.</p>
1.41 asau 4519: <div class="sect1">
1.1 dsieger 4520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4521: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4522: <p>The process of converting packages to use the buildlink3
1.23 wiz 4523: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4524: The things to keep in mind are:</p>
1.23 wiz 4525: <div class="orderedlist"><ol class="orderedlist" type="1">
4526: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4527: instead of the actual toolchain. Some packages are tricky,
4528: and the only way to know for sure is the check
4529: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4530: wrappers are being invoked.</p></li>
1.23 wiz 4531: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4532: the package Makefile, e.g. Java VMs, standalone shells,
4533: etc., because the code to symlink files into
4534: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4535: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4536: </p></li>
1.23 wiz 4537: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4538: <code class="filename">buildlink3.mk</code> files that you list in a
4539: package's Makefile are added as dependencies for that package.
4540: </p></li>
4541: </ol></div>
4542: <p>If a dependency on a particular package is required for its libraries and
4543: headers, then we replace:</p>
4544: <pre class="programlisting">
4545: DEPENDS+= foo>=1.1.0:../../category/foo
4546: </pre>
4547: <p>with</p>
4548: <pre class="programlisting">
4549: .include "../../category/foo/buildlink3.mk"
4550: </pre>
4551: <p>The buildlink3.mk files usually define the required dependencies.
4552: If you need a newer version of the dependency when using buildlink3.mk
4553: files, then you can define it in your Makefile; for example:</p>
4554: <pre class="programlisting">
4555: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4556: .include "../../category/foo/buildlink3.mk"
4557: </pre>
4558: <p>There are several <code class="filename">buildlink3.mk</code>
4559: files in <code class="filename">pkgsrc/mk</code>
4560: that handle special package issues:</p>
1.41 asau 4561: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4562: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4563: the native or a pkgsrc Berkeley DB implementation based on
4564: the values of <code class="varname">BDB_ACCEPTED</code> and
4565: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4566: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4567: comes with neither Curses nor NCurses, this will take care
1.120 sevan 4568: to install the <a href="http://cdn.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 4569: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4570: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4571: adding a dependency on Heimdal or MIT-krb5 for packages that
4572: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4573: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4574: system-provided Motif installation or adds a dependency on
1.120 sevan 4575: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a> or <a href="http://cdn.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 4576: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 4577: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
4578: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 4579: which Motif version will be used.</p></li>
1.55 ryoon 4580: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4581: system-provided GNU readline or editline (libedit) installation,
1.120 sevan 4582: or adds a dependency on <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
4583: <a href="http://cdn.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 4584: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4585: If your package really needs GNU readline library, its Makefile
4586: should include <code class="filename">devel/readline/buildlink3.mk</code>
4587: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4588: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4589: variables that may be used by packages that use the
4590: Open Sound System (OSS) API.</p></li>
1.23 wiz 4591: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4592: any of the Postgres versions in the variable
4593: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4594: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4595: the file for more information.</p></li>
1.23 wiz 4596: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4597: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.120 sevan 4598: a dependency on <a href="http://cdn.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 4599: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4600: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4601: library.</p></li>
4602: </ul></div>
4603: <p>The comments in those <code class="filename">buildlink3.mk</code>
4604: files provide a more complete
4605: description of how to use them properly.</p>
4606: </div>
1.41 asau 4607: <div class="sect1">
1.1 dsieger 4608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4609: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4610: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4611: included by Makefiles to indicate the need to compile and link
4612: against header files and libraries provided by the package. A
4613: <code class="filename">buildlink3.mk</code> file should always provide
4614: enough information to add the correct type of dependency
4615: relationship and include any other
4616: <code class="filename">buildlink3.mk</code> files that it needs to find
4617: headers and libraries that it needs in turn.</p>
4618: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.120 sevan 4619: file for further editing, Rene Hexel's <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.1 dsieger 4620: package is highly recommended. For most packages, the following
4621: command will generate a good starting point for
4622: <code class="filename">buildlink3.mk</code> files:</p>
4623: <pre class="screen">
4624: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4625: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4626: </pre>
1.41 asau 4627: <div class="sect2">
1.1 dsieger 4628: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4629: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4630: <p>The following real-life example
4631: <code class="filename">buildlink3.mk</code> is taken
4632: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4633: <pre class="programlisting">
1.18 snj 4634: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4635:
1.112 rillig 4636: BUILDLINK_TREE+= tiff
1.1 dsieger 4637:
1.18 snj 4638: .if !defined(TIFF_BUILDLINK3_MK)
4639: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4640:
1.112 rillig 4641: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4642: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4643: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4644:
4645: .include "../../devel/zlib/buildlink3.mk"
4646: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4647: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4648:
1.112 rillig 4649: BUILDLINK_TREE+= -tiff
1.1 dsieger 4650: </pre>
4651: <p>The header and footer manipulate
1.18 snj 4652: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4653: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4654: the dependency tree.</p>
4655: <p>The main section is protected from multiple inclusion
1.1 dsieger 4656: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4657: added. Several important variables are set in the section:</p>
1.41 asau 4658: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4659: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4660: is the actual dependency recorded in the installed
4661: package; this should always be set using
1.10 hubertf 4662: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4663: we're appending to any pre-existing list of values. This
4664: variable should be set to the first version of the
1.26 wiz 4665: package that had an backwards-incompatible API change.
1.1 dsieger 4666: </p></li>
1.23 wiz 4667: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4668: is the location of the <em class="replaceable"><code>pkg</code></em>
4669: pkgsrc directory.</p></li>
1.23 wiz 4670: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4671: (not shown above) controls whether we use
4672: <code class="varname">BUILD_DEPENDS</code> or
4673: <code class="varname">DEPENDS</code> to add the dependency on
4674: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4675: selected by setting
4676: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4677: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4678: used.</p></li>
1.23 wiz 4679: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4680: and
4681: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4682: (not shown above) are lists of subdirectories of
4683: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4684: to add to the header and library search paths. These
1.23 wiz 4685: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4686: respectively.</p></li>
1.23 wiz 4687: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4688: (not shown above) is the list of preprocessor flags to add
4689: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4690: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4691: should be avoided and instead be handled using
4692: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4693: above.</p></li>
4694: </ul></div>
4695: <p>The following variables are all optionally defined within
4696: this second section (protected against multiple inclusion) and
4697: control which package files are symlinked into
4698: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4699: transformed during the symlinking:</p>
1.41 asau 4700: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4701: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4702: (not shown above) is a shell glob pattern relative to
4703: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4704: to be symlinked into
4705: <code class="filename">${BUILDLINK_DIR}</code>,
4706: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4707: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4708: (not shown above) is a shell pipeline that
4709: outputs to stdout a list of files relative to
4710: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4711: The resulting files are to be symlinked
4712: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4713: this takes the <code class="filename">+CONTENTS</code> of a
4714: <em class="replaceable"><code>pkg</code></em> and filters it through
4715: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4716: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4717: (not shown above) is a filter command that filters
4718: <code class="filename">+CONTENTS</code> input into a list of files
4719: relative to
4720: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4721: on stdout. By default,
1.1 dsieger 4722: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4723: outputs the contents of the <code class="filename">include</code>
4724: and <code class="filename">lib</code> directories in the package
1.84 wiz 4725: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4726: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4727: (not shown above) is a list of sed arguments used to
4728: transform the name of the source filename into a
1.10 hubertf 4729: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4730: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4731: </ul></div>
1.18 snj 4732: <p>This section can additionally include any
1.1 dsieger 4733: <code class="filename">buildlink3.mk</code> needed for
4734: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4735: Including these <code class="filename">buildlink3.mk</code> files
4736: means that the headers and libraries for these
4737: dependencies are also symlinked into
4738: <code class="filename">${BUILDLINK_DIR}</code>
4739: whenever the <em class="replaceable"><code>pkg</code></em>
4740: <code class="filename">buildlink3.mk</code>
1.18 snj 4741: file is included. Dependencies are only added for directly
4742: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4743: <p>When providing a <code class="filename">buildlink3.mk</code> and
4744: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4745: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4746: header files are automatically exposed when the package is
4747: use.</p>
4748: <p>In particular, if only an executable
4749: (<code class="filename">bin/foo</code>) is linked against a library, that
4750: library does not need to be propagated in the
4751: <code class="filename">buildlink3.mk</code> file.</p>
4752: <p>The following steps should help you decide if a
4753: <code class="filename">buildlink3.mk</code> file needs to be included:
4754: </p>
4755: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4756: <li class="listitem"><p>Look at the installed header files: What
4757: headers do they include? The packages providing these files
4758: must be buildlinked.</p></li>
1.49 wiz 4759: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4760: libraries and look against what other libraries they link.
4761: Some of the packages providing these probably need to be
4762: buildlinked; however, it's not automatic, since e.g. GTK on
4763: some systems pulls in the X libraries, so they will show up in
4764: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4765: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4766: used as a hint.</p></li>
1.47 wiz 4767: </ul></div>
4768: <p>
4769: </p>
1.1 dsieger 4770: </div>
1.41 asau 4771: <div class="sect2">
1.1 dsieger 4772: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 4773: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 4774: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4775: and
4776: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4777: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4778: <p>These two variables differ in that one describes source
4779: compatibility (API) and the other binary compatibility (ABI).
4780: The difference is that a change in the API breaks compilation of
4781: programs while changes in the ABI stop compiled programs from
4782: running.</p>
4783: <p>Changes to the
1.27 wiz 4784: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4785: variable in a <code class="filename">buildlink3.mk</code> file happen
4786: very rarely. One possible reason is that all packages depending
4787: on this already need a newer version. In case it is bumped see
4788: the description below.</p>
4789: <p>The most common example of an ABI change is that the major
4790: version of a shared library is increased. In this case,
4791: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4792: should be adjusted to require at least the new package version.
4793: Then the packages that depend on this package need their
4794: <code class="varname">PKGREVISION</code>s increased and, if they have
4795: <code class="filename">buildlink3.mk</code> files, their
4796: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4797: adjusted, too. This is needed so pkgsrc will require the correct
4798: package dependency and not settle for an older one when building
4799: the source.</p>
1.108 rillig 4800: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.26 wiz 4801: more information about dependencies on other packages,
4802: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4803: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4804: <p>Please take careful consideration before adjusting
4805: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4806: or
4807: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4808: as we don't want to cause unneeded package deletions and
4809: rebuilds. In many cases, new versions of packages work just
4810: fine with older dependencies.</p>
4811: <p>Also it is not needed to set
1.26 wiz 4812: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4813: when it is identical to
1.1 dsieger 4814: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4815: </div>
4816: </div>
1.41 asau 4817: <div class="sect1">
1.1 dsieger 4818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4819: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4820: <p>Some packages in pkgsrc install headers and libraries that
4821: coincide with headers and libraries present in the base system.
4822: Aside from a <code class="filename">buildlink3.mk</code> file, these
4823: packages should also include a <code class="filename">builtin.mk</code>
4824: file that includes the necessary checks to decide whether using
4825: the built-in software or the pkgsrc software is
4826: appropriate.</p>
4827: <p>The only requirements of a builtin.mk file for
4828: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4829: <div class="orderedlist"><ol class="orderedlist" type="1">
4830: <li class="listitem"><p>It should set
1.1 dsieger 4831: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4832: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4833: after it is included.</p></li>
1.23 wiz 4834: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4835: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4836: which is already set before the
4837: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4838: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4839: is <span class="emphasis"><em>very</em></span> important and takes careful
4840: attention to <code class="filename">Makefile</code> coding.</p></li>
4841: </ol></div>
1.41 asau 4842: <div class="sect2">
1.1 dsieger 4843: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4844: <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 4845: <p>The following is the recommended template for builtin.mk
4846: files:</p>
4847: <pre class="programlisting">
4848: .if !defined(IS_BUILTIN.foo)
4849: #
4850: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4851: # genuinely exists in the system or not.
4852: #
4853: IS_BUILTIN.foo?= no
4854:
4855: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4856: # version can be determined.
4857: #
4858: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4859: BUILTIN_PKG.foo?= foo-1.0
4860: . endif
4861: .endif # IS_BUILTIN.foo
4862:
4863: .if !defined(USE_BUILTIN.foo)
4864: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4865: . if defined(BUILTIN_PKG.foo)
4866: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4867: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4868: USE_BUILTIN.foo!= \
4869: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4870: && ${ECHO} "yes" || ${ECHO} "no"
4871: . endif
4872: . endfor
4873: . endif
4874: .endif # USE_BUILTIN.foo
4875:
4876: CHECK_BUILTIN.foo?= no
4877: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4878: #
4879: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4880: # "yes" or "no".
4881: #
4882: .endif # CHECK_BUILTIN.foo
4883: </pre>
4884: <p>The first section sets
4885: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4886: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4887: in the base system. This should not be a base system software
4888: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 4889: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 4890: included as part of the base system. This variable is only
4891: used internally within the <code class="filename">builtin.mk</code>
4892: file.</p>
4893: <p>The second section sets
4894: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4895: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4896: system if it exists (if
4897: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4898: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 4899: within the <code class="filename">builtin.mk</code> file.</p>
4900: <p>The third section sets
4901: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4902: and is <span class="emphasis"><em>required</em></span> in all
4903: <code class="filename">builtin.mk</code> files. The code in this
4904: section must make the determination whether the built-in
4905: software is adequate to satisfy the dependencies listed in
4906: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4907: This is typically done by comparing
4908: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4909: against each of the dependencies in
4910: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4911: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4912: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4913: end of the <code class="filename">builtin.mk</code> file. Note that
4914: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4915: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 4916: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4917: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 4918: that the built-in version of the software is similar enough to
4919: be used as a replacement.</p>
4920: <p>The last section is guarded by
4921: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4922: and includes code that uses the value of
4923: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4924: set in the previous section. This typically includes, e.g.,
4925: adding additional dependency restrictions and listing additional
4926: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4927: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
4928: </div>
1.41 asau 4929: <div class="sect2">
1.1 dsieger 4930: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4931: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 4932: <p>When building packages, it's possible to choose whether to set
4933: a global preference for using either the built-in (native)
4934: version or the pkgsrc version of software to satisfy a
4935: dependency. This is controlled by setting
4936: <code class="varname">PREFER_PKGSRC</code> and
4937: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 4938: 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 4939: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4940: use the pkgsrc versions of software, while
4941: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4942: built-in versions. Preferences are determined by the most
4943: specific instance of the package in either
4944: <code class="varname">PREFER_PKGSRC</code> or
4945: <code class="varname">PREFER_NATIVE</code>. If a package is specified
4946: in neither or in both variables, then
4947: <code class="varname">PREFER_PKGSRC</code> has precedence over
4948: <code class="varname">PREFER_NATIVE</code>. For example, to require
4949: using pkgsrc versions of software for all but the most basic
4950: bits on a NetBSD system, you can set:</p>
4951: <pre class="programlisting">
4952: PREFER_PKGSRC= yes
4953: PREFER_NATIVE= getopt skey tcp_wrappers
4954: </pre>
4955: <p>A package <span class="emphasis"><em>must</em></span> have a
4956: <code class="filename">builtin.mk</code>
4957: file to be listed in <code class="varname">PREFER_NATIVE</code>,
4958: otherwise it is simply ignored in that list.</p>
1.117 sevan 4959: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
4960: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
4961: bootstrap.
4962: Switching between settings globally at a later date can introduce
4963: complications with dependency resolution. This is caused by packages
4964: built with the opposite preference being installed alongside each other.</p>
4965: <pre class="screen">
4966: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
4967: </pre>
1.1 dsieger 4968: </div>
4969: </div>
4970: </div>
1.41 asau 4971: <div class="chapter">
1.1 dsieger 4972: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4973: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 4974: <div class="toc">
4975: <p><b>Table of Contents</b></p>
1.100 leot 4976: <dl class="toc">
1.6 rillig 4977: <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 4978: <dd><dl>
1.6 rillig 4979: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
4980: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 4981: </dl></dd>
1.6 rillig 4982: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 4983: <dd><dl>
1.23 wiz 4984: <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 4985: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
4986: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
4987: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
4988: </dl></dd>
4989: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
4990: <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>
4991: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
4992: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
4993: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
4994: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
4995: <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 4996: </dl>
4997: </div>
4998: <p>This chapter describes the framework known as
4999: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5001: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5002: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5003: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5004: provided that packages are correctly designed.</p></li>
1.23 wiz 5005: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5006: <li class="listitem"><p>Registration of system users and groups.</p></li>
5007: <li class="listitem"><p>Registration of system shells.</p></li>
5008: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5009: </ul></div>
5010: <p>The following sections inspect each of the above points in detail.</p>
5011: <p>You may be thinking that many of the things described here could be
5012: easily done with simple code in the package's post-installation target
5013: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5014: as the code in them is only executed when building from source. Machines
5015: using binary packages could not benefit from it at all (as the code itself
5016: could be unavailable). Therefore, the only way to achieve any of the items
5017: described above is by means of the installation scripts, which are
5018: automatically generated by pkginstall.</p>
1.41 asau 5019: <div class="sect1">
1.1 dsieger 5020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5021: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5022: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5023: of files and directories that belong to a package. The names used in it
5024: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5025: which means that it cannot register files outside this directory (absolute
5026: path names are not allowed). Despite this restriction, some packages need
5027: to install files outside this location; e.g., under
5028: <code class="filename">${VARBASE}</code> or
5029: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5030: is to create such files during installation time by using
5031: installation scripts.</p>
5032: <p>The generic installation scripts are shell scripts that can
5033: contain arbitrary code. The list of scripts to execute is taken from
5034: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5035: <code class="filename">INSTALL</code>. A similar variable exists for package
5036: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5037: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5038: commands, so they have the potential to create and manage files
5039: anywhere in the file system.</p>
5040: <p>Using these general installation files is not recommended, but
5041: may be needed in some special cases. One reason for avoiding them is
5042: that the user has to trust the packager that there is no unwanted or
5043: simply erroneous code included in the installation script. Also,
5044: previously there were many similar scripts for the same functionality,
5045: and fixing a common error involved finding and changing all of
5046: them.</p>
5047: <p>The pkginstall framework offers another, standardized way. It
5048: provides generic scripts to abstract the manipulation of such files
5049: and directories based on variables set in the package's
5050: <code class="filename">Makefile</code>. The rest of this section describes
5051: these variables.</p>
1.41 asau 5052: <div class="sect2">
1.1 dsieger 5053: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5054: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5055: <p>The following variables can be set to request the creation of
5056: directories anywhere in the file system:</p>
1.41 asau 5057: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5058: <li class="listitem">
5059: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5060: contain a list of directories that should be created and should attempt
5061: to be destroyed by the installation scripts. The difference between
5062: the two is that the latter prompts the administrator to remove any
5063: directories that may be left after deinstallation (because they were
1.108 rillig 5064: not empty), while the former does not. Example:</p>
5065: <pre class="programlisting">
5066: MAKE_DIRS+= ${VARBASE}/foo/private
5067: </pre>
5068: </li>
1.23 wiz 5069: <li class="listitem">
1.1 dsieger 5070: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5071: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5072: which directories should be created and should attempt to be destroyed
5073: by the installation scripts. Each tuple holds the following values,
5074: separated by spaces: the directory name, its owner, its group and its
5075: numerical mode. For example:</p>
5076: <pre class="programlisting">
1.108 rillig 5077: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5078: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5079: </pre>
5080: <p>The difference between the two is exactly the same as their
5081: non-<code class="varname">PERMS</code> counterparts.</p>
5082: </li>
5083: </ul></div>
5084: </div>
1.41 asau 5085: <div class="sect2">
1.1 dsieger 5086: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5087: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5088: <p>Creating non-empty files outside the installation prefix is tricky
5089: because the <code class="filename">PLIST</code> forces all files to be inside it.
5090: To overcome this problem, the only solution is to extract the file in the
5091: known place (i.e., inside the installation prefix) and copy it to the
5092: appropriate location during installation (done by the installation scripts
5093: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5094: file</em></span> in the following paragraphs, which describe the variables
5095: that can be used to automatically and consistently handle files outside the
5096: installation prefix:</p>
1.41 asau 5097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5098: <li class="listitem">
1.1 dsieger 5099: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5100: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5101: During installation time, the master file is copied to the target one
5102: if and only if the latter does not exist. Upon deinstallation, the
5103: target file is removed provided that it was not modified by the
5104: installation.</p>
5105: <p>The difference between the two is that the latter prompts the
5106: administrator to remove any files that may be left after
5107: deinstallation (because they were not empty), while the former does
5108: not.</p>
5109: </li>
1.23 wiz 5110: <li class="listitem">
1.1 dsieger 5111: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5112: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5113: files as well as their target locations. For each of them, it also
5114: specifies their owner, their group and their numeric permissions, in
5115: this order. For example:</p>
5116: <pre class="programlisting">
1.108 rillig 5117: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5118: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5119: </pre>
5120: <p>The difference between the two is exactly the same as their
5121: non-<code class="varname">PERMS</code> counterparts.</p>
5122: </li>
5123: </ul></div>
5124: </div>
5125: </div>
1.41 asau 5126: <div class="sect1">
1.1 dsieger 5127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5128: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5129: <p>Configuration files are special in the sense that they are installed
5130: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5131: need special treatment during installation (most of which is automated by
5132: pkginstall). The main concept you must bear in mind is that files marked
5133: as configuration files are automatically copied to the right place (somewhere
5134: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5135: and only if</em></span> they didn't exist before. Similarly, they will not
5136: be removed if they have local modifications. This ensures that
5137: administrators never lose any custom changes they may have made.</p>
1.41 asau 5138: <div class="sect2">
1.1 dsieger 5139: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5140: <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 5141: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5142: specifies where configuration files shall be installed. Its contents are
5143: set based upon the following variables:</p>
1.41 asau 5144: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5145: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5146: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5147: be overridden by the user to point to his preferred location (e.g.,
5148: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5149: Packages must not use it directly.</p></li>
1.23 wiz 5150: <li class="listitem">
1.1 dsieger 5151: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5152: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5153: for the package being built shall be installed. The definition of this
5154: variable only makes sense in the package's
5155: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5156: <p>As an example, consider the Apache package,
1.120 sevan 5157: <a href="http://cdn.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 5158: configuration files under the
5159: <code class="filename">httpd/</code> subdirectory of
5160: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5161: Makefile.</p>
5162: </li>
1.23 wiz 5163: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5164: variable that holds this package's configuration directory (if
5165: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5166: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5167: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5168: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5169: directory where the configuration files for the package identified by
5170: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5171: </ul></div>
5172: <p>Based on the above variables, pkginstall determines the value of
5173: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5174: variable that can be used within a package to refer to its configuration
5175: directory. The algorithm used to set its value is basically the
5176: following:</p>
1.23 wiz 5177: <div class="orderedlist"><ol class="orderedlist" type="1">
5178: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5179: its value is used.</p></li>
1.23 wiz 5180: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5181: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5182: <code class="filename">Makefile</code>, the resulting value is
5183: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5184: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5185: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5186: </ol></div>
5187: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5188: 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
5189: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5190: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5191: </div>
1.41 asau 5192: <div class="sect2">
1.1 dsieger 5193: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5194: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5195: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5196: known place, you need to teach each package where it shall install its
5197: files. In some cases you will have to patch the package Makefiles to
5198: achieve it. If you are lucky, though, it may be as easy as passing an
5199: extra flag to the configuration script; this is the case of GNU Autoconf-
5200: generated files:</p>
5201: <pre class="programlisting">
5202: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5203: </pre>
5204: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5205: for</em></span> its configuration files, not where they will be originally
5206: installed (although the difference is never explicit,
5207: unfortunately).</p>
5208: </div>
1.41 asau 5209: <div class="sect2">
1.1 dsieger 5210: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5211: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5212: <p>As said before, pkginstall automatically handles configuration files.
5213: This means that <span class="strong"><strong>the packages themselves must not
5214: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5215: directly</strong></span>. Bad news is that many software installation scripts
5216: will, out of the box, mess with the contents of that directory. So what is
5217: the correct procedure to fix this issue?</p>
5218: <p>You must teach the package (usually by manually patching it) to
5219: install any configuration files under the examples hierarchy,
5220: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5221: <code class="filename">PLIST</code> registers them and the administrator always
5222: has the original copies available.</p>
5223: <p>Once the required configuration files are in place (i.e., under the
5224: examples hierarchy), the pkginstall framework can use them as master copies
5225: during the package installation to update what is in
5226: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5227: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5228: 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 5229: about their syntax and their purpose. Here is an example, taken from the
1.120 sevan 5230: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.1 dsieger 5231: <pre class="programlisting">
5232: EGDIR= ${PREFIX}/share/doc/mutt/samples
5233: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5234: </pre>
5235: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5236: package and has no meaning outside it.</p>
5237: </div>
1.41 asau 5238: <div class="sect2">
1.1 dsieger 5239: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5240: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5241: <p>The automatic copying of config files can be toggled by setting the
5242: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5243: installation.</p>
5244: </div>
5245: </div>
1.41 asau 5246: <div class="sect1">
1.1 dsieger 5247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5248: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5249: <p>System startup scripts are special files because they must be
5250: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5251: 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 5252: can be used. However, pkginstall provides a special mechanism to handle
5253: these files.</p>
5254: <p>In order to provide system startup scripts, the package has
5255: to:</p>
1.23 wiz 5256: <div class="orderedlist"><ol class="orderedlist" type="1">
5257: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5258: the <code class="literal">.sh</code> suffix appended. Considering the
1.120 sevan 5259: <a href="http://cdn.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 5260: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5261: <li class="listitem">
1.1 dsieger 5262: <p>Tell pkginstall to handle it, appending the name of the script,
5263: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5264: Continuing the previous example:</p>
5265: <pre class="programlisting">
5266: RCD_SCRIPTS+= cupsd
5267: </pre>
5268: </li>
5269: </ol></div>
5270: <p>Once this is done, pkginstall will do the following steps for each
5271: script in an automated fashion:</p>
1.23 wiz 5272: <div class="orderedlist"><ol class="orderedlist" type="1">
5273: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5274: substitutions described in the <code class="filename">FILES_SUBST</code>
5275: variable.</p></li>
1.23 wiz 5276: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5277: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5278: that this master file must be explicitly registered in the
5279: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5280: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5281: from the examples hierarchy into the system-wide startup scripts
5282: directory.</p></li>
5283: </ol></div>
1.41 asau 5284: <div class="sect2">
1.1 dsieger 5285: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5286: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5287: <p>The automatic copying of config files can be toggled by setting the
5288: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5289: installation. Note that the scripts will be always copied inside the
5290: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5291: matter what the value of this variable is.</p>
5292: </div>
5293: </div>
1.41 asau 5294: <div class="sect1">
1.1 dsieger 5295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5296: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5297: <p>If a package needs to create special users and/or groups during
5298: installation, it can do so by using the pkginstall framework.</p>
5299: <p>Users can be created by adding entries to the
5300: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5301: syntax:</p>
5302: <pre class="programlisting">
5303: user:group
5304: </pre>
5305: <p>Further specification of user details may be done by setting
5306: per-user variables.
5307: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5308: numeric UID for the user.
5309: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5310: user's description or comment.
5311: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5312: user's home directory, and defaults to
5313: <code class="filename">/nonexistent</code> if not specified.
5314: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5315: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5316: not specified.</p>
5317: <p>Similarly, groups can be created by adding entries to the
5318: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5319: <pre class="programlisting">
5320: group
5321: </pre>
5322: <p>The numeric GID of the group may be set by defining
5323: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5324: <p>If a package needs to create the users and groups at an earlier
1.116 wiz 5325: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5326: <code class="literal">configure</code>,<code class="literal">build</code>, or
5327: <code class="literal">pre-install</code> to indicate the phase before which the
5328: users and groups are created. In this case, the numeric UIDs and GIDs
5329: of the created users and groups are automatically hardcoded into the
5330: final installation scripts.</p>
1.1 dsieger 5331: </div>
1.41 asau 5332: <div class="sect1">
1.1 dsieger 5333: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5334: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5335: <p>Packages that install system shells should register them in the shell
5336: database, <code class="filename">/etc/shells</code>, to make things easier to the
5337: administrator. This must be done from the installation scripts to keep
5338: binary packages working on any system. pkginstall provides an easy way to
5339: accomplish this task.</p>
5340: <p>When a package provides a shell interpreter, it has to set the
5341: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5342: add some hooks to the installation scripts to handle it. Consider the
1.120 sevan 5343: following example, taken from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.1 dsieger 5344: <pre class="programlisting">
5345: PKG_SHELL= ${PREFIX}/bin/zsh
5346: </pre>
1.41 asau 5347: <div class="sect2">
1.1 dsieger 5348: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5349: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5350: <p>The automatic registration of shell interpreters can be disabled by
5351: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5352: environment variable to <code class="literal">NO</code>.</p>
5353: </div>
5354: </div>
1.41 asau 5355: <div class="sect1">
1.1 dsieger 5356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5357: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5358: <p>Packages that install X11 fonts should update the database files
5359: that index the fonts within each fonts directory. This can easily be
5360: accomplished within the pkginstall framework.</p>
5361: <p>When a package installs X11 fonts, it must list the directories in
5362: which fonts are installed in the
5363: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5364: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5365: <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 5366: installation scripts to run the appropriate commands to update the fonts
5367: database files within each of those directories. For convenience, if the
5368: directory path is relative, it is taken to be relative to the package's
1.120 sevan 5369: installation prefix. Consider the following example, taken from <a href="http://cdn.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 5370: <pre class="programlisting">
1.67 wiz 5371: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5372: </pre>
1.41 asau 5373: <div class="sect2">
1.1 dsieger 5374: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5375: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5376: <p>The automatic update of fonts databases can be disabled by
5377: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5378: environment variable to <code class="literal">NO</code>.</p>
5379: </div>
5380: </div>
5381: </div>
1.41 asau 5382: <div class="chapter">
1.1 dsieger 5383: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5384: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5385: <div class="toc">
5386: <p><b>Table of Contents</b></p>
1.100 leot 5387: <dl class="toc">
1.6 rillig 5388: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5389: <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 5390: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5391: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5392: </dl>
5393: </div>
5394: <p>Many packages have the ability to be built to support different
5395: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5396: in pkgsrc that provides generic handling of those options that
5397: determine different ways in which the packages can be built. It's
5398: possible for the user to specify exactly which sets of options will be
5399: built into a package or to allow a set of global default options
5400: apply.</p>
1.7 rillig 5401: <p>There are two broad classes of behaviors that one might want to
5402: control via options. One is whether some particular feature is
5403: enabled in a program that will be built anyway, often by including or
5404: not including a dependency on some other package. The other is
5405: whether or not an additional program will be built as part of the
5406: package. Generally, it is better to make a split package for such
5407: additional programs instead of using options, because it enables
5408: binary packages to be built which can then be added separately. For
5409: example, the foo package might have minimal dependencies (those
5410: packages without which foo doesn't make sense), and then the foo-gfoo
5411: package might include the GTK frontend program gfoo. This is better
5412: than including a gtk option to foo that adds gfoo, because either that
5413: option is default, in which case binary users can't get foo without
5414: gfoo, or not default, in which case they can't get gfoo. With split
5415: packages, they can install foo without having GTK, and later decide to
5416: install gfoo (pulling in GTK at that time). This is an advantage to
5417: source users too, avoiding the need for rebuilds.</p>
5418: <p>Plugins with widely varying dependencies should usually be split
5419: instead of options.</p>
5420: <p>It is often more work to maintain split packages, especially if
5421: the upstream package does not support this. The decision of split
5422: vs. option should be made based on the likelihood that users will want
5423: or object to the various pieces, the size of the dependencies that are
5424: included, and the amount of work.</p>
5425: <p>A further consideration is licensing. Non-free parts, or parts
5426: that depend on non-free dependencies (especially plugins) should
5427: almost always be split if feasible.</p>
1.41 asau 5428: <div class="sect1">
1.1 dsieger 5429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5430: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 5431: <p>Global default options are listed in
5432: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5433: that should be built into every package if that option is supported.
1.10 hubertf 5434: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5435: </div>
1.41 asau 5436: <div class="sect1">
1.1 dsieger 5437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5438: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5439: </h2></div></div></div>
5440: <p>The following example shows how
5441: <code class="filename">bsd.options.mk</code> should be used
5442: by the hypothetical ``wibble'' package, either in the package
5443: <code class="filename">Makefile</code>, or in a file,
5444: e.g. <code class="filename">options.mk</code>, that is included by the
5445: main package <code class="filename">Makefile</code>.</p>
5446: <pre class="programlisting">
5447: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5448: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5449: PKG_OPTIONS_OPTIONAL_GROUPS= database
5450: PKG_OPTIONS_GROUP.database= mysql pgsql
5451: PKG_SUGGESTED_OPTIONS= wibble-foo
5452: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5453: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5454:
5455: .include "../../mk/bsd.prefs.mk"
5456:
5457: # this package was previously named wibble2
5458: .if defined(PKG_OPTIONS.wibble2)
5459: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5460: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5461: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5462: .endif
5463:
5464: .include "../../mk/bsd.options.mk"
5465:
5466: # Package-specific option-handling
5467:
5468: ###
5469: ### FOO support
5470: ###
5471: .if !empty(PKG_OPTIONS:Mwibble-foo)
5472: CONFIGURE_ARGS+= --enable-foo
5473: .endif
5474:
5475: ###
5476: ### LDAP support
5477: ###
5478: .if !empty(PKG_OPTIONS:Mldap)
5479: . include "../../databases/openldap-client/buildlink3.mk"
5480: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5481: .endif
5482:
5483: ###
5484: ### database support
5485: ###
5486: .if !empty(PKG_OPTIONS:Mmysql)
5487: . include "../../mk/mysql.buildlink3.mk"
5488: .endif
5489: .if !empty(PKG_OPTIONS:Mpgsql)
5490: . include "../../mk/pgsql.buildlink3.mk"
5491: .endif
5492: </pre>
5493: <p>The first section contains the information about which build
5494: options are supported by the package, and any default options settings
5495: if needed.</p>
1.23 wiz 5496: <div class="orderedlist"><ol class="orderedlist" type="1">
5497: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.120 sevan 5498: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1 dsieger 5499: options. It should be set to
5500: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5501: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5502: at the point where the options are processed.</p></li>
1.23 wiz 5503: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5504: build options supported by the package.</p></li>
1.23 wiz 5505: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5506: list of names of groups of mutually exclusive options. The options in
5507: each group are listed in
5508: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5509: The most specific setting of any option from the group takes
5510: precedence over all other options in the group. Options from the
5511: groups will be automatically added to
5512: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5513: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5514: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5515: packages will fail if no option from the group is
5516: selected.</p></li>
1.23 wiz 5517: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5518: of names of sets of options. At least one option from each set must
5519: be selected. The options in each set are listed in
5520: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5521: Options from the sets will be automatically added to
5522: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5523: fail if no option from the set is selected.</p></li>
1.23 wiz 5524: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5525: build options which are enabled by default.</p></li>
1.23 wiz 5526: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5527: of
1.23 wiz 5528: <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 5529: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5530: their option counterparts. Pairs should be added with
1.23 wiz 5531: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5532: warning will be issued if the user uses a legacy
5533: variable.</p></li>
1.23 wiz 5534: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5535: of
1.23 wiz 5536: <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 5537: pairs that map options that have been renamed to their new
1.23 wiz 5538: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5539: the listing of global legacy options. A warning will be issued if
5540: the user uses a legacy option.</p></li>
1.23 wiz 5541: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5542: options implied by deprecated variables used. This can be used for
5543: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5544: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5545: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5546: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5547: a list of warnings about deprecated variables or options used, and
5548: what to use instead.</p></li>
5549: </ol></div>
5550: <p>A package should never modify
5551: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5552: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5553: To suggest a default set of options, use
5554: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5555: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5556: including <code class="filename">bsd.options.mk</code>. If none of
5557: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5558: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5559: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5560: happen with platform-specific options if none of them is supported on
5561: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5562: empty list and the package is otherwise treated as not using the
5563: options framework.</p>
5564: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5565: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5566: build options, properly filtered to remove unsupported and duplicate
5567: options.</p>
5568: <p>The remaining sections contain the logic that is specific to
5569: each option. The correct way to check for an option is to check
5570: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5571: <pre class="programlisting">
5572: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5573: </pre>
5574: </div>
1.41 asau 5575: <div class="sect1">
1.1 dsieger 5576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5577: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 5578: <p>Options that enable similar features in different packages (like
5579: optional support for a library) should use a common name in all
5580: packages that support it (like the name of the library). If another
5581: package already has an option with the same meaning, use the same
5582: name.</p>
5583: <p>Options that enable features specific to one package, where it's
5584: unlikely that another (unrelated) package has the same (or a similar)
5585: optional feature, should use a name prefixed with
5586: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5587: <p>If a group of related packages share an optional feature
5588: specific to that group, prefix it with the name of the
1.23 wiz 5589: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5590: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5591: <p>For new options, add a line to
5592: <code class="filename">mk/defaults/options.description</code>. Lines have two
5593: fields, separated by tab. The first field is the option name, the
5594: second its description. The description should be a whole sentence
5595: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5596: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5597: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5598: </div>
1.41 asau 5599: <div class="sect1">
1.7 rillig 5600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5601: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5602: <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 5603: different dependencies based on the options with which the package was
5604: built. For querying these options, the file
5605: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5606: typical example looks like this:</p>
5607: <pre class="programlisting">
5608: pkgbase := libpurple
5609: .include "../../mk/pkg-build-options.mk"
5610:
5611: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5612: ...
5613: .endif
5614: </pre>
5615: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5616: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5617: options of the libpurple package, which can then be queried like
5618: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5619: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5620: details.</p>
5621: </div>
1.1 dsieger 5622: </div>
1.41 asau 5623: <div class="chapter">
1.1 dsieger 5624: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5625: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 5626: <div class="toc">
5627: <p><b>Table of Contents</b></p>
1.100 leot 5628: <dl class="toc">
1.6 rillig 5629: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
5630: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
5631: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
5632: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 5633: <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 5634: <dd><dl>
5635: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
5636: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
5637: </dl></dd>
1.23 wiz 5638: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5639: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5640: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5641: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5642: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5643: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5644: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5645: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5646: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5647: <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 5648: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
5649: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 5650: </dl>
5651: </div>
1.41 asau 5652: <div class="sect1">
1.1 dsieger 5653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5654: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 5655: <p>This chapter gives a detailed description on how a package is
5656: built. Building a package is separated into different
5657: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5658: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5659: described in the following sections. Each phase is split into
1.1 dsieger 5660: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5661: containing phase, prefixed by one of <code class="varname">pre-</code>,
5662: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5663: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5664: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5665: <p>Never override the regular targets (like
5666: <code class="varname">fetch</code>), if you have to, override the
5667: <code class="varname">do-*</code> ones instead.</p>
5668: <p>The basic steps for building a program are always the same. First
5669: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5670: the local system and then extracted. After any pkgsrc-specific patches
5671: to compile properly are applied, the software can be configured, then
5672: built (usually by compiling), and finally the generated binaries, etc.
5673: can be put into place on the system.</p>
5674: <p>To get more details about what is happening at each step,
5675: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5676: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5677: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5678: </div>
1.41 asau 5679: <div class="sect1">
1.1 dsieger 5680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5681: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 5682: <p>Before outlining the process performed by the NetBSD package system in
5683: the next section, here's a brief discussion on where programs are
5684: installed, and which variables influence this.</p>
5685: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5686: where all files of the final program shall be installed. It is
5687: usually set to <code class="varname">LOCALBASE</code>
5688: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5689: for pkgs in the <code class="filename">cross</code> category. The value of
5690: <code class="varname">PREFIX</code> needs to be put
5691: into the various places in the program's source where paths to
1.108 rillig 5692: 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 5693: <p>When choosing which of these variables to use,
5694: follow the following rules:</p>
1.41 asau 5695: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5696: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5697: where the current pkg will be installed. When referring to a
5698: pkg's own installation path, use
1.23 wiz 5699: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5700: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5701: are installed. If you need to construct a -I or -L argument
5702: to the compiler to find includes and libraries installed by
1.23 wiz 5703: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5704: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5705: installed all packages in <code class="filename">/usr/local</code>. As
5706: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5707: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5708: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5709: distribution (from xsrc, etc.) is installed. When looking for
5710: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5711: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5712: <li class="listitem"><p>X11-based packages using imake must set
5713: <code class="varname">USE_IMAKE</code> to be installed correctly under
5714: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5715: <li class="listitem">
1.99 sevan 5716: <p>To determine the prefix of an
1.1 dsieger 5717: installed package, the <code class="varname">EVAL_PREFIX</code>
5718: definition can be used. It takes pairs in the format
1.120 sevan 5719: <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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 5720: variable <code class="varname">DIRNAME</code> will be set to the prefix
5721: of the installed package <package>, or
1.99 sevan 5722: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> if the package is not
1.1 dsieger 5723: installed.</p>
5724: <p>This is best illustrated by example.</p>
5725: <p>The following lines are taken from
5726: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
5727: <pre class="programlisting">
5728: EVAL_PREFIX+= GTKDIR=gtk+
5729: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
5730: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
5731: CONFIGURE_ARGS+= --enable-multibyte
5732: </pre>
5733: <p>Specific defaults can be defined for the packages
5734: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
5735: definition of the form:</p>
5736: <pre class="programlisting">
5737: GTKDIR_DEFAULT= ${LOCALBASE}
5738: </pre>
5739: <p>where <code class="varname">GTKDIR</code> corresponds
5740: to the first definition in
5741: the <code class="varname">EVAL_PREFIX</code> pair.</p>
5742: </li>
1.23 wiz 5743: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.120 sevan 5744: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1 dsieger 5745: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5746: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5747: </ul></div>
5748: </div>
1.41 asau 5749: <div class="sect1">
1.1 dsieger 5750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5751: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5752: <p>When building a package, various directories are used to store
1.1 dsieger 5753: source files, temporary files, pkgsrc-internal files, and so on. These
5754: directories are explained here.</p>
5755: <p>Some of the directory variables contain relative pathnames. There
5756: are two common base directories for these relative directories:
5757: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5758: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5759: inside the package itself.</p>
1.41 asau 5760: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5761: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5762: <dd><p>This is an absolute pathname that points to the pkgsrc
5763: root directory. Generally, you don't need
5764: it.</p></dd>
5765: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5766: <dd><p>This is an absolute pathname that points to the
5767: current package.</p></dd>
5768: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5769: <dd><p>This is a pathname relative to
5770: <code class="varname">PKGSRCDIR</code> that points to the current
5771: package.</p></dd>
5772: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5773: <dd><p>This is an absolute pathname pointing to the directory
5774: where all work takes place. The distfiles are extracted to this
5775: directory. It also contains temporary directories and log files used by
5776: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5777: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5778: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5779: <dd><p>This is an absolute pathname pointing to the directory
5780: where the distfiles are extracted. It is usually a direct subdirectory
5781: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5782: that isn't hidden. This variable may be changed by a package
5783: <code class="filename">Makefile</code>.</p></dd>
5784: </dl></div>
1.14 jmcneill 5785: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5786: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5787: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5788: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5789: If users would like to have their pkgsrc trees behave in a
5790: read-only manner, then the value of
5791: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5792: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5793: </div>
1.41 asau 5794: <div class="sect1">
1.1 dsieger 5795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5796: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 5797: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5798: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5799: phase. This will automatically run all phases that are required for this
5800: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5801: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5802: the package will be built, but not installed.</p>
5803: </div>
1.41 asau 5804: <div class="sect1">
1.1 dsieger 5805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5806: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5807: <p>The first step in building a package is to fetch the
5808: distribution files (distfiles) from the sites that are providing
5809: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5810: phase.</p>
1.41 asau 5811: <div class="sect2">
1.1 dsieger 5812: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5813: <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 5814: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5815: defines all URLs from where the distfile, whose name is
5816: derived from the <code class="varname">DISTNAME</code> variable, is
5817: fetched. The more complicated cases are described
5818: below.</p>
5819: <p>The variable <code class="varname">DISTFILES</code> specifies
5820: the list of distfiles that have to be fetched. Its value
1.66 asau 5821: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5822: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5823: so that most packages don't need to define it at all.
5824: <code class="varname">EXTRACT_SUFX</code> is
5825: <code class="literal">.tar.gz</code> by default, but can be changed
5826: freely. Note that if your package requires additional
5827: distfiles to the default one, you cannot just append the
5828: additional filenames using the <code class="literal">+=</code>
5829: operator, but you have write for example:</p>
5830: <pre class="programlisting">
1.66 asau 5831: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5832: </pre>
5833: <p>Each distfile is fetched from a list of sites, usually
5834: <code class="varname">MASTER_SITES</code>. If the package has multiple
5835: <code class="varname">DISTFILES</code> or multiple
5836: <code class="varname">PATCHFILES</code> from different sites, you can
5837: set
5838: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5839: to the list of URLs where the file
5840: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5841: (including the suffix) can be found.</p>
5842: <pre class="programlisting">
5843: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5844: DISTFILES+= foo-file.tar.gz
5845: SITES.foo-file.tar.gz= \
5846: http://www.somewhere.com/somehow/ \
5847: http://www.somewhereelse.com/mirror/somehow/
5848: </pre>
5849: <p>When actually fetching the distfiles, each item from
5850: <code class="varname">MASTER_SITES</code> or
5851: <code class="varname">SITES.*</code> gets the name of each distfile
5852: appended to it, without an intermediate slash. Therefore,
5853: all site values have to end with a slash or other separator
5854: character. This allows for example to set
5855: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5856: that gets the name of the distfile as a parameter. In this
5857: case, the definition would look like:</p>
5858: <pre class="programlisting">
5859: MASTER_SITES= http://www.example.com/download.cgi?file=
5860: </pre>
1.22 jakllsch 5861: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5862: In that case the URL is taken as is, fetched and the result
5863: stored under the name of the distfile. You can use this style
5864: for the case when the download URL style does not match the
5865: above common case. For example, if permanent download URL is a
5866: redirector to the real download URL, or the download file name
5867: is offered by an HTTP Content-Disposition header. In the
5868: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5869: created instead of the default
5870: <code class="filename">v1.0.0.tar.gz</code>.</p>
5871: <pre class="programlisting">
5872: DISTNAME= foo-1.0.0
5873: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5874: </pre>
1.1 dsieger 5875: <p>There are some predefined values for
5876: <code class="varname">MASTER_SITES</code>, which can be used in
5877: packages. The names of the variables should speak for
5878: themselves.</p>
5879: <pre class="programlisting">
5880: ${MASTER_SITE_APACHE}
5881: ${MASTER_SITE_BACKUP}
5882: ${MASTER_SITE_CYGWIN}
5883: ${MASTER_SITE_DEBIAN}
5884: ${MASTER_SITE_FREEBSD}
5885: ${MASTER_SITE_FREEBSD_LOCAL}
5886: ${MASTER_SITE_GENTOO}
5887: ${MASTER_SITE_GNOME}
5888: ${MASTER_SITE_GNU}
5889: ${MASTER_SITE_GNUSTEP}
1.66 asau 5890: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 5891: ${MASTER_SITE_IFARCHIVE}
5892: ${MASTER_SITE_KDE}
5893: ${MASTER_SITE_MOZILLA}
1.66 asau 5894: ${MASTER_SITE_MOZILLA_ALL}
5895: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 5896: ${MASTER_SITE_MYSQL}
1.66 asau 5897: ${MASTER_SITE_NETLIB}
1.1 dsieger 5898: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 5899: ${MASTER_SITE_OSDN}
1.1 dsieger 5900: ${MASTER_SITE_PERL_CPAN}
5901: ${MASTER_SITE_PGSQL}
1.66 asau 5902: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 5903: ${MASTER_SITE_R_CRAN}
5904: ${MASTER_SITE_SOURCEFORGE}
5905: ${MASTER_SITE_SUNSITE}
5906: ${MASTER_SITE_SUSE}
5907: ${MASTER_SITE_TEX_CTAN}
5908: ${MASTER_SITE_XCONTRIB}
5909: ${MASTER_SITE_XEMACS}
1.66 asau 5910: ${MASTER_SITE_XORG}
1.1 dsieger 5911: </pre>
5912: <p>Some explanations for the less self-explaining ones:
5913: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 5914: 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 5915: 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 5916: <p>If you choose one of these predefined sites, you may
5917: want to specify a subdirectory of that site. Since these
5918: macros may expand to more than one actual site, you
5919: <span class="emphasis"><em>must</em></span> use the following construct to
5920: specify a subdirectory:</p>
5921: <pre class="programlisting">
5922: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5923: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5924: </pre>
5925: <p>Note the trailing slash after the subdirectory
5926: name.</p>
5927: </div>
1.41 asau 5928: <div class="sect2">
1.1 dsieger 5929: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5930: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 5931: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5932: all the distfiles exist in a local directory
5933: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
5934: user). If the files do not exist, they are fetched using
5935: commands of the form</p>
5936: <pre class="programlisting">
5937: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5938: </pre>
5939: <p>where <code class="literal">${site}</code> varies through
5940: several possibilities in turn: first,
5941: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
5942: sites specified in either <code class="varname">SITES.file</code> if
5943: defined, else <code class="varname">MASTER_SITES</code> or
5944: <code class="varname">PATCH_SITES</code>, as applies, then finally the
5945: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
5946: all except the first and the last can be optionally sorted
5947: by the user, via setting either
5948: <code class="varname">MASTER_SORT_RANDOM</code>, and
5949: <code class="varname">MASTER_SORT_AWK</code> or
5950: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 5951: <p> The specific command and arguments used depend on the
5952: <code class="varname">FETCH_USING</code> parameter. The example above is
5953: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 5954: <p>The distfiles mirror run by the NetBSD Foundation uses the
5955: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
5956: distfiles, if they are freely distributable. Packages setting
5957: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 5958: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 5959: mirrored.</p>
5960: </div>
5961: </div>
1.41 asau 5962: <div class="sect1">
1.1 dsieger 5963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5964: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 5965: <p>After the distfile(s) are fetched, their checksum is
5966: generated and compared with the checksums stored in the
5967: distinfo file. If the checksums don't match, the build is
5968: aborted. This is to ensure the same distfile is used for
5969: building, and that the distfile wasn't changed, e.g. by some
5970: malign force, deliberately changed distfiles on the master
5971: distribution site or network lossage.</p>
5972: </div>
1.41 asau 5973: <div class="sect1">
1.1 dsieger 5974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5975: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 5976: <p>When the distfiles are present on the local system, they
5977: need to be extracted, as they usually come in the form of some
5978: compressed archive format.</p>
5979: <p>By default, all <code class="varname">DISTFILES</code> are
5980: extracted. If you only need some of them, you can set the
5981: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
5982: files.</p>
5983: <p>Extracting the files is usually done by a little
5984: program, <code class="filename">mk/extract/extract</code>, which
5985: already knows how to extract various archive formats, so most
5986: likely you will not need to change anything here. But if you
5987: need, the following variables may help you:</p>
1.41 asau 5988: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5989: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
5990: <dd><p>Use these variables to override the default
5991: options for an extract command, which are defined in
5992: <code class="filename">mk/extract/extract</code>.</p></dd>
5993: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
5994: <dd><p>This variable can be set to
1.14 jmcneill 5995: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
5996: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 5997: absolute pathname pointing to the command with which tar
1.14 jmcneill 5998: archives should be extracted. It is preferred to choose bsdtar over gtar
5999: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6000: </dl></div>
6001: <p>If the <code class="filename">extract</code> program doesn't
6002: serve your needs, you can also override the
6003: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6004: command used for extracting the files. This command is
6005: executed in the <code class="filename">${WRKSRC}</code>
6006: directory. During execution of this command, the shell
6007: variable <code class="varname">extract_file</code> holds the absolute
6008: pathname of the file that is going to be extracted.</p>
6009: <p>And if that still does not suffice, you can override the
6010: <code class="varname">do-extract</code> target in the package
6011: Makefile.</p>
6012: </div>
1.41 asau 6013: <div class="sect1">
1.1 dsieger 6014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6015: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6016: <p>After extraction, all the patches named by the
6017: <code class="varname">PATCHFILES</code>, those present in the patches
6018: subdirectory of the package as well as in
6019: $LOCALPATCHES/$PKGPATH (e.g.
6020: <code class="filename">/usr/local/patches/graphics/png</code>) are
6021: applied. Patchfiles ending in <code class="filename">.Z</code> or
6022: <code class="filename">.gz</code> are uncompressed before they are
6023: applied, files ending in <code class="filename">.orig</code> or
6024: <code class="filename">.rej</code> are ignored. Any special options to
1.120 sevan 6025: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.108 rillig 6026: <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.120 sevan 6027: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1 dsieger 6028: it fail if the patches apply with some lines of fuzz. Please
6029: fix (regen) the patches so that they apply cleanly. The
6030: rationale behind this is that patches that don't apply cleanly
6031: may end up being applied in the wrong place, and cause severe
6032: harm there.</p>
6033: </div>
1.41 asau 6034: <div class="sect1">
1.1 dsieger 6035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6036: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6037: <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 6038: </p>
6039: </div>
1.41 asau 6040: <div class="sect1">
1.1 dsieger 6041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6042: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6043: <p>This phase creates wrapper programs for the compilers and
6044: linkers. The following variables can be used to tweak the
6045: wrappers.</p>
1.41 asau 6046: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6047: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6048: <dd><p>The command used to print progress
6049: messages. Does nothing by default. Set to
6050: <code class="literal">${ECHO}</code> to see the progress
6051: messages.</p></dd>
6052: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6053: <dd><p>This variable can be set to
6054: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6055: depending on whether you want additional information in the
6056: wrapper log file.</p></dd>
6057: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6058: <dd><p>This variable can be set to
6059: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6060: on whether the wrapper should use its cache, which will
6061: improve the speed. The default value is
6062: <code class="literal">yes</code>, but is forced to
6063: <code class="literal">no</code> if the platform does not support
6064: it.</p></dd>
6065: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6066: <dd><p>A list of reordering commands. A reordering
6067: command has the form
6068: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6069: It ensures that that
6070: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6071: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6072: </p></dd>
6073: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6074: <dd><p>A list of transformation commands. [TODO:
6075: investigate further]</p></dd>
6076: </dl></div>
6077: </div>
1.41 asau 6078: <div class="sect1">
1.1 dsieger 6079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6080: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6081: <p>Most pieces of software need information on the header
6082: files, system calls, and library routines which are available
6083: on the platform they run on. The process of determining this
6084: information is known as configuration, and is usually
6085: automated. In most cases, a script is supplied with the
6086: distfiles, and its invocation results in generation of header
6087: files, Makefiles, etc.</p>
6088: <p>If the package contains a configure script, this can be
6089: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6090: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6091: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6092: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6093: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6094: <pre class="programlisting">
6095: .for d in ${CONFIGURE_DIRS}
6096: cd ${WRKSRC} \
6097: && cd ${d} \
6098: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6099: .endfor
6100: </pre>
6101: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6102: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6103: <code class="varname">WRKSRC</code>. In each of these directories, the
6104: configure script is run with the environment
6105: <code class="varname">CONFIGURE_ENV</code> and arguments
6106: <code class="varname">CONFIGURE_ARGS</code>. The variables
6107: <code class="varname">CONFIGURE_ENV</code>,
6108: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6109: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6110: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6111: package.</p>
1.37 wiz 6112: <p>If the program uses the Perl way of configuration (mainly Perl
6113: modules, but not only), i.e. a file called
6114: <code class="filename">Makefile.PL</code>, it should include
6115: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6116: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6117: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6118: <p>If the program uses an <code class="filename">Imakefile</code>
6119: for configuration, the appropriate steps can be invoked by
6120: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6121: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6122: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6123: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6124: <p>If the program uses <code class="filename">cmake</code>
6125: for configuration, the appropriate steps can be invoked by
1.23 wiz 6126: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6127: You can add variables to cmake's environment by adding them to the
6128: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6129: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6130: The top directory argument is given by the
6131: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6132: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6133: <p>If there is no configure step at all, set
1.23 wiz 6134: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6135: </div>
1.41 asau 6136: <div class="sect1">
1.1 dsieger 6137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6138: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6139: <p>For building a package, a rough equivalent of the
6140: following code is executed.</p>
6141: <pre class="programlisting">
6142: .for d in ${BUILD_DIRS}
6143: cd ${WRKSRC} \
6144: && cd ${d} \
6145: && env ${MAKE_ENV} \
6146: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6147: -f ${MAKE_FILE} \
6148: ${BUILD_TARGET}
6149: .endfor
6150: </pre>
6151: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6152: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6153: <code class="varname">WRKSRC</code>. In each of these directories,
6154: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6155: <code class="varname">MAKE_ENV</code> and arguments
6156: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6157: <code class="varname">MAKE_ENV</code>,
6158: <code class="varname">BUILD_MAKE_FLAGS</code>,
6159: <code class="varname">MAKE_FILE</code> and
6160: <code class="varname">BUILD_TARGET</code> may all be changed by the
6161: package.</p>
6162: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6163: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6164: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6165: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6166: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6167: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6168: <p>If there is no build step at all, set
1.23 wiz 6169: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6170: </div>
1.41 asau 6171: <div class="sect1">
1.1 dsieger 6172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6173: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6174: <p>[TODO]</p>
6175: </div>
1.41 asau 6176: <div class="sect1">
1.1 dsieger 6177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6178: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6179: <p>Once the build stage has completed, the final step is to
6180: install the software in public directories, so users can
6181: access the programs and files.</p>
6182: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6183: equivalent of the following code is executed. Additionally,
6184: before and after this code, much magic is performed to do
6185: consistency checks, registering the package, and so on.</p>
6186: <pre class="programlisting">
6187: .for d in ${INSTALL_DIRS}
6188: cd ${WRKSRC} \
6189: && cd ${d} \
6190: && env ${MAKE_ENV} \
6191: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6192: -f ${MAKE_FILE} \
6193: ${INSTALL_TARGET}
6194: .endfor
6195: </pre>
6196: <p>The variable's meanings are analogous to the ones in the
6197: <span class="emphasis"><em>build</em></span> phase.
6198: <code class="varname">INSTALL_DIRS</code> defaults to
6199: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6200: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6201: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6202: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6203: defined.</p>
6204: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6205: variables are useful. They are all variations of the
1.120 sevan 6206: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1 dsieger 6207: permissions preset. <code class="varname">INSTALL</code> is the plain
6208: install command. The specialized variants, together with their
6209: intended use, are:</p>
1.41 asau 6210: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6211: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6212: <dd><p>directories that contain
6213: binaries</p></dd>
6214: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6215: <dd><p>directories that contain
6216: scripts</p></dd>
6217: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6218: <dd><p>directories that contain shared and static
6219: libraries</p></dd>
6220: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6221: <dd><p>directories that contain data
6222: files</p></dd>
6223: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6224: <dd><p>directories that contain man
6225: pages</p></dd>
1.100 leot 6226: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6227: <dd><p>directories that contain data files for games
6228: </p></dd>
1.1 dsieger 6229: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6230: <dd><p>binaries that can be stripped from debugging
6231: symbols</p></dd>
6232: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6233: <dd><p>binaries that cannot be
6234: stripped</p></dd>
6235: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6236: <dd><p>game
6237: binaries</p></dd>
6238: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6239: <dd><p>shared and static
6240: libraries</p></dd>
6241: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6242: <dd><p>data files</p></dd>
6243: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6244: <dd><p>data files for
6245: games</p></dd>
6246: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6247: <dd><p>man pages</p></dd>
6248: </dl></div>
6249: <p>Some other variables are:</p>
1.41 asau 6250: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6251: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.120 sevan 6252: <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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.106 tnn 6253: when installing binaries. Any debugging sections and symbols present in
6254: binaries will be preserved.
6255: </p></dd>
1.1 dsieger 6256: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6257: <dd><p>A list of directories relative to
6258: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6259: beginning of the <span class="emphasis"><em>install</em></span> phase.
6260: The package is supposed to create all needed directories itself
6261: before installing files to it and list all other directories here.
6262: </p></dd>
6263: </dl></div>
6264: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6265: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6266: mostly relevant for packages in the <code class="filename">regress</code>
6267: category.</p>
6268: </div>
1.41 asau 6269: <div class="sect1">
1.1 dsieger 6270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6271: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6272: <p>Once the install stage has completed, a binary package of
6273: the installed files can be built. These binary packages can be
6274: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6275: the <span class="command"><strong>make bin-install</strong></span> or by using
6276: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6277: <p>By default, the binary packages are created in
6278: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6279: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6280: one for each category in the <code class="varname">CATEGORIES</code>
6281: variable. <code class="varname">PACKAGES</code> defaults to
6282: <code class="filename">pkgsrc/packages</code>.</p>
6283: </div>
1.41 asau 6284: <div class="sect1">
1.1 dsieger 6285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6286: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6287: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6288: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6289: to clean the work directories of all dependencies too, use
1.10 hubertf 6290: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6291: </div>
1.41 asau 6292: <div class="sect1">
1.1 dsieger 6293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6294: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6295: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6296: <dt><span class="term">pre/post-*</span></dt>
6297: <dd><p>For any of the main targets described in the
6298: previous section, two auxiliary targets exist with
1.23 wiz 6299: <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 6300: prefix for the main target's name. These targets are
6301: invoked before and after the main target is called,
6302: allowing extra configuration or installation steps be
6303: performed from a package's Makefile, for example, which
6304: a program's configure script or install target
6305: omitted.</p></dd>
6306: <dt><span class="term">do-*</span></dt>
6307: <dd><p>Should one of the main targets do the wrong thing,
6308: and should there be no variable to fix this, you can
6309: redefine it with the do-* target. (Note that redefining
6310: the target itself instead of the do-* target is a bad
6311: idea, as the pre-* and post-* targets won't be called
6312: anymore, etc.) You will not usually need to do
6313: this.</p></dd>
6314: <dt><span class="term">reinstall</span></dt>
6315: <dd>
1.10 hubertf 6316: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6317: you noticed some file was not installed properly, you
6318: can repeat the installation with this target, which will
1.23 wiz 6319: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6320: <p>This is the default value of
6321: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6322: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6323: package</strong></span>, where the defaults are
1.23 wiz 6324: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6325: respectively.</p>
6326: </dd>
6327: <dt><span class="term">deinstall</span></dt>
6328: <dd>
1.120 sevan 6329: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1 dsieger 6330: current directory, effectively de-installing the
6331: package. The following variables can be used to tune the
6332: behaviour:</p>
1.41 asau 6333: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6334: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.120 sevan 6335: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1 dsieger 6336: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6337: <dd><p>Remove all packages that require (depend on)
6338: the given package. This can be used to remove any
6339: packages that may have been pulled in by a given
1.10 hubertf 6340: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6341: DEINSTALLDEPENDS=1</strong></span> is done in
6342: <code class="filename">pkgsrc/x11/kde</code>, this is
6343: likely to remove whole KDE. Works by adding
1.120 sevan 6344: <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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1 dsieger 6345: command line.</p></dd>
6346: </dl></div>
6347: </dd>
6348: <dt><span class="term">bin-install</span></dt>
6349: <dd><p>Install a binary package from local disk and via FTP
6350: from a list of sites (see the
6351: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6352: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6353: available anywhere. The arguments given to
1.10 hubertf 6354: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6355: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6356: operation, etc.</p></dd>
1.95 wiz 6357: <dt><span class="term">install-clean</span></dt>
6358: <dd><p>This target removes the state files for the "install" and later
6359: phases so that the "install" target may be re-invoked. This can be
6360: used after editing the PLIST to install the package without
6361: rebuilding it.</p></dd>
6362: <dt><span class="term">build-clean</span></dt>
6363: <dd><p>This target removes the state files for the "build" and later
6364: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6365: <dt><span class="term">update</span></dt>
6366: <dd>
6367: <p>This target causes the current package to be
6368: updated to the latest version. The package and all
6369: depending packages first get de-installed, then current
6370: versions of the corresponding packages get compiled and
6371: installed. This is similar to manually noting which
6372: packages are currently installed, then performing a
1.10 hubertf 6373: series of <span class="command"><strong>make deinstall</strong></span> and
6374: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6375: <code class="varname">UPDATE_TARGET</code> is set to) for these
6376: packages.</p>
1.23 wiz 6377: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6378: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6379: update</strong></span> was interrupted for some reason.
6380: However, in this case, make sure you don't call
1.10 hubertf 6381: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6382: list of dependent packages in <code class="varname">WRKDIR</code>.
6383: Otherwise, you lose the ability to automatically update
6384: the current package along with the dependent packages
6385: you have installed.</p>
1.10 hubertf 6386: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6387: update</strong></span> will only work as long as the package
6388: tree remains unchanged. If the source code for one of
6389: the packages to be updated has been changed, resuming
1.10 hubertf 6390: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6391: fail!</p>
6392: <p>The following variables can be used either on the
1.10 hubertf 6393: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6394: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6395: update</strong></span>:</p>
1.41 asau 6396: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6397: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6398: <dd><p>Install target to recursively use for the
6399: updated package and the dependent packages.
6400: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6401: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6402: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6403: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6404: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6405: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6406: endless loop!</p></dd>
6407: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6408: <dd><p>Don't clean up after updating. Useful if
6409: you want to leave the work sources of the updated
6410: packages around for inspection or other purposes.
6411: Be sure you eventually clean up the source tree
1.23 wiz 6412: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6413: or you may run into troubles with old source code
6414: still lying around on your next
1.10 hubertf 6415: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6416: update</strong></span>.</p></dd>
6417: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6418: <dd><p>Deinstall each package before installing
6419: (making <code class="varname">DEPENDS_TARGET</code>). This
6420: may be necessary if the
1.23 wiz 6421: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6422: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6423: update</strong></span>.</p></dd>
6424: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6425: <dd><p>Allows you to disable recursion and hardcode
6426: the target for packages. The default is
1.23 wiz 6427: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6428: facilitating a recursive update of prerequisite
6429: packages. Only set
6430: <code class="varname">DEPENDS_TARGET</code> if you want to
6431: disable recursive updates. Use
6432: <code class="varname">UPDATE_TARGET</code> instead to just
6433: set a specific target for each package to be
1.10 hubertf 6434: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6435: (see above).</p></dd>
6436: </dl></div>
6437: </dd>
6438: <dt><span class="term">clean-update</span></dt>
6439: <dd>
6440: <p>Clean the source tree for all packages that would
1.10 hubertf 6441: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6442: from the current directory. This target should not be
6443: used if the current package (or any of its depending
6444: packages) have already been de-installed (e.g., after
1.10 hubertf 6445: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6446: some packages you intended to update. As a rule of
6447: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6448: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6449: and only if you have a dirty package tree (e.g., if you
6450: used <code class="varname">NOCLEAN</code>).</p>
6451: <p>If you are unsure about whether your tree is
1.10 hubertf 6452: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6453: clean</strong></span> at the top of the tree, or use the
6454: following sequence of commands from the directory of the
6455: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6456: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6457: time, otherwise you lose all the packages you wanted to
6458: update!):</p>
6459: <pre class="screen">
6460: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6461: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6462: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6463: </pre>
6464: <p>The following variables can be used either on the
1.10 hubertf 6465: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6466: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6467: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6468: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6469: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6470: reconstruct the list of directories to update for
1.10 hubertf 6471: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6472: update</strong></span> successfully installed all
6473: packages you wanted to update. Normally, this is
1.10 hubertf 6474: done automatically on <span class="command"><strong>make
1.1 dsieger 6475: update</strong></span>, but may have been suppressed by
6476: the <code class="varname">NOCLEAN</code> variable (see
6477: above).</p></dd>
6478: </dl></div>
6479: </dd>
6480: <dt><span class="term">replace</span></dt>
6481: <dd>
6482: <p>Update the installation of the current package. This
6483: differs from update in that it does not replace dependent
1.120 sevan 6484: packages. You will need to install <a href="http://cdn.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 6485: target to work.</p>
6486: <p><span class="emphasis"><em>Be careful when using this
6487: target!</em></span> There are no guarantees that dependent
6488: packages will still work, in particular they will most
1.10 hubertf 6489: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6490: library package whose shared library major version changed
6491: between your installed version and the new one. For this
6492: reason, this target is not officially supported and only
6493: recommended for advanced users.</p>
6494: </dd>
6495: <dt><span class="term">info</span></dt>
1.120 sevan 6496: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1 dsieger 6497: package. You can use this to check which version of a
6498: package is installed.</p></dd>
6499: <dt><span class="term">index</span></dt>
6500: <dd>
6501: <p>This is a top-level command, i.e. it should be used in
6502: the <code class="filename">pkgsrc</code> directory. It creates a
6503: database of all packages in the local pkgsrc tree, including
6504: dependencies, comment, maintainer, and some other useful
6505: information. Individual entries are created by running
1.10 hubertf 6506: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6507: directories. This index file is saved as
6508: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6509: verbose format by running <span class="command"><strong>make
1.1 dsieger 6510: print-index</strong></span>. You can search in it with
1.10 hubertf 6511: <span class="command"><strong>make search
1.1 dsieger 6512: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6513: extract a list of all packages that depend on a particular
1.10 hubertf 6514: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6515: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6516: <p>Running this command takes a very long time, some
6517: hours even on fast machines!</p>
6518: </dd>
6519: <dt><span class="term">readme</span></dt>
6520: <dd>
6521: <p>This target generates a
6522: <code class="filename">README.html</code> file, which can be
1.120 sevan 6523: viewed using a browser such as <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="http://cdn.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 6524: contain references to any packages which are in the
6525: <code class="varname">PACKAGES</code> directory on the local
6526: host. The generated files can be made to refer to URLs
6527: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6528: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6529: wanted to generate <code class="filename">README.html</code>
6530: files which pointed to binary packages on the local
6531: machine, in the directory
6532: <code class="filename">/usr/packages</code>, set
6533: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6534: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6535: <code class="varname">${PACKAGES}</code> directory and its
6536: subdirectories will be searched for all the binary
6537: packages.</p>
6538: <p>The target can be run at the toplevel or in category
6539: directories, in which case it descends recursively.</p>
6540: </dd>
6541: <dt><span class="term">readme-all</span></dt>
6542: <dd><p>This is a top-level command, run it in
6543: <code class="filename">pkgsrc</code>. Use this target to create a
6544: file <code class="filename">README-all.html</code> which contains a
6545: list of all packages currently available in the NetBSD
6546: Packages Collection, together with the category they belong
6547: to and a short description. This file is compiled from the
6548: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6549: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6550: readme</strong></span>.</p></dd>
6551: <dt><span class="term">cdrom-readme</span></dt>
6552: <dd><p>This is very much the same as the
1.23 wiz 6553: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6554: used when generating a pkgsrc tree to be written to a
6555: CD-ROM. This target also produces
6556: <code class="filename">README.html</code> files, and can be made
6557: to refer to URLs based on
6558: <code class="varname">CDROM_PKG_URL_HOST</code> and
6559: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6560: <dt><span class="term">show-distfiles</span></dt>
6561: <dd><p>This target shows which distfiles and patchfiles
6562: are needed to build the package
6563: (<code class="varname">ALLFILES</code>, which contains all
6564: <code class="varname">DISTFILES</code> and
6565: <code class="varname">PATCHFILES</code>, but not
6566: <code class="filename">patches/*</code>).</p></dd>
6567: <dt><span class="term">show-downlevel</span></dt>
6568: <dd><p>This target shows nothing if the package is not
6569: installed. If a version of this package is installed,
6570: but is not the version provided in this version of
6571: pkgsrc, then a warning message is displayed. This target
6572: can be used to show which of your installed packages are
6573: downlevel, and so the old versions can be deleted, and
6574: the current ones added.</p></dd>
6575: <dt><span class="term">show-pkgsrc-dir</span></dt>
6576: <dd><p>This target shows the directory in the pkgsrc
6577: hierarchy from which the package can be built and
6578: installed. This may not be the same directory as the one
6579: from which the package was installed. This target is
6580: intended to be used by people who may wish to upgrade
6581: many packages on a single host, and can be invoked from
6582: the top-level pkgsrc Makefile by using the
1.23 wiz 6583: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6584: <dt><span class="term">show-installed-depends</span></dt>
6585: <dd><p>This target shows which installed packages match
6586: the current package's <code class="varname">DEPENDS</code>. Useful
6587: if out of date dependencies are causing build
6588: problems.</p></dd>
1.95 wiz 6589: <dt><span class="term">print-build-depends-list</span></dt>
6590: <dd><p>This target shows the list of packages that the current package
6591: depends on for building.</p></dd>
6592: <dt><span class="term">print-run-depends-list</span></dt>
6593: <dd><p>This target shows the list of packages that the current package
6594: depends on for running.</p></dd>
1.1 dsieger 6595: <dt><span class="term">check-shlibs</span></dt>
6596: <dd><p>After a package is installed, check all its
6597: binaries and (on ELF platforms) shared libraries to see
6598: if they find the shared libs they need. Run by default
1.10 hubertf 6599: 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 6600: <dt><span class="term">print-PLIST</span></dt>
6601: <dd>
1.23 wiz 6602: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6603: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6604: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6605: -newer work/.extract_done</strong></span>. An attempt is made
6606: to care for shared libs etc., but it is
6607: <span class="emphasis"><em>strongly</em></span> recommended to review the
6608: result before putting it into
6609: <code class="filename">PLIST</code>. On upgrades, it's useful to
6610: diff the output of this command against an already
6611: existing <code class="filename">PLIST</code> file.</p>
1.120 sevan 6612: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 6613: other methods that don't update file access times, be
6614: sure to add these files manually to your
1.23 wiz 6615: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6616: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6617: them!</p>
1.23 wiz 6618: <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 6619: information on this target.</p>
6620: </dd>
6621: <dt><span class="term">bulk-package</span></dt>
6622: <dd>
6623: <p>Used to do bulk builds. If an appropriate binary
6624: package already exists, no action is taken. If not, this
6625: target will compile, install and package it (and its
6626: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 6627: 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
6628: builds)</i></a>).
1.1 dsieger 6629: After creating the binary package, the sources, the
6630: just-installed package and its required packages are
6631: removed, preserving free disk space.</p>
6632: <p><span class="emphasis"><em>Beware that this target may deinstall
6633: all packages installed on a system!</em></span></p>
6634: </dd>
6635: <dt><span class="term">bulk-install</span></dt>
6636: <dd>
6637: <p>Used during bulk-installs to install required
6638: packages. If an up-to-date binary package is available,
1.120 sevan 6639: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10 hubertf 6640: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6641: but the installed binary won't be removed.</p>
6642: <p>A binary package is considered
1.23 wiz 6643: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.120 sevan 6644: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41 asau 6645: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6646: <li class="listitem"><p>None of the package's files
1.1 dsieger 6647: (<code class="filename">Makefile</code>, ...) were modified
6648: since it was built.</p></li>
1.23 wiz 6649: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6650: packages were modified since it was built.</p></li>
6651: </ul></div>
6652: <p><span class="emphasis"><em>Beware that this target may deinstall
6653: all packages installed on a system!</em></span></p>
6654: </dd>
6655: </dl></div>
6656: </div>
6657: </div>
1.41 asau 6658: <div class="chapter">
1.1 dsieger 6659: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6660: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6661: <div class="toc">
6662: <p><b>Table of Contents</b></p>
1.100 leot 6663: <dl class="toc">
1.6 rillig 6664: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
6665: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
6666: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6667: </dl>
6668: </div>
6669: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6670: by pkgsrc and also for individual packages to define what commands
6671: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
6672: or for later run-time of an installed packaged (such as
6673: <code class="varname">DEPENDS</code>).
6674: If the native system provides an adequate tool, then in many cases, a pkgsrc
6675: package will not be used.</p>
6676: <p>When building a package, the replacement tools are
6677: made available in a directory (as symlinks or wrapper scripts)
6678: that is early in the executable search path. Just like the buildlink
6679: system, this helps with consistent builds.</p>
6680: <p>A tool may be needed to help build a specific package. For example,
6681: perl, GNU make (gmake) or yacc may be needed.</p>
6682: <p>Also a tool may be needed, for example, because the native system's supplied
6683: tool may be inefficient for building a package with pkgsrc.
6684: For example, a package may need GNU awk, bison (instead of
6685: yacc) or a better sed.</p>
6686: <p>The tools used by a package can be listed by running
1.10 hubertf 6687: <span class="command"><strong>make show-tools</strong></span>.</p>
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="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6691: <p>The default set of tools used by pkgsrc is defined in
6692: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6693: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6694: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6695: These can be seen by running:
1.10 hubertf 6696: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6697: <p>If a package needs a specific program to build
6698: then the <code class="varname">USE_TOOLS</code> variable can be used
6699: to define the tools needed.</p>
6700: </div>
1.41 asau 6701: <div class="sect1">
1.1 dsieger 6702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6703: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6704: <p>In the following examples, the :run means that it is needed at
6705: run-time (and becomes a DEPENDS).
1.1 dsieger 6706: The default is a build dependency which can be set with
6707: :build. (So in this example, it is the same as gmake:build
6708: and pkg-config:build.)</p>
6709: <pre class="programlisting">
6710: USE_TOOLS+= gmake perl:run pkg-config
6711: </pre>
6712: <p>When using the tools framework, a
6713: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6714: which contains the full path to the appropriate tool. For example,
1.23 wiz 6715: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6716: on Linux systems.</p>
6717: <p>If you always need a pkgsrc version of the
6718: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6719: </p>
6720: </div>
1.41 asau 6721: <div class="sect1">
1.1 dsieger 6722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6723: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6724: <p>When improving or porting pkgsrc to a new platform, have a look
6725: at (or create) the corresponding platform specific make file fragment under
6726: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6727: the name of the common tools. For example:</p>
6728: <pre class="programlisting">
6729: .if exists(/usr/bin/bzcat)
6730: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6731: .elif exists(/usr/bin/bzip2)
6732: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6733: .endif
6734:
6735: TOOLS_PLATFORM.true?= true # shell builtin
6736: </pre>
6737: </div>
6738: </div>
1.41 asau 6739: <div class="chapter">
1.1 dsieger 6740: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6741: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 6742: <div class="toc">
6743: <p><b>Table of Contents</b></p>
1.100 leot 6744: <dl class="toc">
1.6 rillig 6745: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 6746: <dd><dl>
1.108 rillig 6747: <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>
6748: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
6749: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
6750: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
6751: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
6752: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
6753: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
6754: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
6755: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
6756: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6757: <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 6758: </dl></dd>
1.108 rillig 6759: <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 6760: <dd><dl>
6761: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6762: <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 6763: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 6764: </dl></dd>
1.108 rillig 6765: <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 6766: <dd><dl>
6767: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
6768: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6769: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
6770: </dl></dd>
6771: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
6772: <dd><dl>
6773: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
6774: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
6775: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 6776: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
6777: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 6778: </dl></dd>
1.108 rillig 6779: <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 6780: <dd><dl>
6781: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
6782: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 6783: <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 6784: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
6785: </dl></dd>
1.108 rillig 6786: <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 6787: <dd><dl>
6788: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
6789: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
6790: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
6791: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
6792: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6793: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
6794: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
6795: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 6796: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 6797: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 6798: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
6799: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
6800: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
6801: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
6802: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
6803: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
6804: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
6805: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 6806: emulation</a></span></dt>
1.6 rillig 6807: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
6808: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6809: </dl></dd>
1.6 rillig 6810: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6811: </dl>
6812: </div>
1.41 asau 6813: <div class="sect1">
1.1 dsieger 6814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6815: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 6816: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6817: different platforms. As a result, it is important to ensure,
6818: where possible, that packages in pkgsrc are portable. This
6819: chapter mentions some particular details you should pay
6820: attention to while working on pkgsrc.</p>
1.41 asau 6821: <div class="sect2">
1.1 dsieger 6822: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6823: <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 6824: </h3></div></div></div>
6825: <p>The pkgsrc user can configure pkgsrc by overriding several
6826: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6827: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6828: want to use those variables in the preprocessor directives of
1.120 sevan 6829: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 6830: <code class="literal">.for</code>), you need to include the file
6831: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6832: loads the user preferences.</p>
6833: <p>But note that some variables may not be completely defined
6834: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6835: included, as they may contain references to variables that are
1.108 rillig 6836: not yet defined. In shell commands (the lines in
6837: <code class="filename">Makefile</code> that are indented with a tab) this
6838: is no problem, since variables are only expanded when they are
6839: used. But in the preprocessor directives mentioned above and in
6840: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6841: dependencies</code>) the variables are expanded at load
6842: time.</p>
1.41 asau 6843: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6844: <h3 class="title">Note</h3>
1.108 rillig 6845: <p>To check whether a variable can be used at load time,
6846: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6847: </div>
6848: </div>
1.41 asau 6849: <div class="sect2">
1.1 dsieger 6850: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6851: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6852: <p>Occasionally, packages require interaction from the user,
6853: and this can be in a number of ways:</p>
1.41 asau 6854: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6855: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 6856: interaction such as entering username/password or accepting a
6857: license on a web page.</p></li>
1.23 wiz 6858: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 6859: passwords.</p></li>
1.23 wiz 6860: <li class="listitem"><p>help to configure the package before it is built</p></li>
6861: <li class="listitem"><p>help during the build process</p></li>
6862: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 6863: </ul></div>
1.108 rillig 6864: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6865: variable to define which stages need interaction. This should be
6866: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 6867: <pre class="programlisting">
6868: INTERACTIVE_STAGE= configure install
1.111 sevan 6869: </pre>
1.1 dsieger 6870: <p>The user can then decide to skip this package by setting the
1.108 rillig 6871: <code class="varname">BATCH</code> variable. Packages that require interaction
6872: are also excluded from bulk builds.</p>
1.1 dsieger 6873: </div>
1.41 asau 6874: <div class="sect2">
1.1 dsieger 6875: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6876: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 6877: <p>Authors of software can choose the licence under which software
6878: can be copied. The Free Software Foundation has declared some
6879: licenses "Free", and the Open Source Initiative has a definition of
6880: "Open Source".</p>
6881: <p>By default, pkgsrc allows packages with Free or Open Source
6882: licenses to be built. To allow packages with other licenses to be
6883: built as well, the pkgsrc user needs to add these licenses to the
6884: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6885: that this variable only affects which packages may be
6886: <span class="emphasis"><em>built</em></span>, while the license terms often also
6887: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 6888: <p>One might want to only install packages with a BSD license,
1.108 rillig 6889: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 6890: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 6891: user can override the default by setting the
6892: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 6893: of "+=". The licenses accepted by default are defined in the
6894: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6895: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 6896: <p>The license tag mechanism is intended to address
6897: copyright-related issues surrounding building, installing and
6898: using a package, and not to address redistribution issues (see
6899: <code class="varname">RESTRICTED</code> and
1.111 sevan 6900: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 6901: Packages with redistribution restrictions should set these
6902: tags.</p>
1.1 dsieger 6903: <p>Denoting that a package may be copied according to a
6904: particular license is done by placing the license in
6905: <code class="filename">pkgsrc/licenses</code> and setting the
6906: <code class="varname">LICENSE</code> variable to a string identifying the
1.120 sevan 6907: license, e.g. in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1 dsieger 6908: <pre class="programlisting">
6909: LICENSE= xv-license
1.111 sevan 6910: </pre>
1.1 dsieger 6911: <p>When trying to build, the user will get a notice that the
6912: package is covered by a license which has not been placed in the
6913: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
6914: <pre class="programlisting">
6915: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6916: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6917: ===> To view the license, enter "/usr/bin/make show-license".
6918: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6919: ===> ACCEPTABLE_LICENSES+=xv-license
6920: *** Error code 1
1.111 sevan 6921: </pre>
1.10 hubertf 6922: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 6923: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 6924: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 6925: convey to pkgsrc that it should not in the future fail because of
6926: that license:</p>
6927: <pre class="programlisting">
6928: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 6929: </pre>
6930: <p>The use of <code class="varname">LICENSE=shareware</code>,
6931: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
6932: is deprecated because it does not crisply refer to a particular
6933: license text. Another problem with such usage is that it does not
6934: enable a user to tell pkgsrc to proceed for a single package
6935: without also telling pkgsrc to proceed for all packages with that
6936: tag.</p>
6937: <div class="sect3">
6938: <div class="titlepage"><div><div><h4 class="title">
6939: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 6940: <p>When adding a package with a new license, the following steps
6941: are required:</p>
6942: <div class="orderedlist"><ol class="orderedlist" type="1">
6943: <li class="listitem">
1.111 sevan 6944: <p>Check whether the license qualifies as Free or Open
6945: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
6946: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
6947: Open Source Initiative</a>. If this is the case, the filename in
6948: <code class="filename">pkgsrc/licenses/</code> does not need the
6949: <code class="filename">-license</code> suffix, and the license name should be
6950: added to:</p>
1.48 rodent 6951: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6952: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
6953: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
6954: </ul></div>
6955: </li>
6956: <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>
6957: </ol></div>
1.111 sevan 6958: </div>
6959: <div class="sect3">
6960: <div class="titlepage"><div><div><h4 class="title">
6961: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 6962: <p>When the license changes (in a way other than formatting),
1.111 sevan 6963: make sure that the new license has a different name (e.g.,
1.1 dsieger 6964: append the version number if it exists, or the date). Just
6965: because a user told pkgsrc to build programs under a previous
6966: version of a license does not mean that pkgsrc should build
6967: programs under the new licenses. The higher-level point is that
6968: pkgsrc does not evaluate licenses for reasonableness; the only
6969: test is a mechanistic test of whether a particular text has been
1.111 sevan 6970: approved by either of two bodies (FSF or OSI).</p>
6971: </div>
1.1 dsieger 6972: </div>
1.41 asau 6973: <div class="sect2">
1.1 dsieger 6974: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6975: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 6976: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 6977: By declaring the restrictions, package tools can
1.1 dsieger 6978: automatically refrain from e.g. placing binary packages on FTP
6979: sites.</p>
1.111 sevan 6980: <p>There are four possible restrictions, which are
1.1 dsieger 6981: the cross product of sources (distfiles) and binaries not being
6982: placed on FTP sites and CD-ROMs. Because this is rarely the exact
6983: language in any license, and because non-Free licenses tend to be
6984: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 6985: CD-ROM.
6986:
6987: "FTP" means making the source or binary file available over the
6988: Internet at no charge.
6989:
6990: "CD-ROM" means making the source or binary available on some kind of
6991: media, together with other source and binary packages, which is sold
6992: for a distribution charge.
1.1 dsieger 6993: </p>
6994: <p>In order to encode these restrictions, the package system
6995: defines five make variables that can be set to note these
6996: restrictions:</p>
1.41 asau 6997: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6998: <li class="listitem">
1.1 dsieger 6999: <p><code class="varname">RESTRICTED</code></p>
7000: <p>This variable should be set whenever a restriction
7001: exists (regardless of its kind). Set this variable to a
7002: string containing the reason for the restriction. It should
7003: be understood that those wanting to understand the restriction
7004: will have to read the license, and perhaps seek advice of
7005: counsel.</p>
7006: </li>
1.23 wiz 7007: <li class="listitem">
1.1 dsieger 7008: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7009: <p>Binaries may not be placed on CD-ROM containing other
7010: binary packages, for which a distribution charge may be made.
7011: In this case, set this variable to
7012: <code class="varname">${RESTRICTED}</code>.</p>
7013: </li>
1.23 wiz 7014: <li class="listitem">
1.1 dsieger 7015: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7016: <p>Binaries may not made available on the Internet without
7017: charge. In this case, set this variable to
7018: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7019: binary packages will not be included on ftp.NetBSD.org.</p>
7020: </li>
1.23 wiz 7021: <li class="listitem">
1.1 dsieger 7022: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7023: <p>Distfiles may not be placed on CD-ROM, together with
7024: other distfiles, for which a fee may be charged. In this
7025: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7026: </p>
7027: </li>
1.23 wiz 7028: <li class="listitem">
1.1 dsieger 7029: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7030: <p>Distfiles may not made available via FTP at no charge.
7031: In this case, set this variable to
7032: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7033: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7034: </li>
7035: </ul></div>
1.111 sevan 7036: <p>Please note that packages will be removed from pkgsrc when the
7037: distfiles are not distributable and cannot be obtained for a period
7038: of one full quarter branch. Packages with manual/interactive fetch
7039: must have a maintainer and it is his/her responsibility to ensure
7040: this.</p>
1.1 dsieger 7041: </div>
1.41 asau 7042: <div class="sect2">
1.1 dsieger 7043: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7044: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7045: <p>Your package may depend on some other package being present
7046: - and there are various ways of expressing this dependency.
7047: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7048: <code class="varname">DEPENDS</code> definitions, the
7049: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7050: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7051: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7052: 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 7053: <p>The basic difference between the two variables is as
7054: follows: The <code class="varname">DEPENDS</code> definition registers
7055: that pre-requisite in the binary package so it will be pulled in
7056: when the binary package is later installed, whilst the
7057: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7058: dependency that is only needed for building the package.</p>
7059: <p>This means that if you only need a package present whilst
7060: you are building, it should be noted as a
7061: <code class="varname">BUILD_DEPENDS</code>.</p>
7062: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7063: <code class="varname">DEPENDS</code> definition is:</p>
7064: <pre class="programlisting">
7065: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7066: </pre>
1.23 wiz 7067: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7068: may include any of the wildcard version numbers recognized by
1.120 sevan 7069: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7070: <div class="orderedlist"><ol class="orderedlist" type="1">
7071: <li class="listitem">
1.1 dsieger 7072: <p>If your package needs another package's binaries or
1.54 wiz 7073: libraries to build and run, and if that package has a
1.1 dsieger 7074: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7075: <pre class="programlisting">
7076: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7077: </pre>
1.1 dsieger 7078: </li>
1.23 wiz 7079: <li class="listitem">
1.54 wiz 7080: <p>If your package needs another package's binaries or
7081: libraries only for building, and if that package has a
7082: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7083: <pre class="programlisting">
7084: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7085: </pre>
1.54 wiz 7086: <p>but set
7087: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7088: to make it a build dependency only. This case is rather
7089: rare.</p>
7090: </li>
7091: <li class="listitem">
1.25 spz 7092: <p>If your package needs binaries from another package to build,
7093: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7094: <pre class="programlisting">
1.25 spz 7095: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.111 sevan 7096: </pre>
1.1 dsieger 7097: </li>
1.25 spz 7098: <li class="listitem"><p>If your package needs a library with which to link and
7099: there is no <code class="filename">buildlink3.mk</code> file
7100: available, create one. Using
7101: <code class="varname">DEPENDS</code> won't be sufficient because the
7102: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7103: <li class="listitem">
1.25 spz 7104: <p>If your package needs some executable to be able to run
7105: correctly and if there's no
7106: <code class="filename">buildlink3.mk</code> file, this is specified
7107: using the <code class="varname">DEPENDS</code> variable. The
1.120 sevan 7108: <a href="http://cdn.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 7109: be able to execute the latex binary from the teTeX package
7110: when it runs, and that is specified:</p>
1.1 dsieger 7111: <pre class="programlisting">
1.25 spz 7112: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.111 sevan 7113: </pre>
1.25 spz 7114: </li>
7115: <li class="listitem">
7116: <p>You can use wildcards in package dependencies. Note that
7117: such wildcard dependencies are retained when creating binary
7118: packages. The dependency is checked when installing the binary
7119: package and any package which matches the pattern will be
7120: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7121: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7122: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7123: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7124: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7125: <p>Wildcards can also be used to specify that a package
7126: will only build against a certain minimum version of a
7127: pre-requisite:</p>
7128: <pre class="programlisting">
1.25 spz 7129: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7130: </pre>
1.25 spz 7131: <p>This means that the package will build using version 6.0
7132: of ImageMagick or newer. Such a dependency may be warranted
7133: if, for example, the command line options of an executable
7134: have changed.</p>
7135: <p>If you need to depend on minimum versions of libraries,
7136: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7137: <p>For security fixes, please update the package
1.108 rillig 7138: 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 7139: information.</p>
7140: </li>
7141: </ol></div>
7142: <p>If your package needs files from another package to build,
7143: add the relevant distribution files to
7144: <code class="varname">DISTFILES</code>, so they will be extracted
1.120 sevan 7145: automatically. See the <a href="http://cdn.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 7146: (It relies on the jpeg sources being present in source form
7147: during the build.)</p>
7148: </div>
1.41 asau 7149: <div class="sect2">
1.1 dsieger 7150: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7151: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7152: <p>Your package may conflict with other packages a user might
7153: already have installed on his system, e.g. if your package
7154: installs the same set of files as another package in the pkgsrc
1.80 wiz 7155: tree or has the same <code class="varname">PKGNAME</code>.</p>
7156: <p>These cases are handled automatically by the packaging tools
7157: at package installation time and do not need to be handled
7158: manually.</p>
7159: <p>In case the conflicts can not be recognized automatically
7160: (e.g., packages using the same config file location but no other
7161: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7162: space-separated list of packages (including version string) your
7163: package conflicts with.</p>
1.120 sevan 7164: <p>For example, if both <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
7165: and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
1.80 wiz 7166: use the same config file, you would set in
7167: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7168: <pre class="programlisting">
1.80 wiz 7169: CONFLICTS= baz-[0-9]*
1.111 sevan 7170: </pre>
1.80 wiz 7171: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7172: <pre class="programlisting">
1.80 wiz 7173: CONFLICTS= bar-[0-9]*
1.111 sevan 7174: </pre>
1.1 dsieger 7175: </div>
1.41 asau 7176: <div class="sect2">
1.1 dsieger 7177: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7178: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7179: <p>There are several reasons why a package might be
7180: instructed to not build under certain circumstances. If the
7181: package builds and runs on most platforms, the exceptions
1.83 dholland 7182: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7183: the package builds and runs on a small handful of platforms,
7184: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7185: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7186: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7187: (OS-version-platform) that can use glob-style
7188: wildcards.</p>
7189: <p>If a package is not appropriate for some platforms (as
1.114 maya 7190: opposed to merely broken), a different set of variables should be
1.83 dholland 7191: used as this affects failure reporting and statistics.
7192: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7193: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7194: the package is appropriate for only a small handful of platforms
7195: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7196: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7197: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7198: (OS-version-platform) that can use glob-style
7199: wildcards.</p>
7200: <p>Some packages are tightly bound to a specific version of an
1.120 sevan 7201: operating system, e.g. LKMs or <a href="http://cdn.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 7202: backwards compatible with other versions of the OS, and should be
7203: uploaded to a version specific directory on the FTP server. Mark
7204: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7205: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7206: the package system internals, but may be used in the
7207: future.</p>
7208: <p>If the package should be skipped (for example, because it
7209: provides functionality already provided by the system), set
7210: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7211: the package should fail because some preconditions are not met,
7212: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7213: message.</p>
7214: </div>
1.41 asau 7215: <div class="sect2">
1.1 dsieger 7216: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7217: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7218: <p>To ensure that a package may not be deleted, once it has been
7219: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7220: be set in the package Makefile. This will be carried into any
7221: binary package that is made from this pkgsrc entry. A
1.23 wiz 7222: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.120 sevan 7223: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7224: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7225: </div>
1.41 asau 7226: <div class="sect2">
1.1 dsieger 7227: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7228: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7229: <p>When a vulnerability is found, this should be noted in
7230: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7231: and after committing that file, ask pkgsrc-security@NetBSD.org to
7232: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7233: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7234: <code class="varname">PKGREVISION</code> should be increased (this is of
7235: course not necessary if the problem is fixed by using a newer
7236: release of the software), and the pattern in the
7237: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7238: <p>Also, if the fix should be applied to the stable pkgsrc
7239: branch, be sure to submit a pullup request!</p>
7240: <p>Binary packages already on ftp.NetBSD.org will be handled
7241: semi-automatically by a weekly cron job.</p>
7242: </div>
1.41 asau 7243: <div class="sect2">
1.1 dsieger 7244: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7245: <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 7246: <p>When making fixes to an existing package it can be useful
7247: to change the version number in <code class="varname">PKGNAME</code>. To
7248: avoid conflicting with future versions by the original author, a
1.23 wiz 7249: <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 7250: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7251: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7252: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7253: <pre class="programlisting">
7254: DISTNAME= foo-17.42
7255: PKGREVISION= 9
1.111 sevan 7256: </pre>
1.1 dsieger 7257: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7258: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7259: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7260: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7261: <code class="varname">PKGNAME_NOREV</code>.</p>
7262: <p>When a new release of the package is released, the
7263: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7264: minor release of the above package, things should be like:</p>
7265: <pre class="programlisting">
7266: DISTNAME= foo-17.43
1.111 sevan 7267: </pre>
1.1 dsieger 7268: <p><code class="varname">PKGREVISION</code> should be incremented for any
7269: non-trivial change in the resulting binary package. Without a
7270: <code class="varname">PKGREVISION</code> bump, someone with the previous
7271: version installed has no way of knowing that their package is out
7272: of date. Thus, changes without increasing
7273: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7274: trivial that no reasonable person would want to upgrade", and this
7275: is the rough test for when increasing
7276: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7277: changes that do not merit increasing
7278: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7279: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7280: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7281: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7282: or comments in Makefile.</p></li>
1.23 wiz 7283: <li class="listitem"><p>
1.1 dsieger 7284: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7285: <li class="listitem"><p>
1.1 dsieger 7286: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7287: <li class="listitem"><p>
1.1 dsieger 7288: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7289: </ul></div>
7290: <p>Examples of changes that do merit an increase to
7291: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7293: <li class="listitem"><p>
1.1 dsieger 7294: Security fixes</p></li>
1.23 wiz 7295: <li class="listitem"><p>
1.1 dsieger 7296: Changes or additions to a patch file</p></li>
1.23 wiz 7297: <li class="listitem"><p>
1.1 dsieger 7298: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 7299: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 7300: </ul></div>
7301: <p>PKGREVISION must also be incremented when dependencies have ABI
7302: changes.</p>
7303: </div>
1.41 asau 7304: <div class="sect2">
1.1 dsieger 7305: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7306: <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 7307: <p>When you want to replace the same text in multiple files
7308: or when the replacement text varies, patches alone cannot help.
7309: This is where the SUBST framework comes in. It provides an
7310: easy-to-use interface for replacing text in files.
7311: Example:</p>
7312: <pre class="programlisting">
7313: SUBST_CLASSES+= fix-paths
7314: SUBST_STAGE.fix-paths= pre-configure
7315: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7316: SUBST_FILES.fix-paths= src/*.c
7317: SUBST_FILES.fix-paths+= scripts/*.sh
7318: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7319: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 sevan 7320: </pre>
1.1 dsieger 7321: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7322: that are used to identify the different SUBST blocks that are
7323: defined. The SUBST framework is heavily used by pkgsrc, so it is
7324: important to always use the <code class="literal">+=</code> operator with
7325: this variable. Otherwise some substitutions may be
7326: skipped.</p>
7327: <p>The remaining variables of each SUBST block are
7328: parameterized with the identifier from the first line
7329: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7330: parameters to a function call.</p>
7331: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7332: which the replacement will take place. All combinations of
7333: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7334: <code class="literal">post-</code> together with a phase name are
7335: possible, though only few are actually used. Most commonly used
7336: are <code class="literal">post-patch</code> and
7337: <code class="literal">pre-configure</code>. Of these two,
7338: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7339: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7340: have the state after applying the patches but before making any
7341: other changes. This is especially useful when you are debugging
7342: a package in order to create new patches for it. Similarly,
7343: <code class="literal">post-build</code> is preferred over
7344: <code class="literal">pre-install</code>, because the install phase should
7345: generally be kept as simple as possible. When you use
7346: <code class="literal">post-build</code>, you have the same files in the
7347: working directory that will be installed later, so you can check
7348: if the substitution has succeeded.</p>
7349: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7350: that is printed just before the substitution is done.</p>
7351: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7352: globbing patterns that specifies the files in which the
7353: substitution will take place. The patterns are interpreted
7354: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7355: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.120 sevan 7356: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1 dsieger 7357: command should be prefixed with <code class="literal">-e</code>, so that
7358: all SUBST blocks look uniform.</p>
7359: <p>There are some more variables, but they are so seldomly
7360: used that they are only documented in the
7361: <code class="filename">mk/subst.mk</code> file.</p>
7362: </div>
7363: </div>
1.41 asau 7364: <div class="sect1">
1.1 dsieger 7365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7366: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7367: <div class="sect2">
1.1 dsieger 7368: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7369: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 7370: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7371: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7372: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7373: with the name of each file to download as an argument, expecting
7374: it to output the URL of the directory from which to download
1.120 sevan 7375: it. <a href="http://cdn.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 7376: example of this usage.</p>
7377: <p>If the download can't be automated, because the user must
7378: submit personal information to apply for a password, or must pay
7379: for the source, or whatever, you can set
7380: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7381: displayed to the user before aborting the build. Example:</p>
7382: <pre class="programlisting">
7383: FETCH_MESSAGE= "Please download the files"
7384: FETCH_MESSAGE+= " "${DISTFILES:Q}
7385: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7386: </pre>
1.1 dsieger 7387: </div>
1.41 asau 7388: <div class="sect2">
1.1 dsieger 7389: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7390: <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 7391: <p>Sometimes authors of a software package make some
7392: modifications after the software was released, and they put up a
7393: new distfile without changing the package's version number. If a
7394: package is already in pkgsrc at that time, the checksum will
7395: no longer match. The contents of the new distfile should be
7396: compared against the old one before changing anything, to make
7397: sure the distfile was really updated on purpose, and that
7398: no trojan horse or so crept in.
7399: Please mention that the distfiles were compared and what was found
1.53 rodent 7400: in your commit message.</p>
1.109 wiz 7401: <p>Then, the correct way to work around this is to set
7402: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7403: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7404: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7405: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7406: <code class="varname">PATCHFILES</code> for this package will be put in that
1.109 wiz 7407: 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 7408: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7409: including the <code class="filename">nbX</code> suffix) or a date stamp can
7410: be appended, like
7411: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53 rodent 7412: <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>
7413: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7414: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7415: path in the filenames.
1.53 rodent 7416: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7417: Furthermore, a mail to the package's authors seems appropriate
7418: telling them that changing distfiles after releases without
7419: changing the file names is not good practice.</p>
7420: </div>
1.88 tnn 7421: <div class="sect2">
7422: <div class="titlepage"><div><div><h3 class="title">
7423: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 7424: <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:
7425: </p>
1.88 tnn 7426: <div class="sect3">
7427: <div class="titlepage"><div><div><h4 class="title">
7428: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
7429: <p>
7430: 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.
7431: </p>
7432: <pre class="programlisting">
7433: DISTNAME= exampleproject-1.0
1.90 tnn 7434: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7435: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7436: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7437: EXTRACT_SUFX= .zip
7438: </pre>
7439: </div>
7440: <div class="sect3">
7441: <div class="titlepage"><div><div><h4 class="title">
7442: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
7443: <p>
7444: 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.
7445: </p>
7446: <pre class="programlisting">
7447: DISTNAME= example-1.0
1.107 jnemeth 7448: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7449: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7450: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7451: </pre>
1.88 tnn 7452: </div>
7453: <div class="sect3">
7454: <div class="titlepage"><div><div><h4 class="title">
7455: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
7456: <p>
7457: 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.
7458: </p>
7459: <pre class="programlisting">
7460: DISTNAME= offensive-1.6
1.90 tnn 7461: PKGNAME= ${DISTNAME:S/offensive/proper/}
7462: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7463: GITHUB_PROJECT= exampleproject
7464: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7465: EXTRACT_SUFX= .zip
1.111 sevan 7466: </pre>
1.88 tnn 7467: </div>
7468: </div>
1.1 dsieger 7469: </div>
1.41 asau 7470: <div class="sect1">
1.1 dsieger 7471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7472: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7473: <div class="sect2">
1.1 dsieger 7474: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7475: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7476: <p>pkgsrc supports many different machines, with different
7477: object formats like a.out and ELF, and varying abilities to do
7478: shared library and dynamic loading at all. To accompany this,
7479: varying commands and options have to be passed to the
7480: compiler, linker, etc. to get the Right Thing, which can be
7481: pretty annoying especially if you don't have all the machines
7482: at your hand to test things. The
1.120 sevan 7483: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 7484: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7485: both static and dynamic libraries from a set of source files,
7486: thus being platform-independent.</p>
7487: <p>Here's how to use libtool in a package in seven simple
7488: steps:</p>
1.23 wiz 7489: <div class="orderedlist"><ol class="orderedlist" type="1">
7490: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7491: Makefile.</p></li>
1.23 wiz 7492: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7493: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7494: add it to the definition of <code class="varname">CC</code>, if only
7495: libraries are being built in a given Makefile. This one command
7496: will build both PIC and non-PIC library objects, so you need not
7497: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7498: <li class="listitem">
1.1 dsieger 7499: <p>For the linking of the library, remove any
1.23 wiz 7500: <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
7501: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7502: <pre class="programlisting">
7503: ${LIBTOOL} --mode=link \
7504: ${CC} -o ${.TARGET:.a=.la} \
7505: ${OBJS:.o=.lo} \
7506: -rpath ${PREFIX}/lib \
7507: -version-info major:minor
1.111 sevan 7508: </pre>
1.1 dsieger 7509: <p>Note that the library is changed to have a
7510: <code class="filename">.la</code> extension, and the objects are
7511: changed to have a <code class="filename">.lo</code>
7512: extension. Change <code class="varname">OBJS</code> as
7513: necessary. This automatically creates all of the
7514: <code class="filename">.a</code>,
7515: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7516: necessary) in the build directory. Be sure to include
1.23 wiz 7517: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7518: minor are zero, as libtool will otherwise strip off the
7519: shared library version.</p>
7520: <p>From the libtool manual:</p>
7521: <pre class="programlisting">
7522: So, libtool library versions are described by three integers:
7523:
7524: CURRENT
7525: The most recent interface number that this library implements.
7526:
7527: REVISION
7528: The implementation number of the CURRENT interface.
7529:
7530: AGE
7531: The difference between the newest and oldest interfaces that
7532: this library implements. In other words, the library implements
7533: all the interface numbers in the range from number `CURRENT -
7534: AGE' to `CURRENT'.
7535:
7536: If two libraries have identical CURRENT and AGE numbers, then the
7537: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 7538: </pre>
1.23 wiz 7539: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7540: different results for a.out and ELF (excluding symlinks)
7541: in only one case. An ELF library of the form
1.23 wiz 7542: <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 7543: will have a symlink of
1.23 wiz 7544: <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 7545: on an a.out platform. This is handled
7546: automatically.</p>
1.23 wiz 7547: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7548: directory of the library being built.</p>
7549: <p>In the <code class="filename">PLIST</code>, include only the
7550: <code class="filename">.la</code> file, the other files will be
7551: added automatically.</p>
7552: </li>
1.23 wiz 7553: <li class="listitem">
1.1 dsieger 7554: <p>When linking shared object (<code class="filename">.so</code>)
1.120 sevan 7555: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 7556: shared libraries, use <span class="quote">“<span class="quote">-module
7557: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7558: tacked on.</p>
7559: <p>The <code class="filename">PLIST</code> file gets the
7560: <code class="filename">foo.so</code> entry.</p>
7561: </li>
1.23 wiz 7562: <li class="listitem">
1.1 dsieger 7563: <p>When linking programs that depend on these libraries
7564: <span class="emphasis"><em>before</em></span> they are installed, preface
1.120 sevan 7565: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-7.0.2"><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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 7566: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7567: libraries (static or shared), but please be aware that
7568: libtool will not allow you to specify a relative path in
1.23 wiz 7569: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7570: expects you to change that argument to be the
7571: <code class="filename">.la</code> file. e.g.</p>
7572: <pre class="programlisting">
7573: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 7574: </pre>
1.1 dsieger 7575: <p>should be changed to:</p>
7576: <pre class="programlisting">
7577: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 7578: </pre>
1.1 dsieger 7579: <p>and it will do the right thing with the libraries.</p>
7580: </li>
1.23 wiz 7581: <li class="listitem">
1.120 sevan 7582: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
7583: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 7584: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7585: <code class="filename">.la</code>. e.g.</p>
7586: <pre class="programlisting">
1.22 jakllsch 7587: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 7588: </pre>
1.1 dsieger 7589: <p>This will install the static <code class="filename">.a</code>,
7590: shared library, any needed symlinks, and run
1.120 sevan 7591: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 7592: </li>
1.23 wiz 7593: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7594: the <code class="filename">.la</code>
7595: file (this is a change from previous behaviour).</p></li>
7596: </ol></div>
7597: </div>
1.41 asau 7598: <div class="sect2">
1.1 dsieger 7599: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7600: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7601: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7602: package Makefile. This will override the package's own libtool
7603: in most cases. For older libtool using packages, libtool is
7604: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7605: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7606: configure; find work*/ -name libtool</strong></span>.</p>
7607: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7608: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7609: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7610: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7611: package's libtool script(s), set it as appropriate.</p>
7612: <p>If you do not need <code class="filename">*.a</code> static
7613: libraries built and installed, then use
7614: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7615: <p>If your package makes use of the platform-independent library
7616: for loading dynamic shared objects, that comes with libtool
7617: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7618: <p>Some packages use libtool incorrectly so that the package
7619: may not work or build in some circumstances. Some of the more
7620: common errors are:</p>
1.41 asau 7621: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7622: <li class="listitem">
1.1 dsieger 7623: <p>The inclusion of a shared object (-module) as a dependent library in an
7624: executable or library. This in itself isn't a problem if one of two things
7625: has been done:</p>
1.23 wiz 7626: <div class="orderedlist"><ol class="orderedlist" type="1">
7627: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7628: <code class="filename">libfoo.la</code>, not
7629: <code class="filename">foo.la</code></p></li>
1.23 wiz 7630: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7631: </ol></div>
7632: </li>
1.23 wiz 7633: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7634: The function lt_dlinit() should be called and the macro
7635: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7636: executables.</p></li>
7637: </ul></div>
7638: </div>
1.41 asau 7639: <div class="sect2">
1.1 dsieger 7640: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7641: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7642: <p>If a package needs GNU autoconf or automake to be executed
7643: to regenerate the configure script and Makefile.in makefile
7644: templates, then they should be executed in a pre-configure
7645: target.</p>
7646: <p>For packages that need only autoconf:</p>
7647: <pre class="programlisting">
7648: AUTOCONF_REQD= 2.50 # if default version is not good enough
7649: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7650: ...
7651:
7652: pre-configure:
7653: cd ${WRKSRC} && autoconf
7654:
7655: ...
1.111 sevan 7656: </pre>
1.1 dsieger 7657: <p>and for packages that need automake and autoconf:</p>
7658: <pre class="programlisting">
7659: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7660: USE_TOOLS+= automake # use "automake14" for automake-1.4
7661: ...
7662:
7663: pre-configure:
7664: set -e; cd ${WRKSRC}; \
7665: aclocal; autoheader; automake -a --foreign -i; autoconf
7666:
7667: ...
1.111 sevan 7668: </pre>
1.1 dsieger 7669: <p>Packages which use GNU Automake will almost certainly
7670: require GNU Make.</p>
7671: <p>There are times when the configure process makes
7672: additional changes to the generated files, which then causes
7673: the build process to try to re-execute the automake sequence.
7674: This is prevented by touching various files in the configure
7675: stage. If this causes problems with your package you can set
7676: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7677: Makefile.</p>
7678: </div>
7679: </div>
1.41 asau 7680: <div class="sect1">
1.1 dsieger 7681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7682: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 7683: <div class="sect2">
1.1 dsieger 7684: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7685: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7686: <p>Compilers for the C, C++, and Fortran languages comes with
7687: the NetBSD base system. By default, pkgsrc assumes that a package
7688: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 7689: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7690: <p>To declare which language's compiler a package needs, set
7691: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7692: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7693: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7694: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7695: written in C++, usually need a C compiler for the configure
7696: phase.</p>
7697: </div>
1.41 asau 7698: <div class="sect2">
1.1 dsieger 7699: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7700: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 7701: <p>If a program is written in Java, use the Java framework in
7702: pkgsrc. The package must include
7703: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7704: provides the following variables:</p>
1.41 asau 7705: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7706: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7707: dependency on the JDK is added. If
1.23 wiz 7708: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7709: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7710: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7711: JDK.</p></li>
1.23 wiz 7712: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7713: a package needs a Java2 implementation. The supported values
1.23 wiz 7714: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7715: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7716: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7717: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7718: above. This variable is not set by default.</p></li>
1.24 wiz 7719: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7720: automatically set to the runtime location of the used Java
7721: implementation dependency. It may be used to set
7722: <code class="varname">JAVA_HOME</code> to a good value if the program
7723: needs this variable to be defined.
7724: </p></li>
1.1 dsieger 7725: </ul></div>
7726: </div>
1.41 asau 7727: <div class="sect2">
1.1 dsieger 7728: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7729: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7730: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7731: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7732: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7733: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7734: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7735: that you want adjusted. Every occurrence of
7736: <code class="filename">*/bin/perl</code> in a she-bang line will be
7737: replaced with the full path to the perl executable.</p>
1.1 dsieger 7738: <p>If a particular version of perl is needed, set the
7739: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7740: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 7741: <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 7742: about handling perl modules.</p>
7743: </div>
1.41 asau 7744: <div class="sect2">
1.1 dsieger 7745: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 7746: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
7747: <p><code class="varname">REPLACE_SH</code>,
7748: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7749: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7750: hash bangs in files. Please use the appropriate one, prefering
7751: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7752: Each should contain a list of scripts, relative to
7753: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7754: occurrence of the matching shell in a she-bang line will be
7755: replaced with the full path to the shell executable.
1.40 wiz 7756: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7757: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7758: </div>
1.41 asau 7759: <div class="sect2">
1.40 wiz 7760: <div class="titlepage"><div><div><h3 class="title">
7761: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7762: <p>Currently, there is no special handling for other languages
7763: in pkgsrc. If a compiler package provides a
7764: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7765: just add a (build) dependency on the appropriate compiler
7766: package.</p>
7767: </div>
7768: </div>
1.41 asau 7769: <div class="sect1">
1.1 dsieger 7770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7771: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7772: <p>The most common failures when building a package are that
7773: some platforms do not provide certain header files, functions or
7774: libraries, or they provide the functions in a library that the
7775: original package author didn't know. To work around this, you
7776: can rewrite the source code in most cases so that it does not
7777: use the missing functions or provides a replacement function.</p>
1.41 asau 7778: <div class="sect2">
1.1 dsieger 7779: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7780: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7781: <p>If a package already comes with a GNU configure script, the
7782: preferred way to fix the build failure is to change the
7783: configure script, not the code. In the other cases, you can
7784: utilize the C preprocessor, which defines certain macros
7785: depending on the operating system and hardware architecture it
7786: compiles for. These macros can be queried using for example
7787: <code class="varname">#if defined(__i386)</code>. Almost every operating
7788: system, hardware architecture and compiler has its own macro.
7789: For example, if the macros <code class="varname">__GNUC__</code>,
7790: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7791: are all defined, you know that you are using NetBSD on an i386
7792: compatible CPU, and your compiler is GCC.</p>
7793: <p>The list of the following macros for hardware and
7794: operating system depends on the compiler that is used. For
7795: example, if you want to conditionally compile code on Solaris,
7796: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7797: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7798: <div class="sect3">
1.1 dsieger 7799: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7800: <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 7801: <p>To distinguish between 4.4 BSD-derived systems and the
7802: rest of the world, you should use the following code.</p>
7803: <pre class="programlisting">
7804: #include <sys/param.h>
7805: #if (defined(BSD) && BSD >= 199306)
7806: /* BSD-specific code goes here */
7807: #else
7808: /* non-BSD-specific code goes here */
7809: #endif
7810: </pre>
7811: <p>If this distinction is not fine enough, you can also test
7812: for the following macros.</p>
7813: <pre class="programlisting">
1.45 obache 7814: Cygwin __CYGWIN__
7815: DragonFly __DragonFly__
1.1 dsieger 7816: FreeBSD __FreeBSD__
1.45 obache 7817: Haiku __HAIKU__
1.1 dsieger 7818: Interix __INTERIX
7819: IRIX __sgi (TODO: get a definite source for this)
7820: Linux linux, __linux, __linux__
1.83 dholland 7821: Mac OS X __APPLE__
1.45 obache 7822: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7823: Minix3 __minix
1.1 dsieger 7824: NetBSD __NetBSD__
7825: OpenBSD __OpenBSD__
7826: Solaris sun, __sun
7827: </pre>
7828: </div>
1.41 asau 7829: <div class="sect3">
1.1 dsieger 7830: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7831: <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 7832: <pre class="programlisting">
7833: i386 i386, __i386, __i386__
7834: MIPS __mips
7835: SPARC sparc, __sparc
7836: </pre>
7837: </div>
1.41 asau 7838: <div class="sect3">
1.1 dsieger 7839: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7840: <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 7841: <pre class="programlisting">
7842: GCC __GNUC__ (major version), __GNUC_MINOR__
7843: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7844: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7845: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7846: </pre>
7847: </div>
7848: </div>
1.41 asau 7849: <div class="sect2">
1.1 dsieger 7850: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7851: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 7852: <p>Some source files trigger bugs in the compiler, based on
7853: combinations of compiler version and architecture and almost
7854: always relation to optimisation being enabled. Common symptoms
7855: are gcc internal errors or never finishing compiling a
7856: file.</p>
7857: <p>Typically, a workaround involves testing the
7858: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7859: optimisation for that combination of file,
1.87 tnn 7860: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7861: <p>This used to be a big problem in the past, but is rarely
7862: needed now as compiler technology has matured. If you still need
7863: to add a compiler specific workaround, please do so in the file
7864: <code class="filename">hacks.mk</code> and describe the symptom and
7865: compiler version as detailed as possible.</p>
1.1 dsieger 7866: </div>
1.41 asau 7867: <div class="sect2">
1.1 dsieger 7868: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 7869: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
7870: </h3></div></div></div>
1.1 dsieger 7871: <p>This error message often means that a package did not
7872: link to a shared library it needs. The following functions are
7873: known to cause this error message over and over.</p>
7874: <div class="informaltable">
1.106 tnn 7875: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 7876: <colgroup>
7877: <col>
7878: <col>
7879: <col>
7880: </colgroup>
7881: <thead><tr>
7882: <th>Function</th>
7883: <th>Library</th>
7884: <th>Affected platforms</th>
7885: </tr></thead>
7886: <tbody>
7887: <tr>
7888: <td>accept, bind, connect</td>
7889: <td>-lsocket</td>
7890: <td>Solaris</td>
7891: </tr>
7892: <tr>
7893: <td>crypt</td>
7894: <td>-lcrypt</td>
7895: <td>DragonFly, NetBSD</td>
7896: </tr>
7897: <tr>
7898: <td>dlopen, dlsym</td>
7899: <td>-ldl</td>
7900: <td>Linux</td>
7901: </tr>
7902: <tr>
7903: <td>gethost*</td>
7904: <td>-lnsl</td>
7905: <td>Solaris</td>
7906: </tr>
7907: <tr>
7908: <td>inet_aton</td>
7909: <td>-lresolv</td>
7910: <td>Solaris</td>
7911: </tr>
7912: <tr>
7913: <td>nanosleep, sem_*, timer_*</td>
7914: <td>-lrt</td>
7915: <td>Solaris</td>
7916: </tr>
7917: <tr>
7918: <td>openpty</td>
7919: <td>-lutil</td>
7920: <td>Linux</td>
7921: </tr>
7922: </tbody>
7923: </table>
7924: </div>
7925: <p>To fix these linker errors, it is often sufficient to say
7926: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
7927: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 7928: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 7929: bmake</strong></span>.</p>
1.41 asau 7930: <div class="sect3">
1.1 dsieger 7931: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7932: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 7933: <p>When you are using the SunPro compiler, there is another
7934: possibility. That compiler cannot handle the following code:</p>
7935: <pre class="programlisting">
7936: extern int extern_func(int);
7937:
7938: static inline int
7939: inline_func(int x)
7940: {
7941: return extern_func(x);
7942: }
7943:
7944: int main(void)
7945: {
7946: return 0;
7947: }
7948: </pre>
7949: <p>It generates the code for <code class="function">inline_func</code> even if
7950: that function is never used. This code then refers to
7951: <code class="function">extern_func</code>, which can usually not be resolved. To
7952: solve this problem you can try to tell the package to disable inlining
7953: of functions.</p>
7954: </div>
7955: </div>
1.41 asau 7956: <div class="sect2">
1.1 dsieger 7957: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7958: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 7959: <p>Sometimes packages fail to build because the compiler runs
7960: into an operating system specific soft limit. With the
7961: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 7962: to unlimit the resources. Currently, the allowed values are any combination of
7963: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
7964: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 7965: Setting this variable is similar to running the shell builtin
1.10 hubertf 7966: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 7967: segment size or maximum stack size of a process, respectively, to
7968: their hard limits.</p>
7969: </div>
7970: </div>
1.41 asau 7971: <div class="sect1">
1.1 dsieger 7972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7973: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 7974: <div class="sect2">
1.1 dsieger 7975: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7976: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 7977: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 7978: with some operating systems cannot create more than one
7979: directory at a time. As such, you should call
7980: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
7981: <pre class="programlisting">
7982: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7983: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 7984: </pre>
1.23 wiz 7985: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
7986: dir2</code></span>”</span> to the
1.1 dsieger 7987: <code class="varname">INSTALLATION_DIRS</code> variable, which will
7988: automatically do the right thing.</p>
7989: </div>
1.41 asau 7990: <div class="sect2">
1.1 dsieger 7991: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7992: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 7993: <p>In general, documentation should be installed into
7994: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7995: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
7996: includes the version number of the package).</p>
7997: <p>Many modern packages using GNU autoconf allow to set the
7998: directory where HTML documentation is installed with the
1.23 wiz 7999: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8000: is needed because otherwise the documentation ends up in
8001: <code class="filename">${PREFIX}/share/doc/html</code> or other
8002: places.</p>
8003: <p>An exception to the above is that library API documentation
1.120 sevan 8004: generated with the <a href="http://cdn.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 8005: browsers (devhelp) should be left at their default location, which
8006: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8007: documentation can be recognized from files ending in
8008: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8009: (It is also acceptable to install such files in
8010: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8011: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8012: <code class="filename">.devhelp*</code> file must be directly in that
8013: directory then, no additional subdirectory level is allowed in
8014: this case. This is usually achieved by using
1.23 wiz 8015: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8016: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8017: though.)</p>
8018: </div>
1.41 asau 8019: <div class="sect2">
1.1 dsieger 8020: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8021: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8022: <p>Certain packages, most of them in the games category, install
8023: a score file that allows all users on the system to record their
8024: highscores. In order for this to work, the binaries need to be
8025: installed setgid and the score files owned by the appropriate
1.35 wiz 8026: group and/or owner (traditionally the "games" user/group). Set
8027: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8028: following variables, documented in more detail in
8029: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8030: behaviour: <code class="varname">GAMEDATAMODE</code>,
8031: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8032: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8033: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8034: <code class="varname">GAMEDATA_PERMS</code> and
8035: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8036: <p>An example that illustrates some of the variables described above is
8037: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8038: used to properly set directory permissions of the directory where the
8039: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8040: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8041: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8042: binary:</p>
8043: <pre class="programlisting">
1.112 rillig 8044: USE_GAMESGROUP= yes
1.100 leot 8045:
1.112 rillig 8046: BUILD_DEFS+= VARBASE
1.100 leot 8047:
1.112 rillig 8048: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8049: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8050: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8051: </pre>
1.100 leot 8052: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8053: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8054: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8055: needed to be accessed by setgid games and
8056: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8057: <p>A package should therefore never hard code file ownership or
1.100 leot 8058: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8059: or alternatively on <code class="varname">INSTALL_GAME</code>,
8060: <code class="varname">INSTALL_GAME_DATA</code> and
8061: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8062: </div>
1.41 asau 8063: <div class="sect2">
1.1 dsieger 8064: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8065: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8066: <p><code class="varname">DESTDIR</code> support means that a package
8067: installs into a staging directory, not the final location of the
8068: files. Then a binary package is created which can be used for
8069: installation as usual. There are two ways: Either the package must
1.23 wiz 8070: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8071: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8072: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8073: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8074: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8075: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8076: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8077: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8078: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8079: the inclusion.</p></li>
1.23 wiz 8080: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8081: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8082: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8083: automatically. Many manual rules and pre/post-install often are
8084: incorrect; fix them.</p></li>
1.23 wiz 8085: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8086: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8087: <li class="listitem"><p>In general, packages should support
1.4 rillig 8088: <code class="varname">UNPRIVILEGED</code> to be able to use
8089: DESTDIR.</p></li>
8090: </ul></div>
8091: </div>
1.41 asau 8092: <div class="sect2">
1.4 rillig 8093: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8094: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8095: <p>Your package may also contain scripts with hardcoded paths to
8096: other interpreters besides (or as well as) perl. To correct the
8097: full pathname to the script interpreter, you need to set the
8098: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8099: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8100: <pre class="programlisting">
8101: REPLACE_INTERPRETER+= tcl
8102: REPLACE.tcl.old= .*/bin/tclsh
8103: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8104: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8105: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8106: </pre>
1.41 asau 8107: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8108: <h3 class="title">Note</h3>
8109: <p>Before March 2006, these variables were called
8110: <code class="varname">_REPLACE.*</code> and
8111: <code class="varname">_REPLACE_FILES.*</code>.</p>
8112: </div>
8113: </div>
1.41 asau 8114: <div class="sect2">
1.1 dsieger 8115: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8116: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8117: <p>Makefiles of packages providing perl5 modules should include
8118: the Makefile fragment
8119: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8120: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8121: configuration for such modules as well as various hooks to tune
8122: this configuration. See comments in this file for
8123: details.</p>
8124: <p>Perl5 modules will install into different places depending
8125: on the version of perl used during the build process. To
8126: address this, pkgsrc will append lines to the
8127: <code class="filename">PLIST</code> corresponding to the files listed in
8128: the installed <code class="filename">.packlist</code> file generated by
8129: most perl5 modules. This is invoked by defining
8130: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8131: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8132: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8133: e.g.:</p>
1.1 dsieger 8134: <pre class="programlisting">
1.47 wiz 8135: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8136: </pre>
1.47 wiz 8137: <p>The perl5 config variables
8138: <code class="varname">installarchlib</code>,
8139: <code class="varname">installscript</code>,
8140: <code class="varname">installvendorbin</code>,
8141: <code class="varname">installvendorscript</code>,
8142: <code class="varname">installvendorarch</code>,
8143: <code class="varname">installvendorlib</code>,
8144: <code class="varname">installvendorman1dir</code>, and
8145: <code class="varname">installvendorman3dir</code> represent those
8146: locations in which components of perl5 modules may be installed,
8147: provided as variable with uppercase and prefixed with
8148: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8149: and may be used by perl5 packages that don't have a packlist.
8150: These variables are also substituted for in the
8151: <code class="filename">PLIST</code> as uppercase prefixed with
8152: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8153: </div>
1.41 asau 8154: <div class="sect2">
1.1 dsieger 8155: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8156: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8157: <p>Some packages install info files or use the
1.23 wiz 8158: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8159: commands. <code class="varname">INFO_FILES</code> should be defined in
8160: the package Makefile so that <code class="filename">INSTALL</code> and
8161: <code class="filename">DEINSTALL</code> scripts will be generated to
8162: handle registration of the info files in the Info directory
1.23 wiz 8163: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8164: files registration is either provided by the system, or by a
8165: special purpose package automatically added as dependency if
8166: needed.</p>
8167: <p><code class="varname">PKGINFODIR</code> is the directory under
8168: <code class="filename">${PREFIX}</code> where info files are primarily
8169: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8170: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8171: <p>The info files for the package should be listed in the
8172: package <code class="filename">PLIST</code>; however any split info files
8173: need not be listed.</p>
1.23 wiz 8174: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8175: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8176: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8177: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8178: should be noted with the <code class="varname">TEXINFO_REQD</code>
8179: variable in the package <code class="filename">Makefile</code>. By
8180: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8181: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8182: does not match the required minimum, a build dependency on the
1.120 sevan 8183: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1 dsieger 8184: be added automatically.</p>
8185: <p>The build and installation process of the software provided
8186: by the package should not use the
1.10 hubertf 8187: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8188: info files is the task of the package
8189: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8190: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8191: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8192: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8193: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8194: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8195: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8196: no effect except the logging of a message. The script overriding
1.10 hubertf 8197: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8198: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8199: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8200: </div>
1.41 asau 8201: <div class="sect2">
1.1 dsieger 8202: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8203: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8204: <p>All packages that install manual pages should install them
8205: into the same directory, so that there is one common place to look
8206: for them. In pkgsrc, this place is
8207: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8208: should be used in packages. The default for
8209: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8210: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8211: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8212: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8213: <h3 class="title">Note</h3>
8214: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8215: is far from complete.</p>
8216: </div>
8217: <p>The <code class="filename">PLIST</code> files can just use
8218: <code class="filename">man/</code> as the top level directory for the man
8219: page file entries, and the pkgsrc framework will convert as
8220: needed. In all other places, the correct
8221: <code class="varname">PKGMANDIR</code> must be used.</p>
8222: <p>Packages that are
8223: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8224: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8225: <code class="filename">./configure</code>
8226: --mandir switch to set where the man pages should be installed.
8227: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8228: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8229: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8230: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8231: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8232: Or if the <code class="filename">./configure</code> script uses
8233: a non-standard use of --mandir, you can set
8234: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8235: <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 8236: information on installation of compressed manual pages.</p>
8237: </div>
1.41 asau 8238: <div class="sect2">
1.1 dsieger 8239: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8240: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8241: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8242: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8243: you need to take some extra steps to make sure they get registered
8244: in the database:</p>
1.23 wiz 8245: <div class="orderedlist"><ol class="orderedlist" type="1">
8246: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8247: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8248: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8249: deinstallation time, and tells the package where to install
1.7 rillig 8250: GConf data files using some standard configure arguments. It
1.1 dsieger 8251: also disallows any access to the database directly from the
8252: package.</p></li>
1.23 wiz 8253: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8254: <code class="filename">.schemas</code> files under
8255: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8256: installed under <code class="filename">${PREFIX}/etc</code>, you will
8257: need to manually patch the package.</p></li>
1.23 wiz 8258: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8259: directory, as they will be handled automatically. See
1.84 wiz 8260: <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 8261: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8262: your <code class="filename">Makefile</code> with a list of all
8263: <code class="filename">.schemas</code> files installed by the package, if
8264: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8265: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8266: your <code class="filename">Makefile</code> with a
8267: list of all <code class="filename">.entries</code> files installed by the
8268: package, if any. Names must not contain any directories in
8269: them.</p></li>
8270: </ol></div>
8271: </div>
1.41 asau 8272: <div class="sect2">
1.1 dsieger 8273: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8274: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8275: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8276: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8277: get registered in the database:</p>
1.23 wiz 8278: <div class="orderedlist"><ol class="orderedlist" type="1">
8279: <li class="listitem"><p>Include
1.18 snj 8280: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8281: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8282: takes care of rebuilding the scrollkeeper database at
8283: installation and deinstallation time, and disallows any access
8284: to it directly from the package.</p></li>
1.23 wiz 8285: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8286: <code class="filename">libdata/scrollkeeper</code> directory, as they
8287: will be handled automatically.</p></li>
1.23 wiz 8288: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8289: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8290: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8291: </ol></div>
8292: </div>
1.41 asau 8293: <div class="sect2">
1.1 dsieger 8294: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8295: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8296: <p>If a package installs font files, you will need to rebuild
8297: the fonts database in the directory where they get installed at
8298: installation and deinstallation time. This can be automatically
8299: done by using the pkginstall framework.</p>
8300: <p>You can list the directories where fonts are installed in the
8301: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8302: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8303: <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 8304: Also make sure that the database file
8305: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8306: <p>Note that you should not create new directories for fonts;
8307: instead use the standard ones to avoid that the user needs to
8308: manually configure his X server to find them.</p>
8309: </div>
1.41 asau 8310: <div class="sect2">
1.1 dsieger 8311: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8312: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8313: <p>If a package installs GTK2 immodules or loaders, you need to
8314: take some extra steps to get them registered in the GTK2 database
8315: properly:</p>
1.23 wiz 8316: <div class="orderedlist"><ol class="orderedlist" type="1">
8317: <li class="listitem"><p>Include
1.1 dsieger 8318: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8319: <code class="filename">buildlink3.mk</code> file. This takes care of
8320: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8321: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8322: your package installs GTK2 immodules.</p></li>
1.23 wiz 8323: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8324: GTK2 loaders.</p></li>
1.23 wiz 8325: <li class="listitem">
1.1 dsieger 8326: <p>Patch the package to not touch any of the GTK2
8327: databases directly. These are:</p>
1.41 asau 8328: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8329: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8330: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8331: </ul></div>
8332: </li>
1.23 wiz 8333: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8334: any entries under the <code class="filename">libdata/gtk-2.0</code>
8335: directory, as they will be handled automatically.</p></li>
8336: </ol></div>
8337: </div>
1.41 asau 8338: <div class="sect2">
1.1 dsieger 8339: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8340: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8341: <p>If a package installs SGML or XML data files that need to be
8342: registered in system-wide catalogs (like DTDs, sub-catalogs,
8343: etc.), you need to take some extra steps:</p>
1.23 wiz 8344: <div class="orderedlist"><ol class="orderedlist" type="1">
8345: <li class="listitem"><p>Include
1.1 dsieger 8346: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8347: your <code class="filename">Makefile</code>, which takes care of
8348: registering those files in system-wide catalogs at
8349: installation and deinstallation time.</p></li>
1.23 wiz 8350: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8351: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8352: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8353: any XML catalogs installed by the package.</p></li>
1.23 wiz 8354: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8355: to be added to the SGML catalog. These come in groups of
8356: three strings; see xmlcatmgr(1) for more information
8357: (specifically, arguments recognized by the 'add' action).
8358: Note that you will normally not use this variable.</p></li>
1.23 wiz 8359: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8360: to be added to the XML catalog. These come in groups of three
8361: strings; see xmlcatmgr(1) for more information (specifically,
8362: arguments recognized by the 'add' action). Note that you will
8363: normally not use this variable.</p></li>
8364: </ol></div>
8365: </div>
1.41 asau 8366: <div class="sect2">
1.1 dsieger 8367: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8368: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8369: <p>If a package provides extensions to the MIME database by
8370: installing <code class="filename">.xml</code> files inside
8371: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8372: need to take some extra steps to ensure that the database is kept
8373: consistent with respect to these new files:</p>
1.23 wiz 8374: <div class="orderedlist"><ol class="orderedlist" type="1">
8375: <li class="listitem"><p>Include
1.1 dsieger 8376: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8377: (avoid using the <code class="filename">buildlink3.mk</code> file from
8378: this same directory, which is reserved for inclusion from
8379: other <code class="filename">buildlink3.mk</code> files). It takes
8380: care of rebuilding the MIME database at installation and
8381: deinstallation time, and disallows any access to it directly
8382: from the package.</p></li>
1.23 wiz 8383: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8384: <code class="filename">share/mime</code> directory,
8385: <span class="emphasis"><em>except</em></span> for files saved under
8386: <code class="filename">share/mime/packages</code>. The former are
8387: handled automatically by
8388: the update-mime-database program, but the latter are
8389: package-dependent and must be removed by the package that
8390: installed them in the first place.</p></li>
1.23 wiz 8391: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8392: from the PLIST. They will be handled by the shared-mime-info
8393: package.</p></li>
8394: </ol></div>
8395: </div>
1.41 asau 8396: <div class="sect2">
1.1 dsieger 8397: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8398: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8399: <p>If a package uses intltool during its build, add
8400: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8401: which forces it to use the intltool package provided by pkgsrc,
8402: instead of the one bundled with the distribution file.</p>
8403: <p>This tracks intltool's build-time dependencies and uses the
8404: latest available version; this way, the package benefits of any
8405: bug fixes that may have appeared since it was released.</p>
8406: </div>
1.41 asau 8407: <div class="sect2">
1.1 dsieger 8408: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8409: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8410: <p>If a package contains a rc.d script, it won't be copied into
8411: the startup directory by default, but you can enable it, by adding
8412: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8413: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8414: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8415: it will automatically remove the scripts when the package is
8416: deinstalled.</p>
8417: </div>
1.41 asau 8418: <div class="sect2">
1.1 dsieger 8419: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8420: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8421: <p>If a package installs TeX packages into the texmf tree,
8422: the <code class="filename">ls-R</code> database of the tree needs to be
8423: updated.</p>
1.41 asau 8424: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8425: <h3 class="title">Note</h3>
1.22 jakllsch 8426: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8427: packages should install files
1.22 jakllsch 8428: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8429: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8430: </div>
1.23 wiz 8431: <div class="orderedlist"><ol class="orderedlist" type="1">
8432: <li class="listitem"><p>Include
1.22 jakllsch 8433: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8434: takes care of rebuilding the <code class="filename">ls-R</code>
8435: database at installation and deinstallation time.</p></li>
1.23 wiz 8436: <li class="listitem">
1.1 dsieger 8437: <p>If your package installs files into a texmf
8438: tree other than the one
1.22 jakllsch 8439: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8440: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8441: trees that need database update.</p>
8442: <p>If your package also installs font map files that need
1.10 hubertf 8443: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8444: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8445: set <code class="varname">TEX_MAP_FILES</code> and/or
8446: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8447: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8448: be run automatically at installation/deinstallation to
8449: enable/disable font map files for TeX output
8450: drivers.</p>
8451: </li>
1.23 wiz 8452: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8453: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8454: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8455: </ol></div>
8456: </div>
1.41 asau 8457: <div class="sect2">
1.1 dsieger 8458: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8459: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 8460: emulation</h3></div></div></div>
8461: <p>There are some packages that provide libraries and
8462: executables for running binaries from a one operating system
8463: on a different one (if the latter supports it). One example
8464: is running Linux binaries on NetBSD.</p>
1.120 sevan 8465: <p>The <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1 dsieger 8466: helps in extracting and packaging Linux rpm packages.</p>
8467: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8468: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8469: if all libraries for each installed executable can be found by
8470: the dynamic linker. Since the standard dynamic linker is run,
8471: this fails for emulation packages, because the libraries used
8472: by the emulation are not in the standard directories.</p>
8473: </div>
1.41 asau 8474: <div class="sect2">
1.1 dsieger 8475: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8476: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8477: <p>If a package installs images under the
8478: <code class="filename">share/icons/hicolor</code> and/or updates the
8479: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8480: database, you need to take some extra steps to make sure that the
8481: shared theme directory is handled appropriately and that the cache
8482: database is rebuilt:</p>
1.23 wiz 8483: <div class="orderedlist"><ol class="orderedlist" type="1">
8484: <li class="listitem"><p>Include
1.1 dsieger 8485: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8486: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8487: entry that refers to the theme cache.</p></li>
1.23 wiz 8488: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8489: directories from the <code class="filename">share/icons/hicolor</code>
8490: hierarchy because they will be handled automatically.</p></li>
8491: </ol></div>
8492: <p>The best way to verify that the PLIST is correct with
8493: respect to the last two points is to regenerate it using
1.10 hubertf 8494: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8495: </div>
1.41 asau 8496: <div class="sect2">
1.1 dsieger 8497: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8498: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8499: <p>If a package installs <code class="filename">.desktop</code> files
8500: under <code class="filename">share/applications</code> and these include
1.53 rodent 8501: MIME information (MimeType key), you need to take extra steps to
8502: ensure that they are registered into the MIME database:</p>
1.23 wiz 8503: <div class="orderedlist"><ol class="orderedlist" type="1">
8504: <li class="listitem"><p>Include
1.1 dsieger 8505: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8506: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8507: <code class="filename">share/applications/mimeinfo.cache</code> file.
8508: It will be handled automatically.</p></li>
8509: </ol></div>
8510: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8511: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8512: print-PLIST</strong></span>.</p>
8513: </div>
8514: </div>
1.41 asau 8515: <div class="sect1">
1.1 dsieger 8516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8517: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8518: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8519: immediately. In this case, one can plainly mark a package as broken. For
8520: this, one just sets the variable <code class="varname">BROKEN</code> to the
8521: reason why the package is broken (similar to the
8522: <code class="varname">RESTRICTED</code> variable). A user trying to build
8523: the package will immediately be shown this message, and the build
8524: will not be even tried.</p>
8525: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8526: intervals.</p>
8527: </div>
8528: </div>
1.41 asau 8529: <div class="chapter">
1.1 dsieger 8530: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8531: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 8532: <p>To check out all the gotchas when building a package, here are
8533: the steps that I do in order to get a package working. Please note
8534: this is basically the same as what was explained in the previous
8535: sections, only with some debugging aids.</p>
1.41 asau 8536: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8537: <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>
8538: <li class="listitem">
1.120 sevan 8539: <p>Install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.1 dsieger 8540: create a directory for a new package, change into it, then run
1.10 hubertf 8541: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8542: <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>
8543: <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>
8544: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8545: </li>
1.23 wiz 8546: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8547: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8548: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8549: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8550: configure step to the package's
8551: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8552: <li class="listitem">
1.1 dsieger 8553: <p>Make the package compile, doing multiple rounds of</p>
8554: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8555: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8556: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8557: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8558: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8559: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8560: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8561: <p>Doing this step as non-root user will ensure that no files
8562: are modified that shouldn't be, especially during the build
1.10 hubertf 8563: phase. <span class="command"><strong>mkpatches</strong></span>,
8564: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.120 sevan 8565: from the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.1 dsieger 8566: package.</p>
8567: </li>
1.23 wiz 8568: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
8569: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
8570: <li class="listitem">
1.1 dsieger 8571: <p>Generate a <code class="filename">PLIST</code>:</p>
8572: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8573: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8574: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8575: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8576: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8577: <p>You usually need to be <code class="username">root</code> to do
8578: this. Look if there are any files left:</p>
8579: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8580: <p>If this reveals any files that are missing in
8581: <code class="filename">PLIST</code>, add them.</p>
8582: </li>
1.23 wiz 8583: <li class="listitem">
1.1 dsieger 8584: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8585: package again and make a binary package:</p>
8586: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8587: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8588: </li>
1.23 wiz 8589: <li class="listitem">
1.1 dsieger 8590: <p>Delete the installed package:</p>
8591: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8592: </li>
1.23 wiz 8593: <li class="listitem">
1.10 hubertf 8594: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8595: command, which shouldn't find anything now:</p>
8596: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8597: </li>
1.23 wiz 8598: <li class="listitem">
1.1 dsieger 8599: <p>Reinstall the binary package:</p>
8600: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8601: </li>
1.23 wiz 8602: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8603: <li class="listitem">
1.120 sevan 8604: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="http://cdn.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 8605: reports:</p>
8606: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8607: </li>
1.23 wiz 8608: <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 8609: </ul></div>
8610: </div>
1.41 asau 8611: <div class="chapter">
1.1 dsieger 8612: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8613: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8614: <div class="toc">
8615: <p><b>Table of Contents</b></p>
1.100 leot 8616: <dl class="toc">
1.6 rillig 8617: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
8618: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8619: <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 8620: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 8621: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 8622: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
8623: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8624: </dl>
8625: </div>
1.41 asau 8626: <div class="sect1">
1.1 dsieger 8627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8628: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8629: <p>Our policy is that we accept binaries only from pkgsrc
8630: developers to guarantee that the packages don't contain any
8631: trojan horses etc. This is not to annoy anyone but rather to
8632: protect our users! You're still free to put up your home-made
8633: binary packages and tell the world where to get them. NetBSD
8634: developers doing bulk builds and wanting to upload them please
1.66 asau 8635: 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
8636: builds)</i></a>.</p>
1.1 dsieger 8637: </div>
1.41 asau 8638: <div class="sect1">
1.1 dsieger 8639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8640: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8641: <p>First, check that your package is complete, compiles and
1.10 hubertf 8642: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.120 sevan 8643: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 8644: archive that contains all files that make up the package.
8645: Finally, send this package to the pkgsrc bug tracking system,
1.120 sevan 8646: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 8647: that, go to the web page
1.10 hubertf 8648: <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 8649: which contains some instructions and a link to a form where you
8650: can submit packages. The
1.120 sevan 8651: <a href="http://cdn.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 8652: also available as a substitute for either of the above two tools.
8653: </p>
1.1 dsieger 8654: <p>In the form of the problem report, the category should be
1.23 wiz 8655: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8656: and version number, and the description field should contain a
8657: short description of your package (contents of the COMMENT
8658: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8659: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8660: <p>If you want to submit several packages, please send a
8661: separate PR for each one, it's easier for us to track things
8662: that way.</p>
8663: <p>Alternatively, you can also import new packages into
1.23 wiz 8664: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8665: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8666: for details.</p>
8667: </div>
1.41 asau 8668: <div class="sect1">
1.1 dsieger 8669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8670: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8671: <p>Please note all package additions, updates, moves, and
8672: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8673: important to keep this file up to date and conforming to the
8674: existing format, because it will be used by scripts to
1.10 hubertf 8675: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8676: sites. Additionally, check the
8677: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
8678: for the package you updated or removed, in case it was mentioned
8679: there.</p>
8680: <p>When the <code class="varname">PKGREVISION</code> of a package is
8681: bumped, the change should appear in
8682: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
8683: related or otherwise relevant. Mass bumps that result from a
8684: dependency being updated should not be mentioned. In all other
8685: cases it's the developer's decision.</p>
8686: <p>There is a make target that helps in creating proper
1.10 hubertf 8687: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 8688: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8689: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
8690: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
8691: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 8692: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8693: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 8694: For new packages, or package moves or removals, set the
8695: <code class="varname">CTYPE</code> variable on the command line to "Added",
8696: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 8697: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 8698: not the same as your NetBSD login name. The target also automatically
8699: removes possibly existing entries for the package in the
8700: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 8701: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 8702: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
8703: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8704: makes the cvs commands use the main repository.
8705: </p>
1.1 dsieger 8706: </div>
1.41 asau 8707: <div class="sect1">
1.1 dsieger 8708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 8709: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 8710: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 8711: access to the pkgsrc repository.</p>
8712: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8713: Start by adding the directory and then files in the directory. Don't
8714: forget to add the new package to the category's
8715: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8716: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8717: <pre class="programlisting">
8718: <code class="prompt">$</code> cd .../pkgsrc/category
8719: <code class="prompt">$</code> cvs add pkgname
8720: <code class="prompt">$</code> cd pkgname
8721: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8722: <code class="prompt">$</code> cvs add patches/p*
8723: <code class="prompt">$</code> cvs status | less
1.34 wiz 8724: <code class="prompt">$</code> cvs commit
1.33 wiz 8725: <code class="prompt">$</code> cd ..
8726: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 8727: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 8728: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 8729: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 8730: </pre>
1.1 dsieger 8731: <p>The commit message of the initial import should include part of the
8732: <code class="filename">DESCR</code> file, so people reading the mailing lists know
8733: what the package is/does.</p>
1.33 wiz 8734: <p>Also mention the new package in
8735: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8736: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8737: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 8738: </div>
1.41 asau 8739: <div class="sect1">
1.1 dsieger 8740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8741: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 8742: <p>Please always put a concise, appropriate and relevant summary of the
8743: changes between old and new versions into the commit log when updating
8744: a package. There are various reasons for this:</p>
1.41 asau 8745: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8746: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 8747: or its information may be overwritten by newer information.</p></li>
1.23 wiz 8748: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8749: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 8750: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8751: repository is very useful for people who read the pkgsrc-changes mailing
8752: list, so that they can make tactical decisions about when to upgrade
8753: the package.</p></li>
8754: </ul></div>
8755: <p>Please also recognize that, just because a new version of a package
8756: has been released, it should not automatically be upgraded in the CVS
8757: repository. We prefer to be conservative in the packages that are
8758: included in pkgsrc - development or beta packages are not really the
8759: best thing for most places in which pkgsrc is used. Please use your
8760: judgement about what should go into pkgsrc, and bear in mind that
8761: stability is to be preferred above new and possibly untested features.</p>
8762: </div>
1.41 asau 8763: <div class="sect1">
1.1 dsieger 8764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 8765: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
8766: <p>Renaming packages is not recommended.</p>
8767: <p>When renaming packages, be sure to fix any references to old name
8768: in other Makefiles, options, buildlink files, etc.</p>
8769: <p>Also When renaming a package, please define
8770: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8771: pattern(s) of the previous package name.
8772: This may be repeated for multiple renames.
8773: The new package would be an exact replacement.
8774: </p>
1.23 wiz 8775: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 8776: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8777: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8778: not be an exact replacement but is a suggestion for the replaced
8779: functionality.</p>
8780: </div>
1.41 asau 8781: <div class="sect1">
1.20 snj 8782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8783: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
8784: <p>It is preferred that packages are not renamed or moved, but if needed
8785: please follow these steps.
8786: </p>
1.23 wiz 8787: <div class="orderedlist"><ol class="orderedlist" type="1">
8788: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8789: <li class="listitem">
1.1 dsieger 8790: <p>Remove all CVS dirs.</p>
8791: <p>Alternatively to the first two steps you can also do:</p>
8792: <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>
8793: <p>and use that for further work.</p>
8794: </li>
1.23 wiz 8795: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8796: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8797: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8798: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 8799: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8800: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8801: for doing an update using pkgsrc building; for example, it can
1.120 sevan 8802: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 8803: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8804: new <code class="varname">PKGPATH</code> for that moved package. Note that
8805: it may have multiple matches, so the tool should also check on the
8806: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8807: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8808: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 8809: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 8810: place.</p></li>
1.23 wiz 8811: <li class="listitem">
1.1 dsieger 8812: <p>Check if any package depends on it:
8813: </p>
8814: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8815: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8816: </li>
1.23 wiz 8817: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8818: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8819: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8820: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8821: <li class="listitem">
1.1 dsieger 8822: <p>Commit the changed and removed files:</p>
8823: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
8824: <p>(and any packages from step 5, of course).</p>
8825: </li>
8826: </ol></div>
8827: </div>
8828: </div>
1.41 asau 8829: <div class="chapter">
1.1 dsieger 8830: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8831: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 8832: <p>This section contains the answers to questions that may
8833: arise when you are writing a package. If you don't find your
8834: question answered here, first have a look in the other chapters,
8835: and if you still don't have the answer, ask on the
8836: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 8837: <div class="qandaset">
1.122 ! leot 8838: <a name="idm80577712"></a><dl>
1.6 rillig 8839: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 8840: MAKEFLAGS, .MAKEFLAGS and
8841: MAKE_FLAGS?</a>
8842: </dt>
1.6 rillig 8843: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 8844: MAKE, GMAKE and
8845: MAKE_PROGRAM?</a>
8846: </dt>
1.6 rillig 8847: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 8848: CC, PKG_CC and
8849: PKGSRC_COMPILER?</a>
8850: </dt>
1.6 rillig 8851: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 8852: BUILDLINK_LDFLAGS,
8853: BUILDLINK_LDADD and
8854: BUILDLINK_LIBS?</a>
8855: </dt>
1.6 rillig 8856: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 8857: VARNAME=BUILDLINK_PREFIX.foo
8858: say it's empty?</a>
8859: </dt>
1.6 rillig 8860: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 8861: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
8862: don't understand the := inside
8863: it.</a>
8864: </dt>
1.6 rillig 8865: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 8866: developers?</a>
8867: </dt>
1.6 rillig 8868: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 8869: documentation?</a>
8870: </dt>
1.6 rillig 8871: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 8872: do?</a>
8873: </dt>
8874: </dl>
1.41 asau 8875: <table border="0" style="width: 100%;">
8876: <colgroup>
1.1 dsieger 8877: <col align="left" width="1%">
1.23 wiz 8878: <col>
1.41 asau 8879: </colgroup>
1.1 dsieger 8880: <tbody>
1.41 asau 8881: <tr class="question">
1.1 dsieger 8882: <td align="left" valign="top">
1.122 ! leot 8883: <a name="devfaq.makeflags"></a><a name="idm80577328"></a><p><b>22.1.</b></p>
1.1 dsieger 8884: </td>
8885: <td align="left" valign="top"><p>What is the difference between
8886: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
8887: <code class="varname">MAKE_FLAGS</code>?</p></td>
8888: </tr>
8889: <tr class="answer">
8890: <td align="left" valign="top"></td>
8891: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.120 sevan 8892: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 8893: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
8894: the <code class="varname">MAKE_PROGRAM</code> when building the
8895: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
8896: </tr>
1.41 asau 8897: <tr class="question">
1.1 dsieger 8898: <td align="left" valign="top">
1.122 ! leot 8899: <a name="devfaq.make"></a><a name="idm80573232"></a><p><b>22.2.</b></p>
1.1 dsieger 8900: </td>
8901: <td align="left" valign="top"><p>What is the difference between
8902: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
8903: <code class="varname">MAKE_PROGRAM</code>?</p></td>
8904: </tr>
8905: <tr class="answer">
8906: <td align="left" valign="top"></td>
8907: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.120 sevan 8908: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 8909: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
8910: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
8911: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
8912: Make program that is used for building the
8913: package.</p></td>
8914: </tr>
1.41 asau 8915: <tr class="question">
1.1 dsieger 8916: <td align="left" valign="top">
1.122 ! leot 8917: <a name="devfaq.cc"></a><a name="idm80568880"></a><p><b>22.3.</b></p>
1.1 dsieger 8918: </td>
8919: <td align="left" valign="top"><p>What is the difference between
8920: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
8921: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
8922: </tr>
8923: <tr class="answer">
8924: <td align="left" valign="top"></td>
8925: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
8926: compiler, which can be configured by the pkgsrc user.
8927: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
8928: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
8929: path to a compiler, but the type of compiler that should be
8930: used. See <code class="filename">mk/compiler.mk</code> for more
8931: information about the latter variable.</p></td>
8932: </tr>
1.41 asau 8933: <tr class="question">
1.1 dsieger 8934: <td align="left" valign="top">
1.122 ! leot 8935: <a name="devfaq.bl3flags"></a><a name="idm80564656"></a><p><b>22.4.</b></p>
1.1 dsieger 8936: </td>
8937: <td align="left" valign="top"><p>What is the difference between
8938: <code class="varname">BUILDLINK_LDFLAGS</code>,
8939: <code class="varname">BUILDLINK_LDADD</code> and
8940: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
8941: </tr>
8942: <tr class="answer">
8943: <td align="left" valign="top"></td>
8944: <td align="left" valign="top"><p>[FIXME]</p></td>
8945: </tr>
1.41 asau 8946: <tr class="question">
1.1 dsieger 8947: <td align="left" valign="top">
1.122 ! leot 8948: <a name="devfaq.bl3prefix"></a><a name="idm80562480"></a><p><b>22.5.</b></p>
1.1 dsieger 8949: </td>
1.10 hubertf 8950: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 8951: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
8952: say it's empty?</p></td>
8953: </tr>
8954: <tr class="answer">
8955: <td align="left" valign="top"></td>
8956: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 8957: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
8958: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 8959: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 8960: command.</p></td>
8961: </tr>
1.41 asau 8962: <tr class="question">
1.1 dsieger 8963: <td align="left" valign="top">
1.122 ! leot 8964: <a name="devfaq.master_sites"></a><a name="idm80559408"></a><p><b>22.6.</b></p>
1.1 dsieger 8965: </td>
8966: <td align="left" valign="top"><p>What does
1.108 rillig 8967: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
8968: don't understand the <code class="code">:=</code> inside
1.1 dsieger 8969: it.</p></td>
8970: </tr>
8971: <tr class="answer">
8972: <td align="left" valign="top"></td>
1.108 rillig 8973: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
8974: assignment operator, although it looks like it.
1.1 dsieger 8975: Instead, it is a degenerate form of
1.108 rillig 8976: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.120 sevan 8977: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 8978: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 8979: case of <code class="varname">MASTER_SITE_*</code>,
8980: <em class="replaceable"><code>old_string</code></em> is the empty string and
8981: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 8982: <code class="code">package/</code>. That's where the
8983: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 8984: together.</p></td>
8985: </tr>
1.41 asau 8986: <tr class="question">
1.1 dsieger 8987: <td align="left" valign="top">
1.122 ! leot 8988: <a name="devfaq.mailinglists"></a><a name="idm80552496"></a><p><b>22.7.</b></p>
1.1 dsieger 8989: </td>
8990: <td align="left" valign="top"><p>Which mailing lists are there for package
8991: developers?</p></td>
8992: </tr>
8993: <tr class="answer">
8994: <td align="left" valign="top"></td>
1.41 asau 8995: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 8996: <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 8997: <dd><p>This is a list for technical discussions related
8998: to pkgsrc development, e.g. soliciting feedback for changes to
8999: pkgsrc infrastructure, proposed new features, questions related
9000: to porting pkgsrc to a new platform, advice for maintaining a
9001: package, patches that affect many packages, help requests moved
9002: from pkgsrc-users when an infrastructure bug is found,
9003: etc.</p></dd>
1.10 hubertf 9004: <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 9005: <dd><p>All bug reports in category "pkg" sent with
1.120 sevan 9006: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 9007: directly; use one of the other mailing
9008: lists.</p></dd>
9009: </dl></div></td>
9010: </tr>
1.41 asau 9011: <tr class="question">
1.1 dsieger 9012: <td align="left" valign="top">
1.122 ! leot 9013: <a name="devfaq.documentation"></a><a name="idm80548656"></a><p><b>22.8.</b></p>
1.1 dsieger 9014: </td>
9015: <td align="left" valign="top"><p>Where is the pkgsrc
9016: documentation?</p></td>
9017: </tr>
9018: <tr class="answer">
9019: <td align="left" valign="top"></td>
9020: <td align="left" valign="top">
9021: <p>There are many places where you can find
9022: documentation about pkgsrc:</p>
1.41 asau 9023: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9024: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9025: of chapters that explain large parts of pkgsrc, but some
9026: chapters tend to be outdated. Which ones they are is hard to
9027: say.</p></li>
1.23 wiz 9028: <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 9029: about certain features, announcements of new parts of the pkgsrc
9030: infrastructure and sometimes even announcements that a certain
9031: feature has been marked as obsolete. The benefit here is that
9032: each message has a date appended to it.</p></li>
1.23 wiz 9033: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9034: <code class="filename">mk/</code> directory start with a comment that
9035: describes the purpose of the file and how it can be used by the
9036: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9037: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9038: help</strong></span>.</p></li>
1.23 wiz 9039: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9040: information, but they tend to be highly abbreviated, especially
9041: for actions that occur often. Some contain a detailed
9042: description of what has changed, but they are geared towards the
9043: other pkgsrc developers, not towards an average pkgsrc user.
9044: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9045: don't know what has been before, these messages may not be worth
9046: too much to you.</p></li>
1.23 wiz 9047: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9048: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9049: mind of the developer who wrote the code. To get this
1.10 hubertf 9050: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9051: to see who has written it and ask on the
9052: <code class="literal">tech-pkg</code> mailing list, so that others can
9053: find your questions later (see above). To be sure that the
9054: developer in charge reads the mail, you may CC him or
9055: her.</p></li>
9056: </ul></div>
9057: </td>
9058: </tr>
1.41 asau 9059: <tr class="question">
1.1 dsieger 9060: <td align="left" valign="top">
1.122 ! leot 9061: <a name="devfaq.too-much-time"></a><a name="idm80542256"></a><p><b>22.9.</b></p>
1.1 dsieger 9062: </td>
9063: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9064: do?</p></td>
9065: </tr>
9066: <tr class="answer">
9067: <td align="left" valign="top"></td>
9068: <td align="left" valign="top">
9069: <p>This is not really an FAQ yet, but here's the answer
9070: anyway.</p>
1.41 asau 9071: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9072: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.120 sevan 9073: <a href="http://cdn.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 9074: will tell you about newer versions of installed packages that are
9075: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9076: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9077: — it contains a list of suggested new packages and a list of
1.1 dsieger 9078: cleanups and enhancements for pkgsrc that would be nice to
9079: have.</p></li>
1.23 wiz 9080: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9081: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9082: mailing list.</p></li>
9083: </ul></div>
9084: </td>
9085: </tr>
9086: </tbody>
9087: </table>
9088: </div>
9089: </div>
1.41 asau 9090: <div class="chapter">
1.1 dsieger 9091: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9092: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9093: <div class="toc">
9094: <p><b>Table of Contents</b></p>
1.100 leot 9095: <dl class="toc">
1.6 rillig 9096: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9097: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9098: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9099: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9100: </dl>
9101: </div>
1.10 hubertf 9102: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9103: site</a>:</p>
9104: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9105: environment, an intuitive and attractive desktop for users, and the
9106: GNOME development platform, an extensive framework for building
9107: applications that integrate into the rest of the desktop.</p></blockquote></div>
9108: <p>pkgsrc provides a seamless way to automatically build and install
9109: a complete GNOME environment <span class="emphasis"><em>under many different
9110: platforms</em></span>. We can say with confidence that pkgsrc is one of
9111: the most advanced build and packaging systems for GNOME due to its
9112: included technologies buildlink3, the wrappers and tools framework and
9113: automatic configuration file management. Lots of efforts are put into
9114: achieving a completely clean deinstallation of installed software
9115: components.</p>
1.10 hubertf 9116: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9117: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9118: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9119: pkgsrc as its preferred packaging system, contributing lots of
9120: portability fixes to make GNOME build and install under it.</p>
9121: <p>This chapter is aimed at pkgsrc developers and other people
9122: interested in helping our GNOME porting and packaging efforts. It
9123: provides instructions on how to manage the existing packages and some
9124: important information regarding their internals.</p>
1.41 asau 9125: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9126: <h3 class="title">We need your help!</h3>
9127: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9128: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9129: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9130: work</a> list! There is still a long way to go to get a
9131: fully-functional GNOME desktop under NetBSD and we need your help to
9132: achieve it!</p>
9133: </div>
1.41 asau 9134: <div class="sect1">
1.1 dsieger 9135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9136: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9137: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9138: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 9139: <li class="listitem"><p><a href="http://cdn.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 9140: the core GNOME desktop environment. It only includes the necessary
9141: bits to get it to boot correctly, although it may lack important
9142: functionality for daily operation. The idea behind this package is
9143: to let end users build their own configurations on top of this one,
9144: first installing this meta package to achieve a functional setup and
9145: then adding individual applications.</p></li>
1.120 sevan 9146: <li class="listitem"><p><a href="http://cdn.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 9147: complete installation of the GNOME platform and desktop as defined
9148: by the GNOME project; this is based on the components distributed in
9149: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9150: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9151: official FTP server. Developer-only tools found in those
9152: directories are not installed unless required by some other
9153: component to work properly. Similarly, packages from the bindings
9154: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9155: in unless required as a dependency for an end-user component. This
1.120 sevan 9156: package "extends" <a href="http://cdn.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>
9157: <li class="listitem"><p><a href="http://cdn.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 9158: Installs all the tools required to build a GNOME component when
9159: fetched from the CVS repository. These are required to let the
1.10 hubertf 9160: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9161: </ul></div>
9162: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9163: sorted in a way that eases updates: a package may depend on other
9164: packages listed before it but not on any listed after it. It is very
9165: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9166: change it to alphabetical sorting!</em></span></p>
9167: </div>
1.41 asau 9168: <div class="sect1">
1.1 dsieger 9169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9170: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9171: <p>Almost all GNOME applications are written in C and use a common
9172: set of tools as their build system. Things get different with the new
9173: bindings to other languages (such as Python), but the following will
9174: give you a general idea on the minimum required tools:</p>
1.41 asau 9175: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9176: <li class="listitem">
1.1 dsieger 9177: <p>Almost all GNOME applications use the GNU Autotools as their
9178: build system. As a general rule you will need to tell this to your
9179: package:</p>
9180: <pre class="programlisting">
9181: GNU_CONFIGURE=yes
9182: USE_LIBTOOL=yes
9183: USE_TOOLS+=gmake
9184: </pre>
9185: </li>
1.23 wiz 9186: <li class="listitem">
1.1 dsieger 9187: <p>If the package uses pkg-config to detect dependencies, add this
9188: tool to the list of required utilities:</p>
1.111 sevan 9189: <pre class="programlisting">
9190: USE_TOOLS+=pkg-config
9191: </pre>
1.120 sevan 9192: <p>Also use <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.1 dsieger 9193: the end of the build process to ensure that you did not miss to
9194: specify any dependency in your package and that the version
9195: requirements are all correct.</p>
9196: </li>
1.23 wiz 9197: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9198: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9199: to handle dependencies and to force the package to use the latest
9200: available version.</p></li>
1.23 wiz 9201: <li class="listitem">
1.1 dsieger 9202: <p>If the package uses gtk-doc (a documentation generation
9203: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9204: tool is rather big and the distfile should come with pregenerated
9205: documentation anyway; if it does not, it is a bug that you ought to
9206: report. For such packages you should disable gtk-doc (unless it is
9207: the default):</p>
1.111 sevan 9208: <pre class="programlisting">
9209: CONFIGURE_ARGS+=--disable-gtk-doc
9210: </pre>
1.1 dsieger 9211: <p>The default location of installed HTML files
9212: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9213: and should not be changed unless the package insists on installing
9214: them somewhere else. Otherwise programs as
1.10 hubertf 9215: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9216: do that with an entry similar to:</p>
1.111 sevan 9217: <pre class="programlisting">
9218: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9219: </pre>
1.1 dsieger 9220: </li>
9221: </ul></div>
9222: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9223: files under the installation prefix to maintain databases. In this
9224: context, shared means that those exact same directories and files are
9225: used among several different packages, leading to conflicts in the
9226: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9227: handle the most common cases, so you have to forget about using
9228: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9229: omitting shared files from them. If you find yourself doing those,
9230: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9231: <p>The following table lists the common situations that result in
9232: using shared directories or files. For each of them, the appropriate
9233: solution is given. After applying the solution be sure to
9234: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9235: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9236: <div class="table">
1.6 rillig 9237: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9238: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9239: <colgroup>
9240: <col>
9241: <col>
9242: </colgroup>
9243: <thead><tr>
9244: <th>If the package...</th>
9245: <th>Then...</th>
9246: </tr></thead>
9247: <tbody>
9248: <tr>
9249: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9250: <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 9251: </tr>
9252: <tr>
9253: <td>Installs icons under the
9254: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9255: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9256: <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 9257: </tr>
9258: <tr>
9259: <td>Installs files under
9260: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9261: <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 9262: </tr>
9263: <tr>
9264: <td>Installs <code class="filename">.desktop</code> files under
9265: <code class="filename">share/applications</code> and these include MIME
9266: information.</td>
1.10 hubertf 9267: <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 9268: </tr>
9269: </tbody>
9270: </table></div>
9271: </div>
9272: <br class="table-break">
9273: </div>
1.41 asau 9274: <div class="sect1">
1.1 dsieger 9275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9276: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9277: <p>When seeing GNOME as a whole, there are two kinds of
9278: updates:</p>
1.41 asau 9279: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9280: <dt><span class="term">Major update</span></dt>
9281: <dd>
9282: <p>Given that there is still a very long way for GNOME 3 (if it
9283: ever appears), we consider a major update one that goes from a
9284: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9285: where <code class="literal">Y</code> is even and greater than
9286: <code class="literal">X</code>. These are hard to achieve because they
9287: introduce lots of changes in the components' code and almost all
9288: GNOME distfiles are updated to newer versions. Some of them can
9289: even break API and ABI compatibility with the previous major
9290: version series. As a result, the update needs to be done all at
9291: once to minimize breakage.</p>
9292: <p>A major update typically consists of around 80 package
9293: updates and the addition of some new ones.</p>
9294: </dd>
9295: <dt><span class="term">Minor update</span></dt>
9296: <dd>
9297: <p>We consider a minor update one that goes from a
9298: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9299: one where <code class="literal">Y</code> is greater than
9300: <code class="literal">X</code>. These are easy to achieve because they do
9301: not update all GNOME components, can be done in an incremental way
9302: and do not break API nor ABI compatibility.</p>
9303: <p>A minor update typically consists of around 50 package
9304: updates, although the numbers here may vary a lot.</p>
9305: </dd>
9306: </dl></div>
9307: <p>In order to update the GNOME components in pkgsrc to a new stable
9308: release (either major or minor), the following steps should be
9309: followed:</p>
1.23 wiz 9310: <div class="orderedlist"><ol class="orderedlist" type="1">
9311: <li class="listitem">
1.1 dsieger 9312: <p>Get a list of all the tarballs that form the new release by
9313: using the following commands. These will leave the full list of the
1.18 snj 9314: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9315: file:</p>
9316: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9317: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9318: awk '{ print $9 }' >list.txt</code></strong>
9319: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9320: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9321: awk '{ print $9 }' >>list.txt</code></strong></pre>
9322: </li>
1.23 wiz 9323: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9324: bump their version to the release you are updating them to. The
9325: three meta packages should be always consistent with versioning.
9326: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9327: in them.</p></li>
1.23 wiz 9328: <li class="listitem">
1.1 dsieger 9329: <p>For each meta package, update all its
9330: <code class="varname">DEPENDS</code> lines to match the latest versions as
9331: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9332: newer version (even if found in the FTP) because the meta packages
9333: are supposed to list the exact versions that form a specific GNOME
9334: release. Exceptions are permitted here if a newer version solves a
9335: serious issue in the overall desktop experience; these typically
9336: come in the form of a revision bump in pkgsrc, not in newer versions
9337: from the developers.</p>
9338: <p>Packages not listed in the <code class="filename">list.txt</code> file
9339: should be updated to the latest version available (if found in
9340: pkgsrc). This is the case, for example, of the dependencies on the
1.120 sevan 9341: GNU Autotools in the <a href="http://cdn.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 9342: </li>
1.23 wiz 9343: <li class="listitem">
1.1 dsieger 9344: <p>Generate a patch from the modified meta packages and extract the
9345: list of "new" lines. This will provide you an outline on what
9346: packages need to be updated in pkgsrc and in what order:</p>
9347: <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>
9348: </li>
1.23 wiz 9349: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9350: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9351: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9352: of <code class="filename">todo.txt</code> and update the packages listed in
9353: it in order. For major desktop updates none of these should be
9354: committed until the entire set is completed because there are chances
9355: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9356: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9357: the tree one by one with appropriate log messages. At the end,
9358: commit the three meta package updates and all the corresponding
9359: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9360: <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>
9361: </ol></div>
9362: </div>
1.41 asau 9363: <div class="sect1">
1.1 dsieger 9364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9365: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9366: <p>GNOME is a very big component in pkgsrc which approaches 100
9367: packages. Please, it is very important that you always, always,
9368: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9369: 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 9370: their attention on portability issues and to ensure that future versions
9371: can be built out-of-the box on NetBSD. The less custom patches in
9372: pkgsrc, the easier further updates are. Those developers in charge of
9373: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9374: <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 9375: Bugzilla</a>. Not all components use these to track bugs, but most
9376: of them do. Do not be short on your reports: always provide detailed
9377: explanations of the current failure, how it can be improved to achieve
9378: maximum portability and, if at all possible, provide a patch against CVS
9379: head. The more verbose you are, the higher chances of your patch being
9380: accepted.</p>
9381: <p>Also, please avoid using preprocessor magic to fix portability
9382: issues. While the FreeBSD GNOME people are doing a great job in porting
9383: GNOME to their operating system, the official GNOME sources are now
9384: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9385: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 9386: 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 9387: details.</p>
9388: </div>
9389: </div>
9390: </div>
1.41 asau 9391: <div class="part">
1.1 dsieger 9392: <div class="titlepage"><div><div><h1 class="title">
9393: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9394: <div class="partintro">
1.1 dsieger 9395: <div></div>
9396: <p>This part of the guide deals with everything
9397: from the infrastructure that is behind the interfaces described
9398: in the developer's guide. A casual package maintainer should not
9399: need anything from this part.</p>
9400: <div class="toc">
9401: <p><b>Table of Contents</b></p>
1.100 leot 9402: <dl class="toc">
1.6 rillig 9403: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9404: <dd><dl>
1.6 rillig 9405: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9406: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9407: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9408: <dd><dl>
1.6 rillig 9409: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9410: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9411: </dl></dd>
1.6 rillig 9412: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9413: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9414: <dd><dl>
1.6 rillig 9415: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9416: <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 9417: </dl></dd>
1.6 rillig 9418: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9419: <dd><dl>
1.23 wiz 9420: <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>
9421: <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 9422: </dl></dd>
9423: </dl></dd>
1.6 rillig 9424: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 9425: <dd><dl>
1.108 rillig 9426: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9427: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9428: <dd><dl>
1.108 rillig 9429: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9430: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9431: </dl></dd>
9432: </dl></dd>
1.6 rillig 9433: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 9434: <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 9435: </dl>
9436: </div>
9437: </div>
1.41 asau 9438: <div class="chapter">
1.1 dsieger 9439: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9440: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9441: <div class="toc">
9442: <p><b>Table of Contents</b></p>
1.100 leot 9443: <dl class="toc">
1.6 rillig 9444: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9445: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9446: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9447: <dd><dl>
1.6 rillig 9448: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9449: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9450: </dl></dd>
1.6 rillig 9451: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9452: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9453: <dd><dl>
1.6 rillig 9454: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9455: <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 9456: </dl></dd>
1.6 rillig 9457: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9458: <dd><dl>
1.23 wiz 9459: <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>
9460: <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 9461: </dl></dd>
9462: </dl>
9463: </div>
9464: <p>The pkgsrc infrastructure consists of many small Makefile
9465: fragments. Each such fragment needs a properly specified
9466: interface. This chapter explains how such an interface looks
9467: like.</p>
1.41 asau 9468: <div class="sect1">
1.1 dsieger 9469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9470: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9471: <p>Whenever a variable is defined in the pkgsrc
9472: infrastructure, the location and the way of definition provide
9473: much information about the intended use of that variable.
9474: Additionally, more documentation may be found in a header
9475: comment or in this pkgsrc guide.</p>
9476: <p>A special file is
9477: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9478: variables that are intended to be user-defined. They are either
9479: defined using the <code class="literal">?=</code> operator or they are
9480: left undefined because defining them to anything would
1.23 wiz 9481: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9482: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9483: file.</p>
9484: <p>Outside this file, the following conventions apply:
9485: Variables that are defined using the <code class="literal">?=</code>
9486: operator may be overridden by a package.</p>
9487: <p>Variables that are defined using the <code class="literal">=</code>
9488: operator may be used read-only at run-time.</p>
9489: <p>Variables whose name starts with an underscore must not be
9490: accessed outside the pkgsrc infrastructure at all. They may
9491: change without further notice.</p>
1.41 asau 9492: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9493: <h3 class="title">Note</h3>
9494: <p>These conventions are currently not applied
9495: consistently to the complete pkgsrc
9496: infrastructure.</p>
9497: </div>
9498: </div>
1.41 asau 9499: <div class="sect1">
1.1 dsieger 9500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9501: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9502: <p>All variables that contain lists of things should default
9503: to being empty. Two examples that do not follow this rule are
9504: <code class="varname">USE_LANGUAGES</code> and
9505: <code class="varname">DISTFILES</code>. These variables cannot simply be
9506: modified using the <code class="literal">+=</code> operator in package
9507: <code class="filename">Makefile</code>s (or other files included by
9508: them), since there is no guarantee whether the variable is
9509: already set or not, and what its value is. In the case of
1.23 wiz 9510: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9511: the default value and just define it as in the following
9512: example.</p>
9513: <pre class="programlisting">
9514: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9515: </pre>
9516: <p>Because of the selection of this default value, the same
9517: value appears in many package Makefiles. Similarly for
9518: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9519: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9520: doesn't stand out. Nevertheless it is mentioned in many
9521: files.</p>
9522: </div>
1.41 asau 9523: <div class="sect1">
1.1 dsieger 9524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9525: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 9526: <div class="sect2">
1.1 dsieger 9527: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9528: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 9529: <p>Variable evaluation takes place either at load time or at
9530: runtime, depending on the context in which they occur. The
9531: contexts where variables are evaluated at load time are:</p>
1.41 asau 9532: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9533: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9534: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9535: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9536: <code class="literal">.for</code>,</p></li>
1.23 wiz 9537: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9538: </ul></div>
9539: <p>A special exception are references to the iteration
9540: variables of <code class="literal">.for</code> loops, which are expanded
9541: inline, no matter in which context they appear.</p>
9542: <p>As the values of variables may change during load time,
9543: care must be taken not to evaluate them by accident. Typical
9544: examples for variables that should not be evaluated at load time
9545: are <code class="varname">DEPENDS</code> and
9546: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9547: clear, here is an example:</p>
9548: <pre class="programlisting">
9549: CONFIGURE_ARGS= # none
9550: CFLAGS= -O
9551: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9552:
9553: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9554:
9555: CFLAGS+= -Wall
1.111 sevan 9556: </pre>
1.1 dsieger 9557: <p>This code shows how the use of the <code class="literal">:=</code>
9558: operator can quickly lead to unexpected results. The first
9559: paragraph is fairly common code. The second paragraph evaluates
9560: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9561: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9562: <code class="literal">-Wall</code> is appended to the
9563: <code class="varname">CFLAGS</code>, but this addition will not appear in
9564: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9565: paragraphs from above typically occur in completely unrelated
9566: files.</p>
9567: </div>
1.41 asau 9568: <div class="sect2">
1.1 dsieger 9569: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9570: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9571: <p>After all the files have been loaded, the values of the
9572: variables cannot be changed anymore. Variables that are used in
9573: the shell commands are expanded at this point.</p>
9574: </div>
9575: </div>
1.41 asau 9576: <div class="sect1">
1.1 dsieger 9577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9578: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9579: <p>There are many ways in which the definition and use of a
1.108 rillig 9580: variable can be restricted in order to detect bugs and violations
9581: of the (mostly unwritten) policies. A package can be checked with
9582: <code class="literal">pkglint -Wall</code> to see whether it meets these
9583: rules.</p>
1.1 dsieger 9584: </div>
1.41 asau 9585: <div class="sect1">
1.1 dsieger 9586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9587: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9588: <p>Most of the <code class="filename">.mk</code> files fall into one
9589: of the following classes. Cases where a file falls into more
9590: than one class should be avoided as it often leads to subtle
9591: bugs.</p>
1.41 asau 9592: <div class="sect2">
1.1 dsieger 9593: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9594: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9595: <p>In a traditional imperative programming language some of
9596: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9597: procedures. They take some input parameters and—after
9598: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9599: variables in <code class="filename">Makefile</code>s have global scope
9600: care must be taken not to use parameter names that have already
9601: another meaning. For example, <code class="varname">PKGNAME</code> is a
9602: bad choice for a parameter name.</p>
9603: <p>Procedures are completely evaluated at preprocessing time.
9604: That is, when calling a procedure all input parameters must be
9605: completely resolvable. For example,
9606: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9607: parameter since it is very likely that further text will be
9608: added after calling the procedure, which would effectively apply
9609: the procedure to only a part of the variable. Also, references
1.108 rillig 9610: to other variables will be modified after calling the
1.1 dsieger 9611: procedure.</p>
9612: <p>A procedure can declare its output parameters either as
9613: suitable for use in preprocessing directives or as only
9614: available at runtime. The latter alternative is for variables
9615: that contain references to other runtime variables.</p>
9616: <p>Procedures shall be written such that it is possible to
9617: call the procedure more than once. That is, the file must not
9618: contain multiple-inclusion guards.</p>
9619: <p>Examples for procedures are
9620: <code class="filename">mk/bsd.options.mk</code> and
9621: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9622: that the parameters are evaluated at load time, they should be
9623: assigned using the <code class="literal">:=</code> operator, which should
9624: be used only for this purpose.</p>
9625: </div>
1.41 asau 9626: <div class="sect2">
1.1 dsieger 9627: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9628: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9629: <p>Action files take some input parameters and may define
9630: runtime variables. They shall not define loadtime variables.
9631: There are action files that are included implicitly by the
9632: pkgsrc infrastructure, while other must be included
9633: explicitly.</p>
9634: <p>An example for action files is
9635: <code class="filename">mk/subst.mk</code>.</p>
9636: </div>
9637: </div>
1.41 asau 9638: <div class="sect1">
1.1 dsieger 9639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9640: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 9641: <p>Package <code class="filename">Makefile</code>s usually consist of
9642: a set of variable definitions, and include the file
9643: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9644: Before that, they may also include various other
9645: <code class="filename">*.mk</code> files if they need to query the
9646: availability of certain features like the type of compiler or
9647: the X11 implementation. Due to the heavy use of preprocessor
9648: directives like <code class="literal">.if</code> and
9649: <code class="literal">.for</code>, the order in which the files are loaded
9650: matters.</p>
9651: <p>This section describes at which point the various files
9652: are loaded and gives reasons for that order.</p>
1.41 asau 9653: <div class="sect2">
1.1 dsieger 9654: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9655: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 9656: </h3></div></div></div>
9657: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
9658: is to define some essential variables like
9659: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9660: <code class="varname">MACHINE_ARCH</code>.</p>
9661: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 9662: 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 9663: After that, those variables
1.1 dsieger 9664: that have not been overridden by the user are loaded from
9665: <code class="filename">mk/defaults/mk.conf</code>.</p>
9666: <p>After the user settings, the system settings and platform
9667: settings are loaded, which may override the user
9668: settings.</p>
9669: <p>Then, the tool definitions are loaded. The tool wrappers
9670: are not yet in effect. This only happens when building a
9671: package, so the proper variables must be used instead of the
9672: direct tool names.</p>
9673: <p>As the last steps, some essential variables from the
9674: wrapper and the package system flavor are loaded, as well as the
9675: variables that have been cached in earlier phases of a package
9676: build.</p>
9677: </div>
1.41 asau 9678: <div class="sect2">
1.1 dsieger 9679: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9680: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 9681: </h3></div></div></div>
9682: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9683: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9684: loaded, which fill default values for those variables that have
9685: not been defined by the package. These variables may later
9686: be used even in unrelated files.</p>
9687: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9688: provides the target <code class="literal">error-check</code> that is added
9689: as a special dependency to all other targets that use
9690: <code class="varname">DELAYED_ERROR_MSG</code> or
9691: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9692: <p>Then, the package-specific hacks from
9693: <code class="filename">hacks.mk</code> are included.</p>
9694: <p>Then, various other files follow. Most of them don't have
9695: any dependencies on what they need to have included before or
9696: after them, though some do.</p>
9697: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9698: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9699: restricts the use of these variables to all the files that have
9700: been included before. Appearances in later files will be
9701: silently ignored.</p>
9702: <p>Then, the files for the main targets are included, in the
9703: order of later execution, though the actual order should not
9704: matter.</p>
9705: <p>At last, some more files are included that don't set any
9706: interesting variables but rather just define make targets to be
9707: executed.</p>
9708: </div>
9709: </div>
9710: </div>
1.41 asau 9711: <div class="chapter">
1.1 dsieger 9712: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9713: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 9714: <div class="toc">
9715: <p><b>Table of Contents</b></p>
1.100 leot 9716: <dl class="toc">
1.108 rillig 9717: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9718: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9719: <dd><dl>
1.108 rillig 9720: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9721: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9722: </dl></dd>
9723: </dl>
9724: </div>
9725: <p>The pkgsrc infrastructure consists of a large codebase,
9726: and there are many corners where every little bit of a file is
9727: well thought out, making pkgsrc likely to fail as soon as
9728: anything is changed near those parts. To prevent most changes
9729: from breaking anything, a suite of regression tests should go
9730: along with every important part of the pkgsrc infrastructure.
9731: This chapter describes how regression tests work in pkgsrc and
9732: how you can add new tests.</p>
1.41 asau 9733: <div class="sect1">
1.1 dsieger 9734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9735: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.120 sevan 9736: <p>You first need to install the <a href="http://cdn.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 9737: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 9738: can simply run that command, which will run all tests in the
9739: <code class="filename">regress</code> category.</p>
9740: </div>
1.41 asau 9741: <div class="sect1">
1.1 dsieger 9742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9743: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.1 dsieger 9744: <p>Every directory in the <code class="filename">regress</code>
9745: category that contains a file called <code class="filename">spec</code>
9746: is considered a regression test. This file is a shell program
1.10 hubertf 9747: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 9748: The following functions can be overridden to suit your
9749: needs.</p>
1.41 asau 9750: <div class="sect2">
1.1 dsieger 9751: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9752: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
9753: <p>These functions do not take any parameters. Although they
9754: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9755: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9756: question</a> for details.</p>
1.41 asau 9757: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9758: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 9759: <dd><p>This function prepares the environment for the
9760: test. By default it does nothing.</p></dd>
1.108 rillig 9761: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9762: <dd>
9763: <p>This function runs the actual test. By default,
1.1 dsieger 9764: it calls <code class="varname">TEST_MAKE</code> with the arguments
9765: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9766: error messages into the file
1.108 rillig 9767: <code class="varname">TEST_OUTFILE</code>.</p>
9768: <p>When defining this function, make sure that all output that
9769: needs to be checked is written to the correct output file.
9770: Example:</p>
9771: <pre class="programlisting">
9772: do_test() {
1.112 rillig 9773: echo "Example output"
1.108 rillig 9774: } 1>$TEST_OUTFILE 2>&1
9775: </pre>
9776: </dd>
9777: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9778: <dd>
9779: <p>This function is run after the test and is
1.1 dsieger 9780: typically used to compare the actual output from the one that is
9781: expected. It can make use of the various helper functions from
1.108 rillig 9782: the next section. Example:</p>
9783: <pre class="programlisting">
9784: check_result() {
1.112 rillig 9785: exit_status 0
9786: output_require "Example"
9787: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9788: output_prohibit "no such file or directory"
1.108 rillig 9789: }
9790: </pre>
9791: </dd>
9792: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 9793: <dd><p>This function cleans everything up after the
9794: test has been run. By default it does nothing.</p></dd>
9795: </dl></div>
9796: </div>
1.41 asau 9797: <div class="sect2">
1.1 dsieger 9798: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9799: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.41 asau 9800: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9801: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 9802: <dd><p>This function compares the exitcode of the
1.108 rillig 9803: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 9804: If they differ, the test will fail.</p></dd>
1.108 rillig 9805: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9806: <dd>
9807: <p>This function checks for each of its parameters
9808: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 9809: extended regular expression. If it does not, the test will
1.108 rillig 9810: fail. Example:</p>
9811: <pre class="programlisting">
9812: output_require "looks fine"
9813: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9814: </pre>
9815: </dd>
1.1 dsieger 9816: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9817: <dd><p>This function checks for each of its parameters
1.10 hubertf 9818: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 9819: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9820: If any of the regular expressions matches, the test will
9821: fail.</p></dd>
9822: </dl></div>
9823: </div>
9824: </div>
9825: </div>
1.41 asau 9826: <div class="chapter">
1.1 dsieger 9827: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9828: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 9829: <div class="toc">
9830: <p><b>Table of Contents</b></p>
1.108 rillig 9831: <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 9832: </div>
9833: <p>The pkgsrc system has already been ported to many
9834: operating systems, hardware architectures and compilers. This
9835: chapter explains the necessary steps to make pkgsrc even more
9836: portable.</p>
1.41 asau 9837: <div class="sect1">
1.1 dsieger 9838: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9839: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 9840: <p>To port pkgsrc to a new operating system (called
9841: <code class="literal">MyOS</code> in this example), you need to touch the
9842: following files:</p>
1.41 asau 9843: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9844: <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>
9845: <dd><p>This file contains some basic definitions, for
9846: example the name of the C
9847: compiler.</p></dd>
9848: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
9849: <dd><p>Insert code that defines the variables
9850: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
9851: <code class="varname">LOWER_OS_VERSION</code>,
9852: <code class="varname">LOWER_VENDOR</code>,
9853: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
9854: <code class="varname">APPEND_ELF</code>, and the other variables that
9855: appear in this file.</p></dd>
9856: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9857: <dd><p>This file contains the platform-specific
9858: definitions that are used by pkgsrc. Start by copying one of the
9859: other files and edit it to your
9860: needs.</p></dd>
9861: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9862: <dd><p>This file defines the paths to all the tools
9863: that are needed by one or the other package in pkgsrc, as well
9864: as by pkgsrc itself. Find out where these tools are on your
9865: platform and add them.</p></dd>
9866: </dl></div>
9867: <p>Now, you should be able to build some basic packages, like
1.120 sevan 9868: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1 dsieger 9869: </div>
9870: </div>
9871: </div>
1.41 asau 9872: <div class="appendix">
9873: <div class="titlepage"><div><div><h1 class="title">
9874: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 9875: <div class="toc">
9876: <p><b>Table of Contents</b></p>
1.100 leot 9877: <dl class="toc">
1.1 dsieger 9878: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
9879: <dd><dl>
9880: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
9881: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
9882: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 9883: <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 9884: </dl></dd>
9885: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
9886: </dl>
9887: </div>
9888: <p>We checked to find a piece of software that wasn't in the packages
9889: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 9890: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 9891: present in the tree is beyond us, but it's useful for the purposes of
9892: this exercise.</p>
1.41 asau 9893: <div class="sect1">
1.1 dsieger 9894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9895: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 9896: <div class="sect2">
1.1 dsieger 9897: <div class="titlepage"><div><div><h3 class="title">
9898: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
9899: <pre class="programlisting">
9900: # $NetBSD$
9901: #
9902:
9903: DISTNAME= bison-1.25
9904: CATEGORIES= devel
9905: MASTER_SITES= ${MASTER_SITE_GNU}
9906:
1.29 dholland 9907: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 9908: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
9909: COMMENT= GNU yacc clone
9910:
9911: GNU_CONFIGURE= yes
1.46 wiz 9912: INFO_FILES= yes
1.1 dsieger 9913:
9914: .include "../../mk/bsd.pkg.mk"
9915: </pre>
9916: </div>
1.41 asau 9917: <div class="sect2">
1.1 dsieger 9918: <div class="titlepage"><div><div><h3 class="title">
9919: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
9920: <pre class="programlisting">
9921: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.120 sevan 9922: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 9923: of the NetBSD source tree is beyond me.
9924: </pre>
9925: </div>
1.41 asau 9926: <div class="sect2">
1.1 dsieger 9927: <div class="titlepage"><div><div><h3 class="title">
9928: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
9929: <pre class="programlisting">
9930: @comment $NetBSD$
9931: bin/bison
9932: man/man1/bison.1.gz
9933: share/bison.simple
9934: share/bison.hairy
9935: </pre>
9936: </div>
1.41 asau 9937: <div class="sect2">
1.1 dsieger 9938: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 9939: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 9940: </h3></div></div></div>
9941: <p>The NetBSD package system comes with
1.120 sevan 9942: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 9943: which helps to check the contents of these
9944: files. After installation it is quite easy to use, just change to the
9945: directory of the package you wish to examine and execute
1.10 hubertf 9946: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 9947: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
9948: looks fine.</pre>
9949: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 9950: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 9951: -Wall</strong></span> for a very thorough check.</p>
9952: </div>
9953: </div>
1.41 asau 9954: <div class="sect1">
1.1 dsieger 9955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9956: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
9957: <p>Create the directory where the package lives,
9958: plus any auxiliary directories:</p>
9959: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
9960: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
9961: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
9962: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
9963: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 9964: <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 9965: then continue with fetching the distfile:</p>
9966: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
9967: >> bison-1.25.tar.gz doesn't seem to exist on this system.
9968: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
9969: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9970: ftp: Error retrieving file: 500 Internal error
9971:
9972: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
9973: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9974: ftp: Error retrieving file: 500 Internal error
9975:
9976: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
9977: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9978: Successfully retrieved file.</pre>
9979: <p>Generate the checksum of the distfile into
9980: <code class="filename">distinfo</code>:</p>
9981: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
9982: <p>Now compile:</p>
9983: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
9984: >> Checksum OK for bison-1.25.tar.gz.
9985: ===> Extracting for bison-1.25
9986: ===> Patching for bison-1.25
9987: ===> Ignoring empty patch directory
9988: ===> Configuring for bison-1.25
9989: creating cache ./config.cache
9990: checking for gcc... cc
9991: checking whether we are using GNU C... yes
9992: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
9993: checking how to run the C preprocessor... cc -E
9994: checking for minix/config.h... no
9995: checking for POSIXized ISC... no
9996: checking whether cross-compiling... no
9997: checking for ANSI C header files... yes
9998: checking for string.h... yes
9999: checking for stdlib.h... yes
10000: checking for memory.h... yes
10001: checking for working const... yes
10002: checking for working alloca.h... no
10003: checking for alloca... yes
10004: checking for strerror... yes
10005: updating cache ./config.cache
10006: creating ./config.status
10007: creating Makefile
10008: ===> Building for bison-1.25
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 LR0.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 allocate.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 closure.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 conflicts.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 derives.c
10014: 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
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 getargs.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 gram.c
10017: 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
10018: 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
10019: 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
10020: 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
10021: 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
10022: 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
10023: 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
10024: 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
10025: 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
10026: 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
10027: 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
10028: 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
10029: 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
10030: 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
10031: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10032: rm -f bison.s1
10033: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10034: <p>Everything seems OK, so install the files:</p>
10035: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10036: >> Checksum OK for bison-1.25.tar.gz.
10037: ===> Installing for bison-1.25
10038: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10039: rm -f /usr/pkg/bin/bison
10040: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10041: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10042: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10043: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10044: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10045: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10046: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10047: ===> Registering installation for bison-1.25</pre>
10048: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10049: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10050: binary package, do this now:</p>
10051: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10052: >> Checksum OK for bison-1.25.tar.gz.
10053: ===> Building package for bison-1.25
10054: Creating package bison-1.25.tgz
10055: Registering depends:.
10056: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10057: <p>Now that you don't need the source and object files
10058: any more, clean up:</p>
10059: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10060: ===> Cleaning for bison-1.25</pre>
10061: </div>
10062: </div>
1.41 asau 10063: <div class="appendix">
10064: <div class="titlepage"><div><div><h1 class="title">
10065: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10066: <div class="toc">
10067: <p><b>Table of Contents</b></p>
1.100 leot 10068: <dl class="toc">
1.1 dsieger 10069: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10070: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10071: </dl>
10072: </div>
1.41 asau 10073: <div class="sect1">
1.1 dsieger 10074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10075: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10076: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10077: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10078: => figlet221.tar.gz doesn't seem to exist on this system.
10079: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10080: => [172219 bytes]
10081: Connected to ftp.plig.net.
10082: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10083: 331 Guest login ok, send your complete e-mail address as password.
10084: 230-You are user #5 of 500 simultaneous users allowed.
10085: 230-
10086: 230- ___ _ _ _
10087: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10088: 230- | _| _| . |_| . | | | . |_| . | _| . |
10089: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10090: 230- |_| |_| |___| |___|
10091: 230-
10092: 230-** Welcome to ftp.plig.org **
10093: 230-
10094: 230-Please note that all transfers from this FTP site are logged. If you
10095: 230-do not like this, please disconnect now.
10096: 230-
1.18 snj 10097: 230-This archive is available via
1.1 dsieger 10098: 230-
10099: 230-HTTP: http://ftp.plig.org/
10100: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10101: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10102: 230-
10103: 230-Please email comments, bug reports and requests for packages to be
10104: 230-mirrored to ftp-admin@plig.org.
10105: 230-
10106: 230-
10107: 230 Logged in anonymously.
10108: Remote system type is UNIX.
10109: Using binary mode to transfer files.
10110: 200 Type okay.
10111: 250 "/pub" is new cwd.
10112: 250-"/pub/figlet" is new cwd.
10113: 250-
10114: 250-Welcome to the figlet archive at ftp.figlet.org
10115: 250-
10116: 250- ftp://ftp.figlet.org/pub/figlet/
10117: 250-
10118: 250-The official FIGlet web page is:
10119: 250- http://www.figlet.org/
10120: 250-
10121: 250-If you have questions, please mailto:info@figlet.org. If you want to
10122: 250-contribute a font or something else, you can email us.
10123: 250
10124: 250 "/pub/figlet/program" is new cwd.
10125: 250 "/pub/figlet/program/unix" is new cwd.
10126: local: figlet221.tar.gz remote: figlet221.tar.gz
10127: 502 Unimplemented command.
10128: 227 Entering Passive Mode (195,40,6,41,246,104)
10129: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10130: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10131: 226 Transfer completed.
10132: 172219 bytes received in 00:02 (75.99 KB/s)
10133: 221 Goodbye.
10134: => Checksum OK for figlet221.tar.gz.
10135: ===> Extracting for figlet-2.2.1nb2
10136: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10137: ===> Patching for figlet-2.2.1nb2
10138: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10139: ===> Overriding tools for figlet-2.2.1nb2
10140: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10141: ===> Configuring for figlet-2.2.1nb2
10142: ===> Building for figlet-2.2.1nb2
10143: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10144: chmod a+x figlet
10145: gcc -O2 -o chkfont chkfont.c
10146: => Unwrapping files-to-be-installed.
10147: <code class="prompt">#</code>
10148: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10149: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10150: ===> Installing for figlet-2.2.1nb2
10151: install -d -o root -g wheel -m 755 /usr/pkg/bin
10152: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10153: mkdir -p /usr/pkg/share/figlet
10154: cp figlet /usr/pkg/bin
10155: cp chkfont /usr/pkg/bin
10156: chmod 555 figlist showfigfonts
10157: cp figlist /usr/pkg/bin
10158: cp showfigfonts /usr/pkg/bin
10159: cp fonts/*.flf /usr/pkg/share/figlet
10160: cp fonts/*.flc /usr/pkg/share/figlet
10161: cp figlet.6 /usr/pkg/man/man6
10162: ===> Registering installation for figlet-2.2.1nb2
10163: <code class="prompt">#</code></pre>
10164: </div>
1.41 asau 10165: <div class="sect1">
1.1 dsieger 10166: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10167: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10168: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10169: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10170: ===> Packaging figlet-2.2.1nb2
10171: ===> Building binary package for figlet-2.2.1nb2
10172: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10173: Using SrcDir value of /usr/pkg
10174: Registering depends:.
10175: <code class="prompt">#</code></pre>
10176: </div>
10177: </div>
1.41 asau 10178: <div class="appendix">
10179: <div class="titlepage"><div><div><h1 class="title">
10180: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10181: <div class="toc">
10182: <p><b>Table of Contents</b></p>
1.100 leot 10183: <dl class="toc">
1.23 wiz 10184: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10185: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10186: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10187: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10188: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10189: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10190: source packages</a></span></dt>
10191: </dl>
10192: </div>
10193: <p>As in other big projects, the directory layout of pkgsrc
10194: is quite complex for newbies. This chapter explains where you
10195: find things on the FTP server. The base directory on
1.10 hubertf 10196: <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 10197: On other servers it may be different, but inside this directory,
10198: everything should look the same, no matter on which server you
10199: are. This directory contains some subdirectories, which are
10200: explained below.</p>
1.41 asau 10201: <div class="sect1">
1.1 dsieger 10202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10203: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10204: <p>The directory <code class="filename">distfiles</code> contains lots
10205: of archive files from all pkgsrc packages, which are mirrored
10206: here. The subdirectories are called after their package names
10207: and are used when the distributed files have names that don't
10208: explicitly contain a version number or are otherwise too generic
10209: (for example <code class="filename">release.tar.gz</code>).</p>
10210: </div>
1.41 asau 10211: <div class="sect1">
1.1 dsieger 10212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10213: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10214: <p>This directory contains things that individual pkgsrc
10215: developers find worth publishing.</p>
10216: </div>
1.41 asau 10217: <div class="sect1">
1.1 dsieger 10218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10219: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10220: <p>This directory contains binary packages for the various
10221: platforms that are supported by pkgsrc.
10222: 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 10223: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10224: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10225: operating system for which the packages have been built. The
1.10 hubertf 10226: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10227: command, so it may differ from the one you are used to
10228: hear.</p></li>
1.23 wiz 10229: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10230: architecture of the platform for which the packages have been
1.10 hubertf 10231: built. It also includes the <code class="varname">ABI</code> (Application
10232: Binary Interface) for platforms that have several of
10233: them.</p></li>
1.23 wiz 10234: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10235: the operating system. For version numbers that change often (for
10236: example NetBSD-current), the often-changing part should be
10237: replaced with an <code class="literal">x</code>, for example
10238: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10239: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10240: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10241: for a stable branch, or <code class="literal">head</code> for packages
10242: built from the HEAD branch. The latter should only be used when
10243: the packages are updated on a regular basis. Otherwise the date
10244: from checking out pkgsrc should be appended, for example
10245: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10246: </ul></div>
10247: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10248: can quickly click through the directories on the
10249: server and find the best binary packages for their machines. Since they
10250: usually know the operating system and the hardware architecture, OPSYS
10251: and ARCH are placed first. After these choices, they can select the
10252: best combination of OSVERSION and TAG together, since it is usually the
10253: case that packages stay compatible between different version of the
10254: operating system.</p>
10255: <p>In each of these directories, there is a
10256: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10257: <code class="filename">All</code> which contains all binary packages.
10258: Besides that, there are various category directories that
10259: contain symbolic links to the real binary packages.</p>
10260: </div>
1.41 asau 10261: <div class="sect1">
1.1 dsieger 10262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10263: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10264: <p>Here are the reports from bulk builds, for those who want
10265: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10266: 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 10267: </div>
1.41 asau 10268: <div class="sect1">
1.8 rillig 10269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10270: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10271: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10272: source packages</h2></div></div></div>
1.23 wiz 10273: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10274: that is the files that define how to create binary packages from
10275: source archives.</p>
10276: <p>The directory <code class="filename">pkgsrc</code> contains a
10277: snapshot of the CVS repository, which is updated regularly. The
10278: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10279: directory, ready to be downloaded as a whole.</p>
10280: <p>In the directories for the quarterly branches, there is an
10281: additional file called
1.22 jakllsch 10282: <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 10283: which contains the state of pkgsrc when it was branched.</p>
10284: </div>
10285: </div>
1.41 asau 10286: <div class="appendix">
10287: <div class="titlepage"><div><div><h1 class="title">
10288: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10289: <div class="toc">
10290: <p><b>Table of Contents</b></p>
1.100 leot 10291: <dl class="toc">
1.1 dsieger 10292: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10293: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10294: </dl>
10295: </div>
10296: <p>This section contains information on editing the pkgsrc
10297: guide itself.</p>
1.41 asau 10298: <div class="sect1">
1.1 dsieger 10299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10300: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10301: <p>The pkgsrc guide's source code is stored in
10302: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10303: are created from it:</p>
1.41 asau 10304: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10305: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10306: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10307: <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>
10308: <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 10309: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10310: <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 10311: PostScript version of the pkgsrc guide.</p></li>
10312: </ul></div>
10313: </div>
1.41 asau 10314: <div class="sect1">
1.1 dsieger 10315: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10316: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10317: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10318: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10319: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10320: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10321: documentation) installed. These are automatically installed when
1.120 sevan 10322: you install the <a href="http://cdn.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 10323: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10324: right directory. All further steps will take place
10325: here.</p></li>
1.41 asau 10326: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10327: <code class="filename">files/</code>.</p></li>
1.41 asau 10328: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10329: guide for valid XML and to build the final output files. If you
10330: get any errors at this stage, you can just edit the files, as
10331: there are only symbolic links in the working directory, pointing
10332: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10333: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10334: commit)</strong></span></p></li>
1.41 asau 10335: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10336: regenerate the output files with the proper RCS
10337: Ids.</p></li>
1.41 asau 10338: <li class="step">
1.10 hubertf 10339: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10340: commit the files in both <code class="filename">pkgsrc/doc</code> and
10341: <code class="filename">htdocs</code>.</p>
1.41 asau 10342: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10343: <h3 class="title">Note</h3>
10344: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10345: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10346: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10347: directory.</p>
10348: </div>
10349: </li>
10350: </ol></div>
10351: </div>
10352: </div>
10353: </div></body>
10354: </html>
CVSweb <webmaster@jp.NetBSD.org>