Annotation of pkgsrc/doc/pkgsrc.html, revision 1.246
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 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.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 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.110 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.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 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.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.241 jnemeth 33: <div><p class="copyright">Copyright © 1994-2017 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.31 2017/07/30 22:07:39 jnemeth Exp $</p></div>
1.148 asau 35: <div><div class="abstract">
1.75 rillig 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.210 leot 48: <dl class="toc">
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 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>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 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.157 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 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.109 rillig 104: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 105: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 106: <dd><dl>
1.103 wiz 107: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 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.88 wiz 110: </dl></dd>
1.103 wiz 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.75 rillig 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.106 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.75 rillig 121: <dd><dl>
1.180 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.174 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.106 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.128 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.106 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.194 bsiegert 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.128 wiz 146: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 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.75 rillig 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.106 rillig 158: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 159: <dd><dl>
1.106 rillig 160: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 161: <dd><dl>
1.106 rillig 162: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.245 wiz 163: <dt><span class="sect2"><a href="#creating.python-module">10.1.2. Python modules and programs</a></span></dt>
1.91 rillig 164: </dl></dd>
1.106 rillig 165: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
166: <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>
167: </dl></dd>
168: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
169: <dd><dl>
1.128 wiz 170: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
171: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219 rillig 172: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106 rillig 173: <dd><dl>
174: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
175: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
176: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
177: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
178: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
179: </dl></dd>
180: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
181: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
182: <dd><dl>
183: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
184: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
185: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
186: </dl></dd>
1.128 wiz 187: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
188: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 189: </dl></dd>
1.128 wiz 190: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 191: <dd><dl>
192: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 193: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 194: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
195: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
196: <dd><dl>
197: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228 yyamano 198: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220 wiz 199: <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>
200: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.106 rillig 201: </dl></dd>
202: </dl></dd>
203: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
204: <dd><dl>
205: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 206: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
207: <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.106 rillig 208: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
209: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 210: <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.106 rillig 211: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 212: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
213: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106 rillig 214: </dl></dd>
215: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
216: <dd><dl>
217: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 218: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 219: <dd><dl>
220: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 221: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
222: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
223: and
224: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
225: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 226: </dl></dd>
1.128 wiz 227: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 228: <dd><dl>
1.128 wiz 229: <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.106 rillig 230: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
231: </dl></dd>
232: </dl></dd>
233: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
234: <dd><dl>
235: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
236: <dd><dl>
237: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
238: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
239: </dl></dd>
240: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
241: <dd><dl>
1.128 wiz 242: <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.106 rillig 243: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
244: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
245: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
246: </dl></dd>
247: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
248: <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>
249: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
250: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
251: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
252: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
253: <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>
254: </dl></dd>
255: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
256: <dd><dl>
257: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 258: <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.106 rillig 259: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 260: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 261: </dl></dd>
262: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
263: <dd><dl>
264: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
265: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
266: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
267: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 268: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 269: <dd><dl>
270: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
271: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
272: </dl></dd>
1.128 wiz 273: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
274: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
275: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
276: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
277: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
279: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
280: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
281: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
282: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 283: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
284: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
285: </dl></dd>
286: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
287: <dd><dl>
288: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
289: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
290: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
291: </dl></dd>
292: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
293: <dd><dl>
294: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
295: <dd><dl>
1.218 rillig 296: <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>
297: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
298: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
299: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
300: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
301: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
302: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
303: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
304: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
305: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
306: <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.106 rillig 307: </dl></dd>
1.218 rillig 308: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 309: <dd><dl>
310: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
311: <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.199 tnn 312: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106 rillig 313: </dl></dd>
1.218 rillig 314: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 315: <dd><dl>
316: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
317: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
318: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
319: </dl></dd>
320: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
321: <dd><dl>
322: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
323: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
324: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 325: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
326: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 327: </dl></dd>
1.218 rillig 328: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 329: <dd><dl>
330: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
331: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 332: <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.106 rillig 333: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
334: </dl></dd>
1.218 rillig 335: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 336: <dd><dl>
337: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
338: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
339: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
340: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
341: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
342: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
343: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
344: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 345: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 346: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 347: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
348: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
349: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
350: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
351: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
352: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
353: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
354: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 355: emulation</a></span></dt>
1.106 rillig 356: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
357: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 358: </dl></dd>
1.106 rillig 359: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 360: </dl></dd>
1.106 rillig 361: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
362: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 363: <dd><dl>
1.106 rillig 364: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
365: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
366: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.243 wiz 367: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
368: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
369: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
370: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
371: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.106 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.85 jmmv 380: </dl></dd>
1.75 rillig 381: </dl></dd>
382: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
383: <dd><dl>
1.106 rillig 384: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 385: <dd><dl>
1.106 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.81 rillig 389: <dd><dl>
1.106 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.81 rillig 392: </dl></dd>
1.106 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.75 rillig 395: <dd><dl>
1.106 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.75 rillig 398: </dl></dd>
1.106 rillig 399: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 400: <dd><dl>
1.128 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.75 rillig 403: </dl></dd>
404: </dl></dd>
1.106 rillig 405: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 406: <dd><dl>
1.219 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.75 rillig 409: <dd><dl>
1.219 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.75 rillig 412: </dl></dd>
413: </dl></dd>
1.106 rillig 414: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.219 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.75 rillig 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.128 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.75 rillig 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>
1.76 rillig 433: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
434: <dd><dl>
1.128 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.76 rillig 441: source packages</a></span></dt>
442: </dl></dd>
1.75 rillig 443: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
444: <dd><dl>
1.79 rillig 445: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 446: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
447: </dl></dd>
448: </dl>
449: </div>
1.82 rillig 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.106 rillig 455: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 456: </dt>
1.106 rillig 457: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 458: </dt>
1.82 rillig 459: </dl>
460: </div>
1.148 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.75 rillig 464: <div class="toc">
465: <p><b>Table of Contents</b></p>
1.210 leot 466: <dl class="toc">
1.75 rillig 467: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 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>
1.75 rillig 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>
1.88 wiz 474: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 475: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
476: </dl>
477: </div>
1.148 asau 478: <div class="sect1">
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 488: <p>pkgsrc currently contains several thousand packages,
489: including:</p>
1.148 asau 490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232 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.75 rillig 492: web server</p></li>
1.232 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.75 rillig 494: web browser</p></li>
1.232 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.75 rillig 496: Desktop Environment</p></li>
1.232 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.75 rillig 498: Desktop Environment</p></li>
499: </ul></div>
1.219 rillig 500: <p>… just to name a few.</p>
1.75 rillig 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.148 asau 504: <div class="sect2">
1.82 rillig 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.148 asau 510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 511: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 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.128 wiz 517: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 518: including binaries, libraries, man pages and other
519: documentation.</p></li>
1.214 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.128 wiz 524: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 525: consists of highly portable code. This allows the greatest speed of
1.132 spz 526: development when porting to a new platform. This portability also
1.82 rillig 527: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
528: platforms</em></span>.</p></li>
1.128 wiz 529: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 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.128 wiz 533: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 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>
1.91 rillig 539: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 541: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 542: — That means, if a package contains bugs, it's better to find
1.91 rillig 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.232 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.91 rillig 546: of shell scripts), and post-installation checks (installed files,
547: references to shared libraries, script interpreters).</p></li>
1.128 wiz 548: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 549: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 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>
1.82 rillig 553: </div>
1.148 asau 554: <div class="sect2">
1.82 rillig 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>
1.75 rillig 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>
1.82 rillig 564: <div class="table">
565: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 566: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 567: <colgroup>
568: <col>
569: <col>
1.202 sevan 570: <col>
1.82 rillig 571: </colgroup>
572: <thead><tr>
573: <th>Platform</th>
574: <th>Date Support Added</th>
1.202 sevan 575: <th>Notes</th>
1.82 rillig 576: </tr></thead>
577: <tbody>
578: <tr>
1.110 hubertf 579: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 580: <td align="center">Aug 1997</td>
1.202 sevan 581: <td class="auto-generated"> </td>
1.82 rillig 582: </tr>
583: <tr>
1.110 hubertf 584: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 585: <td align="center">Mar 1999</td>
1.203 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.82 rillig 587: </tr>
588: <tr>
1.110 hubertf 589: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 590: <td align="center">Jun 1999</td>
1.203 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.82 rillig 592: </tr>
593: <tr>
594: <td>
1.230 sevan 595: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 596: </td>
597: <td align="center">Oct 2001</td>
1.203 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.82 rillig 599: </tr>
600: <tr>
1.110 hubertf 601: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 602: <td align="center">Nov 2002</td>
1.203 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.82 rillig 604: </tr>
605: <tr>
1.110 hubertf 606: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 607: <td align="center">Nov 2002</td>
1.203 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.82 rillig 609: </tr>
610: <tr>
1.110 hubertf 611: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 612: <td align="center">Dec 2002</td>
1.202 sevan 613: <td>
1.203 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.202 sevan 616: </td>
1.82 rillig 617: </tr>
618: <tr>
619: <td>BSD/OS</td>
620: <td align="center">Dec 2003</td>
1.202 sevan 621: <td class="auto-generated"> </td>
1.82 rillig 622: </tr>
623: <tr>
1.110 hubertf 624: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 625: <td align="center">Dec 2003</td>
1.203 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.82 rillig 627: </tr>
628: <tr>
629: <td>
1.110 hubertf 630: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 631: (Microsoft Windows Services for Unix)
632: </td>
633: <td align="center">Mar 2004</td>
1.203 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.82 rillig 635: </tr>
636: <tr>
1.110 hubertf 637: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 638: <td align="center">Oct 2004</td>
1.202 sevan 639: <td class="auto-generated"> </td>
1.82 rillig 640: </tr>
641: <tr>
1.110 hubertf 642: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 643: <td align="center">Nov 2004</td>
1.203 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.82 rillig 645: </tr>
1.98 wiz 646: <tr>
1.110 hubertf 647: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 648: <td align="center">Apr 2007</td>
1.203 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.98 wiz 650: </tr>
1.128 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.203 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.128 wiz 655: </tr>
1.151 obache 656: <tr>
657: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 658: <td align="center">Jan 2011</td>
1.202 sevan 659: <td class="auto-generated"> </td>
1.151 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.203 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.151 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.203 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.151 obache 670: </tr>
1.166 jnemeth 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.203 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.166 jnemeth 675: </tr>
1.214 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.82 rillig 681: </tbody>
1.91 rillig 682: </table></div>
1.82 rillig 683: </div>
1.91 rillig 684: <br class="table-break">
1.82 rillig 685: </div>
1.75 rillig 686: </div>
1.148 asau 687: <div class="sect1">
1.75 rillig 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.110 hubertf 691: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 692: describes how one can use one of the packages in the Package
693: Collection, either by installing a precompiled binary package,
1.93 rillig 694: or by building one's own copy using the NetBSD package system.
1.110 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.75 rillig 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.110 hubertf 698: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 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.110 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.75 rillig 703: </div>
1.148 asau 704: <div class="sect1">
1.75 rillig 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.128 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.75 rillig 709: terminology used within this document.</p>
1.148 asau 710: <div class="variablelist"><dl class="variablelist">
1.75 rillig 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
1.236 wiz 716: <code class="filename">/usr/pkgsrc</code>,
717: but may be stored in any location,
718: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75 rillig 719: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 720: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 721: is part of the NetBSD operating system and can be bootstrapped
722: to run on non-NetBSD operating systems as well. It handles
723: building (compiling), installing, and removing of
724: packages.</p></dd>
1.75 rillig 725: <dt><span class="term">Distfile</span></dt>
726: <dd><p>This term describes the file or files that are
727: provided by the author of the piece of software to
728: distribute his work. All the changes necessary to build on
729: NetBSD are reflected in the corresponding package. Usually
730: the distfile is in the form of a compressed tar-archive,
731: but other types are possible, too. Distfiles are usually
732: stored below
1.76 rillig 733: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 734: <dt><span class="term">Port</span></dt>
735: <dd><p>This is the term used by FreeBSD and OpenBSD people
736: for what we call a package.
1.128 wiz 737: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 738: architecture.</p></dd>
739: <dt><span class="term">Precompiled/binary package</span></dt>
740: <dd>
741: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 742: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 743: file so it can be installed on machines of the same
744: machine architecture without the need to
745: recompile. Packages are usually generated in
1.76 rillig 746: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 747: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 748: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 749: especially in the context of precompiled packages.</p>
750: </dd>
751: <dt><span class="term">Program</span></dt>
1.88 wiz 752: <dd><p>The piece of software to be installed which will be
753: constructed from all the files in the distfile by the
754: actions defined in the corresponding package.</p></dd>
1.75 rillig 755: </dl></div>
1.148 asau 756: <div class="sect2">
1.75 rillig 757: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 758: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 759: <div class="variablelist"><dl class="variablelist">
1.75 rillig 760: <dt><span class="term">pkgsrc users</span></dt>
761: <dd>
762: <p>The
763: pkgsrc users are people who use the packages provided by pkgsrc.
764: Typically they are system administrators. The people using the
1.128 wiz 765: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
766: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 767: <p>There are two kinds of pkgsrc users: Some only want to
768: install pre-built binary packages. Others build the pkgsrc
769: packages from source, either for installing them directly or for
1.110 hubertf 770: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75 rillig 771: documentation.</p>
772: </dd>
773: <dt><span class="term">package maintainers</span></dt>
774: <dd><p>A
1.110 hubertf 775: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75 rillig 776: <dt><span class="term">infrastructure developers</span></dt>
777: <dd><p>These people are involved in all those files
1.76 rillig 778: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 779: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75 rillig 780: too.</p></dd>
781: </dl></div>
782: </div>
783: </div>
1.148 asau 784: <div class="sect1">
1.75 rillig 785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
786: <a name="typography"></a>1.4. Typography</h2></div></div></div>
787: <p>When giving examples for commands, shell prompts are used to
788: show if the command should/can be issued as root, or if
1.128 wiz 789: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 sevan 790: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
791: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
792: bourne shell and derivatives.</p>
1.75 rillig 793: </div>
794: </div>
1.148 asau 795: <div class="part">
1.75 rillig 796: <div class="titlepage"><div><div><h1 class="title">
797: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
798: <div class="toc">
799: <p><b>Table of Contents</b></p>
1.210 leot 800: <dl class="toc">
1.75 rillig 801: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
802: <dd><dl>
803: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
804: <dd><dl>
1.157 asau 805: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 806: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 807: </dl></dd>
808: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
811: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
812: </dl></dd>
813: </dl></dd>
814: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
815: <dd><dl>
1.82 rillig 816: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
817: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 818: </dl></dd>
819: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
820: <dd><dl>
821: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
824: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 825: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
826: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
827: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
828: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
829: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75 rillig 830: </dl></dd>
831: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
832: <dd><dl>
833: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
834: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
835: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
836: </dl></dd>
837: </dl></dd>
838: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
839: <dd><dl>
840: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
841: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 842: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 843: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 844: <dd><dl>
1.103 wiz 845: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 846: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
847: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 848: </dl></dd>
1.103 wiz 849: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
850: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 851: </dl></dd>
852: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
853: <dd><dl>
854: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
855: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 856: </dl></dd>
857: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
858: builds)</a></span></dt>
1.75 rillig 859: <dd><dl>
1.180 wiz 860: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
861: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
862: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
863: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 864: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
865: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 866: </dl></dd>
867: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
868: <dd><dl>
1.128 wiz 869: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
870: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 871: </dl></dd>
872: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
873: <dd><dl>
874: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194 bsiegert 875: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
876: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
877: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
878: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
879: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
880: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
881: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
882: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
883: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 884: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 885: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
886: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
887: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
888: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
889: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
890: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
891: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 892: </dl></dd>
893: </dl>
894: </div>
1.148 asau 895: <div class="chapter">
1.75 rillig 896: <div class="titlepage"><div><div><h2 class="title">
897: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
898: <div class="toc">
899: <p><b>Table of Contents</b></p>
1.210 leot 900: <dl class="toc">
1.75 rillig 901: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
902: <dd><dl>
1.157 asau 903: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 904: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 905: </dl></dd>
906: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
907: <dd><dl>
908: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
909: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
910: </dl></dd>
911: </dl>
912: </div>
1.91 rillig 913: <p>Before you download and extract the files, you need to decide
914: where you want to extract them. When using pkgsrc as root user, pkgsrc
915: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
916: free to install the sources and binary packages wherever you want in
917: your filesystem, provided that the pathname does not contain white-space
918: or other characters that are interpreted specially by the shell and some
919: other programs. A safe bet is to use only letters, digits, underscores
920: and dashes.</p>
1.148 asau 921: <div class="sect1">
1.75 rillig 922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
923: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
924: <p>Before you download any pkgsrc files, you should decide
925: whether you want the <span class="emphasis"><em>current</em></span> branch or the
926: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
927: quarterly basis from the current branch and only gets modified
928: for security updates. The names of the stable branches are built
929: from the year and the quarter, for example
1.230 sevan 930: <code class="literal">2016Q4</code>.</p>
1.75 rillig 931: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 932: want to download pkgsrc. You can get it as a tar file or via CVS.
933: Both ways are described here.</p>
1.157 asau 934: <p>Note that tar archive contains CVS working copy.
935: Thus you can switch to using CVS at any later time.</p>
1.148 asau 936: <div class="sect2">
1.75 rillig 937: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 938: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 939: <p>The primary download location for all pkgsrc files is
1.157 asau 940: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
941: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
942: (it points to the same location).
943: There are a number of subdirectories for different purposes,
944: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
945: <p>The tar archive for the current branch is in the directory
946: <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.230 sevan 947: It is autogenerated weekly.</p>
1.157 asau 948: <p>To save download time we provide bzip2- and
949: xz-compressed archives which are published at
950: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
951: and
952: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
953: respectively.
954: </p>
955: <p>You can fetch the same files using FTP.</p>
1.230 sevan 956: <p>The tar file for the stable branch 2016Q4 is in the
957: 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.112 weinem 958: <p>To download a pkgsrc stable tarball, run:</p>
959: <pre class="screen">
1.166 jnemeth 960: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.126 jakllsch 961: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 962: stable branch to be downloaded, for example,
1.230 sevan 963: <span class="quote">“<span class="quote">pkgsrc-2016Q4</span>”</span>.</p>
1.188 snj 964: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 965: or your web browser.</p>
1.112 weinem 966: <p>Then, extract it with:</p>
1.188 snj 967: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 968: <p>This will create the directory <code class="filename">pkgsrc/</code>
969: in <code class="filename">/usr/</code> and all the package source will be
970: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
971: <p>To download pkgsrc-current, run:</p>
972: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75 rillig 973: </div>
1.148 asau 974: <div class="sect2">
1.75 rillig 975: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 976: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
977: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 978: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.128 wiz 979: </pre>
980: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.230 sevan 981: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2016Q4</span>”</span></p>
1.128 wiz 982: <p>This will create the directory <code class="filename">pkgsrc/</code>
983: in your <code class="filename">/usr/</code> directory and all the package source
984: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
985: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 986: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 987: </pre>
1.188 snj 988: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 989: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146 wiz 990: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128 wiz 991: </pre>
992: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
993: For Bourne shells, you can set it in your <code class="filename">.profile</code>
994: or better globally in <code class="filename">/etc/profile</code>:</p>
995: <pre class="programlisting">
996: # set CVS remote shell command
997: CVS_RSH=ssh
998: export CVS_RSH
999: </pre>
1000: <p>By default, CVS doesn't do things like most people would expect it to do.
1001: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1002: in your home directory and saving the following lines to it.
1003: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1004: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1005: <pre class="programlisting">
1006: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1007: cvs -q -z2
1.101 rillig 1008: checkout -P
1.103 wiz 1009: update -dP
1010: diff -upN
1.101 rillig 1011: rdiff -u
1.128 wiz 1012: release -d
1.101 rillig 1013: </pre>
1.75 rillig 1014: </div>
1015: </div>
1.148 asau 1016: <div class="sect1">
1.75 rillig 1017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1018: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1019: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1020: (which also works if you have first installed it via a tar
1021: file). It saves bandwidth and hard disk activity, compared to
1022: downloading the tar file again.</p>
1.148 asau 1023: <div class="sect2">
1.75 rillig 1024: <div class="titlepage"><div><div><h3 class="title">
1025: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1026: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1027: <h3 class="title">Warning</h3>
1.77 rillig 1028: <p>When updating from a tar file, you first need to
1029: completely remove the old pkgsrc directory. Otherwise those
1030: files that have been removed from pkgsrc in the mean time will
1031: not be removed on your local disk, resulting in inconsistencies.
1032: When removing the old files, any changes that you have done to
1033: the pkgsrc files will be lost after updating. Therefore updating
1034: via CVS is strongly recommended.</p>
1.75 rillig 1035: </div>
1.82 rillig 1036: <p>Note that by default the distfiles and the binary packages
1037: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1038: before updating. You can also configure pkgsrc to store distfiles
1039: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1040: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1041: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1042: <p>To update pkgsrc from a tar file, download the tar file as
1043: explained above. Then, make sure that you have not made any
1044: changes to the files in the pkgsrc directory. Remove the pkgsrc
1045: directory and extract the new tar file. Done.</p>
1046: </div>
1.148 asau 1047: <div class="sect2">
1.75 rillig 1048: <div class="titlepage"><div><div><h3 class="title">
1049: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1050: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1051: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1052: </pre>
1053: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1054: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1055: </pre>
1.148 asau 1056: <div class="sect3">
1.75 rillig 1057: <div class="titlepage"><div><div><h4 class="title">
1058: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1059: <p>When updating pkgsrc, the CVS program keeps track of the
1060: branch you selected. But if you, for whatever reason, want to
1061: switch from the stable branch to the current one, you can do it
1.128 wiz 1062: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1063: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1064: back to the stable branch, add the
1.230 sevan 1065: <span class="quote">“<span class="quote">-rpkgsrc-2016Q4</span>”</span> option.</p>
1.75 rillig 1066: </div>
1.148 asau 1067: <div class="sect3">
1.75 rillig 1068: <div class="titlepage"><div><div><h4 class="title">
1069: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1070: <p>When you update pkgsrc, the CVS program will only touch
1071: those files that are registered in the CVS repository. That
1072: means that any packages that you created on your own will stay
1073: unmodified. If you change files that are managed by CVS, later
1074: updates will try to merge your changes with those that have been
1075: done by others. See the CVS manual, chapter
1.128 wiz 1076: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1077: </div>
1078: </div>
1079: </div>
1080: </div>
1.148 asau 1081: <div class="chapter">
1.75 rillig 1082: <div class="titlepage"><div><div><h2 class="title">
1083: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1084: <div class="toc">
1085: <p><b>Table of Contents</b></p>
1.210 leot 1086: <dl class="toc">
1.82 rillig 1087: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1088: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 1089: </dl>
1090: </div>
1.148 asau 1091: <div class="sect1">
1.75 rillig 1092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1093: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1094: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.82 rillig 1095: </div>
1.148 asau 1096: <div class="sect1">
1.82 rillig 1097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1098: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1099: <p>pkgsrc can be bootstrapped for use in two different modes:
1100: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1101: to privileged one all programs are installed under one particular user
1.149 asau 1102: and cannot utilise privileged operations (packages don't create
1103: special users and all special file permissions like setuid are ignored).
1104: </p>
1.82 rillig 1105: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1106: <pre class="screen">
1.167 asau 1107: <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.75 rillig 1108: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1109: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1110: </pre>
1.149 asau 1111: <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>
1112: <p>By default, in privileged mode pkgsrc uses
1113: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1114: where programs will be installed in,
1.230 sevan 1115: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 asau 1116: directory where pkgsrc will do its internal bookkeeping,
1117: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1118: where packages install their persistent data.
1119: In unprivileged mode pkgsrc uses
1120: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230 sevan 1121: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 asau 1122: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1123: </p>
1124: <p>You can change default layout using command-line arguments.
1125: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1126: </p>
1.148 asau 1127: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1128: <h3 class="title">Note</h3>
1.110 hubertf 1129: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1130: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1131: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1132: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1133: </div>
1.149 asau 1134: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1135: <h3 class="title">Note</h3>
1136: <p>It is possible to bootstrap multiple instances of pkgsrc
1137: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1138: corresponding to the installation you're working with to build
1139: and install packages.
1140: </p>
1141: </div>
1.75 rillig 1142: </div>
1143: </div>
1.148 asau 1144: <div class="chapter">
1.75 rillig 1145: <div class="titlepage"><div><div><h2 class="title">
1146: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1147: <div class="toc">
1148: <p><b>Table of Contents</b></p>
1.210 leot 1149: <dl class="toc">
1.75 rillig 1150: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1151: <dd><dl>
1152: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1153: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1154: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1155: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1156: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1157: <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>
1158: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75 rillig 1159: </dl></dd>
1160: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1161: <dd><dl>
1162: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1163: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1164: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1165: </dl></dd>
1166: </dl>
1167: </div>
1168: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1169: is to only install the package tools and to use binary packages
1.128 wiz 1170: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1171: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1172: of pkgsrc, too. Then you are able to build your own packages,
1173: and you can still use binary packages from someone else.</p>
1.148 asau 1174: <div class="sect1">
1.75 rillig 1175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1176: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1177: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1178: server and its mirrors, there are collections of binary packages,
1179: ready to be installed. These binary packages have been built using the
1180: default settings for the directories, that is:</p>
1.148 asau 1181: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1182: <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>
1183: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1184: <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.109 rillig 1185: </ul></div>
1186: <p>If you cannot use these directories for whatever reasons (maybe
1187: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1188: 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.148 asau 1189: <div class="sect2">
1.75 rillig 1190: <div class="titlepage"><div><div><h3 class="title">
1191: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1192: <p>To install binary packages, you first need to know from where
1193: to get them. The first place where you should look is on the main
1.110 hubertf 1194: 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.105 weinem 1195: <p>This directory contains binary packages for multiple
1196: platforms. First, select your operating system. (Ignore the
1197: directories with version numbers attached to it, they just exist for
1198: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1199: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1200: <p>In this directory, you often find a file called
1201: <code class="filename">bootstrap.tar.gz</code> which contains the package
1202: management tools. If the file is missing, it is likely that your
1203: operating system already provides those tools. Download the file and
1204: extract it in the <code class="filename">/</code> directory. It will create
1205: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230 sevan 1206: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1207: </div>
1.148 asau 1208: <div class="sect2">
1.75 rillig 1209: <div class="titlepage"><div><div><h3 class="title">
1210: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1211: <p>In the directory from the last section, there is a
1.196 wiz 1212: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1213: binary packages that are available for the platform, excluding those
1214: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1215: medium you are using).</p>
1.109 rillig 1216: <p>To install packages directly from an FTP or HTTP server, run
1217: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1218: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1219: <pre class="screen">
1220: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196 wiz 1221: <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.109 rillig 1222: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1223: </pre>
1224: <p>Instead of URLs, you can also use local paths, for example if
1225: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1226: repository. If you want to install packages from multiple sources,
1227: you can separate them by a semicolon in
1228: <code class="varname">PKG_PATH</code>.</p>
1229: <p>After these preparations, installing a package is very
1230: easy:</p>
1231: <pre class="screen">
1.230 sevan 1232: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1233: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.109 rillig 1234: </pre>
1.75 rillig 1235: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1236: package in question will be installed, too, assuming they are
1237: present where you install from.</p>
1.128 wiz 1238: <p>Adding packages might install vulnerable packages.
1239: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1240: regularly, especially after installing new packages, and verify
1241: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1242: <p>After you've installed packages, be sure to have
1.88 wiz 1243: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1244: <code class="varname">PATH</code> so you can actually start the just
1245: installed program.</p>
1.75 rillig 1246: </div>
1.148 asau 1247: <div class="sect2">
1.75 rillig 1248: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1249: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1250: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1251: installed from source code or from a binary package. The
1.110 hubertf 1252: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1253: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1254: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1255: name can be given with or without version number. Wildcards can
1256: also be used to deinstall a set of packages, for example
1257: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1258: so that the shell does not expand them before
1259: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1260: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1261: removes all the packages that require the package in question
1262: and then removes the package itself. For example:
1.82 rillig 1263:
1.88 wiz 1264: </p>
1.82 rillig 1265: <pre class="screen">
1.88 wiz 1266: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1267: </pre>
1.82 rillig 1268: <p>
1269:
1.88 wiz 1270: will remove jpeg and all the packages that used it; this allows
1271: upgrading the jpeg package.</p>
1.82 rillig 1272: </div>
1.148 asau 1273: <div class="sect2">
1.82 rillig 1274: <div class="titlepage"><div><div><h3 class="title">
1275: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1276: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1277: installed packages or binary package files.</p>
1.82 rillig 1278: </div>
1.148 asau 1279: <div class="sect2">
1.82 rillig 1280: <div class="titlepage"><div><div><h3 class="title">
1281: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1282: <p>
1.88 wiz 1283: The NetBSD Security-Officer and Packages Groups maintain a list of
1284: known security vulnerabilities to packages which are (or have been)
1285: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1286: 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.88 wiz 1287: </p>
1.82 rillig 1288: <p>
1.125 wiz 1289: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1290: this list can be downloaded
1291: automatically, and a security audit of all packages installed on a system
1292: can take place.
1293: </p>
1.82 rillig 1294: <p>
1.125 wiz 1295: There are two components to auditing. The first
1296: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1297: is for downloading
1.88 wiz 1298: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1299: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1300: installed packages are vulnerable. If a package is vulnerable, you
1301: will see output similar to the following:
1302: </p>
1.82 rillig 1303: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1304: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1305: <p>
1.125 wiz 1306: You may wish to have the
1.110 hubertf 1307: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1308: file downloaded daily so that
1309: it remains current. This may be done by adding an appropriate entry
1.238 leot 1310: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1311: </p>
1312: <pre class="screen">
1.233 sevan 1313: # Download vulnerabilities file
1.230 sevan 1314: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 sevan 1315: # Audit the installed packages and email results to root
1316: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1317: root >/dev/null 2>&1
1.125 wiz 1318: </pre>
1319: <p>
1.230 sevan 1320: will update the vulnerability list every day at 3AM, followed by an audit
1321: at 3:09AM. The result of the audit are then emailed to root.
1.125 wiz 1322:
1.230 sevan 1323: On NetBSD this may be accomplished instead by adding the following
1324: line to <code class="filename">/etc/daily.conf</code>:
1325: </p>
1326: <pre class="screen">
1327: fetch_pkg_vulnerabilities=YES
1328: </pre>
1329: <p>
1330: to fetch the vulnerability list from the daily security script. The system
1331: is set to audit the packages by default but can be set explicitly, if
1.235 yyamano 1332: desired (not required), by adding the following line to
1.230 sevan 1333: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1334: </p>
1335: <pre class="screen">
1.230 sevan 1336: check_pkg_vulnerabilities=YES
1.125 wiz 1337: </pre>
1338: <p>
1.238 leot 1339: see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-7.1"><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.1"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88 wiz 1340: </p>
1.82 rillig 1341: </div>
1.148 asau 1342: <div class="sect2">
1.82 rillig 1343: <div class="titlepage"><div><div><h3 class="title">
1344: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1345: <p>
1.232 sevan 1346: 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.128 wiz 1347: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1348: argument to check if your packages are up-to-date, e.g.
1349: </p>
1350: <pre class="screen">
1351: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1352: ...
1.88 wiz 1353: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1354: </pre>
1.110 hubertf 1355: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1356: package on your system and rebuild any dependencies.
1357: </p>
1.82 rillig 1358: </div>
1.148 asau 1359: <div class="sect2">
1.82 rillig 1360: <div class="titlepage"><div><div><h3 class="title">
1361: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1362: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1363: administrative functions on the package system.</p>
1.82 rillig 1364: </div>
1.75 rillig 1365: </div>
1.148 asau 1366: <div class="sect1">
1.75 rillig 1367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1368: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1369: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1370: directory now contains a set of packages, organized into
1371: categories. You can browse the online index of packages, or run
1.110 hubertf 1372: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1373: directory to build local <code class="filename">README.html</code> files for
1.232 sevan 1374: 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.88 wiz 1375: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1376: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1377: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1378: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1379: different <code class="varname">LOCALBASE</code> definitions on the same
1380: system (inside a chroot is an exception). </p>
1381: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1382: 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.88 wiz 1383: instructions how to create your own packages.</p>
1.148 asau 1384: <div class="sect2">
1.75 rillig 1385: <div class="titlepage"><div><div><h3 class="title">
1386: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1387: <p>To build packages from source, you need a working C
1.88 wiz 1388: compiler. On NetBSD, you need to install the
1.128 wiz 1389: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1390: sets. If you want to build X11-related packages, the
1.128 wiz 1391: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1392: sets are required, too.</p>
1.75 rillig 1393: </div>
1.148 asau 1394: <div class="sect2">
1.75 rillig 1395: <div class="titlepage"><div><div><h3 class="title">
1396: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1397: <p>The first step for building a package is downloading the
1.88 wiz 1398: distfiles (i.e. the unmodified source). If they have not yet been
1399: downloaded, pkgsrc will fetch them automatically.</p>
1400: <p>If you have all files that you need in the
1401: <code class="filename">distfiles</code> directory,
1402: you don't need to connect. If the distfiles are on CD-ROM, you can
1403: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1404: </p>
1.82 rillig 1405: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1406: <p>
1.110 hubertf 1407: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1408: <p>By default a list of distribution sites will be randomly
1409: intermixed to prevent huge load on servers which holding popular
1410: packages (for example, SourceForge.net mirrors). Thus, every
1411: time when you need to fetch yet another distfile all the mirrors
1412: will be tried in new (random) order. You can turn this feature
1413: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1414: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1415: <p>You can overwrite some of the major distribution sites to
1416: fit to sites that are close to your own. By setting one or two
1417: variables you can modify the order in which the master sites are
1418: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1419: delimited list of domain suffixes.
1420: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1421: contains a whitespace delimited list of regular expressions. It
1422: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1423: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1424: some examples. This may save some of your bandwidth and
1425: time.</p>
1.75 rillig 1426: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1427: if you want to keep the settings, by editing the
1.110 hubertf 1428: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1429: and adding the definitions there.</p>
1.82 rillig 1430: <p>
1.88 wiz 1431: If a package depends on many other packages (such as
1.245 wiz 1432: <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 build process may
1.88 wiz 1433: alternate between periods of
1434: downloading source, and compiling. To ensure you have all the source
1435: downloaded initially you can run the command:
1436: </p>
1.82 rillig 1437: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1438: <p>
1.88 wiz 1439: which will output and run a set of shell commands to fetch the
1440: necessary files into the <code class="filename">distfiles</code> directory. You can
1441: also choose to download the files manually.
1442: </p>
1.75 rillig 1443: </div>
1.148 asau 1444: <div class="sect2">
1.75 rillig 1445: <div class="titlepage"><div><div><h3 class="title">
1446: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1447: <p>
1.88 wiz 1448: Once the software has downloaded, any patches will be applied, then it
1449: will be compiled for you. This may take some time depending on your
1450: computer, and how many other packages the software depends on and their
1451: compile time.
1452: </p>
1.148 asau 1453: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1454: <h3 class="title">Note</h3>
1455: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1456: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1457: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1458: </div>
1.87 wiz 1459: <p>For example, type</p>
1.88 wiz 1460: <pre class="screen">
1461: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1462: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1463: </pre>
1.75 rillig 1464: <p>at the shell prompt to build the various components of the
1.88 wiz 1465: package.</p>
1.82 rillig 1466: <p>The next stage is to actually install the newly compiled
1.88 wiz 1467: program onto your system. Do this by entering:
1.82 rillig 1468:
1.88 wiz 1469: </p>
1.82 rillig 1470: <pre class="screen">
1.88 wiz 1471: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1472: </pre>
1.82 rillig 1473: <p>
1474:
1.88 wiz 1475: while you are still in the directory for whatever package you
1476: are installing.</p>
1.82 rillig 1477: <p>Installing the package on your system may require you to
1.88 wiz 1478: be root. However, pkgsrc has a
1479: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1480: to only become root for the actual installation step.</p>
1.82 rillig 1481: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1482: You can now enter:
1.82 rillig 1483:
1.88 wiz 1484: </p>
1.82 rillig 1485: <pre class="screen">
1.88 wiz 1486: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1487: </pre>
1.82 rillig 1488: <p>
1489:
1.88 wiz 1490: to remove the compiled files in the work directory, as you shouldn't need
1491: them any more. If other packages were also added to your system
1492: (dependencies) to allow your program to compile, you can tidy these up
1493: also with the command:</p>
1.82 rillig 1494: <pre class="screen">
1.88 wiz 1495: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1496: </pre>
1.75 rillig 1497: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 1498: 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.88 wiz 1499: <p>The program is installed under the default root of the
1500: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1501: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1502: variable in your environment, and it will use that value as the
1503: root of your packages tree. So, to use
1504: <code class="filename">/usr/local</code>, set
1505: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1506: Please note that you should use a directory which is dedicated to
1507: packages and not shared with other programs (i.e., do not try and
1508: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1509: to add any of your own files or directories (such as
1510: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1511: <code class="filename">pkgsrc/</code>) below the
1512: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1513: conflicts between programs and other files installed by the
1514: package system and whatever else may have been installed
1515: there.</p>
1.110 hubertf 1516: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1517: alter some configuration options at build time. Have a look at
1518: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1519: of what will be set there by default. Environment variables such
1520: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1521: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1522: set them each time you want to use pkgsrc.</p>
1.128 wiz 1523: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1524: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1525: or being installed. This may be for debugging purposes, or out of
1526: simple curiosity. A number of utility values have been added to
1527: help with this.</p>
1.128 wiz 1528: <div class="orderedlist"><ol class="orderedlist" type="1">
1529: <li class="listitem">
1.238 leot 1530: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 1531: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1532: information will be displayed. For example,</p>
1.75 rillig 1533: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1534: <p>will show all the commands that are invoked, up to and
1.128 wiz 1535: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1536: </li>
1.128 wiz 1537: <li class="listitem">
1.238 leot 1538: <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.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1539: definition, then the <code class="varname">VARNAME</code> definition
1540: should be used, in conjunction with the show-var
1.238 leot 1541: 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.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1542: variable <code class="varname">LOCALBASE</code>:</p>
1543: <pre class="screen">
1544: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1545: /usr/pkg
1546: <code class="prompt">%</code>
1.88 wiz 1547: </pre>
1.75 rillig 1548: </li>
1549: </ol></div>
1550: <p>If you want to install a binary package that you've either
1.88 wiz 1551: created yourself (see next section), that you put into
1552: pkgsrc/packages manually or that is located on a remote FTP
1553: server, you can use the "bin-install" target. This target will
1.238 leot 1554: 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.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 1555: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1556: sites searched is kept in the variable
1557: <code class="varname">BINPKG_SITES</code>, which defaults to
1.238 leot 1558: 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.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 1559: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1560: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1561: details.</p>
1562: <p>A final word of warning: If you set up a system that has a
1563: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1564: set that before any packages are installed, as you cannot use
1565: several directories for the same purpose. Doing so will result in
1566: pkgsrc not being able to properly detect your installed packages,
1567: and fail miserably. Note also that precompiled binary packages are
1568: usually built with the default <code class="varname">LOCALBASE</code> of
1569: <code class="filename">/usr/pkg</code>, and that you should
1570: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1571: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 1572: </div>
1573: </div>
1574: </div>
1.148 asau 1575: <div class="chapter">
1.75 rillig 1576: <div class="titlepage"><div><div><h2 class="title">
1577: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
1578: <div class="toc">
1579: <p><b>Table of Contents</b></p>
1.210 leot 1580: <dl class="toc">
1.75 rillig 1581: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
1582: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 1583: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 1584: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 1585: <dd><dl>
1.103 wiz 1586: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 1587: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1588: <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.88 wiz 1589: </dl></dd>
1.103 wiz 1590: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
1591: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 1592: </dl>
1593: </div>
1.104 rillig 1594: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 1595: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1596: that file depends on the installation. On NetBSD, when you use
1.238 leot 1597: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 1598: <code class="filename">/etc/</code>. In all other cases the default location is
1599: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1600: bootstrap program to install the binary packages.</p>
1601: <p>The format of the configuration file is that of the usual
1602: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1603: is done by setting variables in this file. Note that you can define all
1604: kinds of variables, and no special error checking (for example for
1.223 rillig 1605: spelling mistakes) takes place.</p>
1.148 asau 1606: <div class="sect1">
1.75 rillig 1607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1608: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.223 rillig 1609: <p>The following variables apply to all
1.89 rillig 1610: pkgsrc packages. A complete list of the variables that can be
1611: configured by the user is available in
1612: <code class="filename">mk/defaults/mk.conf</code>, together with some
1613: comments that describe each variable's intent.</p>
1.148 asau 1614: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1615: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1616: packages will be installed. The default is
1.76 rillig 1617: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1618: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 1619: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1620: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 1621: installed. The default is
1.76 rillig 1622: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1623: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1624: X11 is installed on the system. The default is
1.194 bsiegert 1625: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1626: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1627: downloaded copies of the original source distributions used
1628: for building pkgsrc packages. The default is
1.76 rillig 1629: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1630: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1631: database about installed packages is stored. The default is
1.230 sevan 1632: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1633: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1634: If set, override the packages'
1635: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1636: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1637: Backup location(s) for distribution files and patch files
1638: if not found locally or in
1.76 rillig 1639: <code class="filename">${MASTER_SITES}</code> or
1640: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1641: The defaults is
1642: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1643: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 1644: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1645: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 1646: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1647: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1648: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 1649: List of acceptable licenses. License names are case-sensitive.
1650: Whenever you try to build a package whose license is not in this
1651: list, you will get an error message. If the license condition is
1652: simple enough, the error message will include specific
1653: instructions on how to change this variable.</p></li>
1.75 rillig 1654: </ul></div>
1655: </div>
1.148 asau 1656: <div class="sect1">
1.75 rillig 1657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1658: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1659: <p>
1.75 rillig 1660: </p>
1.148 asau 1661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1662: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1663: directory for the binary packages. The default is
1.76 rillig 1664: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1665: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1666: The top level directory where, if defined, the separate
1667: working directories will get created, and symbolically
1.76 rillig 1668: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1669: This is useful for building packages on several
1.76 rillig 1670: architectures, then <code class="filename">${PKGSRCDIR}</code>
1671: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 1672: is local to every architecture. (It should be noted that
1673: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 1674: — it is an internal definition which refers to the
1.75 rillig 1675: root of the pkgsrc tree. It is possible to have many
1676: pkgsrc tree instances.)</p></li>
1.128 wiz 1677: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1678: Directory for local patches that aren't part of pkgsrc.
1.219 rillig 1679: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> for more
1.93 rillig 1680: information.</p></li>
1.128 wiz 1681: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1682: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1683: BSD-style Makefile. If this is not set,
1684: <code class="varname">MAKECONF</code> is set to
1.76 rillig 1685: <code class="filename">/dev/null</code> to avoid picking up
1686: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 1687: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 1688: By default, dependencies are only installed, and no binary
1689: package is created for them. You can set this variable to
1.174 asau 1690: <code class="literal">package-install</code> to automatically create binary
1.190 wiz 1691: packages after installing dependencies. Please note that the
1.194 bsiegert 1692: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.190 wiz 1693: <code class="literal">yes</code> to preserve binary packages when
1694: using the <code class="literal">install</code> as well.</p></li>
1.75 rillig 1695: </ul></div>
1696: </div>
1.148 asau 1697: <div class="sect1">
1.75 rillig 1698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 1699: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.217 jnemeth 1700: <p>Packages have to support installation into a
1.103 wiz 1701: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1702: to be built, before the actual filesystem is touched. DESTDIR
1703: support exists in two variations:</p>
1.148 asau 1704: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1705: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 1706: installation and packaging is still run as root.</p></li>
1707: <li class="listitem"><p>Full DESTDIR support can run the complete
1708: build, installation and packaging as normal user. Root
1709: privileges are only needed to add packages.</p></li>
1710: </ul></div>
1.103 wiz 1711: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1712: clean</code></strong> needs to be run as root.</p>
1.118 imil 1713: <p>Considering the <code class="filename">foo/bar</code> package,
1714: DESTDIR full support can be tested using the following commands
1715:
1716: </p>
1717: <pre class="programlisting">
1718: <code class="prompt">$</code> id
1719: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1720: <code class="prompt">$</code> mkdir $HOME/packages
1721: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1722: </pre>
1723: <p>
1724:
1725: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1726: should be needed
1727:
1728: </p>
1729: <pre class="programlisting">
1.174 asau 1730: <code class="prompt">$</code> make stage-install
1.118 imil 1731: </pre>
1732: <p>
1733:
1734: Create a package without root privileges
1735:
1736: </p>
1737: <pre class="programlisting">
1.174 asau 1738: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1739: </pre>
1740: <p>
1741:
1742: For the following command, you must be able to gain root
1.238 leot 1743: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 1744:
1745: </p>
1746: <pre class="programlisting">
1.174 asau 1747: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 1748: </pre>
1749: <p>
1750:
1751: Then, as a simple user
1752:
1753: </p>
1754: <pre class="programlisting">
1755: <code class="prompt">$</code> make clean
1756: </pre>
1757: <p>
1758:
1759: </p>
1.103 wiz 1760: </div>
1.148 asau 1761: <div class="sect1">
1.103 wiz 1762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1763: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1764: <div class="sect2">
1.78 rillig 1765: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 1766: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 1767: <p>By default, pkgsrc will use GCC to build packages. This may be
1768: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 1769: <div class="variablelist"><dl class="variablelist">
1.89 rillig 1770: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1771: <dd>
1772: <p>This is a list of values specifying the chain of
1773: compilers to invoke when building packages. Valid values
1774: are:</p>
1.148 asau 1775: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 1776: <li class="listitem"><p><code class="varname">ccc</code>:
1777: Compaq C Compilers (Tru64)</p></li>
1778: <li class="listitem"><p><code class="varname">ccache</code>:
1779: compiler cache (chainable)</p></li>
1780: <li class="listitem"><p><code class="varname">clang</code>:
1781: Clang C and Objective-C compiler</p></li>
1.128 wiz 1782: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1783: distributed C/C++ (chainable)</p></li>
1.174 asau 1784: <li class="listitem"><p><code class="varname">f2c</code>:
1785: Fortran 77 to C compiler (chainable)</p></li>
1786: <li class="listitem"><p><code class="varname">icc</code>:
1787: Intel C++ Compiler (Linux)</p></li>
1788: <li class="listitem"><p><code class="varname">ido</code>:
1789: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 1790: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1791: GNU C/C++ Compiler</p></li>
1.174 asau 1792: <li class="listitem"><p><code class="varname">hp</code>:
1793: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1794: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1795: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1796: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1797: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1798: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1799: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1800: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1801: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1802: </ul></div>
1803: <p>The default is
1.128 wiz 1804: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 1805: <code class="varname">ccache</code> and/or
1806: <code class="varname">distcc</code> with an appropriate
1807: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 1808: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1809: variable should always be terminated with a value for
1810: a real compiler. Note that only one real compiler
1.128 wiz 1811: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1812: is not allowed).</p>
1.89 rillig 1813: </dd>
1814: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1815: <dd><p>This specifies the minimum version of GCC to use
1816: when building packages. If the system GCC doesn't
1817: satisfy this requirement, then pkgsrc will build and
1818: install one of the GCC packages to use instead.</p></dd>
1.225 maya 1819: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
1820: <dd><p>Specifies which version of python to use when several
1821: options are available.</p></dd>
1822: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1823: <dd><p>Specifies the fortran compiler to use.
1824: The default is <code class="varname">g95</code>, and
1825: <code class="varname">gfortran</code> is an alternative.</p></dd>
1826: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1827: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1828: <code class="varname">gfortran</code> is used, this option specifies which
1829: version to use.</p></dd>
1.89 rillig 1830: </dl></div>
1831: </div>
1.148 asau 1832: <div class="sect2">
1.89 rillig 1833: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 1834: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 1835: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1836: please make sure to use the <code class="literal">+=</code> operator
1837: instead of the <code class="literal">=</code> operator:</p>
1838: <pre class="programlisting">
1.100 rillig 1839: CFLAGS+= -your -flags
1.78 rillig 1840: </pre>
1841: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 1842: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 1843: need to add their own flags. You may want to take a look
1.232 sevan 1844: 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.128 wiz 1845: package if you're interested in optimization specifically
1846: for the current CPU. </p>
1.78 rillig 1847: </div>
1.148 asau 1848: <div class="sect2">
1.88 wiz 1849: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 1850: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 1851: <p>If you want to pass flags to the linker, both in the configure
1852: step and the build step, you can do this in two ways. Either set
1853: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1854: between the two is that <code class="varname">LIBS</code> will be appended to
1855: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1856: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1857: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1858: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1859: <code class="varname">CFLAGS</code>, if you do not wish to override these
1860: settings, use the <code class="literal">+=</code> operator:</p>
1861: <pre class="programlisting">
1.100 rillig 1862: LDFLAGS+= -your -linkerflags
1.88 wiz 1863: </pre>
1864: </div>
1.78 rillig 1865: </div>
1.148 asau 1866: <div class="sect1">
1.78 rillig 1867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 1868: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 1869: <p>
1.75 rillig 1870: </p>
1.148 asau 1871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1872: <li class="listitem">
1.75 rillig 1873: <p><code class="varname">PKG_DEVELOPER</code>:
1874: Run some sanity checks that package developers want:
1875: </p>
1.148 asau 1876: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 1877: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 1878: fuzz</p></li>
1.128 wiz 1879: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 1880: binaries will find their shared libs.</p></li>
1.75 rillig 1881: </ul></div>
1882: <p>
1.87 wiz 1883: </p>
1.75 rillig 1884: </li>
1.128 wiz 1885: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 1886: of debugging output which is displayed whilst making and
1887: installing the package. The default value for this is 0,
1888: which will not display the commands as they are executed
1889: (normal, default, quiet operation); the value 1 will display
1890: all shell commands before their invocation, and the value 2
1891: will display both the shell commands before their invocation,
1.223 rillig 1892: as well as their actual execution progress with <span class="command"><strong>set
1893: -x</strong></span>.</p></li>
1.75 rillig 1894: </ul></div>
1895: <p>
1896: </p>
1897: </div>
1.148 asau 1898: <div class="sect1">
1.75 rillig 1899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 1900: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 1901: <p>Some packages have build time options, usually to select
1902: between different dependencies, enable optional support for big
1903: dependencies or enable experimental features.</p>
1.75 rillig 1904: <p>To see which options, if any, a package supports, and which
1.110 hubertf 1905: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 1906: show-options</strong></span>, for example:</p>
1.75 rillig 1907: <pre class="programlisting">
1908: The following options are supported by this package:
1909: ssl Enable SSL support.
1910: Exactly one of the following gecko options is required:
1911: firefox Use firefox as gecko rendering engine.
1912: mozilla Use mozilla as gecko rendering engine.
1913: At most one of the following database options may be selected:
1914: mysql Enable support for MySQL database.
1915: pgsql Enable support for PostgreSQL database.
1.1 grant 1916:
1.75 rillig 1917: These options are enabled by default: firefox
1918: These options are currently enabled: mozilla ssl
1.1 grant 1919: </pre>
1.75 rillig 1920: <p>The following variables can be defined in
1.110 hubertf 1921: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 1922: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1923: which can be used to select or disable options for all packages
1924: that support them, and
1925: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1926: which can be used to select or disable options specifically for
1927: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 1928: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 1929: are disabled. A few examples:</p>
1.75 rillig 1930: <pre class="screen">
1.110 hubertf 1931: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75 rillig 1932: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1933: PKG_OPTIONS.kdebase= debug -sasl
1934: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 1935: <p>It is important to note that options that were specifically
1.120 snj 1936: suggested by the package maintainer must be explicitly removed if
1.111 rillig 1937: you do not wish to include the option. If you are unsure you can view
1938: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 1939: <p>The following settings are consulted in the order given, and
1940: the last setting that selects or disables an option is
1941: used:</p>
1.128 wiz 1942: <div class="orderedlist"><ol class="orderedlist" type="1">
1943: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 1944: maintainer</p></li>
1.128 wiz 1945: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 1946: variables (see below)</p></li>
1.128 wiz 1947: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1948: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 1949: </ol></div>
1950: <p>For groups of mutually exclusive options, the last option
1.88 wiz 1951: selected is used, all others are automatically disabled. If an
1952: option of the group is explicitly disabled, the previously
1953: selected option, if any, is used. It is an error if no option
1954: from a required group of options is selected, and building the
1955: package will fail.</p>
1956: <p>Before the options framework was introduced, build options
1957: were selected by setting a variable (often named
1958: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 1959: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 1960: transition to the options framework for the user, these legacy
1961: variables are converted to the appropriate options setting
1962: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1963: automatically. A warning is issued to prompt the user to update
1.110 hubertf 1964: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 1965: directly. Support for the legacy variables will be removed
1966: eventually.</p>
1.75 rillig 1967: </div>
1968: </div>
1.148 asau 1969: <div class="chapter">
1.75 rillig 1970: <div class="titlepage"><div><div><h2 class="title">
1971: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
1972: <div class="toc">
1973: <p><b>Table of Contents</b></p>
1.210 leot 1974: <dl class="toc">
1.75 rillig 1975: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
1976: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1977: </dl>
1978: </div>
1.148 asau 1979: <div class="sect1">
1.75 rillig 1980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1981: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 1982: <p>Once you have built and installed a package, you can create
1983: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.238 leot 1984: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 1985: the same package on a group of hosts and wasting CPU time. It also
1986: provides a simple means for others to install your package, should
1987: you distribute it.</p>
1988: <p>To create a binary package, change into the appropriate
1.110 hubertf 1989: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 1990: package</strong></span>:</p>
1991: <pre class="screen">
1.223 rillig 1992: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1993: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
1994: </pre>
1.87 wiz 1995: <p>This will build and install your package (if not already done),
1996: and then build a binary package from what was installed. You can
1.110 hubertf 1997: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 1998: it. Binary packages are created by default in
1999: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2000: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.232 sevan 2001: 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.110 hubertf 2002: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2003: such a binary package.</p>
1.75 rillig 2004: </div>
1.148 asau 2005: <div class="sect1">
1.75 rillig 2006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2007: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2008: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.106 rillig 2009: </div>
2010: </div>
1.148 asau 2011: <div class="chapter">
1.106 rillig 2012: <div class="titlepage"><div><div><h2 class="title">
2013: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2014: builds)</h2></div></div></div>
2015: <div class="toc">
2016: <p><b>Table of Contents</b></p>
1.210 leot 2017: <dl class="toc">
1.180 wiz 2018: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2019: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2020: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2021: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 2022: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2023: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2024: </dl>
2025: </div>
1.180 wiz 2026: <p>For a number of reasons you may want to build binary packages
2027: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2028: For instance, when you have multiple machines that should run the same software,
2029: it is wasted time if they all build their packages themselves from source.
2030: Or you may want to build a list of packages you want and check them before
2031: deploying onto production system.
2032: There is a way of getting a set of binary packages:
1.223 rillig 2033: The bulk build system, or pbulk ("p" stands for "parallel").
2034: This chapter describes how to set it up.</p>
1.148 asau 2035: <div class="sect1">
1.106 rillig 2036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2037: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2038: <p>First of all, you have to decide whether you build all packages
2039: or a limited set of them. Full bulk builds usually consume a lot more resources,
2040: both space and time, than builds for some practical sets of packages.
2041: There exists a number of particularly heavy packages that are not actually
2042: interesting to a wide audience.
2043:
2044: For a limited bulk builds you need to make a list of packages you want to build.
1.223 rillig 2045: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 wiz 2046: </p>
2047: <p>During bulk builds various packages are installed and deinstalled
2048: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2049: so make sure that you don't need any package during the builds.
1.223 rillig 2050: Essentially, you should provide a fresh system, either a chroot environment
1.180 wiz 2051: or something even more restrictive, depending on what the operating system provides,
2052: or dedicate the whole physical machine.
2053: As a useful side effect this makes sure that bulk builds cannot
2054: break anything in your system. There have been numerous cases where
1.106 rillig 2055: certain packages tried to install files outside the
2056: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2057: <code class="filename">/etc</code>.
2058: </p>
1.106 rillig 2059: </div>
1.148 asau 2060: <div class="sect1">
1.106 rillig 2061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2062: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2063: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2064: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2065: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2066: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2067: </ul></div>
1.148 asau 2068: <div class="sect2">
1.116 rillig 2069: <div class="titlepage"><div><div><h3 class="title">
1.180 wiz 2070: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.223 rillig 2071: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 asau 2072: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2073: Configure network access to fetch distribution files.
1.223 rillig 2074: Create a user with name "pbulk".</p>
1.178 asau 2075: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2076: <pre class="screen">
1.181 wiz 2077: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && ftp -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2078: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2079: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178 asau 2080: </pre>
2081: <p>Or any other way that fits (e.g., curl, wget).</p>
2082: <p>Deploy and configure pbulk tools, e.g.:</p>
2083: <pre class="screen">
1.230 sevan 2084: <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.178 asau 2085: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
2086: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2087: </pre>
2088: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2089: <h3 class="title">Note</h3>
2090: <p><code class="filename">mk.conf.frag</code> is a fragment of
2091: <code class="filename">mk.conf</code> that contains settings you want to
2092: apply to packages you build. For instance,</p>
2093: <pre class="programlisting">
1.223 rillig 2094: PKG_DEVELOPER= yes # perform more checks
2095: X11_TYPE= modular # use pkgsrc X11
2096: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2097: # when building all packages)
1.178 asau 2098: </pre>
2099: </div>
2100: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223 rillig 2101: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2102: <pre class="programlisting">
2103: www/firefox
2104: mail/thunderbird
2105: misc/libreoffice4
2106: </pre>
1.179 asau 2107: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2108: and make final amendments, if wanted.</p>
1.178 asau 2109: <p>Start it:</p>
2110: <pre class="screen">
2111: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2112: </pre>
2113: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2114: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2115: </p>
2116: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2117: <h3 class="title">Note</h3>
2118: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2119: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2120: The script is kept small enough for better understanding.</p>
2121: </div>
2122: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2123: <h3 class="title">Note</h3>
2124: <p>The <code class="filename">pbulk.sh</code> script supports running
2125: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2126: </div>
1.106 rillig 2127: </div>
2128: </div>
1.148 asau 2129: <div class="sect1">
1.106 rillig 2130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2131: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2132: <p>A complete bulk build requires lots of disk space. Some of the
2133: disk space can be read-only, some other must be writable. Some can be on
2134: remote filesystems (such as NFS) and some should be local. Some can be
2135: temporary filesystems, others must survive a sudden reboot.</p>
2136: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2137: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2138: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2139: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2140: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2141: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2142: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2143: </ul></div>
2144: </div>
2145: <div class="sect1">
2146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2147: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2148: <p>After your pkgsrc bulk-build has completed, you may wish to
2149: create a CD-ROM set of the resulting binary packages to assist
2150: in installing packages on other machines. The
1.232 sevan 2151: <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.87 wiz 2152: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2153: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2154: way that keeps all the dependencies for a given package on the same
2155: CD as that package.</p>
1.148 asau 2156: <div class="sect2">
1.75 rillig 2157: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2158: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2159: <p>Complete documentation for cdpack is found in the cdpack(1)
2160: man page. The following short example assumes that the binary
2161: packages are left in
2162: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2163: sufficient disk space exists in <code class="filename">/u2</code> to
2164: hold the ISO 9660 images.</p>
2165: <pre class="screen">
2166: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2167: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2168: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2169: </pre>
2170: <p>If you wish to include a common set of files
2171: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2172: etc.) on each CD in the collection, then you need to create a
2173: directory which contains these files. e.g.</p>
2174: <pre class="screen">
2175: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2176: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2177: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2178: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2179: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2180: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2181: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2182: </pre>
1.75 rillig 2183: <p>Now create the images:</p>
2184: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76 rillig 2185: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2186: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2187: in their root directories.</p>
1.75 rillig 2188: </div>
2189: </div>
2190: </div>
1.148 asau 2191: <div class="chapter">
1.75 rillig 2192: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2193: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2194: <div class="toc">
2195: <p><b>Table of Contents</b></p>
1.210 leot 2196: <dl class="toc">
1.128 wiz 2197: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2198: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90 rillig 2199: </dl>
2200: </div>
2201: <p>The files that are installed by pkgsrc are organized in a way that
2202: is similar to what you find in the <code class="filename">/usr</code> directory
2203: of the base system. But some details are different. This is because
2204: pkgsrc initially came from FreeBSD and had adopted its file system
2205: hierarchy. Later it was largely influenced by NetBSD. But no matter
2206: which operating system you are using pkgsrc with, you can expect the
2207: same layout for pkgsrc.</p>
1.91 rillig 2208: <p>There are mainly four root directories for pkgsrc, which are all
2209: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2210: When pkgsrc has been installed as root, the default locations
2211: are:</p>
2212: <pre class="programlisting">
1.100 rillig 2213: LOCALBASE= /usr/pkg
2214: PKG_SYSCONFBASE= /usr/pkg/etc
2215: VARBASE= /var
1.231 sevan 2216: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 2217: </pre>
2218: <p>In unprivileged mode (when pkgsrc has been installed as any other
2219: user), the default locations are:</p>
2220: <pre class="programlisting">
1.100 rillig 2221: LOCALBASE= ${HOME}/pkg
2222: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2223: VARBASE= ${HOME}/pkg/var
1.231 sevan 2224: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2225: </pre>
2226: <p>What these four directories are for, and what they look like is
2227: explained below.</p>
1.148 asau 2228: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2229: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2230: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2231: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2232: the well-known subdirectories like <code class="filename">bin</code>,
2233: <code class="filename">include</code>, <code class="filename">lib</code>,
2234: <code class="filename">share</code> and
2235: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2236: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2237: <code class="filename">/var</code> in the base system. Some programs (especially
2238: games, network daemons) need write access to it during normal
2239: operation.</p></li>
1.128 wiz 2240: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2241: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2242: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 2243: itself.</p></li>
2244: </ul></div>
1.148 asau 2245: <div class="sect1">
1.90 rillig 2246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2247: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2248: </h2></div></div></div>
1.90 rillig 2249: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2250: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2251: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2252: <dt><span class="term"><code class="filename">bin</code></span></dt>
2253: <dd><p>Contains executable programs that are intended to be
2254: directly used by the end user.</p></dd>
2255: <dt><span class="term"><code class="filename">emul</code></span></dt>
2256: <dd><p>Contains files for the emulation layers of various other
2257: operating systems, especially for
2258: NetBSD.</p></dd>
2259: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2260: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2261: <dd><p>Contains
2262: the configuration files.</p></dd>
2263: <dt><span class="term"><code class="filename">include</code></span></dt>
2264: <dd><p>Contains headers for the C and C++ programming
2265: languages.</p></dd>
2266: <dt><span class="term"><code class="filename">info</code></span></dt>
2267: <dd><p>Contains GNU info files of various
2268: packages.</p></dd>
2269: <dt><span class="term"><code class="filename">lib</code></span></dt>
2270: <dd><p>Contains shared and static
2271: libraries.</p></dd>
2272: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2273: <dd><p>Contains data files that don't change after
2274: installation. Other data files belong into
2275: <code class="filename">${VARBASE}</code>.</p></dd>
2276: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2277: <dd><p>Contains programs that are not intended to be used by
2278: end users, such as helper programs or network
2279: daemons.</p></dd>
2280: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2281: <dd><p>Contains programs that are intended to be executed as
2282: CGI scripts by a web server.</p></dd>
2283: <dt><span class="term"><code class="filename">man</code> (the usual value of
2284: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2285: <dd><p>Contains brief
2286: documentation in form of manual pages.</p></dd>
2287: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2288: <dd><p>Contains programs that are intended to be used only by
2289: the super-user.</p></dd>
2290: <dt><span class="term"><code class="filename">share</code></span></dt>
2291: <dd><p>Contains platform-independent data files that don't
2292: change after installation.</p></dd>
2293: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2294: <dd><p>Contains documentation files provided by the
2295: packages.</p></dd>
2296: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2297: <dd><p>Contains example files provided by the packages. Among
2298: others, the original configuration files are saved here and copied to
2299: <code class="filename">${PKG_SYSCONFDIR}</code> during
2300: installation.</p></dd>
2301: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2302: <dd><p>Contains the original files for rc.d
2303: scripts.</p></dd>
2304: <dt><span class="term"><code class="filename">var</code> (the usual location of
2305: <code class="filename">${VARBASE}</code>)</span></dt>
2306: <dd><p>Contains files
2307: that may be modified after
2308: installation.</p></dd>
2309: </dl></div>
2310: </div>
1.148 asau 2311: <div class="sect1">
1.90 rillig 2312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2313: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2314: </h2></div></div></div>
1.148 asau 2315: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2316: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2317: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2318: <dd><p>Contains
2319: information about the currently installed
2320: packages.</p></dd>
2321: <dt><span class="term"><code class="filename">games</code></span></dt>
2322: <dd><p>Contains highscore
2323: files.</p></dd>
2324: <dt><span class="term"><code class="filename">log</code></span></dt>
2325: <dd><p>Contains log files.</p></dd>
2326: <dt><span class="term"><code class="filename">run</code></span></dt>
2327: <dd><p>Contains informational files about daemons that are
2328: currently running.</p></dd>
2329: </dl></div>
2330: </div>
2331: </div>
1.148 asau 2332: <div class="chapter">
1.90 rillig 2333: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2334: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2335: <div class="toc">
2336: <p><b>Table of Contents</b></p>
1.210 leot 2337: <dl class="toc">
1.106 rillig 2338: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194 bsiegert 2339: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2340: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2341: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2342: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2343: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2344: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2345: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2346: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2347: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2348: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 2349: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
2350: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2351: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2352: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2353: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2354: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2355: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 2356: </dl>
2357: </div>
2358: <p>This section contains hints, tips & tricks on special things in
2359: pkgsrc that we didn't find a better place for in the previous chapters, and
2360: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2361: <div class="sect1">
1.75 rillig 2362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2363: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2364: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2365: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2366: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 2367: This is a general purpose list for most issues regarding
2368: pkgsrc, regardless of platform, e.g. soliciting user help
2369: for pkgsrc configuration, unexpected build failures, using
2370: particular packages, upgrading pkgsrc installations,
2371: questions regarding the pkgsrc release branches, etc. General announcements or
2372: proposals for changes that impact the pkgsrc user community,
2373: e.g. major infrastructure changes, new features, package
2374: removals, etc., may also be posted.</p></li>
1.128 wiz 2375: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 2376: A list where the results of pkgsrc bulk builds are sent and
2377: discussed.</p></li>
1.128 wiz 2378: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 2379: This list is for those who are interested in getting a
2380: commit message for every change committed to pkgsrc. It is
2381: also available in digest form, meaning one daily message
2382: containing all commit messages for changes to the package
2383: source tree in that 24 hour period.</p></li>
2384: </ul></div>
2385: <p>To subscribe, do:</p>
2386: <pre class="programlisting">
1.100 rillig 2387: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2388: </pre>
2389: <p>Archives for all these mailing lists are available from
1.110 hubertf 2390: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2391: </div>
1.148 asau 2392: <div class="sect1">
1.75 rillig 2393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2394: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2395: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2396: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2397: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 2398: they might be useful, and not to duplicate the documentation that comes
2399: with each package.</p>
2400: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.232 sevan 2401: <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.75 rillig 2402: Symlinks for use by buildlink.</p></li></ul></div>
2403: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2404: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232 sevan 2405: <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.233 sevan 2406: Calculates various kinds of checksums (including SHA3).</p></li>
1.232 sevan 2407: <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.75 rillig 2408: Compatibility library for pkgsrc tools.</p></li>
1.232 sevan 2409: <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.87 wiz 2410: non-BSD systems due to lack of native mtree.</p></li>
1.232 sevan 2411: <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.75 rillig 2412: Up-to-date replacement for
1.76 rillig 2413: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2414: systems where pkg_install is not present.</p></li>
2415: </ul></div>
2416: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2417: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232 sevan 2418: <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.75 rillig 2419: Create a binary package from an
1.110 hubertf 2420: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2421: save the old package.</p></li>
1.232 sevan 2422: <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.75 rillig 2423: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2424: from multiple locations. It currently supports the following
2425: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.232 sevan 2426: <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.117 jnemeth 2427: the best compiler flags to optimise code for your current
1.128 wiz 2428: CPU and compiler. </p></li>
1.75 rillig 2429: </ul></div>
2430: <p>Utilities for keeping track of installed packages, being up to date,
2431: etc:</p>
1.148 asau 2432: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232 sevan 2433: <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.173 wiz 2434: update tool similar to apt(1). Download, install, and upgrade
2435: binary packages easily.</p></li>
1.232 sevan 2436: <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.75 rillig 2437: packages whose installed versions do not match the latest pkgsrc
2438: entries.</p></li>
1.232 sevan 2439: <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.75 rillig 2440: dependency graphs of packages, to aid in choosing a strategy for
2441: updating.</p></li>
1.232 sevan 2442: <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
2443: 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>
2444: <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.112 weinem 2445: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.232 sevan 2446: <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.75 rillig 2447: does various checks on the complete pkgsrc system.</p></li>
1.232 sevan 2448: <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.75 rillig 2449: packages you have installed.</p></li>
2450: </ul></div>
2451: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2452: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232 sevan 2453: <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.75 rillig 2454: making and maintaining patches for a package (includes pkgdiff,
2455: pkgvi, mkpatches, etc.).</p></li>
1.232 sevan 2456: <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.75 rillig 2457: converting to pkgsrc.</p></li>
2458: </ul></div>
2459: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2460: utilities)</p>
1.148 asau 2461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232 sevan 2462: <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.75 rillig 2463: packages in a chrooted area.</p></li>
1.232 sevan 2464: <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.75 rillig 2465: kernel version for chrooted cross builds.</p></li>
2466: </ul></div>
2467: </div>
1.148 asau 2468: <div class="sect1">
1.75 rillig 2469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2470: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2471: <p>To install packages from source as a non-root user, download
2472: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
2473: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2474: --unprivileged</strong></span>.</p>
2475: <p>This will install the binary part of pkgsrc to
2476: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2477: into <code class="filename">~/pkg/etc</code>.</p>
2478: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75 rillig 2479: </div>
1.148 asau 2480: <div class="sect1">
1.75 rillig 2481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2482: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 2483: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2484: enable this feature by adding the option
2485: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 2486: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2487: distfile is found, pkgsrc will try to resume it.</p>
2488: <p>You can also
1.168 wiz 2489: use a different program than the platform default program by changing the
1.117 jnemeth 2490: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2491: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2492: by using the value manual. A value of custom disables the system defaults
2493: and dependency tracking for the fetch program. In that case you have to
2494: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2495: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2496: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 2497: <p>For example, if you want to use
1.117 jnemeth 2498: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2499: like:</p>
2500: <pre class="programlisting">
1.223 rillig 2501: FETCH_USING= wget
1.1 grant 2502: </pre>
1.75 rillig 2503: </div>
1.148 asau 2504: <div class="sect1">
1.75 rillig 2505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2506: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 2507: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2508: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2509: you will have to add the following line into
1.110 hubertf 2510: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2511: <pre class="programlisting">
1.103 wiz 2512: X11_TYPE=modular
1.1 grant 2513: </pre>
1.75 rillig 2514: </div>
1.148 asau 2515: <div class="sect1">
1.75 rillig 2516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2517: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 2518: <p>If you are sitting behind a firewall which does not allow direct
2519: connections to Internet hosts (i.e. non-NAT), you may specify the
2520: relevant proxy hosts. This is done using an environment variable in the
2521: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 2522: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2523: port 80 as the proxy port number. So the proxy environment variables
2524: are:</p>
2525: <pre class="programlisting">
1.100 rillig 2526: ftp_proxy=ftp://orpheus.amdahl.com:80/
2527: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2528: </pre>
1.75 rillig 2529: </div>
1.148 asau 2530: <div class="sect1">
1.75 rillig 2531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2532: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 2533: <p>Some fetch tools are not prepared to support HTTPS by default
2534: (for example, the one in NetBSD 6.0), or the one installed by the
2535: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2536: dependency graph).</p>
2537: <p>Usually you won't notice, because distribution files are
2538: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2539: be often enough if you are following pkgsrc-current. In that case, set
2540: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2541: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2542: with HTTPS support by default. Of course, these tools need to be
2543: installed before you can use them this way.</p>
2544: </div>
2545: <div class="sect1">
2546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2547: <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.75 rillig 2548: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2549: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2550: the first available command from the following list:</p>
1.148 asau 2551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2552: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2553: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 2554: </ul></div>
2555: <p>On a default NetBSD installation, this will be
1.76 rillig 2556: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 2557: connections first, and falls back to active connections if the server
2558: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 2559: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2560: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2561: <p>Having that option present will prevent
1.76 rillig 2562: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2563: transfers.</p>
2564: </div>
1.148 asau 2565: <div class="sect1">
1.75 rillig 2566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2567: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 2568: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 2569: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 2570: 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.75 rillig 2571: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 2572: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 2573: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 2574: resulting list to your machine at work/school and use it there. If you
1.238 leot 2575: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 2576: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2577: URL:</p>
2578: <p>At home:</p>
2579: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2580: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2581: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2582: <p>At work:</p>
2583: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 2584: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 2585: home.</p>
2586: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 2587: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2588: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 2589: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 2590: directly by running:</p>
1.75 rillig 2591: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2592: <p>If you even decide to ignore
2593: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2594: by running:</p>
2595: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2596: </div>
1.148 asau 2597: <div class="sect1">
1.75 rillig 2598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2599: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2600: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.232 sevan 2601: <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.75 rillig 2602: package, you get the error from make that it doesn't know how to make
1.76 rillig 2603: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 2604: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 2605: the NetBSD base distribution on your machine. It is recommended to do
2606: that to format man pages.</p>
1.232 sevan 2607: <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.75 rillig 2608: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 2609: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 2610: </div>
1.148 asau 2611: <div class="sect1">
1.75 rillig 2612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2613: <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.87 wiz 2614: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 2615: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 2616: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 2617: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2618: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 2619: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 2620: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 2621: -r</strong></span>).</p>
2622: </div>
1.148 asau 2623: <div class="sect1">
1.75 rillig 2624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2625: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 2626: <p>When installing packages as non-root user and using the just-in-time
1.238 leot 2627: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75 rillig 2628: password for each required package installed. To avoid this, the sudo
2629: package can be used, which does password caching over a limited time. To
2630: use it, install sudo (either as binary package or from
1.232 sevan 2631: <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.110 hubertf 2632: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 2633: <span class="emphasis"><em>after</em></span> the definition of the
2634: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 2635: <pre class="programlisting">
1.100 rillig 2636: .if exists(${LOCALBASE}/bin/sudo)
2637: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2638: .endif
1.1 grant 2639: </pre>
1.75 rillig 2640: </div>
1.148 asau 2641: <div class="sect1">
1.75 rillig 2642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2643: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 2644: <p>As the system administrator, you can choose where configuration files
2645: are installed. The default settings make all these files go into
1.76 rillig 2646: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 2647: be suboptimal depending on your expectations (e.g., a read-only,
2648: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2649: configuration of the provided packages).</p>
2650: <p>In order to change the defaults, you can modify the
2651: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 2652: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 2653: directory; some common examples include <code class="filename">/etc</code> or
2654: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 2655: <p>Furthermore, you can change this value on a per-package basis by
2656: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2657: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2658: package you would like to modify, that is, the contents of
2659: <code class="varname">PKGBASE</code>.</p>
2660: <p>Note that after changing these settings, you must rebuild and
2661: reinstall any affected packages.</p>
2662: </div>
1.148 asau 2663: <div class="sect1">
1.75 rillig 2664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2665: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 2666: <p>Please be aware that there can often be bugs in third-party software,
2667: and some of these bugs can leave a machine vulnerable to exploitation by
2668: attackers. In an effort to lessen the exposure, the NetBSD packages team
2669: maintains a database of known-exploits to packages which have at one time
2670: been included in pkgsrc. The database can be downloaded automatically, and
2671: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 2672: do this, refer to the following two tools (installed as part of the
1.232 sevan 2673: <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.128 wiz 2674: <div class="orderedlist"><ol class="orderedlist" type="1">
2675: <li class="listitem">
1.122 reed 2676: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 2677: download a list of the security vulnerabilities information. This list
1.132 spz 2678: is kept up to date by the pkgsrc security team, and is distributed
2679: from the NetBSD ftp server:</p>
2680: <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.75 rillig 2681: </li>
1.128 wiz 2682: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2683: current machine, checking each known vulnerability. If a
1.75 rillig 2684: vulnerable package is installed, it will be shown by output to stdout,
2685: including a description of the type of vulnerability, and a URL
2686: containing more information.</p></li>
2687: </ol></div>
1.233 sevan 2688: <p>Use of these tools is strongly recommended!
2689: 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
2690: reporting.</p>
2691: <p>If this database is installed, pkgsrc builds will use it to
2692: perform a security check before building any package.</p>
1.75 rillig 2693: </div>
1.148 asau 2694: <div class="sect1">
1.75 rillig 2695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2696: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 2697: <p>When you add your own preferences to the
2698: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 2699: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 2700: environment variables to the <code class="filename">./configure</code>
1.238 leot 2701: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 2702: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 2703: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 2704: package.</p>
2705: <p>Currently there is no solution to this problem. If you
2706: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 2707: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 2708: directory and then inspect any <code class="filename">Makefile</code> and
2709: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 2710: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 2711: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 2712: programmers write so bad code that it only works for the
2713: specific combination of <code class="varname">CFLAGS</code> they have
2714: chosen.</p>
2715: </div>
1.148 asau 2716: <div class="sect1">
1.80 rillig 2717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2718: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 2719: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 2720: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 2721: case that occurs often is that people only update pkgsrc in
2722: parts, because of performance reasons. Since pkgsrc is one large
2723: system, not a collection of many small systems, there are
2724: sometimes changes that only work when the whole pkgsrc tree is
2725: updated.</p></li>
1.148 asau 2726: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 2727: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2728: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 2729: files.</p></li>
1.148 asau 2730: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 2731: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 2732: verify this.</p></li>
1.218 rillig 2733: <li class="step"><p>If you are a package developer who wants to invest
2734: some work, have a look at <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.148 asau 2735: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 2736: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2737: </ol></div>
2738: </div>
1.148 asau 2739: <div class="sect1">
1.88 wiz 2740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2741: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.89 rillig 2742: <p>You have modified a file from pkgsrc, and someone else has
2743: modified that same file afterwards in the CVS repository. Both changes
2744: are in the same region of the file, so when you updated pkgsrc, the
2745: <code class="literal">cvs</code> command marked the conflicting changes in the
2746: file. Because of these markers, the file is no longer a valid
2747: <code class="filename">Makefile</code>.</p>
2748: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 2749: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 2750: -dP</strong></span> in that directory to download the current version.</p>
2751: </div>
1.75 rillig 2752: </div>
2753: </div>
1.148 asau 2754: <div class="part">
1.75 rillig 2755: <div class="titlepage"><div><div><h1 class="title">
2756: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 2757: <div class="partintro">
1.77 rillig 2758: <div></div>
2759: <p>This part of the book deals with creating and
1.128 wiz 2760: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 2761: guide on creating a new package. The remaining chapters are more
2762: like a reference manual for pkgsrc.</p>
1.75 rillig 2763: <div class="toc">
2764: <p><b>Table of Contents</b></p>
1.210 leot 2765: <dl class="toc">
1.106 rillig 2766: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 2767: <dd><dl>
1.106 rillig 2768: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 2769: <dd><dl>
1.106 rillig 2770: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.245 wiz 2771: <dt><span class="sect2"><a href="#creating.python-module">10.1.2. Python modules and programs</a></span></dt>
1.91 rillig 2772: </dl></dd>
1.106 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.128 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.219 rillig 2780: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106 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.128 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.106 rillig 2797: </dl></dd>
1.128 wiz 2798: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 2799: <dd><dl>
2800: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 2801: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 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.228 yyamano 2806: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220 wiz 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.106 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.128 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.106 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.128 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.106 rillig 2819: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 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.106 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.128 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.106 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.133 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.106 rillig 2834: </dl></dd>
1.128 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.106 rillig 2836: <dd><dl>
1.128 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.106 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.128 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.106 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.128 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.106 rillig 2867: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 2868: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 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.128 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.106 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.128 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.106 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.218 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.106 rillig 2915: </dl></dd>
1.218 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.106 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.199 tnn 2920: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106 rillig 2921: </dl></dd>
1.218 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.106 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.147 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.106 rillig 2935: </dl></dd>
1.218 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.106 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.128 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.106 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.218 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.106 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.107 rillig 2953: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 2954: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 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.87 wiz 2963: emulation</a></span></dt>
1.106 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.77 rillig 2966: </dl></dd>
1.106 rillig 2967: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 2968: </dl></dd>
1.106 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.77 rillig 2971: <dd><dl>
1.106 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.243 wiz 2975: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
2976: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
2977: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
2978: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
2979: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 2980: </dl></dd>
2981: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
2982: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
2983: <dd><dl>
2984: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
2985: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
2986: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
2987: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 2988: </dl></dd>
1.75 rillig 2989: </dl>
2990: </div>
1.77 rillig 2991: </div>
1.148 asau 2992: <div class="chapter">
1.77 rillig 2993: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2994: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 2995: <div class="toc">
2996: <p><b>Table of Contents</b></p>
1.210 leot 2997: <dl class="toc">
1.106 rillig 2998: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 2999: <dd><dl>
1.106 rillig 3000: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.245 wiz 3001: <dt><span class="sect2"><a href="#creating.python-module">10.1.2. Python modules and programs</a></span></dt>
1.91 rillig 3002: </dl></dd>
1.106 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.91 rillig 3005: </dl>
3006: </div>
1.77 rillig 3007: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 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.128 wiz 3011: <div class="procedure"><ol class="procedure" type="1">
1.232 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.148 asau 3013: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 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.148 asau 3018: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 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.148 asau 3025: <li class="step">
1.91 rillig 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.132 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.91 rillig 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>
1.77 rillig 3042: <pre class="programlisting">
1.100 rillig 3043: [...]
1.77 rillig 3044:
1.174 asau 3045: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3046: DEPENDS+= screen-[0-9]*:../../misc/screen
3047: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3048:
1.100 rillig 3049: [...]
1.77 rillig 3050:
1.100 rillig 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"
1.77 rillig 3054: </pre>
3055: </li>
1.148 asau 3056: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 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.110 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.91 rillig 3060: -e</strong></span>, which outputs additional
3061: explanations.</p></li>
1.148 asau 3062: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 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.91 rillig 3064: over there, you can hopefully continue here.</p></li>
1.148 asau 3065: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 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.148 asau 3070: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 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.148 asau 3072: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3073: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3074: everything works.</p></li>
1.148 asau 3075: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3076: contains a list of the files that are installed by the package, is
1.110 hubertf 3077: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 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.148 asau 3081: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3082: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3083: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3084: has been registered in the database of installed files, but with an
1.110 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.91 rillig 3087: registered with the list of files from
3088: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3089: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3090: package from the set of installed files.</p></li>
1.77 rillig 3091: </ol></div>
1.148 asau 3092: <div class="sect1">
1.91 rillig 3093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3094: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3095: <div class="sect2">
1.91 rillig 3096: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3097: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3098: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3099: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3100: </div>
1.148 asau 3101: <div class="sect2">
1.91 rillig 3102: <div class="titlepage"><div><div><h3 class="title">
1.245 wiz 3103: <a name="creating.python-module"></a>10.1.2. Python modules and programs</h3></div></div></div>
1.118 imil 3104: <p>Python modules and programs packages are easily created using a
3105: set of predefined variables.</p>
3106: <p>
1.171 wiz 3107: If some Python versions are not supported by the software, set the
3108: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3109: that are not supported, e.g.
1.118 imil 3110: </p>
3111: <pre class="programlisting">
1.203 sevan 3112: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.118 imil 3113: </pre>
3114: <p>
1.213 wiz 3115: If the packaged software is a Python module, include one of
3116: <code class="filename">../../lang/python/egg.mk</code>,
3117: <code class="filename">../../lang/python/distutils.mk</code>, or
3118: <code class="filename">../../lang/python/extension.mk</code>.</p>
3119: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3120: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3121: if the packaged software is using setuptools, you only need
3122: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3123: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3124: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3125: so pkgsrc will use this framework.
3126: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3127: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3128: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3129: to the name of the script.</p>
3130: <p>Either way, the package directory should be called
1.128 wiz 3131: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3132: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3133: </p>
3134: <pre class="programlisting">
3135: DISTNAME= foopymodule-1.2.10
3136: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3137: </pre>
1.171 wiz 3138: <p>If it is an application, include
3139: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3140: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3141: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3142: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3143: For example:
1.118 imil 3144: </p>
3145: <pre class="programlisting">
1.142 wiz 3146: REPLACE_PYTHON= *.py
1.118 imil 3147: </pre>
1.171 wiz 3148: <p>Some Python modules have separate distributions for Python-2.x
3149: and Python-3.x support. In pkgsrc this is handled by the
3150: <code class="filename">versioned_dependencies.mk</code> file. Set
3151: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3152: packages that should be depended upon and include
3153: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3154: then the pkgsrc infrastructure will depend on the appropriate package
3155: version. For example:
3156: </p>
3157: <pre class="programlisting">
1.236 wiz 3158: PYTHON_VERSIONED_DEPENDENCIES=gobject
1.171 wiz 3159: </pre>
3160: <p>
3161: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3162: of supported packages.</p>
1.118 imil 3163: </div>
1.91 rillig 3164: </div>
1.148 asau 3165: <div class="sect1">
1.91 rillig 3166: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3167: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3168: <div class="sect2">
1.91 rillig 3169: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3170: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3171: <div class="sect3">
1.91 rillig 3172: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3173: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3174: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3175: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3176: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3177: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3178: <pre class="programlisting">
1.100 rillig 3179: <code class="prompt">$</code> mkdir www/nvu
3180: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3181: </pre>
3182: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3183: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3184: <pre class="programlisting">
1.100 rillig 3185: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3186: </pre>
3187: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3188: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3189: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3190: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3191: <code class="varname">COMMENT</code> fields. Then the package
3192: <code class="filename">Makefile</code> looked like that:</p>
3193: <pre class="programlisting">
1.233 sevan 3194: # $NetBSD $
1.100 rillig 3195: #
1.91 rillig 3196:
1.100 rillig 3197: DISTNAME= nvu-1.0-sources
3198: PKGNAME= nvu-1.0
3199: CATEGORIES= www
3200: MASTER_SITES= http://cvs.nvu.com/download/
3201: EXTRACT_SUFX= .tar.bz2
3202:
3203: MAINTAINER= rillig@NetBSD.org
3204: HOMEPAGE= http://cvs.nvu.com/
3205: COMMENT= Web Authoring System
1.91 rillig 3206:
1.100 rillig 3207: # url2pkg-marker (please do not remove this line.)
3208: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3209: </pre>
1.237 wiz 3210: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.233 sevan 3211: this is a workaround to prevent CVS expanding to the filename of the
3212: guide.</p>
1.91 rillig 3213: <p>Then, I quit the editor and watched pkgsrc downloading a large
3214: source archive:</p>
3215: <pre class="programlisting">
1.100 rillig 3216: url2pkg> Running "make makesum" ...
3217: => Required installed package digest>=20010302: digest-20060826 found
3218: => Fetching nvu-1.0-sources.tar.bz2
3219: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3220: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3221: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3222: url2pkg> Running "make extract" ...
3223: => Required installed package digest>=20010302: digest-20060826 found
3224: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3225: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3226: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3227: ===> Installing dependencies for nvu-1.0
3228: ===> Overriding tools for nvu-1.0
3229: ===> Extracting for nvu-1.0
3230: url2pkg> Adjusting the Makefile.
1.91 rillig 3231:
1.100 rillig 3232: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3233:
1.100 rillig 3234: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3235: </pre>
3236: </div>
1.148 asau 3237: <div class="sect3">
1.91 rillig 3238: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3239: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91 rillig 3240: <p>Now that the package has been extracted, let's see what's inside
3241: it. The package has a <code class="filename">README.txt</code>, but that only
3242: says something about mozilla, so it's probably useless for seeing what
3243: dependencies this package has. But since there is a GNU configure script
3244: in the package, let's hope that it will complain about everything it
3245: needs.</p>
3246: <pre class="programlisting">
1.100 rillig 3247: <code class="prompt">$</code> bmake
3248: => Required installed package digest>=20010302: digest-20060826 found
3249: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3250: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3251: ===> Patching for nvu-1.0
3252: ===> Creating toolchain wrappers for nvu-1.0
3253: ===> Configuring for nvu-1.0
3254: [...]
3255: configure: error: Perl 5.004 or higher is required.
3256: [...]
3257: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3258: [...]
1.91 rillig 3259: </pre>
3260: <p>That worked quite well. So I opened the package Makefile in my
3261: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3262: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3263: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3264: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3265: from scratch.</p>
3266: <pre class="programlisting">
1.100 rillig 3267: <code class="prompt">$</code> bmake clean
3268: ===> Cleaning for nvu-1.0
3269: <code class="prompt">$</code> bmake
3270: [...]
3271: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3272: GNU Make. You will not be able to build Mozilla without GNU Make.
3273: [...]
1.91 rillig 3274: </pre>
1.128 wiz 3275: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3276: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3277: <pre class="programlisting">
1.100 rillig 3278: [...]
3279: checking for GTK - version >= 1.2.0... no
3280: *** Could not run GTK test program, checking why...
3281: [...]
1.91 rillig 3282: </pre>
3283: <p>Now to the other dependencies. The first question is: Where is the
3284: GTK package hidden in pkgsrc?</p>
3285: <pre class="programlisting">
1.100 rillig 3286: <code class="prompt">$</code> echo ../../*/gtk*
3287: [many packages ...]
3288: <code class="prompt">$</code> echo ../../*/gtk
3289: ../../x11/gtk
3290: <code class="prompt">$</code> echo ../../*/gtk2
3291: ../../x11/gtk2
3292: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3293: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3294: </pre>
3295: <p>The first try was definitely too broad. The second one had exactly
3296: one result, which is very good. But there is one pitfall with GNOME
3297: packages. Before GNOME 2 had been released, there were already many
3298: GNOME 1 packages in pkgsrc. To be able to continue to use these
3299: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3300: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3301: whether this was the case here, and indeed it was.</p>
3302: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3303: file, adding the dependency is very easy. I just inserted an
3304: <code class="literal">.include</code> line before the last line of the package
3305: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3306: <pre class="programlisting">
1.100 rillig 3307: [...]
3308: .include "../../x11/gtk2/buildlink3.mk"
3309: .include "../../mk/bsd.pkg.mk
1.91 rillig 3310: </pre>
1.110 hubertf 3311: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3312: was:</p>
3313: <pre class="programlisting">
1.100 rillig 3314: [...]
3315: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3316: checking for GTK - version >= 1.2.0... no
3317: *** Could not run GTK test program, checking why...
3318: *** The test program failed to compile or link. See the file config.log for the
3319: *** exact error that occured. This usually means GTK was incorrectly installed
3320: *** or that you have moved GTK since it was installed. In the latter case, you
3321: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3322: configure: error: Test for GTK failed.
3323: [...]
1.91 rillig 3324: </pre>
1.128 wiz 3325: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3326: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3327: told me that this package really wanted to have the GNOME 1 version of
3328: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3329: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3330: So I changed the <code class="literal">x11/gtk2</code> to
3331: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3332: and tried again.</p>
3333: <pre class="programlisting">
1.100 rillig 3334: [...]
1.166 jnemeth 3335: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3336: In file included from xpidl.c:42:
3337: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3338: In file included from xpidl.c:42:
3339: xpidl.h:132: error: parse error before "IDL_ns"
3340: [...]
1.91 rillig 3341: </pre>
3342: <p>The package still does not find all of its dependencies. Now the
3343: question is: Which package provides the
3344: <code class="filename">libIDL/IDL.h</code> header file?</p>
3345: <pre class="programlisting">
1.100 rillig 3346: <code class="prompt">$</code> echo ../../*/*idl*
3347: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3348: <code class="prompt">$</code> echo ../../*/*IDL*
3349: ../../net/libIDL
1.91 rillig 3350: </pre>
3351: <p>Let's take the one from the second try. So I included the
3352: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3353: again. But the error didn't change. After digging through some of the
3354: code, I concluded that the build process of the package was broken and
3355: couldn't have ever worked, but since the Mozilla source tree is quite
3356: large, I didn't want to fix it. So I added the following to the package
3357: <code class="filename">Makefile</code> and tried again:</p>
3358: <pre class="programlisting">
1.100 rillig 3359: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3360: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 3361: </pre>
3362: <p>The latter line is needed because the package expects the library
3363: <code class="filename">libIDL.so</code>, but only
3364: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3365: wrapper to rewrite that on the fly.</p>
3366: <p>The next problem was related to a recent change of the FreeType
1.232 sevan 3367: 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.91 rillig 3368: which patch files were relevant for this issue and copied them to the
3369: <code class="filename">patches</code> directory. Then I retried, fixed the
3370: patches so that they applied cleanly and retried again. This time,
3371: everything worked.</p>
3372: </div>
1.148 asau 3373: <div class="sect3">
1.91 rillig 3374: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3375: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3376: <pre class="programlisting">
1.100 rillig 3377: <code class="prompt">$</code> bmake CHECK_FILES=no install
3378: [...]
3379: <code class="prompt">$</code> bmake print-PLIST >PLIST
3380: <code class="prompt">$</code> bmake deinstall
3381: <code class="prompt">$</code> bmake install
1.91 rillig 3382: </pre>
3383: </div>
3384: </div>
3385: </div>
1.77 rillig 3386: </div>
1.148 asau 3387: <div class="chapter">
1.75 rillig 3388: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3389: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3390: <div class="toc">
3391: <p><b>Table of Contents</b></p>
1.210 leot 3392: <dl class="toc">
1.128 wiz 3393: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3394: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219 rillig 3395: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106 rillig 3396: <dd><dl>
3397: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3398: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3399: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3400: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3401: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3402: </dl></dd>
3403: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3404: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3405: <dd><dl>
3406: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3407: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3408: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3409: </dl></dd>
1.128 wiz 3410: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3411: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 3412: </dl>
3413: </div>
1.87 wiz 3414: <p>Whenever you're preparing a package, there are a number of
3415: files involved which are described in the following
3416: sections.</p>
1.148 asau 3417: <div class="sect1">
1.75 rillig 3418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3419: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 3420: </h2></div></div></div>
1.75 rillig 3421: <p>Building, installation and creation of a binary package are all
1.87 wiz 3422: controlled by the package's <code class="filename">Makefile</code>.
3423: The <code class="filename">Makefile</code> describes various things about
3424: a package, for example from where to get it, how to configure,
3425: build, and install it.</p>
1.76 rillig 3426: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3427: sections that describe the package.</p>
1.75 rillig 3428: <p>In the first section there are the following variables, which
1.87 wiz 3429: should appear exactly in the order given here. The order and
3430: grouping of the variables is mostly historical and has no further
3431: meaning.</p>
1.148 asau 3432: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3433: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3434: distribution file to be downloaded from the package's
3435: website.</p></li>
1.128 wiz 3436: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3437: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3438: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 3439: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3440: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 3441: directory name together with the version number. It must match the
3442: regular expression
3443: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3444: starts with a letter or digit, and contains only letters, digits,
3445: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 3446: <li class="listitem">
1.75 rillig 3447: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 3448: which the package fits in. You can choose any of the top-level
3449: directories of pkgsrc for it.</p>
1.75 rillig 3450: <p>Currently the following values are available for
1.87 wiz 3451: <code class="varname">CATEGORIES</code>. If more than
3452: one is used, they need to be separated by spaces:</p>
1.75 rillig 3453: <pre class="programlisting">
1.100 rillig 3454: archivers cross geography meta-pkgs security
3455: audio databases graphics misc shells
3456: benchmarks devel ham multimedia sysutils
3457: biology editors inputmethod net textproc
3458: cad emulators lang news time
3459: chat finance mail parallel wm
3460: comms fonts math pkgtools www
3461: converters games mbone print x11
3462: </pre>
1.75 rillig 3463: </li>
1.128 wiz 3464: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 3465: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3466: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3467: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 3468: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.75 rillig 3469: </ul></div>
3470: <p>The second section contains information about separately
1.87 wiz 3471: downloaded patches, if any.
3472: </p>
1.148 asau 3473: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190 wiz 3474: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87 wiz 3475: Name(s) of additional files that contain distribution patches.
3476: There is no default. pkgsrc will look for them at
3477: <code class="varname">PATCH_SITES</code>.
3478: They will automatically be uncompressed before patching if
3479: the names end with <code class="filename">.gz</code> or
3480: <code class="filename">.Z</code>.</p></li>
1.128 wiz 3481: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 3482: Primary location(s) for distribution patch files (see
1.190 wiz 3483: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3484: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.238 leot 3485: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.190 wiz 3486: help find the correct files to patch. It defaults to
3487: <span class="command"><strong>-p0</strong></span>.</p></li>
1.75 rillig 3488: </ul></div>
3489: <p>The third section contains the following variables.
1.87 wiz 3490: </p>
1.148 asau 3491: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3492: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 3493: address of the person who feels responsible for this package,
3494: and who is most likely to look at problems or questions regarding
1.238 leot 3495: 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.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114 jmcneill 3496: Other developers may contact the <code class="varname">MAINTAINER</code>
3497: before making changes to the package, but are not required to
3498: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3499: to yourself. If you really can't maintain the package for future
3500: updates, set it to
1.110 hubertf 3501: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 3502: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 3503: of <code class="varname">MAINTAINER</code> when you do not want other
3504: developers to update or change the package without contacting
3505: you first. A package Makefile should contain one of
3506: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3507: not both. </p></li>
1.128 wiz 3508: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 3509: find more information about the package.</p></li>
1.128 wiz 3510: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 3511: description of the package (should not include the package
3512: name).</p></li>
1.234 leot 3513: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3514: 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.75 rillig 3515: </ul></div>
3516: <p>Other variables that affect the build:
1.87 wiz 3517: </p>
1.148 asau 3518: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 3519: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 3520: interesting distribution files of the package are found. The
3521: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3522: works for most packages.</p>
1.75 rillig 3523: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 3524: (most GNU software does, for instance), but extracts itself in
3525: the current directory, you should set
3526: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3527: <p>If a package doesn't create a subdirectory with the
3528: name of <code class="varname">DISTNAME</code> but some different name,
3529: set <code class="varname">WRKSRC</code> to point to the proper name in
3530: <code class="filename">${WRKDIR}</code>, for example
3531: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.232 sevan 3532: <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.75 rillig 3533: <p>The name of the working directory created by pkgsrc is
1.87 wiz 3534: taken from the <code class="varname">WRKDIR_BASENAME</code>
3535: variable. By default, its value is
3536: <code class="filename">work</code>. If you want to use the same
3537: pkgsrc tree for building different kinds of binary packages,
3538: you can change the variable according to your needs. Two
3539: other variables handle common cases of setting
3540: <code class="varname">WRKDIR_BASENAME</code> individually. If
3541: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 3542: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 3543: the host's name is attached to the directory name. If
3544: <code class="varname">OBJMACHINE</code> is defined, the platform name
3545: is attached, which might look like
3546: <code class="filename">work.i386</code> or
3547: <code class="filename">work.sparc</code>.</p>
1.75 rillig 3548: </li></ul></div>
3549: <p>Please pay attention to the following gotchas:</p>
1.148 asau 3550: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3551: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 3552: installed in compressed form by the package. For packages using
3553: BSD-style makefiles which honor MANZ, there is
3554: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 3555: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3556: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 3557: below).</p></li>
1.128 wiz 3558: <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.75 rillig 3559: </ul></div>
3560: </div>
1.148 asau 3561: <div class="sect1">
1.75 rillig 3562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3563: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 3564: </h2></div></div></div>
1.76 rillig 3565: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 3566: digest, or checksum, of each distfile needed for the package. This
3567: ensures that the distfiles retrieved from the Internet have not been
3568: corrupted during transfer or altered by a malign force to introduce
1.219 rillig 3569: a security hole. To provide maximum security, all distfiles are
3570: protected using three different message digest algorithms (SHA1,
3571: RMD160, SHA512), as well as the file size.</p>
1.76 rillig 3572: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 3573: checksums for all the patches found in the
1.219 rillig 3574: <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.76 rillig 3575: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219 rillig 3576: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75 rillig 3577: <p>Some packages have different sets of distfiles depending on
1.232 sevan 3578: 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.87 wiz 3579: <code class="filename">distinfo</code> file and care should be taken when
3580: upgrading such a package to ensure distfile information is not
3581: lost.</p>
1.75 rillig 3582: </div>
1.148 asau 3583: <div class="sect1">
1.75 rillig 3584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219 rillig 3585: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
3586: </h2></div></div></div>
3587: <p>Some packages don't work out-of-the box on the various
3588: platforms that are supported by pkgsrc. These packages need
3589: to be patched to make them work. The patch files can be
1.93 rillig 3590: found in the <code class="filename">patches/</code> directory.</p>
3591: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3592: applied to the files in <code class="varname">WRKSRC</code> directory after
1.219 rillig 3593: extracting them, in alphabetic order.</p>
1.148 asau 3594: <div class="sect2">
1.93 rillig 3595: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3596: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 3597: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 3598: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 3599: problems. (To force patches to apply with fuzz you can set
3600: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 3601: should contain only changes for a single file, and no file should be
1.93 rillig 3602: patched by more than one patch file. This helps to keep future
3603: modifications simple.</p>
3604: <p>Each patch file is structured as follows: In the first line,
3605: there is the RCS Id of the patch itself. The second line should be
3606: empty for aesthetic reasons. After that, there should be a comment for
3607: each change that the patch does. There are a number of standard
3608: cases:</p>
1.148 asau 3609: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3610: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 3611: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 3612: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 3613: platform and other environment (for example, the compiler) that the
3614: patch is needed for.</p></li>
3615: </ul></div>
1.219 rillig 3616: <p>The patch should be commented so that any
1.93 rillig 3617: developer who knows the code of the application can make some use of
3618: the patch. Special care should be taken for the upstream developers,
3619: since we generally want that they accept our patches, so we have less
3620: work in the future.</p>
3621: </div>
1.148 asau 3622: <div class="sect2">
1.93 rillig 3623: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3624: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 3625: <p>One important thing to mention is to pay attention that no RCS
3626: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 3627: later checked into the NetBSD CVS tree. Use the
1.232 sevan 3628: <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.93 rillig 3629: problems.</p>
1.87 wiz 3630: <p>For even more automation, we recommend using
1.110 hubertf 3631: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 3632: whole set of patches. You just have to backup files before you
3633: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 3634: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3635: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 3636: you upgrade a package this way, you can easily compare the new
3637: set of patches with the previously existing one with
1.130 wiz 3638: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3639: are replaced by new files, so carefully check if you want to take all
3640: the changes.</p>
1.87 wiz 3641: <p>When you have finished a package, remember to generate
1.110 hubertf 3642: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 3643: 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.87 wiz 3644: <p>When adding a patch that corrects a problem in the
3645: distfile (rather than e.g. enforcing pkgsrc's view of where
3646: man pages should go), send the patch as a bug report to the
3647: maintainer. This benefits non-pkgsrc users of the package,
3648: and usually makes it possible to remove the patch in future
3649: version.</p>
1.101 rillig 3650: <p>The file names of the patch files are usually of the form
1.130 wiz 3651: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3652: Many packages still use the previous convention
3653: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3654: but new patches should be of the form containing the filename.
1.232 sevan 3655: <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.130 wiz 3656: automatically.</p>
1.93 rillig 3657: </div>
1.148 asau 3658: <div class="sect2">
1.93 rillig 3659: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3660: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 3661: <p>If you want to share patches between multiple packages
3662: in pkgsrc, e.g. because they use the same distfiles, set
3663: <code class="varname">PATCHDIR</code> to the path where the patch files
3664: can be found, e.g.:</p>
3665: <pre class="programlisting">
1.100 rillig 3666: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 3667: </pre>
1.75 rillig 3668: <p>Patch files that are distributed by the author or other
1.87 wiz 3669: maintainers can be listed in
3670: <code class="varname">PATCHFILES</code>.</p>
3671: <p>If it is desired to store any patches that should not be
3672: committed into pkgsrc, they can be kept outside the pkgsrc
3673: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3674: directory tree there is expected to have the same
1.128 wiz 3675: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 3676: patches are expected to be stored inside these dirs (also
3677: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3678: example, if you want to keep a private patch for
3679: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3680: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3681: files in the named directory are expected to be patch files,
3682: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3683: applied</em></span>.</p>
1.93 rillig 3684: </div>
1.148 asau 3685: <div class="sect2">
1.85 jmmv 3686: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3687: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 3688: <p>When fixing a portability issue in the code do not use
3689: preprocessor magic to check for the current operating system nor
3690: platform. Doing so hurts portability to other platforms because
3691: the OS-specific details are not abstracted appropriately.</p>
3692: <p>The general rule to follow is: instead of checking for the
3693: operating system the application is being built on, check for the
3694: specific <span class="emphasis"><em>features</em></span> you need. For example,
3695: instead of assuming that kqueue is available under NetBSD and
3696: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 3697: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 3698: yes, this generally involves patching the
1.110 hubertf 3699: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 3700: that prevents some OSes from adopting interfaces from other OSes
3701: (e.g. Linux implementing kqueue), something that the above checks
3702: cannot take into account.</p>
3703: <p>Of course, checking for features generally involves more
3704: work on the developer's side, but the resulting changes are
1.87 wiz 3705: cleaner and there are chances they will work on many other
1.85 jmmv 3706: platforms. Not to mention that there are higher chances of being
3707: later integrated into the mainstream sources. Remember:
3708: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3709: <p>Some typical examples:</p>
3710: <div class="table">
1.106 rillig 3711: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.216 tnn 3712: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85 jmmv 3713: <colgroup>
3714: <col>
3715: <col>
3716: <col>
3717: </colgroup>
3718: <thead><tr>
3719: <th>Where</th>
3720: <th>Incorrect</th>
3721: <th>Correct</th>
3722: </tr></thead>
3723: <tbody>
3724: <tr>
3725: <td>configure script</td>
3726: <td>
1.100 rillig 3727: <pre class="programlisting">
3728: case ${target_os} in
3729: netbsd*) have_kvm=yes ;;
3730: *) have_kvm=no ;;
3731: esac
3732: </pre>
1.85 jmmv 3733: </td>
3734: <td>
1.100 rillig 3735: <pre class="programlisting">
3736: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3737: </pre>
1.85 jmmv 3738: </td>
3739: </tr>
3740: <tr>
3741: <td>C source file</td>
3742: <td>
1.100 rillig 3743: <pre class="programlisting">
3744: #if defined(__NetBSD__)
3745: # include <sys/event.h>
3746: #endif
3747: </pre>
1.85 jmmv 3748: </td>
3749: <td>
1.100 rillig 3750: <pre class="programlisting">
3751: #if defined(HAVE_SYS_EVENT_H)
3752: # include <sys/event.h>
3753: #endif
3754: </pre>
1.85 jmmv 3755: </td>
3756: </tr>
3757: <tr>
3758: <td>C source file</td>
3759: <td>
1.100 rillig 3760: <pre class="programlisting">
3761: int
3762: monitor_file(...)
3763: {
3764: #if defined(__NetBSD__)
3765: int fd = kqueue();
3766: ...
3767: #else
3768: ...
3769: #endif
3770: }
3771: </pre>
1.85 jmmv 3772: </td>
3773: <td>
1.100 rillig 3774: <pre class="programlisting">
3775: int
3776: monitor_file(...)
3777: {
3778: #if defined(HAVE_KQUEUE)
3779: int fd = kqueue();
3780: ...
3781: #else
1.223 rillig 3782: ...
1.100 rillig 3783: #endif
3784: }
3785: </pre>
1.85 jmmv 3786: </td>
3787: </tr>
3788: </tbody>
1.91 rillig 3789: </table></div>
1.85 jmmv 3790: </div>
1.91 rillig 3791: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 3792: 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
3793: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 3794: 2</a>). It summarizes multiple details on how to make
3795: software easier to package; all the suggestions in it were
3796: collected from our experience in pkgsrc work, so they are possibly
3797: helpful when creating patches too.</p>
3798: </div>
1.148 asau 3799: <div class="sect2">
1.85 jmmv 3800: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3801: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 3802: <p>Always, always, <span class="strong"><strong>always</strong></span>
3803: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3804: improvements you do to a package to the mainstream developers.
3805: This is the only way to get their attention on portability issues
3806: and to ensure that future versions can be built out-of-the box on
3807: NetBSD. Furthermore, any user that gets newer distfiles will get
3808: the fixes straight from the packaged code.</p>
1.93 rillig 3809: <p>This generally involves cleaning up the patches
3810: (because sometimes the patches that are
1.147 wiz 3811: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 3812: appropriate trackers for the projects and working with the
3813: mainstream authors to accept your changes. It is
3814: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3815: the packages in pkgsrc are kept simple and thus further changes
3816: can be done without much hassle.</p>
1.130 wiz 3817: <p>When you have done this, please add a URL to the upstream
3818: bug report to the patch comment.</p>
1.85 jmmv 3819: <p>Support the idea of free software!</p>
3820: </div>
1.75 rillig 3821: </div>
1.148 asau 3822: <div class="sect1">
1.75 rillig 3823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3824: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 3825: <div class="variablelist"><dl class="variablelist">
1.76 rillig 3826: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 3827: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 3828: any credits where they are due. Please bear in mind that others do not
3829: share your sense of humour (or spelling idiosyncrasies), and that others
3830: will read everything that you write here.</p></dd>
1.76 rillig 3831: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 3832: <dd><p>This file governs the files that are installed on your
3833: system: all the binaries, manual pages, etc. There are other
3834: directives which may be entered in this file, to control the
3835: creation and deletion of directories, and the location of
1.110 hubertf 3836: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87 wiz 3837: information.</p></dd>
1.75 rillig 3838: </dl></div>
3839: </div>
1.148 asau 3840: <div class="sect1">
1.75 rillig 3841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3842: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 3843: <div class="sect2">
1.78 rillig 3844: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3845: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 3846: <div class="variablelist"><dl class="variablelist">
1.76 rillig 3847: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 3848: <dd>
1.238 leot 3849: <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.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 3850: First time after package extraction and before files are
3851: moved in place, the second time after the files to install
3852: are moved in place. This can be used to do any custom
3853: procedures not possible with @exec commands in
1.238 leot 3854: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3855: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><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.135 wiz 3856: Please note that you can modify variables in it easily by using
3857: <code class="varname">FILES_SUBST</code> in the package's
3858: <code class="filename">Makefile</code>:</p>
3859: <pre class="programlisting">
3860: FILES_SUBST+= SOMEVAR="somevalue"
3861: </pre>
3862: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3863: <code class="filename">INSTALL</code>. By default, substitution is
3864: performed for <code class="varname">PREFIX</code>,
3865: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3866: <code class="varname">VARBASE</code>, and a few others, type
3867: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3868: complete list.</p>
3869: </dd>
1.76 rillig 3870: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 3871: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 3872: this script's responsibility to clean up any additional messy details
3873: around the package's installation, since all pkg_delete knows is how to
3874: delete the files created in the original distribution.
1.238 leot 3875: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3876: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135 wiz 3877: The same methods to replace variables can be used as for
3878: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 3879: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 3880: <dd>
3881: <p>This file is displayed after installation of the package.
1.87 wiz 3882: Useful for things like legal notices on almost-free
3883: software and hints for updating config files after
3884: installing modules for apache, PHP etc.
3885: Please note that you can modify variables in it easily by using
3886: <code class="varname">MESSAGE_SUBST</code> in the package's
3887: <code class="filename">Makefile</code>:</p>
1.75 rillig 3888: <pre class="programlisting">
1.100 rillig 3889: MESSAGE_SUBST+= SOMEVAR="somevalue"
3890: </pre>
1.128 wiz 3891: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 3892: <code class="filename">MESSAGE</code>. By default, substitution is
3893: performed for <code class="varname">PKGNAME</code>,
3894: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209 sevan 3895: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87 wiz 3896: <code class="varname">PKG_SYSCONFDIR</code>,
3897: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 3898: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 3899: <p>You can display a different or additional files by
3900: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3901: default is <code class="filename">MESSAGE</code>, if the file
3902: exists.</p>
1.75 rillig 3903: </dd>
1.78 rillig 3904: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 3905: <dd>
3906: <p>This file is used by the alternatives framework.
3907: It creates, configures, and destroys generic wrappers used to
3908: run programs with similar interfaces.
3909: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3910: for more information.</p>
3911: <p>Each line of the file contains two filenames, first
3912: the wrapper and then the alternative provided by the package.
3913: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3914: </dd>
1.78 rillig 3915: </dl></div>
3916: </div>
1.148 asau 3917: <div class="sect2">
1.78 rillig 3918: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3919: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 3920: <div class="variablelist"><dl class="variablelist">
1.78 rillig 3921: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3922: <dd><p>This file contains arbitrary things that could
3923: also go into a <code class="filename">Makefile</code>, but its purpose is
3924: to be used by more than one package. This file should only be
3925: used when the packages that will use the file are known in
3926: advance. For other purposes it is often better to write a
3927: <code class="filename">*.mk</code> file and give it a good name that
3928: describes what it does.</p></dd>
3929: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3930: <dd><p>This file contains the dependency information
1.110 hubertf 3931: 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.78 rillig 3932: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3933: <dd><p>This file contains workarounds for compiler bugs
3934: and similar things. It is included automatically by the pkgsrc
3935: infrastructure, so you don't need an extra
3936: <code class="literal">.include</code> line for
3937: it.</p></dd>
3938: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3939: <dd><p>This file contains the code for the
1.110 hubertf 3940: 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.78 rillig 3941: selected by the user. If a package has only one or two options,
3942: it is equally acceptable to put the code directly into the
3943: <code class="filename">Makefile</code>.</p></dd>
3944: </dl></div>
3945: </div>
1.148 asau 3946: <div class="sect2">
1.78 rillig 3947: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3948: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 3949: <div class="variablelist"><dl class="variablelist">
1.78 rillig 3950: <dt><span class="term"><code class="filename">README*</code></span></dt>
3951: <dd><p>These files do not take place in the creation of
3952: a package and thus are purely informative to the package
3953: developer.</p></dd>
3954: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3955: <dd><p>This file contains things that need to be done
3956: to make the package even
3957: better.</p></dd>
1.75 rillig 3958: </dl></div>
3959: </div>
1.78 rillig 3960: </div>
1.148 asau 3961: <div class="sect1">
1.75 rillig 3962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3963: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 3964: </h2></div></div></div>
1.110 hubertf 3965: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 3966: unpacked into the directory denoted by
3967: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 3968: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 3969: directory is also used to keep various timestamp files.
3970: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3971: The default is <code class="filename">${.CURDIR}/work</code>
3972: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3973: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 3974: </div>
1.148 asau 3975: <div class="sect1">
1.75 rillig 3976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3977: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 3978: </h2></div></div></div>
1.75 rillig 3979: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 3980: to configuration or building, you could place these files here and use
1.110 hubertf 3981: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 3982: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 3983: this. Alternatively, you could simply diff the file against
3984: <code class="filename">/dev/null</code> and use the patch mechanism to manage
3985: the creation of this file.</p>
3986: <p>If you want to share files in this way with other
3987: packages, set the <code class="varname">FILESDIR</code> variable to point
3988: to the other package's <code class="filename">files</code> directory,
3989: e.g.:</p>
3990: <pre class="programlisting">
1.100 rillig 3991: FILESDIR=${.CURDIR}/../xemacs/files
3992: </pre>
1.75 rillig 3993: </div>
3994: </div>
1.148 asau 3995: <div class="chapter">
1.75 rillig 3996: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3997: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 3998: <div class="toc">
3999: <p><b>Table of Contents</b></p>
1.210 leot 4000: <dl class="toc">
1.106 rillig 4001: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4002: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4003: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4004: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4005: <dd><dl>
4006: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228 yyamano 4007: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220 wiz 4008: <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>
4009: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.75 rillig 4010: </dl></dd>
4011: </dl>
4012: </div>
1.76 rillig 4013: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4014: each of which forms a well-defined part of the pkgsrc system. Using
1.238 leot 4015: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75 rillig 4016: like pkgsrc requires some discipline to keep the code correct and
4017: understandable.</p>
1.76 rillig 4018: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4019: programming are variables (which are actually macros) and shell
4020: commands. Among these shell commands may even be more complex ones
1.238 leot 4021: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75 rillig 4022: as intended it is necessary to quote all variables correctly when they
4023: are used.</p>
4024: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4025: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4026: with them.</p>
1.148 asau 4027: <div class="sect1">
1.75 rillig 4028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4029: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4030: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4031: <p>When you are creating a file as a
4032: target of a rule, always write the data to a temporary file first
4033: and finally rename that file. Otherwise there might occur an error
4034: in the middle of generating the file, and when the user runs
1.238 leot 4035: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97 rillig 4036: regenerated properly. Example:</p>
4037: <pre class="programlisting">
1.100 rillig 4038: wrong:
4039: @echo "line 1" > ${.TARGET}
4040: @echo "line 2" >> ${.TARGET}
4041: @false
4042:
4043: correct:
4044: @echo "line 1" > ${.TARGET}.tmp
4045: @echo "line 2" >> ${.TARGET}.tmp
4046: @false
4047: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4048: </pre>
1.110 hubertf 4049: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4050: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4051: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4052: correct</strong></span> gives an error message twice, as expected.</p>
1.238 leot 4053: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4054: <code class="literal">${.TARGET}</code> in case of error, but this only
4055: happens when it is interrupted, for example by pressing
4056: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.238 leot 4057: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4058: </li></ul></div>
4059: </div>
1.148 asau 4060: <div class="sect1">
1.97 rillig 4061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4062: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4063: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4064: can be processed using the five operators ``='', ``+='', ``?='',
1.238 leot 4065: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4066: page.</p>
4067: <p>When a variable's value is parsed from a
1.76 rillig 4068: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4069: backslash character ``\'' are handled specially. If a backslash is
4070: followed by a newline, any whitespace immediately in front of the
4071: backslash, the backslash, the newline, and any whitespace
4072: immediately behind the newline are replaced with a single space. A
4073: backslash character and an immediately following hash character are
4074: replaced with a single hash character. Otherwise, the backslash is
4075: passed as is. In a variable assignment, any hash character that is
4076: not preceded by a backslash starts a comment that continues upto the
4077: end of the logical line.</p>
1.219 rillig 4078: <p>The evaluation of variables either happens immediately or lazy.
4079: It happens immediately when the variable occurs
4080: on the right-hand side of the ``:='' or the ``!='' operator, in a
4081: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4082: In the other cases, it is evaluated lazily.</p>
1.75 rillig 4083: <p>Some of the modifiers split the string into words and then
4084: operate on the words, others operate on the string as a whole. When
1.238 leot 4085: 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.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.75 rillig 4086: <p>There are several types of variables that should be handled
4087: differently. Strings and two types of lists.</p>
1.148 asau 4088: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4089: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4090: characters. Nevertheless, you should restrict yourself to only
4091: using printable characters. Examples are
4092: <code class="varname">PREFIX</code> and
4093: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4094: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4095: are never exported to any shell command. Their elements are
4096: separated by whitespace. Therefore, the elements themselves cannot
4097: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4098: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4099: Examples are <code class="varname">DEPENDS</code> and
4100: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4101: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4102: may be exported to a shell command. Their elements can contain any
4103: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4104: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4105: <code class="varname">DISTFILES</code> and
4106: <code class="varname">MASTER_SITES</code>.</p></li>
4107: </ul></div>
1.148 asau 4108: <div class="sect2">
1.75 rillig 4109: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4110: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4111: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4112: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4113: are reserved for use by the pkgsrc infrastructure. They shall
4114: not be used by package
1.76 rillig 4115: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4116: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4117: lowercase variable names for the iteration
4118: variables.</p></li>
1.128 wiz 4119: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4120: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4121: <code class="varname">DISTFILES</code>.</p></li>
4122: </ul></div>
4123: </div>
4124: </div>
1.148 asau 4125: <div class="sect1">
1.75 rillig 4126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4127: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.148 asau 4128: <div class="sect2">
1.75 rillig 4129: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4130: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.220 wiz 4131: <p>When adding a string that possibly contains whitespace or quotes to
4132: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4133: modifier.</p>
4134: <p>When adding another list to a list (example 2), it must not be
4135: quoted, since its elements are already quoted.</p>
1.75 rillig 4136: <pre class="programlisting">
1.220 wiz 4137: STRING= foo * bar `date`
4138: LIST= # empty
4139: ANOTHER_LIST= a=b c=d
4140:
4141: LIST+= ${STRING:Q} # 1
4142: LIST+= ${ANOTHER_LIST} # 2
4143: </pre>
1.75 rillig 4144: </div>
1.148 asau 4145: <div class="sect2">
1.75 rillig 4146: <div class="titlepage"><div><div><h3 class="title">
1.228 yyamano 4147: <a name="echo-literal"></a>12.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.220 wiz 4148: <p>Echoing a string containing special characters needs special
4149: work.</p>
1.75 rillig 4150: <pre class="programlisting">
1.100 rillig 4151: STRING= foo bar < > * `date` $$HOME ' "
1.219 rillig 4152: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 grant 4153:
1.100 rillig 4154: all:
4155: echo ${STRING} # 1
1.219 rillig 4156: echo ${STRING:Q} # 2
4157: printf '%s\n' ${STRING:Q}'' # 3
1.220 wiz 4158: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 grant 4159: </pre>
1.220 wiz 4160: <p>Example 1 leads to a syntax error in the shell, as the characters
4161: are just copied.</p>
4162: <p>Example 2 quotes the string so that the shell interprets it
4163: correctly. But the echo command may additionally interpret strings with a
4164: leading dash or those containing backslashes.</p>
1.238 leot 4165: <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.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.220 wiz 4166: interprets the format string, but not the next argument.</p>
4167: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4168: need to be quoted because the quoting has already been done
4169: when adding elements to the list.</p>
1.75 rillig 4170: </div>
1.148 asau 4171: <div class="sect2">
1.75 rillig 4172: <div class="titlepage"><div><div><h3 class="title">
1.220 wiz 4173: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4174: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4175: GNU-style configure script (especially those that call other configure
4176: scripts), it must not have leading or trailing whitespace, since
4177: otherwise the configure script gets confused. To trim leading and
4178: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4179: following example:</p>
1.75 rillig 4180: <pre class="programlisting">
1.100 rillig 4181: CPPFLAGS= # empty
1.220 wiz 4182: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.100 rillig 4183: CPPFLAGS+= ${MY_CPPFLAGS}
4184:
4185: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4186:
4187: all:
4188: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.220 wiz 4189: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 grant 4190: </pre>
1.220 wiz 4191: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4192: trailing whitespace because the <code class="code">+=</code> operator always adds a
4193: space.</p>
4194: </div>
4195: <div class="sect2">
4196: <div class="titlepage"><div><div><h3 class="title">
4197: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4198: <p>When a possibly empty variable is used in a shell program, it may
4199: lead to a syntax error.</p>
4200: <pre class="programlisting">
4201: EGFILES= # empty
4202:
4203: install-examples: # produces a syntax error in the shell
4204: for egfile in ${EGFILES}; do \
4205: echo "Installing $$egfile"; \
4206: done
4207: </pre>
4208: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.238 leot 4209: <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.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.220 wiz 4210: To fix this syntax error, use one of the snippets below.</p>
4211: <pre class="programlisting">
4212: EMPTY= # empty
4213:
4214: install-examples:
4215: for egfile in ${EGFILES} ""; do \
4216: [ -n "$$egfile" ] || continue; \
4217: echo "Installing $$egfile"; \
1.100 rillig 4218: done
1.220 wiz 4219: </pre>
4220: <p>In this case, an empty string is appended to the iteration list (to
4221: prevent the syntax error) and filtered out later.</p>
4222: <pre class="programlisting">
4223: EGFILES= # empty
1.100 rillig 4224:
1.220 wiz 4225: install-examples:
4226: .for egfile in ${EGFILES}
4227: echo "Installing ${egfile}"
1.100 rillig 4228: .endfor
1.1 grant 4229: </pre>
1.220 wiz 4230: <p>This variant only works when <code class="varname">EGFILES</code> does not
4231: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4232: simple whitespace.</p>
4233: <p>To have a shell command test whether a make variable is empty, use
4234: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.75 rillig 4235: </div>
4236: </div>
4237: </div>
1.148 asau 4238: <div class="chapter">
1.75 rillig 4239: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4240: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4241: <div class="toc">
4242: <p><b>Table of Contents</b></p>
1.210 leot 4243: <dl class="toc">
1.106 rillig 4244: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4245: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4246: <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.106 rillig 4247: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4248: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4249: <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.106 rillig 4250: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 4251: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4252: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75 rillig 4253: </dl>
4254: </div>
1.87 wiz 4255: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4256: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4257: the package (relative to the <code class="filename">${PREFIX}</code>
4258: directory it's been installed in) plus some additional statements
1.238 leot 4259: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 4260: This chapter addresses some issues that need attention when
4261: dealing with the <code class="filename">PLIST</code> file (or files, see
4262: below!).</p>
1.148 asau 4263: <div class="sect1">
1.75 rillig 4264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4265: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4266: <p>Be sure to add a RCS ID line as the first thing in any
4267: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4268: <pre class="programlisting">
1.233 sevan 4269: @comment $NetBSD $
1.222 sevan 4270: </pre>
1.235 yyamano 4271: <p>An artificial space has been added between NetBSD and $, this is a
1.233 sevan 4272: workaround here to prevent CVS expanding to the filename of the guide. When
1.238 leot 4273: adding the RCS ID the space should be omitted.</p>
1.75 rillig 4274: </div>
1.148 asau 4275: <div class="sect1">
1.75 rillig 4276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4277: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4278: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4279: to output a PLIST that matches any new files since the package
1.110 hubertf 4280: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.87 wiz 4281: more information on this target.</p>
1.75 rillig 4282: </div>
1.148 asau 4283: <div class="sect1">
1.75 rillig 4284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 4285: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4286: </h2></div></div></div>
1.87 wiz 4287: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4288: of AWK patterns and actions that are used to filter the output of
4289: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4290: scripting you like to it, but be careful with quoting.</p>
4291: <p>For example, to get all files inside the
4292: <code class="filename">libdata/foo</code> directory removed from the
4293: resulting PLIST:</p>
4294: <pre class="programlisting">
1.100 rillig 4295: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.222 sevan 4296: </pre>
1.75 rillig 4297: </div>
1.148 asau 4298: <div class="sect1">
1.75 rillig 4299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4300: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4301: <p>A number of variables are substituted automatically in
4302: PLISTs when a package is installed on a system. This includes the
4303: following variables:</p>
1.148 asau 4304: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4305: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4306: <dd>
4307: <p>Some packages like emacs and perl embed information
1.87 wiz 4308: about which architecture they were built on into the
4309: pathnames where they install their files. To handle this
4310: case, PLIST will be preprocessed before actually used, and
4311: the symbol
1.128 wiz 4312: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4313: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4314: same is done if the string
4315: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4316: PLIST somewhere - use this on packages that have GNU
4317: autoconf-created configure scripts.</p>
1.148 asau 4318: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4319: <h3 class="title">Legacy note</h3>
4320: <p>There used to be a symbol
1.128 wiz 4321: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4322: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4323: -m</strong></span>, but that's no longer supported and has
4324: been removed.</p>
1.75 rillig 4325: </div>
4326: </dd>
4327: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4328: <dd>
4329: <p>Some packages want to embed the OS name and version
1.87 wiz 4330: into some paths. To do this, use these variables in the
4331: <code class="filename">PLIST</code>:
4332: </p>
1.148 asau 4333: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4334: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">“<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</span></p></li>
4335: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">“<span class="quote">solaris</span>”</span>)</p></li>
4336: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.75 rillig 4337: </ul></div>
4338: </dd>
4339: </dl></div>
1.199 tnn 4340: <p>For a list of values which are replaced by
4341: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4342: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4343: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87 wiz 4344: <p>If you want to change other variables not listed above, you
4345: can add variables and their expansions to this variable in the
1.110 hubertf 4346: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.75 rillig 4347: <pre class="programlisting">
1.100 rillig 4348: PLIST_SUBST+= SOMEVAR="somevalue"
1.222 sevan 4349: </pre>
1.128 wiz 4350: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4351: in the <code class="filename">PLIST</code> with
1.128 wiz 4352: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4353: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4354: the common case of conditionally including some
4355: <code class="filename">PLIST</code> entries. It can be done by adding
4356: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 4357: setting the corresponding <code class="varname">PLIST.foo</code> variable
4358: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 4359: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 4360: in the <code class="filename">PLIST</code> with either
1.128 wiz 4361: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4362: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 4363: For example, in <code class="filename">Makefile</code>:</p>
4364: <pre class="programlisting">
1.223 rillig 4365: PLIST_VARS+= foo
1.119 mishka 4366: .if <em class="replaceable"><code>condition</code></em>
1.223 rillig 4367: PLIST.foo= yes
1.119 mishka 4368: .else
1.222 sevan 4369: </pre>
1.119 mishka 4370: <p>And then in <code class="filename">PLIST</code>:</p>
4371: <pre class="programlisting">
1.233 sevan 4372: @comment $NetBSD $
1.119 mishka 4373: bin/bar
4374: man/man1/bar.1
4375: ${PLIST.foo}bin/foo
4376: ${PLIST.foo}man/man1/foo.1
4377: ${PLIST.foo}share/bar/foo.data
1.222 sevan 4378: </pre>
1.235 yyamano 4379: <p>An artificial space has been added between NetBSD and $, this is a
1.233 sevan 4380: workaround here to prevent CVS expanding to the filename of the guide. When
4381: adding the RCS ID the space should be ommited.</p>
1.75 rillig 4382: </div>
1.148 asau 4383: <div class="sect1">
1.75 rillig 4384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4385: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 4386: <p>Man pages should be installed in compressed form if
1.87 wiz 4387: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4388: and uncompressed otherwise. To handle this in the
1.128 wiz 4389: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 4390: appended/removed automatically for man pages according to
4391: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4392: or not, see above for details. This modification of the
4393: <code class="filename">PLIST</code> file is done on a copy of it, not
4394: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 4395: </div>
1.148 asau 4396: <div class="sect1">
1.75 rillig 4397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4398: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 4399: </h2></div></div></div>
1.76 rillig 4400: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 4401: in generating the binary package, set the variable
4402: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.238 leot 4403: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 4404: important. The default for <code class="varname">PLIST_SRC</code> is
4405: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 4406: </div>
1.148 asau 4407: <div class="sect1">
1.75 rillig 4408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4409: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 4410: <p>Some packages decide to install a different set of files based on
1.87 wiz 4411: the operating system being used. These differences can be
4412: automatically handled by using the following files:</p>
1.148 asau 4413: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4414: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4415: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4416: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4417: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4418: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 4419: </ul></div>
4420: </div>
1.148 asau 4421: <div class="sect1">
1.75 rillig 4422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197 wiz 4423: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4424: <p>Some packages decide to generate hard-to-guess file names
4425: during installation that are hard to wire down.</p>
4426: <p>In such cases, you can set the
4427: <code class="varname">GENERATE_PLIST</code> variable to shell code
4428: terminated (with a semicolon) that will output PLIST entries which
4429: will be appended to the PLIST</p>
4430: <p>You can find one example in editors/xemacs:</p>
4431: <pre class="programlisting">
1.222 sevan 4432: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4433: </pre>
1.197 wiz 4434: <p>which will append something like
4435: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4436: <code class="filename">PLIST</code>.
4437: </p>
4438: </div>
4439: <div class="sect1">
4440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4441: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128 wiz 4442: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 4443: multiple (and unrelated) packages install files. These
1.125 wiz 4444: directories were problematic because you had to add special
4445: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 4446: centralized package handle them.</p>
1.125 wiz 4447: <p>In pkgsrc, it is now easy: Each package should create
4448: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4449: will remove any directories left empty after uninstalling a
4450: package.</p>
4451: <p>If a package needs an empty directory to work, create
4452: the directory during installation as usual, and also add an
4453: entry to the PLIST:
1.222 sevan 4454:
4455: </p>
1.87 wiz 4456: <pre class="programlisting">
1.125 wiz 4457: @pkgdir path/to/empty/directory
1.222 sevan 4458: </pre>
1.125 wiz 4459: <p>
1.222 sevan 4460:
1.197 wiz 4461: or take a look at <code class="varname">MAKE_DIRS</code> and
4462: <code class="varname">OWN_DIRS</code>.
1.125 wiz 4463: </p>
1.75 rillig 4464: </div>
4465: </div>
1.148 asau 4466: <div class="chapter">
1.75 rillig 4467: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4468: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 4469: <div class="toc">
4470: <p><b>Table of Contents</b></p>
1.210 leot 4471: <dl class="toc">
1.106 rillig 4472: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 4473: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 4474: <dd><dl>
1.106 rillig 4475: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 4476: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
4477: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4478: and
4479: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4480: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 4481: </dl></dd>
1.128 wiz 4482: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 4483: <dd><dl>
1.128 wiz 4484: <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.106 rillig 4485: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 4486: </dl></dd>
4487: </dl>
4488: </div>
4489: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 4490: are seen by a package's configure and build processes. This is implemented
4491: in a two step process:</p>
1.128 wiz 4492: <div class="orderedlist"><ol class="orderedlist" type="1">
4493: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 4494: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4495: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 4496: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 4497: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4498: <code class="option">-L${LOCALBASE}/lib</code> into references to
4499: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4500: native compiler on some operating systems look like GCC, so that
4501: packages that expect GCC won't require modifications to build with
4502: those native compilers.</p></li>
1.75 rillig 4503: </ol></div>
4504: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 4505: package may be built consistently despite what other software may be
4506: installed. Please note that the normal system header and library paths,
4507: e.g. <code class="filename">/usr/include</code>,
4508: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4509: designed to insulate the package build from non-system-supplied
4510: software.</p>
1.148 asau 4511: <div class="sect1">
1.75 rillig 4512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4513: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 4514: <p>The process of converting packages to use the buildlink3
1.128 wiz 4515: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 4516: The things to keep in mind are:</p>
1.128 wiz 4517: <div class="orderedlist"><ol class="orderedlist" type="1">
4518: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 4519: instead of the actual toolchain. Some packages are tricky,
4520: and the only way to know for sure is the check
4521: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4522: wrappers are being invoked.</p></li>
1.128 wiz 4523: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 4524: the package Makefile, e.g. Java VMs, standalone shells,
4525: etc., because the code to symlink files into
4526: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 4527: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 4528: </p></li>
1.128 wiz 4529: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 4530: <code class="filename">buildlink3.mk</code> files that you list in a
4531: package's Makefile are added as dependencies for that package.
4532: </p></li>
1.75 rillig 4533: </ol></div>
1.87 wiz 4534: <p>If a dependency on a particular package is required for its libraries and
4535: headers, then we replace:</p>
1.75 rillig 4536: <pre class="programlisting">
1.100 rillig 4537: DEPENDS+= foo>=1.1.0:../../category/foo
4538: </pre>
1.75 rillig 4539: <p>with</p>
4540: <pre class="programlisting">
1.100 rillig 4541: .include "../../category/foo/buildlink3.mk"
4542: </pre>
1.75 rillig 4543: <p>The buildlink3.mk files usually define the required dependencies.
4544: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 4545: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 4546: <pre class="programlisting">
1.100 rillig 4547: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4548: .include "../../category/foo/buildlink3.mk"
4549: </pre>
1.76 rillig 4550: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 4551: files in <code class="filename">pkgsrc/mk</code>
4552: that handle special package issues:</p>
1.148 asau 4553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4554: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 4555: the native or a pkgsrc Berkeley DB implementation based on
4556: the values of <code class="varname">BDB_ACCEPTED</code> and
4557: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 4558: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 4559: comes with neither Curses nor NCurses, this will take care
1.232 sevan 4560: 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.128 wiz 4561: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 4562: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4563: adding a dependency on Heimdal or MIT-krb5 for packages that
4564: require a Kerberos 5 implementation.</p></li>
1.128 wiz 4565: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 4566: system-provided Motif installation or adds a dependency on
1.239 leot 4567: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.128 wiz 4568: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.239 leot 4569: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
4570: to choose which Motif version will be used.</p></li>
1.161 ryoon 4571: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 4572: system-provided GNU readline or editline (libedit) installation,
1.232 sevan 4573: 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>,
4574: <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.161 ryoon 4575: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4576: If your package really needs GNU readline library, its Makefile
4577: should include <code class="filename">devel/readline/buildlink3.mk</code>
4578: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 4579: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 4580: variables that may be used by packages that use the
4581: Open Sound System (OSS) API.</p></li>
1.128 wiz 4582: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 4583: any of the Postgres versions in the variable
4584: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4585: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 4586: the file for more information.</p></li>
1.128 wiz 4587: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 4588: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.232 sevan 4589: 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.128 wiz 4590: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 4591: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4592: library.</p></li>
1.75 rillig 4593: </ul></div>
1.76 rillig 4594: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 4595: files provide a more complete
4596: description of how to use them properly.</p>
1.75 rillig 4597: </div>
1.148 asau 4598: <div class="sect1">
1.75 rillig 4599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4600: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 4601: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 4602: included by Makefiles to indicate the need to compile and link
4603: against header files and libraries provided by the package. A
4604: <code class="filename">buildlink3.mk</code> file should always provide
4605: enough information to add the correct type of dependency
4606: relationship and include any other
4607: <code class="filename">buildlink3.mk</code> files that it needs to find
4608: headers and libraries that it needs in turn.</p>
4609: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.232 sevan 4610: 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.87 wiz 4611: package is highly recommended. For most packages, the following
4612: command will generate a good starting point for
4613: <code class="filename">buildlink3.mk</code> files:</p>
4614: <pre class="screen">
4615: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4616: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4617: </pre>
1.148 asau 4618: <div class="sect2">
1.75 rillig 4619: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4620: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 4621: <p>The following real-life example
1.87 wiz 4622: <code class="filename">buildlink3.mk</code> is taken
4623: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 4624: <pre class="programlisting">
1.120 snj 4625: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 4626:
1.223 rillig 4627: BUILDLINK_TREE+= tiff
1.1 grant 4628:
1.120 snj 4629: .if !defined(TIFF_BUILDLINK3_MK)
4630: TIFF_BUILDLINK3_MK:=
1.87 wiz 4631:
1.223 rillig 4632: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4633: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4634: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 4635:
1.100 rillig 4636: .include "../../devel/zlib/buildlink3.mk"
4637: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 4638: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 4639:
1.223 rillig 4640: BUILDLINK_TREE+= -tiff
1.100 rillig 4641: </pre>
1.87 wiz 4642: <p>The header and footer manipulate
1.120 snj 4643: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 4644: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 4645: the dependency tree.</p>
4646: <p>The main section is protected from multiple inclusion
1.87 wiz 4647: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4648: added. Several important variables are set in the section:</p>
1.148 asau 4649: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4650: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4651: is the actual dependency recorded in the installed
4652: package; this should always be set using
1.110 hubertf 4653: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 4654: we're appending to any pre-existing list of values. This
4655: variable should be set to the first version of the
1.133 wiz 4656: package that had an backwards-incompatible API change.
1.87 wiz 4657: </p></li>
1.128 wiz 4658: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4659: is the location of the <em class="replaceable"><code>pkg</code></em>
4660: pkgsrc directory.</p></li>
1.128 wiz 4661: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4662: (not shown above) controls whether we use
4663: <code class="varname">BUILD_DEPENDS</code> or
4664: <code class="varname">DEPENDS</code> to add the dependency on
4665: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4666: selected by setting
4667: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4668: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 4669: used.</p></li>
1.128 wiz 4670: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4671: and
4672: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4673: (not shown above) are lists of subdirectories of
1.76 rillig 4674: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 4675: to add to the header and library search paths. These
1.128 wiz 4676: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 4677: respectively.</p></li>
1.128 wiz 4678: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4679: (not shown above) is the list of preprocessor flags to add
4680: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 4681: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 4682: should be avoided and instead be handled using
4683: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 4684: above.</p></li>
1.75 rillig 4685: </ul></div>
1.87 wiz 4686: <p>The following variables are all optionally defined within
4687: this second section (protected against multiple inclusion) and
4688: control which package files are symlinked into
4689: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4690: transformed during the symlinking:</p>
1.148 asau 4691: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4692: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4693: (not shown above) is a shell glob pattern relative to
1.76 rillig 4694: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 4695: to be symlinked into
1.76 rillig 4696: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 4697: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 4698: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4699: (not shown above) is a shell pipeline that
4700: outputs to stdout a list of files relative to
4701: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4702: The resulting files are to be symlinked
4703: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4704: this takes the <code class="filename">+CONTENTS</code> of a
4705: <em class="replaceable"><code>pkg</code></em> and filters it through
4706: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 4707: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4708: (not shown above) is a filter command that filters
1.76 rillig 4709: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 4710: relative to
1.76 rillig 4711: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194 bsiegert 4712: on stdout. By default,
1.75 rillig 4713: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 4714: outputs the contents of the <code class="filename">include</code>
4715: and <code class="filename">lib</code> directories in the package
1.194 bsiegert 4716: <code class="filename">+CONTENTS</code>.</p></li>
1.128 wiz 4717: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4718: (not shown above) is a list of sed arguments used to
4719: transform the name of the source filename into a
1.110 hubertf 4720: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 4721: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 4722: </ul></div>
1.120 snj 4723: <p>This section can additionally include any
1.87 wiz 4724: <code class="filename">buildlink3.mk</code> needed for
4725: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4726: Including these <code class="filename">buildlink3.mk</code> files
4727: means that the headers and libraries for these
4728: dependencies are also symlinked into
4729: <code class="filename">${BUILDLINK_DIR}</code>
4730: whenever the <em class="replaceable"><code>pkg</code></em>
4731: <code class="filename">buildlink3.mk</code>
1.120 snj 4732: file is included. Dependencies are only added for directly
4733: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 4734: <p>When providing a <code class="filename">buildlink3.mk</code> and
4735: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 4736: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 4737: header files are automatically exposed when the package is
4738: use.</p>
4739: <p>In particular, if only an executable
4740: (<code class="filename">bin/foo</code>) is linked against a library, that
4741: library does not need to be propagated in the
4742: <code class="filename">buildlink3.mk</code> file.</p>
4743: <p>The following steps should help you decide if a
4744: <code class="filename">buildlink3.mk</code> file needs to be included:
4745: </p>
4746: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4747: <li class="listitem"><p>Look at the installed header files: What
4748: headers do they include? The packages providing these files
4749: must be buildlinked.</p></li>
1.155 wiz 4750: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4751: libraries and look against what other libraries they link.
4752: Some of the packages providing these probably need to be
4753: buildlinked; however, it's not automatic, since e.g. GTK on
4754: some systems pulls in the X libraries, so they will show up in
4755: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 4756: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 4757: used as a hint.</p></li>
1.153 wiz 4758: </ul></div>
4759: <p>
4760: </p>
1.75 rillig 4761: </div>
1.148 asau 4762: <div class="sect2">
1.75 rillig 4763: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 4764: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 4765: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 4766: and
4767: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4768: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4769: <p>These two variables differ in that one describes source
4770: compatibility (API) and the other binary compatibility (ABI).
4771: The difference is that a change in the API breaks compilation of
4772: programs while changes in the ABI stop compiled programs from
4773: running.</p>
4774: <p>Changes to the
1.134 wiz 4775: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 4776: variable in a <code class="filename">buildlink3.mk</code> file happen
4777: very rarely. One possible reason is that all packages depending
4778: on this already need a newer version. In case it is bumped see
4779: the description below.</p>
4780: <p>The most common example of an ABI change is that the major
4781: version of a shared library is increased. In this case,
4782: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4783: should be adjusted to require at least the new package version.
4784: Then the packages that depend on this package need their
4785: <code class="varname">PKGREVISION</code>s increased and, if they have
4786: <code class="filename">buildlink3.mk</code> files, their
4787: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4788: adjusted, too. This is needed so pkgsrc will require the correct
4789: package dependency and not settle for an older one when building
4790: the source.</p>
1.218 rillig 4791: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.133 wiz 4792: more information about dependencies on other packages,
4793: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 4794: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4795: <p>Please take careful consideration before adjusting
4796: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4797: or
4798: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4799: as we don't want to cause unneeded package deletions and
4800: rebuilds. In many cases, new versions of packages work just
4801: fine with older dependencies.</p>
4802: <p>Also it is not needed to set
1.133 wiz 4803: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4804: when it is identical to
1.87 wiz 4805: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 4806: </div>
4807: </div>
1.148 asau 4808: <div class="sect1">
1.75 rillig 4809: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4810: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 4811: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 4812: coincide with headers and libraries present in the base system.
1.76 rillig 4813: Aside from a <code class="filename">buildlink3.mk</code> file, these
4814: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 4815: file that includes the necessary checks to decide whether using
4816: the built-in software or the pkgsrc software is
1.87 wiz 4817: appropriate.</p>
4818: <p>The only requirements of a builtin.mk file for
4819: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 4820: <div class="orderedlist"><ol class="orderedlist" type="1">
4821: <li class="listitem"><p>It should set
1.87 wiz 4822: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4823: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 4824: after it is included.</p></li>
1.128 wiz 4825: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 4826: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4827: which is already set before the
4828: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 4829: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 4830: is <span class="emphasis"><em>very</em></span> important and takes careful
4831: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 4832: </ol></div>
1.148 asau 4833: <div class="sect2">
1.75 rillig 4834: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4835: <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.75 rillig 4836: <p>The following is the recommended template for builtin.mk
1.87 wiz 4837: files:</p>
1.75 rillig 4838: <pre class="programlisting">
1.100 rillig 4839: .if !defined(IS_BUILTIN.foo)
4840: #
4841: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4842: # genuinely exists in the system or not.
4843: #
4844: IS_BUILTIN.foo?= no
4845:
4846: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4847: # version can be determined.
4848: #
4849: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4850: BUILTIN_PKG.foo?= foo-1.0
4851: . endif
4852: .endif # IS_BUILTIN.foo
4853:
4854: .if !defined(USE_BUILTIN.foo)
4855: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4856: . if defined(BUILTIN_PKG.foo)
4857: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4858: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4859: USE_BUILTIN.foo!= \
4860: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4861: && ${ECHO} "yes" || ${ECHO} "no"
4862: . endif
4863: . endfor
4864: . endif
4865: .endif # USE_BUILTIN.foo
4866:
4867: CHECK_BUILTIN.foo?= no
4868: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4869: #
4870: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4871: # "yes" or "no".
4872: #
4873: .endif # CHECK_BUILTIN.foo
4874: </pre>
1.87 wiz 4875: <p>The first section sets
4876: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4877: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4878: in the base system. This should not be a base system software
4879: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 4880: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 4881: included as part of the base system. This variable is only
4882: used internally within the <code class="filename">builtin.mk</code>
4883: file.</p>
4884: <p>The second section sets
4885: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4886: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4887: system if it exists (if
4888: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4889: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 4890: within the <code class="filename">builtin.mk</code> file.</p>
4891: <p>The third section sets
4892: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4893: and is <span class="emphasis"><em>required</em></span> in all
4894: <code class="filename">builtin.mk</code> files. The code in this
4895: section must make the determination whether the built-in
4896: software is adequate to satisfy the dependencies listed in
4897: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4898: This is typically done by comparing
4899: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4900: against each of the dependencies in
4901: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4902: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4903: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4904: end of the <code class="filename">builtin.mk</code> file. Note that
4905: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4906: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 4907: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4908: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 4909: that the built-in version of the software is similar enough to
4910: be used as a replacement.</p>
4911: <p>The last section is guarded by
4912: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4913: and includes code that uses the value of
4914: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4915: set in the previous section. This typically includes, e.g.,
4916: adding additional dependency restrictions and listing additional
4917: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4918: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 4919: </div>
1.148 asau 4920: <div class="sect2">
1.75 rillig 4921: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4922: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 4923: <p>When building packages, it's possible to choose whether to set
4924: a global preference for using either the built-in (native)
4925: version or the pkgsrc version of software to satisfy a
4926: dependency. This is controlled by setting
4927: <code class="varname">PREFER_PKGSRC</code> and
4928: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 4929: 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.87 wiz 4930: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4931: use the pkgsrc versions of software, while
4932: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4933: built-in versions. Preferences are determined by the most
4934: specific instance of the package in either
4935: <code class="varname">PREFER_PKGSRC</code> or
4936: <code class="varname">PREFER_NATIVE</code>. If a package is specified
4937: in neither or in both variables, then
4938: <code class="varname">PREFER_PKGSRC</code> has precedence over
4939: <code class="varname">PREFER_NATIVE</code>. For example, to require
4940: using pkgsrc versions of software for all but the most basic
4941: bits on a NetBSD system, you can set:</p>
4942: <pre class="programlisting">
1.100 rillig 4943: PREFER_PKGSRC= yes
4944: PREFER_NATIVE= getopt skey tcp_wrappers
4945: </pre>
1.87 wiz 4946: <p>A package <span class="emphasis"><em>must</em></span> have a
4947: <code class="filename">builtin.mk</code>
4948: file to be listed in <code class="varname">PREFER_NATIVE</code>,
4949: otherwise it is simply ignored in that list.</p>
1.229 sevan 4950: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
4951: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
4952: bootstrap.
4953: Switching between settings globally at a later date can introduce
4954: complications with dependency resolution. This is caused by packages
4955: built with the opposite preference being installed alongside each other.</p>
4956: <pre class="screen">
4957: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
4958: </pre>
1.75 rillig 4959: </div>
4960: </div>
4961: </div>
1.148 asau 4962: <div class="chapter">
1.75 rillig 4963: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4964: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 4965: <div class="toc">
4966: <p><b>Table of Contents</b></p>
1.210 leot 4967: <dl class="toc">
1.106 rillig 4968: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 4969: <dd><dl>
1.106 rillig 4970: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
4971: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 4972: </dl></dd>
1.106 rillig 4973: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 4974: <dd><dl>
1.128 wiz 4975: <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.106 rillig 4976: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
4977: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
4978: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
4979: </dl></dd>
4980: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
4981: <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>
4982: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
4983: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
4984: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
4985: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
4986: <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.75 rillig 4987: </dl>
4988: </div>
4989: <p>This chapter describes the framework known as
4990: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 4991: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4992: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 4993: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 4994: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 4995: provided that packages are correctly designed.</p></li>
1.128 wiz 4996: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
4997: <li class="listitem"><p>Registration of system users and groups.</p></li>
4998: <li class="listitem"><p>Registration of system shells.</p></li>
4999: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5000: </ul></div>
5001: <p>The following sections inspect each of the above points in detail.</p>
5002: <p>You may be thinking that many of the things described here could be
5003: easily done with simple code in the package's post-installation target
5004: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5005: as the code in them is only executed when building from source. Machines
5006: using binary packages could not benefit from it at all (as the code itself
5007: could be unavailable). Therefore, the only way to achieve any of the items
5008: described above is by means of the installation scripts, which are
5009: automatically generated by pkginstall.</p>
1.148 asau 5010: <div class="sect1">
1.75 rillig 5011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5012: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5013: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5014: of files and directories that belong to a package. The names used in it
1.76 rillig 5015: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5016: which means that it cannot register files outside this directory (absolute
5017: path names are not allowed). Despite this restriction, some packages need
5018: to install files outside this location; e.g., under
1.76 rillig 5019: <code class="filename">${VARBASE}</code> or
1.87 wiz 5020: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5021: is to create such files during installation time by using
5022: installation scripts.</p>
5023: <p>The generic installation scripts are shell scripts that can
5024: contain arbitrary code. The list of scripts to execute is taken from
5025: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5026: <code class="filename">INSTALL</code>. A similar variable exists for package
5027: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5028: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5029: commands, so they have the potential to create and manage files
5030: anywhere in the file system.</p>
5031: <p>Using these general installation files is not recommended, but
5032: may be needed in some special cases. One reason for avoiding them is
5033: that the user has to trust the packager that there is no unwanted or
5034: simply erroneous code included in the installation script. Also,
5035: previously there were many similar scripts for the same functionality,
5036: and fixing a common error involved finding and changing all of
5037: them.</p>
5038: <p>The pkginstall framework offers another, standardized way. It
5039: provides generic scripts to abstract the manipulation of such files
5040: and directories based on variables set in the package's
5041: <code class="filename">Makefile</code>. The rest of this section describes
5042: these variables.</p>
1.148 asau 5043: <div class="sect2">
1.75 rillig 5044: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5045: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5046: <p>The following variables can be set to request the creation of
5047: directories anywhere in the file system:</p>
1.148 asau 5048: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218 rillig 5049: <li class="listitem">
5050: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5051: contain a list of directories that should be created and should attempt
5052: to be destroyed by the installation scripts. The difference between
5053: the two is that the latter prompts the administrator to remove any
5054: directories that may be left after deinstallation (because they were
1.218 rillig 5055: not empty), while the former does not. Example:</p>
5056: <pre class="programlisting">
5057: MAKE_DIRS+= ${VARBASE}/foo/private
5058: </pre>
5059: </li>
1.128 wiz 5060: <li class="listitem">
1.75 rillig 5061: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5062: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5063: which directories should be created and should attempt to be destroyed
5064: by the installation scripts. Each tuple holds the following values,
5065: separated by spaces: the directory name, its owner, its group and its
5066: numerical mode. For example:</p>
5067: <pre class="programlisting">
1.218 rillig 5068: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5069: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 grant 5070: </pre>
1.75 rillig 5071: <p>The difference between the two is exactly the same as their
5072: non-<code class="varname">PERMS</code> counterparts.</p>
5073: </li>
5074: </ul></div>
5075: </div>
1.148 asau 5076: <div class="sect2">
1.75 rillig 5077: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5078: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5079: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5080: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5081: To overcome this problem, the only solution is to extract the file in the
5082: known place (i.e., inside the installation prefix) and copy it to the
5083: appropriate location during installation (done by the installation scripts
5084: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5085: file</em></span> in the following paragraphs, which describe the variables
5086: that can be used to automatically and consistently handle files outside the
5087: installation prefix:</p>
1.148 asau 5088: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5089: <li class="listitem">
1.75 rillig 5090: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5091: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5092: During installation time, the master file is copied to the target one
5093: if and only if the latter does not exist. Upon deinstallation, the
5094: target file is removed provided that it was not modified by the
5095: installation.</p>
5096: <p>The difference between the two is that the latter prompts the
5097: administrator to remove any files that may be left after
5098: deinstallation (because they were not empty), while the former does
5099: not.</p>
5100: </li>
1.128 wiz 5101: <li class="listitem">
1.75 rillig 5102: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5103: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5104: files as well as their target locations. For each of them, it also
5105: specifies their owner, their group and their numeric permissions, in
5106: this order. For example:</p>
5107: <pre class="programlisting">
1.218 rillig 5108: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5109: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 grant 5110: </pre>
1.75 rillig 5111: <p>The difference between the two is exactly the same as their
5112: non-<code class="varname">PERMS</code> counterparts.</p>
5113: </li>
5114: </ul></div>
5115: </div>
5116: </div>
1.148 asau 5117: <div class="sect1">
1.75 rillig 5118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5119: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5120: <p>Configuration files are special in the sense that they are installed
5121: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5122: need special treatment during installation (most of which is automated by
5123: pkginstall). The main concept you must bear in mind is that files marked
5124: as configuration files are automatically copied to the right place (somewhere
5125: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5126: and only if</em></span> they didn't exist before. Similarly, they will not
5127: be removed if they have local modifications. This ensures that
5128: administrators never lose any custom changes they may have made.</p>
1.148 asau 5129: <div class="sect2">
1.75 rillig 5130: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5131: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 5132: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5133: specifies where configuration files shall be installed. Its contents are
5134: set based upon the following variables:</p>
1.148 asau 5135: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5136: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5137: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5138: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5139: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5140: Packages must not use it directly.</p></li>
1.128 wiz 5141: <li class="listitem">
1.75 rillig 5142: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5143: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5144: for the package being built shall be installed. The definition of this
5145: variable only makes sense in the package's
1.76 rillig 5146: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5147: <p>As an example, consider the Apache package,
1.232 sevan 5148: <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.75 rillig 5149: configuration files under the
1.76 rillig 5150: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5151: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5152: Makefile.</p>
5153: </li>
1.128 wiz 5154: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5155: variable that holds this package's configuration directory (if
5156: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5157: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5158: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5159: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5160: directory where the configuration files for the package identified by
5161: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5162: </ul></div>
5163: <p>Based on the above variables, pkginstall determines the value of
5164: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5165: variable that can be used within a package to refer to its configuration
5166: directory. The algorithm used to set its value is basically the
5167: following:</p>
1.128 wiz 5168: <div class="orderedlist"><ol class="orderedlist" type="1">
5169: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5170: its value is used.</p></li>
1.128 wiz 5171: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5172: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5173: <code class="filename">Makefile</code>, the resulting value is
5174: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5175: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5176: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5177: </ol></div>
1.76 rillig 5178: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5179: 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
5180: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5181: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5182: </div>
1.148 asau 5183: <div class="sect2">
1.75 rillig 5184: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5185: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5186: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5187: known place, you need to teach each package where it shall install its
5188: files. In some cases you will have to patch the package Makefiles to
5189: achieve it. If you are lucky, though, it may be as easy as passing an
5190: extra flag to the configuration script; this is the case of GNU Autoconf-
5191: generated files:</p>
5192: <pre class="programlisting">
1.100 rillig 5193: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5194: </pre>
1.75 rillig 5195: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5196: for</em></span> its configuration files, not where they will be originally
5197: installed (although the difference is never explicit,
5198: unfortunately).</p>
5199: </div>
1.148 asau 5200: <div class="sect2">
1.75 rillig 5201: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5202: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5203: <p>As said before, pkginstall automatically handles configuration files.
5204: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5205: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5206: directly</strong></span>. Bad news is that many software installation scripts
5207: will, out of the box, mess with the contents of that directory. So what is
5208: the correct procedure to fix this issue?</p>
5209: <p>You must teach the package (usually by manually patching it) to
5210: install any configuration files under the examples hierarchy,
1.76 rillig 5211: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5212: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5213: has the original copies available.</p>
5214: <p>Once the required configuration files are in place (i.e., under the
5215: examples hierarchy), the pkginstall framework can use them as master copies
5216: during the package installation to update what is in
1.76 rillig 5217: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5218: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5219: 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.75 rillig 5220: about their syntax and their purpose. Here is an example, taken from the
1.232 sevan 5221: <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.75 rillig 5222: <pre class="programlisting">
1.100 rillig 5223: EGDIR= ${PREFIX}/share/doc/mutt/samples
5224: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5225: </pre>
1.75 rillig 5226: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5227: package and has no meaning outside it.</p>
5228: </div>
1.148 asau 5229: <div class="sect2">
1.75 rillig 5230: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5231: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5232: <p>The automatic copying of config files can be toggled by setting the
5233: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5234: installation.</p>
5235: </div>
5236: </div>
1.148 asau 5237: <div class="sect1">
1.75 rillig 5238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5239: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5240: <p>System startup scripts are special files because they must be
5241: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5242: 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.75 rillig 5243: can be used. However, pkginstall provides a special mechanism to handle
5244: these files.</p>
5245: <p>In order to provide system startup scripts, the package has
5246: to:</p>
1.128 wiz 5247: <div class="orderedlist"><ol class="orderedlist" type="1">
5248: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5249: the <code class="literal">.sh</code> suffix appended. Considering the
1.232 sevan 5250: <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.76 rillig 5251: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5252: <li class="listitem">
1.75 rillig 5253: <p>Tell pkginstall to handle it, appending the name of the script,
5254: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5255: Continuing the previous example:</p>
5256: <pre class="programlisting">
1.100 rillig 5257: RCD_SCRIPTS+= cupsd
1.1 grant 5258: </pre>
1.75 rillig 5259: </li>
5260: </ol></div>
5261: <p>Once this is done, pkginstall will do the following steps for each
5262: script in an automated fashion:</p>
1.128 wiz 5263: <div class="orderedlist"><ol class="orderedlist" type="1">
5264: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5265: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5266: variable.</p></li>
1.128 wiz 5267: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5268: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5269: that this master file must be explicitly registered in the
1.76 rillig 5270: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5271: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5272: from the examples hierarchy into the system-wide startup scripts
5273: directory.</p></li>
5274: </ol></div>
1.148 asau 5275: <div class="sect2">
1.75 rillig 5276: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5277: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5278: <p>The automatic copying of config files can be toggled by setting the
5279: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5280: installation. Note that the scripts will be always copied inside the
1.76 rillig 5281: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5282: matter what the value of this variable is.</p>
5283: </div>
5284: </div>
1.148 asau 5285: <div class="sect1">
1.75 rillig 5286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5287: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5288: <p>If a package needs to create special users and/or groups during
5289: installation, it can do so by using the pkginstall framework.</p>
5290: <p>Users can be created by adding entries to the
5291: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5292: syntax:</p>
5293: <pre class="programlisting">
1.100 rillig 5294: user:group
1.1 grant 5295: </pre>
1.87 wiz 5296: <p>Further specification of user details may be done by setting
5297: per-user variables.
5298: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5299: numeric UID for the user.
5300: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5301: user's description or comment.
5302: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5303: user's home directory, and defaults to
5304: <code class="filename">/nonexistent</code> if not specified.
5305: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5306: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5307: not specified.</p>
1.75 rillig 5308: <p>Similarly, groups can be created by adding entries to the
5309: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5310: <pre class="programlisting">
1.100 rillig 5311: group
1.1 grant 5312: </pre>
1.93 rillig 5313: <p>The numeric GID of the group may be set by defining
1.75 rillig 5314: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5315: <p>If a package needs to create the users and groups at an earlier
1.227 wiz 5316: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5317: <code class="literal">configure</code>,<code class="literal">build</code>, or
5318: <code class="literal">pre-install</code> to indicate the phase before which the
5319: users and groups are created. In this case, the numeric UIDs and GIDs
5320: of the created users and groups are automatically hardcoded into the
5321: final installation scripts.</p>
1.75 rillig 5322: </div>
1.148 asau 5323: <div class="sect1">
1.75 rillig 5324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5325: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5326: <p>Packages that install system shells should register them in the shell
1.76 rillig 5327: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5328: administrator. This must be done from the installation scripts to keep
5329: binary packages working on any system. pkginstall provides an easy way to
5330: accomplish this task.</p>
5331: <p>When a package provides a shell interpreter, it has to set the
5332: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5333: add some hooks to the installation scripts to handle it. Consider the
1.232 sevan 5334: 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.75 rillig 5335: <pre class="programlisting">
1.100 rillig 5336: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5337: </pre>
1.148 asau 5338: <div class="sect2">
1.75 rillig 5339: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5340: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5341: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5342: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5343: environment variable to <code class="literal">NO</code>.</p>
5344: </div>
5345: </div>
1.148 asau 5346: <div class="sect1">
1.75 rillig 5347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5348: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5349: <p>Packages that install X11 fonts should update the database files
5350: that index the fonts within each fonts directory. This can easily be
5351: accomplished within the pkginstall framework.</p>
5352: <p>When a package installs X11 fonts, it must list the directories in
5353: which fonts are installed in the
5354: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5355: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5356: <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.75 rillig 5357: installation scripts to run the appropriate commands to update the fonts
5358: database files within each of those directories. For convenience, if the
5359: directory path is relative, it is taken to be relative to the package's
1.232 sevan 5360: 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.75 rillig 5361: <pre class="programlisting">
1.175 wiz 5362: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5363: </pre>
1.148 asau 5364: <div class="sect2">
1.75 rillig 5365: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5366: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5367: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5368: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5369: environment variable to <code class="literal">NO</code>.</p>
5370: </div>
5371: </div>
5372: </div>
1.148 asau 5373: <div class="chapter">
1.75 rillig 5374: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5375: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 5376: <div class="toc">
5377: <p><b>Table of Contents</b></p>
1.210 leot 5378: <dl class="toc">
1.106 rillig 5379: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 5380: <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.106 rillig 5381: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 5382: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 5383: </dl>
5384: </div>
5385: <p>Many packages have the ability to be built to support different
1.76 rillig 5386: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 5387: in pkgsrc that provides generic handling of those options that
5388: determine different ways in which the packages can be built. It's
5389: possible for the user to specify exactly which sets of options will be
5390: built into a package or to allow a set of global default options
5391: apply.</p>
1.107 rillig 5392: <p>There are two broad classes of behaviors that one might want to
5393: control via options. One is whether some particular feature is
5394: enabled in a program that will be built anyway, often by including or
5395: not including a dependency on some other package. The other is
5396: whether or not an additional program will be built as part of the
5397: package. Generally, it is better to make a split package for such
5398: additional programs instead of using options, because it enables
5399: binary packages to be built which can then be added separately. For
5400: example, the foo package might have minimal dependencies (those
5401: packages without which foo doesn't make sense), and then the foo-gfoo
5402: package might include the GTK frontend program gfoo. This is better
5403: than including a gtk option to foo that adds gfoo, because either that
5404: option is default, in which case binary users can't get foo without
5405: gfoo, or not default, in which case they can't get gfoo. With split
5406: packages, they can install foo without having GTK, and later decide to
5407: install gfoo (pulling in GTK at that time). This is an advantage to
5408: source users too, avoiding the need for rebuilds.</p>
5409: <p>Plugins with widely varying dependencies should usually be split
5410: instead of options.</p>
5411: <p>It is often more work to maintain split packages, especially if
5412: the upstream package does not support this. The decision of split
5413: vs. option should be made based on the likelihood that users will want
5414: or object to the various pieces, the size of the dependencies that are
5415: included, and the amount of work.</p>
5416: <p>A further consideration is licensing. Non-free parts, or parts
5417: that depend on non-free dependencies (especially plugins) should
5418: almost always be split if feasible.</p>
1.148 asau 5419: <div class="sect1">
1.75 rillig 5420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5421: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 5422: <p>Global default options are listed in
5423: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5424: that should be built into every package if that option is supported.
1.110 hubertf 5425: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5426: </div>
1.148 asau 5427: <div class="sect1">
1.75 rillig 5428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5429: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 5430: </h2></div></div></div>
1.75 rillig 5431: <p>The following example shows how
1.76 rillig 5432: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 5433: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 5434: <code class="filename">Makefile</code>, or in a file,
5435: e.g. <code class="filename">options.mk</code>, that is included by the
5436: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5437: <pre class="programlisting">
1.100 rillig 5438: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5439: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5440: PKG_OPTIONS_OPTIONAL_GROUPS= database
5441: PKG_OPTIONS_GROUP.database= mysql pgsql
5442: PKG_SUGGESTED_OPTIONS= wibble-foo
5443: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5444: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5445:
5446: .include "../../mk/bsd.prefs.mk"
5447:
5448: # this package was previously named wibble2
5449: .if defined(PKG_OPTIONS.wibble2)
5450: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5451: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5452: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5453: .endif
5454:
5455: .include "../../mk/bsd.options.mk"
5456:
5457: # Package-specific option-handling
5458:
5459: ###
5460: ### FOO support
5461: ###
5462: .if !empty(PKG_OPTIONS:Mwibble-foo)
5463: CONFIGURE_ARGS+= --enable-foo
5464: .endif
5465:
5466: ###
5467: ### LDAP support
5468: ###
5469: .if !empty(PKG_OPTIONS:Mldap)
5470: . include "../../databases/openldap-client/buildlink3.mk"
5471: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5472: .endif
5473:
5474: ###
5475: ### database support
5476: ###
5477: .if !empty(PKG_OPTIONS:Mmysql)
5478: . include "../../mk/mysql.buildlink3.mk"
5479: .endif
5480: .if !empty(PKG_OPTIONS:Mpgsql)
5481: . include "../../mk/pgsql.buildlink3.mk"
5482: .endif
1.75 rillig 5483: </pre>
5484: <p>The first section contains the information about which build
5485: options are supported by the package, and any default options settings
5486: if needed.</p>
1.128 wiz 5487: <div class="orderedlist"><ol class="orderedlist" type="1">
5488: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.238 leot 5489: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75 rillig 5490: options. It should be set to
1.78 rillig 5491: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5492: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5493: at the point where the options are processed.</p></li>
1.128 wiz 5494: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 5495: build options supported by the package.</p></li>
1.128 wiz 5496: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 5497: list of names of groups of mutually exclusive options. The options in
5498: each group are listed in
5499: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5500: The most specific setting of any option from the group takes
5501: precedence over all other options in the group. Options from the
5502: groups will be automatically added to
5503: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 5504: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 5505: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5506: packages will fail if no option from the group is
5507: selected.</p></li>
1.128 wiz 5508: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 5509: of names of sets of options. At least one option from each set must
5510: be selected. The options in each set are listed in
5511: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5512: Options from the sets will be automatically added to
5513: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5514: fail if no option from the set is selected.</p></li>
1.128 wiz 5515: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 5516: build options which are enabled by default.</p></li>
1.128 wiz 5517: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 5518: of
1.128 wiz 5519: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.110 hubertf 5520: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 5521: their option counterparts. Pairs should be added with
1.128 wiz 5522: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 5523: warning will be issued if the user uses a legacy
5524: variable.</p></li>
1.128 wiz 5525: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 5526: of
1.128 wiz 5527: <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.75 rillig 5528: pairs that map options that have been renamed to their new
1.128 wiz 5529: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 5530: the listing of global legacy options. A warning will be issued if
5531: the user uses a legacy option.</p></li>
1.128 wiz 5532: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 5533: options implied by deprecated variables used. This can be used for
5534: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5535: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5536: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 5537: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 5538: a list of warnings about deprecated variables or options used, and
5539: what to use instead.</p></li>
5540: </ol></div>
5541: <p>A package should never modify
5542: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5543: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5544: To suggest a default set of options, use
5545: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5546: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 5547: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 5548: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5549: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5550: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5551: happen with platform-specific options if none of them is supported on
5552: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5553: empty list and the package is otherwise treated as not using the
5554: options framework.</p>
1.76 rillig 5555: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 5556: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5557: build options, properly filtered to remove unsupported and duplicate
5558: options.</p>
5559: <p>The remaining sections contain the logic that is specific to
5560: each option. The correct way to check for an option is to check
5561: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5562: <pre class="programlisting">
1.100 rillig 5563: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 5564: </pre>
5565: </div>
1.148 asau 5566: <div class="sect1">
1.75 rillig 5567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5568: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 5569: <p>Options that enable similar features in different packages (like
5570: optional support for a library) should use a common name in all
5571: packages that support it (like the name of the library). If another
5572: package already has an option with the same meaning, use the same
5573: name.</p>
5574: <p>Options that enable features specific to one package, where it's
5575: unlikely that another (unrelated) package has the same (or a similar)
5576: optional feature, should use a name prefixed with
5577: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5578: <p>If a group of related packages share an optional feature
5579: specific to that group, prefix it with the name of the
1.128 wiz 5580: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 5581: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5582: <p>For new options, add a line to
1.76 rillig 5583: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 5584: fields, separated by tab. The first field is the option name, the
5585: second its description. The description should be a whole sentence
5586: (starting with an uppercase letter and ending with a period) that
1.128 wiz 5587: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5588: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 5589: </div>
1.148 asau 5590: <div class="sect1">
1.107 rillig 5591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5592: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 5593: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107 rillig 5594: different dependencies based on the options with which the package was
5595: built. For querying these options, the file
5596: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5597: typical example looks like this:</p>
5598: <pre class="programlisting">
5599: pkgbase := libpurple
5600: .include "../../mk/pkg-build-options.mk"
5601:
5602: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5603: ...
5604: .endif
5605: </pre>
5606: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5607: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5608: options of the libpurple package, which can then be queried like
5609: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5610: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5611: details.</p>
5612: </div>
1.75 rillig 5613: </div>
1.148 asau 5614: <div class="chapter">
1.75 rillig 5615: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5616: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 5617: <div class="toc">
5618: <p><b>Table of Contents</b></p>
1.210 leot 5619: <dl class="toc">
1.106 rillig 5620: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
5621: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
5622: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
5623: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 5624: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 5625: <dd><dl>
5626: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
5627: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
5628: </dl></dd>
1.128 wiz 5629: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5630: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5631: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5632: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5633: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5634: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5635: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5636: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5637: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5638: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 5639: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
5640: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 5641: </dl>
5642: </div>
1.148 asau 5643: <div class="sect1">
1.75 rillig 5644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5645: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 5646: <p>This chapter gives a detailed description on how a package is
1.87 wiz 5647: built. Building a package is separated into different
5648: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5649: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 5650: described in the following sections. Each phase is split into
1.87 wiz 5651: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5652: containing phase, prefixed by one of <code class="varname">pre-</code>,
5653: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5654: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5655: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 5656: <p>Never override the regular targets (like
5657: <code class="varname">fetch</code>), if you have to, override the
5658: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 5659: <p>The basic steps for building a program are always the same. First
1.87 wiz 5660: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5661: the local system and then extracted. After any pkgsrc-specific patches
5662: to compile properly are applied, the software can be configured, then
5663: built (usually by compiling), and finally the generated binaries, etc.
5664: can be put into place on the system.</p>
1.97 rillig 5665: <p>To get more details about what is happening at each step,
5666: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5667: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5668: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 5669: </div>
1.148 asau 5670: <div class="sect1">
1.75 rillig 5671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5672: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 5673: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 5674: the next section, here's a brief discussion on where programs are
5675: installed, and which variables influence this.</p>
1.75 rillig 5676: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 5677: where all files of the final program shall be installed. It is
5678: usually set to <code class="varname">LOCALBASE</code>
5679: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 5680: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 5681: <code class="varname">PREFIX</code> needs to be put
5682: into the various places in the program's source where paths to
1.219 rillig 5683: 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.75 rillig 5684: <p>When choosing which of these variables to use,
1.87 wiz 5685: follow the following rules:</p>
1.148 asau 5686: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5687: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 5688: where the current pkg will be installed. When referring to a
5689: pkg's own installation path, use
1.128 wiz 5690: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5691: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 5692: are installed. If you need to construct a -I or -L argument
5693: to the compiler to find includes and libraries installed by
1.128 wiz 5694: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 5695: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5696: installed all packages in <code class="filename">/usr/local</code>. As
5697: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5698: administrator, this variable is a misnomer.</p></li>
1.128 wiz 5699: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 5700: distribution (from xsrc, etc.) is installed. When looking for
5701: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 5702: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.209 sevan 5703: <li class="listitem"><p>X11-based packages using imake must set
5704: <code class="varname">USE_IMAKE</code> to be installed correctly under
5705: <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5706: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.238 leot 5707: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 5708: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5709: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 5710: </ul></div>
5711: </div>
1.148 asau 5712: <div class="sect1">
1.75 rillig 5713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5714: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 5715: <p>When building a package, various directories are used to store
1.87 wiz 5716: source files, temporary files, pkgsrc-internal files, and so on. These
5717: directories are explained here.</p>
1.75 rillig 5718: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 5719: are two common base directories for these relative directories:
5720: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5721: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5722: inside the package itself.</p>
1.148 asau 5723: <div class="variablelist"><dl class="variablelist">
1.75 rillig 5724: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5725: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 5726: root directory. Generally, you don't need
5727: it.</p></dd>
1.97 rillig 5728: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5729: <dd><p>This is an absolute pathname that points to the
5730: current package.</p></dd>
1.75 rillig 5731: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5732: <dd><p>This is a pathname relative to
1.87 wiz 5733: <code class="varname">PKGSRCDIR</code> that points to the current
5734: package.</p></dd>
1.75 rillig 5735: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5736: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 5737: where all work takes place. The distfiles are extracted to this
1.87 wiz 5738: directory. It also contains temporary directories and log files used by
5739: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5740: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 5741: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5742: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 5743: where the distfiles are extracted. It is usually a direct subdirectory
5744: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5745: that isn't hidden. This variable may be changed by a package
5746: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 5747: </dl></div>
1.114 jmcneill 5748: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5749: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 5750: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 5751: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5752: If users would like to have their pkgsrc trees behave in a
5753: read-only manner, then the value of
5754: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5755: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 5756: </div>
1.148 asau 5757: <div class="sect1">
1.75 rillig 5758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5759: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 5760: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 5761: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5762: phase. This will automatically run all phases that are required for this
5763: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 5764: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 5765: the package will be built, but not installed.</p>
1.75 rillig 5766: </div>
1.148 asau 5767: <div class="sect1">
1.75 rillig 5768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5769: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 5770: <p>The first step in building a package is to fetch the
1.88 wiz 5771: distribution files (distfiles) from the sites that are providing
5772: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5773: phase.</p>
1.148 asau 5774: <div class="sect2">
1.81 rillig 5775: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5776: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 5777: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5778: defines all URLs from where the distfile, whose name is
5779: derived from the <code class="varname">DISTNAME</code> variable, is
5780: fetched. The more complicated cases are described
5781: below.</p>
5782: <p>The variable <code class="varname">DISTFILES</code> specifies
5783: the list of distfiles that have to be fetched. Its value
1.174 asau 5784: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5785: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 5786: so that most packages don't need to define it at all.
5787: <code class="varname">EXTRACT_SUFX</code> is
5788: <code class="literal">.tar.gz</code> by default, but can be changed
5789: freely. Note that if your package requires additional
5790: distfiles to the default one, you cannot just append the
5791: additional filenames using the <code class="literal">+=</code>
5792: operator, but you have write for example:</p>
1.81 rillig 5793: <pre class="programlisting">
1.174 asau 5794: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 5795: </pre>
1.88 wiz 5796: <p>Each distfile is fetched from a list of sites, usually
5797: <code class="varname">MASTER_SITES</code>. If the package has multiple
5798: <code class="varname">DISTFILES</code> or multiple
5799: <code class="varname">PATCHFILES</code> from different sites, you can
5800: set
5801: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5802: to the list of URLs where the file
5803: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5804: (including the suffix) can be found.</p>
5805: <pre class="programlisting">
1.100 rillig 5806: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5807: DISTFILES+= foo-file.tar.gz
5808: SITES.foo-file.tar.gz= \
5809: http://www.somewhere.com/somehow/ \
5810: http://www.somewhereelse.com/mirror/somehow/
5811: </pre>
1.81 rillig 5812: <p>When actually fetching the distfiles, each item from
1.88 wiz 5813: <code class="varname">MASTER_SITES</code> or
5814: <code class="varname">SITES.*</code> gets the name of each distfile
5815: appended to it, without an intermediate slash. Therefore,
5816: all site values have to end with a slash or other separator
5817: character. This allows for example to set
5818: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5819: that gets the name of the distfile as a parameter. In this
5820: case, the definition would look like:</p>
1.81 rillig 5821: <pre class="programlisting">
1.100 rillig 5822: MASTER_SITES= http://www.example.com/download.cgi?file=
5823: </pre>
1.125 wiz 5824: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 5825: In that case the URL is taken as is, fetched and the result
5826: stored under the name of the distfile. You can use this style
5827: for the case when the download URL style does not match the
5828: above common case. For example, if permanent download URL is a
5829: redirector to the real download URL, or the download file name
5830: is offered by an HTTP Content-Disposition header. In the
5831: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5832: created instead of the default
5833: <code class="filename">v1.0.0.tar.gz</code>.</p>
5834: <pre class="programlisting">
5835: DISTNAME= foo-1.0.0
5836: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5837: </pre>
1.81 rillig 5838: <p>There are some predefined values for
1.88 wiz 5839: <code class="varname">MASTER_SITES</code>, which can be used in
5840: packages. The names of the variables should speak for
5841: themselves.</p>
5842: <pre class="programlisting">
1.100 rillig 5843: ${MASTER_SITE_APACHE}
5844: ${MASTER_SITE_BACKUP}
5845: ${MASTER_SITE_CYGWIN}
5846: ${MASTER_SITE_DEBIAN}
5847: ${MASTER_SITE_FREEBSD}
5848: ${MASTER_SITE_FREEBSD_LOCAL}
5849: ${MASTER_SITE_GENTOO}
5850: ${MASTER_SITE_GNOME}
5851: ${MASTER_SITE_GNU}
5852: ${MASTER_SITE_GNUSTEP}
1.174 asau 5853: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 5854: ${MASTER_SITE_IFARCHIVE}
5855: ${MASTER_SITE_KDE}
5856: ${MASTER_SITE_MOZILLA}
1.174 asau 5857: ${MASTER_SITE_MOZILLA_ALL}
5858: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 5859: ${MASTER_SITE_MYSQL}
1.174 asau 5860: ${MASTER_SITE_NETLIB}
1.100 rillig 5861: ${MASTER_SITE_OPENOFFICE}
1.208 ryoon 5862: ${MASTER_SITE_OSDN}
1.100 rillig 5863: ${MASTER_SITE_PERL_CPAN}
5864: ${MASTER_SITE_PGSQL}
1.174 asau 5865: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 5866: ${MASTER_SITE_R_CRAN}
5867: ${MASTER_SITE_SOURCEFORGE}
5868: ${MASTER_SITE_SUNSITE}
5869: ${MASTER_SITE_SUSE}
5870: ${MASTER_SITE_TEX_CTAN}
5871: ${MASTER_SITE_XCONTRIB}
5872: ${MASTER_SITE_XEMACS}
1.174 asau 5873: ${MASTER_SITE_XORG}
1.100 rillig 5874: </pre>
1.88 wiz 5875: <p>Some explanations for the less self-explaining ones:
5876: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 5877: 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.132 spz 5878: 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.88 wiz 5879: <p>If you choose one of these predefined sites, you may
5880: want to specify a subdirectory of that site. Since these
5881: macros may expand to more than one actual site, you
5882: <span class="emphasis"><em>must</em></span> use the following construct to
5883: specify a subdirectory:</p>
1.81 rillig 5884: <pre class="programlisting">
1.100 rillig 5885: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5886: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5887: </pre>
1.81 rillig 5888: <p>Note the trailing slash after the subdirectory
1.88 wiz 5889: name.</p>
1.81 rillig 5890: </div>
1.148 asau 5891: <div class="sect2">
1.81 rillig 5892: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5893: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 5894: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5895: all the distfiles exist in a local directory
1.93 rillig 5896: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 5897: user). If the files do not exist, they are fetched using
5898: commands of the form</p>
1.75 rillig 5899: <pre class="programlisting">
1.100 rillig 5900: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5901: </pre>
1.88 wiz 5902: <p>where <code class="literal">${site}</code> varies through
5903: several possibilities in turn: first,
5904: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
5905: sites specified in either <code class="varname">SITES.file</code> if
5906: defined, else <code class="varname">MASTER_SITES</code> or
5907: <code class="varname">PATCH_SITES</code>, as applies, then finally the
5908: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 5909: all except the first and the last can be optionally sorted
5910: by the user, via setting either
5911: <code class="varname">MASTER_SORT_RANDOM</code>, and
5912: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 5913: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 5914: <p> The specific command and arguments used depend on the
5915: <code class="varname">FETCH_USING</code> parameter. The example above is
5916: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 5917: <p>The distfiles mirror run by the NetBSD Foundation uses the
5918: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
5919: distfiles, if they are freely distributable. Packages setting
5920: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 5921: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 5922: mirrored.</p>
1.81 rillig 5923: </div>
1.75 rillig 5924: </div>
1.148 asau 5925: <div class="sect1">
1.75 rillig 5926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5927: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 5928: <p>After the distfile(s) are fetched, their checksum is
5929: generated and compared with the checksums stored in the
5930: distinfo file. If the checksums don't match, the build is
5931: aborted. This is to ensure the same distfile is used for
5932: building, and that the distfile wasn't changed, e.g. by some
5933: malign force, deliberately changed distfiles on the master
5934: distribution site or network lossage.</p>
1.75 rillig 5935: </div>
1.148 asau 5936: <div class="sect1">
1.75 rillig 5937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5938: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 5939: <p>When the distfiles are present on the local system, they
1.88 wiz 5940: need to be extracted, as they usually come in the form of some
5941: compressed archive format.</p>
1.75 rillig 5942: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 5943: extracted. If you only need some of them, you can set the
5944: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
5945: files.</p>
5946: <p>Extracting the files is usually done by a little
1.93 rillig 5947: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 5948: already knows how to extract various archive formats, so most
5949: likely you will not need to change anything here. But if you
5950: need, the following variables may help you:</p>
1.148 asau 5951: <div class="variablelist"><dl class="variablelist">
1.75 rillig 5952: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
5953: <dd><p>Use these variables to override the default
1.88 wiz 5954: options for an extract command, which are defined in
1.93 rillig 5955: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 5956: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
5957: <dd><p>This variable can be set to
1.114 jmcneill 5958: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
5959: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 5960: absolute pathname pointing to the command with which tar
1.114 jmcneill 5961: archives should be extracted. It is preferred to choose bsdtar over gtar
5962: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 5963: </dl></div>
1.88 wiz 5964: <p>If the <code class="filename">extract</code> program doesn't
5965: serve your needs, you can also override the
5966: <code class="varname">EXTRACT_CMD</code> variable, which holds the
5967: command used for extracting the files. This command is
5968: executed in the <code class="filename">${WRKSRC}</code>
5969: directory. During execution of this command, the shell
5970: variable <code class="varname">extract_file</code> holds the absolute
5971: pathname of the file that is going to be extracted.</p>
1.75 rillig 5972: <p>And if that still does not suffice, you can override the
1.88 wiz 5973: <code class="varname">do-extract</code> target in the package
5974: Makefile.</p>
1.75 rillig 5975: </div>
1.148 asau 5976: <div class="sect1">
1.75 rillig 5977: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5978: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 5979: <p>After extraction, all the patches named by the
1.88 wiz 5980: <code class="varname">PATCHFILES</code>, those present in the patches
5981: subdirectory of the package as well as in
5982: $LOCALPATCHES/$PKGPATH (e.g.
5983: <code class="filename">/usr/local/patches/graphics/png</code>) are
5984: applied. Patchfiles ending in <code class="filename">.Z</code> or
5985: <code class="filename">.gz</code> are uncompressed before they are
5986: applied, files ending in <code class="filename">.orig</code> or
5987: <code class="filename">.rej</code> are ignored. Any special options to
1.238 leot 5988: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.219 rillig 5989: <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.238 leot 5990: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 5991: it fail if the patches apply with some lines of fuzz. Please
5992: fix (regen) the patches so that they apply cleanly. The
5993: rationale behind this is that patches that don't apply cleanly
5994: may end up being applied in the wrong place, and cause severe
5995: harm there.</p>
1.75 rillig 5996: </div>
1.148 asau 5997: <div class="sect1">
1.75 rillig 5998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5999: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6000: <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.88 wiz 6001: </p>
1.75 rillig 6002: </div>
1.148 asau 6003: <div class="sect1">
1.75 rillig 6004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6005: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6006: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6007: linkers. The following variables can be used to tweak the
6008: wrappers.</p>
1.148 asau 6009: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6010: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6011: <dd><p>The command used to print progress
1.88 wiz 6012: messages. Does nothing by default. Set to
6013: <code class="literal">${ECHO}</code> to see the progress
6014: messages.</p></dd>
1.75 rillig 6015: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6016: <dd><p>This variable can be set to
1.88 wiz 6017: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6018: depending on whether you want additional information in the
6019: wrapper log file.</p></dd>
1.75 rillig 6020: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6021: <dd><p>This variable can be set to
1.88 wiz 6022: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6023: on whether the wrapper should use its cache, which will
6024: improve the speed. The default value is
6025: <code class="literal">yes</code>, but is forced to
6026: <code class="literal">no</code> if the platform does not support
6027: it.</p></dd>
1.75 rillig 6028: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6029: <dd><p>A list of reordering commands. A reordering
6030: command has the form
6031: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6032: It ensures that that
6033: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6034: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6035: </p></dd>
1.75 rillig 6036: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6037: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6038: investigate further]</p></dd>
1.75 rillig 6039: </dl></div>
6040: </div>
1.148 asau 6041: <div class="sect1">
1.75 rillig 6042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6043: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6044: <p>Most pieces of software need information on the header
6045: files, system calls, and library routines which are available
6046: on the platform they run on. The process of determining this
6047: information is known as configuration, and is usually
6048: automated. In most cases, a script is supplied with the
6049: distfiles, and its invocation results in generation of header
6050: files, Makefiles, etc.</p>
6051: <p>If the package contains a configure script, this can be
6052: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6053: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6054: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6055: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6056: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6057: <pre class="programlisting">
1.100 rillig 6058: .for d in ${CONFIGURE_DIRS}
6059: cd ${WRKSRC} \
6060: && cd ${d} \
6061: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6062: .endfor
6063: </pre>
1.88 wiz 6064: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6065: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6066: <code class="varname">WRKSRC</code>. In each of these directories, the
6067: configure script is run with the environment
6068: <code class="varname">CONFIGURE_ENV</code> and arguments
6069: <code class="varname">CONFIGURE_ARGS</code>. The variables
6070: <code class="varname">CONFIGURE_ENV</code>,
6071: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6072: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6073: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6074: package.</p>
1.144 wiz 6075: <p>If the program uses the Perl way of configuration (mainly Perl
6076: modules, but not only), i.e. a file called
6077: <code class="filename">Makefile.PL</code>, it should include
6078: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6079: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6080: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6081: <p>If the program uses an <code class="filename">Imakefile</code>
6082: for configuration, the appropriate steps can be invoked by
6083: setting <code class="varname">USE_IMAKE</code> to
1.209 sevan 6084: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6085: You can add variables to xmkmf's environment by adding them to the
1.97 rillig 6086: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6087: <p>If the program uses <code class="filename">cmake</code>
6088: for configuration, the appropriate steps can be invoked by
1.128 wiz 6089: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6090: You can add variables to cmake's environment by adding them to the
6091: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6092: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6093: The top directory argument is given by the
6094: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6095: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6096: <p>If there is no configure step at all, set
1.128 wiz 6097: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6098: </div>
1.148 asau 6099: <div class="sect1">
1.75 rillig 6100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6101: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6102: <p>For building a package, a rough equivalent of the
6103: following code is executed.</p>
1.75 rillig 6104: <pre class="programlisting">
1.100 rillig 6105: .for d in ${BUILD_DIRS}
6106: cd ${WRKSRC} \
6107: && cd ${d} \
6108: && env ${MAKE_ENV} \
6109: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6110: -f ${MAKE_FILE} \
6111: ${BUILD_TARGET}
6112: .endfor
6113: </pre>
1.88 wiz 6114: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6115: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6116: <code class="varname">WRKSRC</code>. In each of these directories,
6117: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6118: <code class="varname">MAKE_ENV</code> and arguments
6119: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6120: <code class="varname">MAKE_ENV</code>,
6121: <code class="varname">BUILD_MAKE_FLAGS</code>,
6122: <code class="varname">MAKE_FILE</code> and
6123: <code class="varname">BUILD_TARGET</code> may all be changed by the
6124: package.</p>
1.75 rillig 6125: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6126: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6127: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6128: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6129: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6130: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6131: <p>If there is no build step at all, set
1.128 wiz 6132: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6133: </div>
1.148 asau 6134: <div class="sect1">
1.75 rillig 6135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6136: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6137: <p>[TODO]</p>
6138: </div>
1.148 asau 6139: <div class="sect1">
1.75 rillig 6140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6141: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6142: <p>Once the build stage has completed, the final step is to
1.88 wiz 6143: install the software in public directories, so users can
6144: access the programs and files.</p>
1.75 rillig 6145: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6146: equivalent of the following code is executed. Additionally,
6147: before and after this code, much magic is performed to do
6148: consistency checks, registering the package, and so on.</p>
6149: <pre class="programlisting">
1.100 rillig 6150: .for d in ${INSTALL_DIRS}
6151: cd ${WRKSRC} \
6152: && cd ${d} \
6153: && env ${MAKE_ENV} \
6154: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6155: -f ${MAKE_FILE} \
6156: ${INSTALL_TARGET}
6157: .endfor
6158: </pre>
1.75 rillig 6159: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6160: <span class="emphasis"><em>build</em></span> phase.
6161: <code class="varname">INSTALL_DIRS</code> defaults to
6162: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6163: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6164: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6165: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6166: defined.</p>
1.75 rillig 6167: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6168: variables are useful. They are all variations of the
1.238 leot 6169: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 6170: permissions preset. <code class="varname">INSTALL</code> is the plain
6171: install command. The specialized variants, together with their
6172: intended use, are:</p>
1.148 asau 6173: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6174: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6175: <dd><p>directories that contain
6176: binaries</p></dd>
1.75 rillig 6177: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6178: <dd><p>directories that contain
6179: scripts</p></dd>
1.75 rillig 6180: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6181: <dd><p>directories that contain shared and static
6182: libraries</p></dd>
1.75 rillig 6183: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6184: <dd><p>directories that contain data
6185: files</p></dd>
1.75 rillig 6186: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6187: <dd><p>directories that contain man
6188: pages</p></dd>
1.210 leot 6189: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6190: <dd><p>directories that contain data files for games
6191: </p></dd>
1.75 rillig 6192: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6193: <dd><p>binaries that can be stripped from debugging
6194: symbols</p></dd>
1.75 rillig 6195: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6196: <dd><p>binaries that cannot be
6197: stripped</p></dd>
1.75 rillig 6198: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6199: <dd><p>game
6200: binaries</p></dd>
1.75 rillig 6201: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6202: <dd><p>shared and static
6203: libraries</p></dd>
1.75 rillig 6204: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6205: <dd><p>data files</p></dd>
6206: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6207: <dd><p>data files for
6208: games</p></dd>
1.75 rillig 6209: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6210: <dd><p>man pages</p></dd>
6211: </dl></div>
6212: <p>Some other variables are:</p>
1.148 asau 6213: <div class="variablelist"><dl class="variablelist">
1.216 tnn 6214: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.238 leot 6215: <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.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.216 tnn 6216: when installing binaries. Any debugging sections and symbols present in
6217: binaries will be preserved.
6218: </p></dd>
1.75 rillig 6219: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6220: <dd><p>A list of directories relative to
1.88 wiz 6221: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6222: beginning of the <span class="emphasis"><em>install</em></span> phase.
6223: The package is supposed to create all needed directories itself
6224: before installing files to it and list all other directories here.
6225: </p></dd>
1.75 rillig 6226: </dl></div>
1.97 rillig 6227: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6228: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6229: mostly relevant for packages in the <code class="filename">regress</code>
6230: category.</p>
1.75 rillig 6231: </div>
1.148 asau 6232: <div class="sect1">
1.75 rillig 6233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6234: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6235: <p>Once the install stage has completed, a binary package of
6236: the installed files can be built. These binary packages can be
6237: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6238: the <span class="command"><strong>make bin-install</strong></span> or by using
6239: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6240: <p>By default, the binary packages are created in
6241: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6242: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6243: one for each category in the <code class="varname">CATEGORIES</code>
6244: variable. <code class="varname">PACKAGES</code> defaults to
6245: <code class="filename">pkgsrc/packages</code>.</p>
6246: </div>
1.148 asau 6247: <div class="sect1">
1.88 wiz 6248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6249: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6250: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6251: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6252: to clean the work directories of all dependencies too, use
1.110 hubertf 6253: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6254: </div>
1.148 asau 6255: <div class="sect1">
1.75 rillig 6256: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6257: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6258: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6259: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6260: <dd><p>For any of the main targets described in the
6261: previous section, two auxiliary targets exist with
1.128 wiz 6262: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.87 wiz 6263: prefix for the main target's name. These targets are
1.88 wiz 6264: invoked before and after the main target is called,
6265: allowing extra configuration or installation steps be
6266: performed from a package's Makefile, for example, which
6267: a program's configure script or install target
6268: omitted.</p></dd>
1.75 rillig 6269: <dt><span class="term">do-*</span></dt>
1.88 wiz 6270: <dd><p>Should one of the main targets do the wrong thing,
6271: and should there be no variable to fix this, you can
6272: redefine it with the do-* target. (Note that redefining
6273: the target itself instead of the do-* target is a bad
6274: idea, as the pre-* and post-* targets won't be called
6275: anymore, etc.) You will not usually need to do
6276: this.</p></dd>
1.75 rillig 6277: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6278: <dd>
1.110 hubertf 6279: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6280: you noticed some file was not installed properly, you
6281: can repeat the installation with this target, which will
1.128 wiz 6282: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6283: <p>This is the default value of
6284: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6285: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6286: package</strong></span>, where the defaults are
1.128 wiz 6287: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6288: respectively.</p>
6289: </dd>
1.75 rillig 6290: <dt><span class="term">deinstall</span></dt>
6291: <dd>
1.238 leot 6292: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 6293: current directory, effectively de-installing the
6294: package. The following variables can be used to tune the
6295: behaviour:</p>
1.148 asau 6296: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6297: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.238 leot 6298: <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.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 6299: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6300: <dd><p>Remove all packages that require (depend on)
6301: the given package. This can be used to remove any
6302: packages that may have been pulled in by a given
1.110 hubertf 6303: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6304: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6305: <code class="filename">pkgsrc/x11/kde</code>, this is
6306: likely to remove whole KDE. Works by adding
1.238 leot 6307: <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.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 6308: command line.</p></dd>
1.75 rillig 6309: </dl></div>
6310: </dd>
1.88 wiz 6311: <dt><span class="term">bin-install</span></dt>
6312: <dd><p>Install a binary package from local disk and via FTP
6313: from a list of sites (see the
6314: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6315: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6316: available anywhere. The arguments given to
1.110 hubertf 6317: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6318: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6319: operation, etc.</p></dd>
1.205 wiz 6320: <dt><span class="term">install-clean</span></dt>
6321: <dd><p>This target removes the state files for the "install" and later
6322: phases so that the "install" target may be re-invoked. This can be
6323: used after editing the PLIST to install the package without
6324: rebuilding it.</p></dd>
6325: <dt><span class="term">build-clean</span></dt>
6326: <dd><p>This target removes the state files for the "build" and later
6327: phases so that the "build" target may be re-invoked.</p></dd>
1.75 rillig 6328: <dt><span class="term">update</span></dt>
6329: <dd>
1.88 wiz 6330: <p>This target causes the current package to be
6331: updated to the latest version. The package and all
6332: depending packages first get de-installed, then current
6333: versions of the corresponding packages get compiled and
6334: installed. This is similar to manually noting which
6335: packages are currently installed, then performing a
1.110 hubertf 6336: series of <span class="command"><strong>make deinstall</strong></span> and
6337: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 6338: <code class="varname">UPDATE_TARGET</code> is set to) for these
6339: packages.</p>
1.128 wiz 6340: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 6341: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 6342: update</strong></span> was interrupted for some reason.
6343: However, in this case, make sure you don't call
1.110 hubertf 6344: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 6345: list of dependent packages in <code class="varname">WRKDIR</code>.
6346: Otherwise, you lose the ability to automatically update
6347: the current package along with the dependent packages
6348: you have installed.</p>
1.110 hubertf 6349: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 6350: update</strong></span> will only work as long as the package
6351: tree remains unchanged. If the source code for one of
6352: the packages to be updated has been changed, resuming
1.110 hubertf 6353: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 6354: fail!</p>
6355: <p>The following variables can be used either on the
1.110 hubertf 6356: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6357: alter the behaviour of <span class="command"><strong>make
1.88 wiz 6358: update</strong></span>:</p>
1.148 asau 6359: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6360: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 6361: <dd><p>Install target to recursively use for the
6362: updated package and the dependent packages.
6363: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 6364: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 6365: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 6366: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6367: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6368: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 6369: endless loop!</p></dd>
1.75 rillig 6370: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 6371: <dd><p>Don't clean up after updating. Useful if
6372: you want to leave the work sources of the updated
6373: packages around for inspection or other purposes.
6374: Be sure you eventually clean up the source tree
1.128 wiz 6375: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 6376: or you may run into troubles with old source code
6377: still lying around on your next
1.110 hubertf 6378: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 6379: update</strong></span>.</p></dd>
1.75 rillig 6380: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 6381: <dd><p>Deinstall each package before installing
6382: (making <code class="varname">DEPENDS_TARGET</code>). This
6383: may be necessary if the
1.128 wiz 6384: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 6385: called after interrupting a running <span class="command"><strong>make
1.88 wiz 6386: update</strong></span>.</p></dd>
1.75 rillig 6387: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 6388: <dd><p>Allows you to disable recursion and hardcode
6389: the target for packages. The default is
1.128 wiz 6390: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 6391: facilitating a recursive update of prerequisite
6392: packages. Only set
6393: <code class="varname">DEPENDS_TARGET</code> if you want to
6394: disable recursive updates. Use
6395: <code class="varname">UPDATE_TARGET</code> instead to just
6396: set a specific target for each package to be
1.110 hubertf 6397: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 6398: (see above).</p></dd>
1.75 rillig 6399: </dl></div>
6400: </dd>
6401: <dt><span class="term">clean-update</span></dt>
6402: <dd>
1.88 wiz 6403: <p>Clean the source tree for all packages that would
1.110 hubertf 6404: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 6405: from the current directory. This target should not be
6406: used if the current package (or any of its depending
6407: packages) have already been de-installed (e.g., after
1.110 hubertf 6408: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 6409: some packages you intended to update. As a rule of
6410: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 6411: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 6412: and only if you have a dirty package tree (e.g., if you
6413: used <code class="varname">NOCLEAN</code>).</p>
6414: <p>If you are unsure about whether your tree is
1.110 hubertf 6415: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 6416: clean</strong></span> at the top of the tree, or use the
6417: following sequence of commands from the directory of the
6418: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 6419: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 6420: time, otherwise you lose all the packages you wanted to
6421: update!):</p>
1.87 wiz 6422: <pre class="screen">
6423: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 6424: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 6425: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6426: </pre>
1.88 wiz 6427: <p>The following variables can be used either on the
1.110 hubertf 6428: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6429: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 6430: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6431: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 6432: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 6433: reconstruct the list of directories to update for
1.110 hubertf 6434: this package. Only use this if <span class="command"><strong>make
1.88 wiz 6435: update</strong></span> successfully installed all
6436: packages you wanted to update. Normally, this is
1.110 hubertf 6437: done automatically on <span class="command"><strong>make
1.88 wiz 6438: update</strong></span>, but may have been suppressed by
6439: the <code class="varname">NOCLEAN</code> variable (see
6440: above).</p></dd>
1.75 rillig 6441: </dl></div>
6442: </dd>
1.88 wiz 6443: <dt><span class="term">replace</span></dt>
6444: <dd>
6445: <p>Update the installation of the current package. This
6446: differs from update in that it does not replace dependent
1.232 sevan 6447: 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.88 wiz 6448: target to work.</p>
6449: <p><span class="emphasis"><em>Be careful when using this
6450: target!</em></span> There are no guarantees that dependent
6451: packages will still work, in particular they will most
1.110 hubertf 6452: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 6453: library package whose shared library major version changed
6454: between your installed version and the new one. For this
6455: reason, this target is not officially supported and only
6456: recommended for advanced users.</p>
6457: </dd>
1.75 rillig 6458: <dt><span class="term">info</span></dt>
1.238 leot 6459: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 6460: package. You can use this to check which version of a
6461: package is installed.</p></dd>
6462: <dt><span class="term">index</span></dt>
6463: <dd>
6464: <p>This is a top-level command, i.e. it should be used in
6465: the <code class="filename">pkgsrc</code> directory. It creates a
6466: database of all packages in the local pkgsrc tree, including
6467: dependencies, comment, maintainer, and some other useful
6468: information. Individual entries are created by running
1.110 hubertf 6469: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 6470: directories. This index file is saved as
6471: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 6472: verbose format by running <span class="command"><strong>make
1.88 wiz 6473: print-index</strong></span>. You can search in it with
1.110 hubertf 6474: <span class="command"><strong>make search
1.88 wiz 6475: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6476: extract a list of all packages that depend on a particular
1.110 hubertf 6477: one by running <span class="command"><strong>make show-deps
1.88 wiz 6478: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6479: <p>Running this command takes a very long time, some
6480: hours even on fast machines!</p>
6481: </dd>
1.75 rillig 6482: <dt><span class="term">readme</span></dt>
1.88 wiz 6483: <dd>
6484: <p>This target generates a
6485: <code class="filename">README.html</code> file, which can be
1.232 sevan 6486: 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.88 wiz 6487: contain references to any packages which are in the
6488: <code class="varname">PACKAGES</code> directory on the local
6489: host. The generated files can be made to refer to URLs
6490: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6491: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6492: wanted to generate <code class="filename">README.html</code>
6493: files which pointed to binary packages on the local
6494: machine, in the directory
6495: <code class="filename">/usr/packages</code>, set
6496: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6497: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6498: <code class="varname">${PACKAGES}</code> directory and its
6499: subdirectories will be searched for all the binary
6500: packages.</p>
6501: <p>The target can be run at the toplevel or in category
6502: directories, in which case it descends recursively.</p>
6503: </dd>
1.75 rillig 6504: <dt><span class="term">readme-all</span></dt>
1.88 wiz 6505: <dd><p>This is a top-level command, run it in
6506: <code class="filename">pkgsrc</code>. Use this target to create a
6507: file <code class="filename">README-all.html</code> which contains a
6508: list of all packages currently available in the NetBSD
6509: Packages Collection, together with the category they belong
6510: to and a short description. This file is compiled from the
6511: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 6512: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 6513: readme</strong></span>.</p></dd>
1.75 rillig 6514: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 6515: <dd><p>This is very much the same as the
1.128 wiz 6516: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 6517: used when generating a pkgsrc tree to be written to a
6518: CD-ROM. This target also produces
6519: <code class="filename">README.html</code> files, and can be made
6520: to refer to URLs based on
6521: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 6522: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 6523: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 6524: <dd><p>This target shows which distfiles and patchfiles
6525: are needed to build the package
6526: (<code class="varname">ALLFILES</code>, which contains all
6527: <code class="varname">DISTFILES</code> and
1.87 wiz 6528: <code class="varname">PATCHFILES</code>, but not
6529: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 6530: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 6531: <dd><p>This target shows nothing if the package is not
6532: installed. If a version of this package is installed,
6533: but is not the version provided in this version of
6534: pkgsrc, then a warning message is displayed. This target
6535: can be used to show which of your installed packages are
6536: downlevel, and so the old versions can be deleted, and
6537: the current ones added.</p></dd>
1.75 rillig 6538: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 6539: <dd><p>This target shows the directory in the pkgsrc
6540: hierarchy from which the package can be built and
6541: installed. This may not be the same directory as the one
6542: from which the package was installed. This target is
6543: intended to be used by people who may wish to upgrade
6544: many packages on a single host, and can be invoked from
6545: the top-level pkgsrc Makefile by using the
1.128 wiz 6546: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 6547: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 6548: <dd><p>This target shows which installed packages match
6549: the current package's <code class="varname">DEPENDS</code>. Useful
6550: if out of date dependencies are causing build
6551: problems.</p></dd>
1.205 wiz 6552: <dt><span class="term">print-build-depends-list</span></dt>
6553: <dd><p>This target shows the list of packages that the current package
6554: depends on for building.</p></dd>
6555: <dt><span class="term">print-run-depends-list</span></dt>
6556: <dd><p>This target shows the list of packages that the current package
6557: depends on for running.</p></dd>
1.75 rillig 6558: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 6559: <dd><p>After a package is installed, check all its
6560: binaries and (on ELF platforms) shared libraries to see
6561: if they find the shared libs they need. Run by default
1.110 hubertf 6562: 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.75 rillig 6563: <dt><span class="term">print-PLIST</span></dt>
6564: <dd>
1.128 wiz 6565: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 6566: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 6567: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 6568: -newer work/.extract_done</strong></span>. An attempt is made
6569: to care for shared libs etc., but it is
1.87 wiz 6570: <span class="emphasis"><em>strongly</em></span> recommended to review the
6571: result before putting it into
6572: <code class="filename">PLIST</code>. On upgrades, it's useful to
6573: diff the output of this command against an already
6574: existing <code class="filename">PLIST</code> file.</p>
1.238 leot 6575: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 6576: other methods that don't update file access times, be
6577: sure to add these files manually to your
1.128 wiz 6578: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6579: -newer</span>”</span> command used by this target won't catch
1.87 wiz 6580: them!</p>
1.128 wiz 6581: <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.87 wiz 6582: information on this target.</p>
1.75 rillig 6583: </dd>
6584: <dt><span class="term">bulk-package</span></dt>
6585: <dd>
1.88 wiz 6586: <p>Used to do bulk builds. If an appropriate binary
6587: package already exists, no action is taken. If not, this
6588: target will compile, install and package it (and its
6589: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 6590: 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
6591: builds)</i></a>).
1.88 wiz 6592: After creating the binary package, the sources, the
6593: just-installed package and its required packages are
6594: removed, preserving free disk space.</p>
6595: <p><span class="emphasis"><em>Beware that this target may deinstall
6596: all packages installed on a system!</em></span></p>
1.75 rillig 6597: </dd>
6598: <dt><span class="term">bulk-install</span></dt>
6599: <dd>
1.88 wiz 6600: <p>Used during bulk-installs to install required
6601: packages. If an up-to-date binary package is available,
1.238 leot 6602: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110 hubertf 6603: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 6604: but the installed binary won't be removed.</p>
1.88 wiz 6605: <p>A binary package is considered
1.128 wiz 6606: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.238 leot 6607: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148 asau 6608: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6609: <li class="listitem"><p>None of the package's files
1.88 wiz 6610: (<code class="filename">Makefile</code>, ...) were modified
6611: since it was built.</p></li>
1.128 wiz 6612: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 6613: packages were modified since it was built.</p></li>
1.75 rillig 6614: </ul></div>
1.88 wiz 6615: <p><span class="emphasis"><em>Beware that this target may deinstall
6616: all packages installed on a system!</em></span></p>
1.75 rillig 6617: </dd>
6618: </dl></div>
6619: </div>
6620: </div>
1.148 asau 6621: <div class="chapter">
1.75 rillig 6622: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6623: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 6624: <div class="toc">
6625: <p><b>Table of Contents</b></p>
1.210 leot 6626: <dl class="toc">
1.106 rillig 6627: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
6628: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
6629: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.75 rillig 6630: </dl>
6631: </div>
1.87 wiz 6632: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 6633: by pkgsrc and also for individual packages to define what commands
6634: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
6635: or for later run-time of an installed packaged (such as
6636: <code class="varname">DEPENDS</code>).
6637: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 6638: package will not be used.</p>
6639: <p>When building a package, the replacement tools are
1.75 rillig 6640: made available in a directory (as symlinks or wrapper scripts)
6641: that is early in the executable search path. Just like the buildlink
1.87 wiz 6642: system, this helps with consistent builds.</p>
6643: <p>A tool may be needed to help build a specific package. For example,
6644: perl, GNU make (gmake) or yacc may be needed.</p>
6645: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 6646: tool may be inefficient for building a package with pkgsrc.
6647: For example, a package may need GNU awk, bison (instead of
1.87 wiz 6648: yacc) or a better sed.</p>
6649: <p>The tools used by a package can be listed by running
1.110 hubertf 6650: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6651: <div class="sect1">
1.75 rillig 6652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6653: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 6654: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 6655: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 6656: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6657: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 6658: These can be seen by running:
1.110 hubertf 6659: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 6660: <p>If a package needs a specific program to build
1.75 rillig 6661: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 6662: to define the tools needed.</p>
1.75 rillig 6663: </div>
1.148 asau 6664: <div class="sect1">
1.75 rillig 6665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6666: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 6667: <p>In the following examples, the :run means that it is needed at
6668: run-time (and becomes a DEPENDS).
1.75 rillig 6669: The default is a build dependency which can be set with
6670: :build. (So in this example, it is the same as gmake:build
1.87 wiz 6671: and pkg-config:build.)</p>
1.75 rillig 6672: <pre class="programlisting">
6673: USE_TOOLS+= gmake perl:run pkg-config
6674: </pre>
1.87 wiz 6675: <p>When using the tools framework, a
1.75 rillig 6676: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6677: which contains the full path to the appropriate tool. For example,
1.128 wiz 6678: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 6679: on Linux systems.</p>
6680: <p>If you always need a pkgsrc version of the
1.75 rillig 6681: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6682: </p>
6683: </div>
1.148 asau 6684: <div class="sect1">
1.75 rillig 6685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6686: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 6687: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 6688: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 6689: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 6690: the name of the common tools. For example:</p>
6691: <pre class="programlisting">
6692: .if exists(/usr/bin/bzcat)
6693: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6694: .elif exists(/usr/bin/bzip2)
6695: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6696: .endif
1.69 rillig 6697:
1.75 rillig 6698: TOOLS_PLATFORM.true?= true # shell builtin
6699: </pre>
6700: </div>
6701: </div>
1.148 asau 6702: <div class="chapter">
1.75 rillig 6703: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6704: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 6705: <div class="toc">
6706: <p><b>Table of Contents</b></p>
1.210 leot 6707: <dl class="toc">
1.106 rillig 6708: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 6709: <dd><dl>
1.218 rillig 6710: <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>
6711: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
6712: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
6713: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
6714: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
6715: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
6716: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
6717: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
6718: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
6719: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6720: <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.106 rillig 6721: </dl></dd>
1.218 rillig 6722: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 6723: <dd><dl>
6724: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6725: <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.199 tnn 6726: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106 rillig 6727: </dl></dd>
1.218 rillig 6728: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 6729: <dd><dl>
6730: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
6731: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6732: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
6733: </dl></dd>
6734: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
6735: <dd><dl>
6736: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
6737: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
6738: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 6739: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
6740: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 6741: </dl></dd>
1.218 rillig 6742: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 6743: <dd><dl>
6744: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
6745: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 6746: <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.106 rillig 6747: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
6748: </dl></dd>
1.218 rillig 6749: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 6750: <dd><dl>
6751: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
6752: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
6753: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
6754: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
6755: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6756: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
6757: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
6758: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 6759: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 6760: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 6761: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
6762: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
6763: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
6764: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
6765: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
6766: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
6767: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
6768: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 6769: emulation</a></span></dt>
1.106 rillig 6770: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
6771: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 6772: </dl></dd>
1.106 rillig 6773: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 6774: </dl>
6775: </div>
1.148 asau 6776: <div class="sect1">
1.75 rillig 6777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6778: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.78 rillig 6779: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 6780: different platforms. As a result, it is important to ensure,
6781: where possible, that packages in pkgsrc are portable. This
6782: chapter mentions some particular details you should pay
6783: attention to while working on pkgsrc.</p>
1.148 asau 6784: <div class="sect2">
1.78 rillig 6785: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 6786: <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.93 rillig 6787: </h3></div></div></div>
1.78 rillig 6788: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 6789: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 6790: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 6791: want to use those variables in the preprocessor directives of
1.238 leot 6792: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 6793: <code class="literal">.for</code>), you need to include the file
6794: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6795: loads the user preferences.</p>
1.78 rillig 6796: <p>But note that some variables may not be completely defined
1.219 rillig 6797: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6798: included, as they may contain references to variables that are
6799: not yet defined. In shell commands (the lines in
6800: <code class="filename">Makefile</code> that are indented with a tab) this
6801: is no problem, since variables are only expanded when they are
6802: used. But in the preprocessor directives mentioned above and in
6803: dependency lines (of the form <code class="literal">target:
6804: dependencies</code>) the variables are expanded at load
6805: time.</p>
1.148 asau 6806: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 6807: <h3 class="title">Note</h3>
1.218 rillig 6808: <p>To check whether a variable can be used at load time,
6809: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 6810: </div>
6811: </div>
1.148 asau 6812: <div class="sect2">
1.78 rillig 6813: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 6814: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.88 wiz 6815: <p>Occasionally, packages require interaction from the user,
6816: and this can be in a number of ways:</p>
1.148 asau 6817: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6818: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 6819: interaction such as entering username/password or accepting a
6820: license on a web page.</p></li>
1.128 wiz 6821: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 6822: passwords.</p></li>
1.128 wiz 6823: <li class="listitem"><p>help to configure the package before it is built</p></li>
6824: <li class="listitem"><p>help during the build process</p></li>
6825: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 6826: </ul></div>
1.218 rillig 6827: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6828: variable to define which stages need interaction. This should be
6829: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 6830: <pre class="programlisting">
1.100 rillig 6831: INTERACTIVE_STAGE= configure install
1.222 sevan 6832: </pre>
1.88 wiz 6833: <p>The user can then decide to skip this package by setting the
1.218 rillig 6834: <code class="varname">BATCH</code> variable. Packages that require interaction
6835: are also excluded from bulk builds.</p>
1.75 rillig 6836: </div>
1.148 asau 6837: <div class="sect2">
1.75 rillig 6838: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 6839: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 6840: <p>Authors of software can choose the licence under which software
6841: can be copied. The Free Software Foundation has declared some
6842: licenses "Free", and the Open Source Initiative has a definition of
6843: "Open Source".</p>
6844: <p>By default, pkgsrc allows packages with Free or Open Source
6845: licenses to be built. To allow packages with other licenses to be
6846: built as well, the pkgsrc user needs to add these licenses to the
6847: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6848: that this variable only affects which packages may be
6849: <span class="emphasis"><em>built</em></span>, while the license terms often also
6850: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 6851: <p>One might want to only install packages with a BSD license,
1.218 rillig 6852: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 6853: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 6854: user can override the default by setting the
6855: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 6856: of "+=". The licenses accepted by default are defined in the
6857: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6858: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 6859: <p>The license tag mechanism is intended to address
1.87 wiz 6860: copyright-related issues surrounding building, installing and
6861: using a package, and not to address redistribution issues (see
6862: <code class="varname">RESTRICTED</code> and
1.222 sevan 6863: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 6864: Packages with redistribution restrictions should set these
6865: tags.</p>
1.98 wiz 6866: <p>Denoting that a package may be copied according to a
6867: particular license is done by placing the license in
1.87 wiz 6868: <code class="filename">pkgsrc/licenses</code> and setting the
6869: <code class="varname">LICENSE</code> variable to a string identifying the
1.232 sevan 6870: 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.87 wiz 6871: <pre class="programlisting">
1.100 rillig 6872: LICENSE= xv-license
1.222 sevan 6873: </pre>
1.87 wiz 6874: <p>When trying to build, the user will get a notice that the
1.98 wiz 6875: package is covered by a license which has not been placed in the
6876: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 6877: <pre class="programlisting">
1.100 rillig 6878: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6879: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6880: ===> To view the license, enter "/usr/bin/make show-license".
6881: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6882: ===> ACCEPTABLE_LICENSES+=xv-license
6883: *** Error code 1
1.222 sevan 6884: </pre>
1.110 hubertf 6885: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 6886: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 6887: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 6888: convey to pkgsrc that it should not in the future fail because of
6889: that license:</p>
1.78 rillig 6890: <pre class="programlisting">
1.100 rillig 6891: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 6892: </pre>
6893: <p>The use of <code class="varname">LICENSE=shareware</code>,
6894: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
6895: is deprecated because it does not crisply refer to a particular
6896: license text. Another problem with such usage is that it does not
6897: enable a user to tell pkgsrc to proceed for a single package
6898: without also telling pkgsrc to proceed for all packages with that
6899: tag.</p>
6900: <div class="sect3">
6901: <div class="titlepage"><div><div><h4 class="title">
6902: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 6903: <p>When adding a package with a new license, the following steps
6904: are required:</p>
6905: <div class="orderedlist"><ol class="orderedlist" type="1">
6906: <li class="listitem">
1.222 sevan 6907: <p>Check whether the license qualifies as Free or Open
6908: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
6909: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
6910: Open Source Initiative</a>. If this is the case, the filename in
6911: <code class="filename">pkgsrc/licenses/</code> does not need the
6912: <code class="filename">-license</code> suffix, and the license name should be
6913: added to:</p>
1.154 rodent 6914: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6915: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
6916: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
6917: </ul></div>
6918: </li>
6919: <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>
6920: </ol></div>
1.222 sevan 6921: </div>
6922: <div class="sect3">
6923: <div class="titlepage"><div><div><h4 class="title">
6924: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 6925: <p>When the license changes (in a way other than formatting),
1.222 sevan 6926: make sure that the new license has a different name (e.g.,
1.98 wiz 6927: append the version number if it exists, or the date). Just
6928: because a user told pkgsrc to build programs under a previous
6929: version of a license does not mean that pkgsrc should build
1.99 rillig 6930: programs under the new licenses. The higher-level point is that
1.98 wiz 6931: pkgsrc does not evaluate licenses for reasonableness; the only
6932: test is a mechanistic test of whether a particular text has been
1.222 sevan 6933: approved by either of two bodies (FSF or OSI).</p>
6934: </div>
1.75 rillig 6935: </div>
1.148 asau 6936: <div class="sect2">
1.75 rillig 6937: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 6938: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 6939: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 6940: By declaring the restrictions, package tools can
1.98 wiz 6941: automatically refrain from e.g. placing binary packages on FTP
6942: sites.</p>
1.222 sevan 6943: <p>There are four possible restrictions, which are
1.98 wiz 6944: the cross product of sources (distfiles) and binaries not being
6945: placed on FTP sites and CD-ROMs. Because this is rarely the exact
6946: language in any license, and because non-Free licenses tend to be
6947: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 6948: CD-ROM.
6949:
6950: "FTP" means making the source or binary file available over the
6951: Internet at no charge.
6952:
6953: "CD-ROM" means making the source or binary available on some kind of
6954: media, together with other source and binary packages, which is sold
6955: for a distribution charge.
1.98 wiz 6956: </p>
6957: <p>In order to encode these restrictions, the package system
1.87 wiz 6958: defines five make variables that can be set to note these
6959: restrictions:</p>
1.148 asau 6960: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6961: <li class="listitem">
1.75 rillig 6962: <p><code class="varname">RESTRICTED</code></p>
6963: <p>This variable should be set whenever a restriction
1.87 wiz 6964: exists (regardless of its kind). Set this variable to a
1.98 wiz 6965: string containing the reason for the restriction. It should
6966: be understood that those wanting to understand the restriction
6967: will have to read the license, and perhaps seek advice of
6968: counsel.</p>
1.75 rillig 6969: </li>
1.128 wiz 6970: <li class="listitem">
1.75 rillig 6971: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 6972: <p>Binaries may not be placed on CD-ROM containing other
6973: binary packages, for which a distribution charge may be made.
6974: In this case, set this variable to
6975: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 6976: </li>
1.128 wiz 6977: <li class="listitem">
1.75 rillig 6978: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 6979: <p>Binaries may not made available on the Internet without
6980: charge. In this case, set this variable to
6981: <code class="varname">${RESTRICTED}</code>. If this variable is set,
6982: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 6983: </li>
1.128 wiz 6984: <li class="listitem">
1.75 rillig 6985: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 6986: <p>Distfiles may not be placed on CD-ROM, together with
6987: other distfiles, for which a fee may be charged. In this
6988: case, set this variable to <code class="varname">${RESTRICTED}</code>.
6989: </p>
1.75 rillig 6990: </li>
1.128 wiz 6991: <li class="listitem">
1.75 rillig 6992: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 6993: <p>Distfiles may not made available via FTP at no charge.
6994: In this case, set this variable to
6995: <code class="varname">${RESTRICTED}</code>. If this variable is set,
6996: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 6997: </li>
6998: </ul></div>
1.222 sevan 6999: <p>Please note that packages will be removed from pkgsrc when the
7000: distfiles are not distributable and cannot be obtained for a period
7001: of one full quarter branch. Packages with manual/interactive fetch
7002: must have a maintainer and it is his/her responsibility to ensure
7003: this.</p>
1.75 rillig 7004: </div>
1.148 asau 7005: <div class="sect2">
1.75 rillig 7006: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7007: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.75 rillig 7008: <p>Your package may depend on some other package being present
1.88 wiz 7009: - and there are various ways of expressing this dependency.
7010: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7011: <code class="varname">DEPENDS</code> definitions, the
7012: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7013: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7014: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7015: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7016: <p>The basic difference between the two variables is as
1.87 wiz 7017: follows: The <code class="varname">DEPENDS</code> definition registers
7018: that pre-requisite in the binary package so it will be pulled in
7019: when the binary package is later installed, whilst the
7020: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7021: dependency that is only needed for building the package.</p>
1.75 rillig 7022: <p>This means that if you only need a package present whilst
1.87 wiz 7023: you are building, it should be noted as a
7024: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7025: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7026: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7027: <pre class="programlisting">
1.100 rillig 7028: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7029: </pre>
1.128 wiz 7030: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7031: may include any of the wildcard version numbers recognized by
1.238 leot 7032: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7033: <div class="orderedlist"><ol class="orderedlist" type="1">
7034: <li class="listitem">
1.75 rillig 7035: <p>If your package needs another package's binaries or
1.160 wiz 7036: libraries to build and run, and if that package has a
1.87 wiz 7037: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7038: <pre class="programlisting">
1.100 rillig 7039: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7040: </pre>
1.75 rillig 7041: </li>
1.128 wiz 7042: <li class="listitem">
1.160 wiz 7043: <p>If your package needs another package's binaries or
7044: libraries only for building, and if that package has a
7045: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7046: <pre class="programlisting">
7047: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7048: </pre>
1.160 wiz 7049: <p>but set
7050: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7051: to make it a build dependency only. This case is rather
7052: rare.</p>
7053: </li>
7054: <li class="listitem">
1.132 spz 7055: <p>If your package needs binaries from another package to build,
7056: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7057: <pre class="programlisting">
1.132 spz 7058: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.222 sevan 7059: </pre>
1.75 rillig 7060: </li>
1.132 spz 7061: <li class="listitem"><p>If your package needs a library with which to link and
7062: there is no <code class="filename">buildlink3.mk</code> file
7063: available, create one. Using
7064: <code class="varname">DEPENDS</code> won't be sufficient because the
7065: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7066: <li class="listitem">
1.132 spz 7067: <p>If your package needs some executable to be able to run
7068: correctly and if there's no
7069: <code class="filename">buildlink3.mk</code> file, this is specified
7070: using the <code class="varname">DEPENDS</code> variable. The
1.232 sevan 7071: <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.242 wiz 7072: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7073: when it runs, and that is specified:</p>
1.75 rillig 7074: <pre class="programlisting">
1.242 wiz 7075: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7076: </pre>
1.132 spz 7077: </li>
7078: <li class="listitem">
7079: <p>You can use wildcards in package dependencies. Note that
7080: such wildcard dependencies are retained when creating binary
7081: packages. The dependency is checked when installing the binary
7082: package and any package which matches the pattern will be
7083: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7084: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7085: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7086: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7087: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7088: <p>Wildcards can also be used to specify that a package
1.87 wiz 7089: will only build against a certain minimum version of a
7090: pre-requisite:</p>
1.75 rillig 7091: <pre class="programlisting">
1.132 spz 7092: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7093: </pre>
1.132 spz 7094: <p>This means that the package will build using version 6.0
7095: of ImageMagick or newer. Such a dependency may be warranted
7096: if, for example, the command line options of an executable
7097: have changed.</p>
7098: <p>If you need to depend on minimum versions of libraries,
7099: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7100: <p>For security fixes, please update the package
1.218 rillig 7101: 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.87 wiz 7102: information.</p>
1.75 rillig 7103: </li>
7104: </ol></div>
7105: <p>If your package needs files from another package to build,
1.87 wiz 7106: add the relevant distribution files to
7107: <code class="varname">DISTFILES</code>, so they will be extracted
1.232 sevan 7108: 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.87 wiz 7109: (It relies on the jpeg sources being present in source form
7110: during the build.)</p>
1.75 rillig 7111: </div>
1.148 asau 7112: <div class="sect2">
1.75 rillig 7113: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7114: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7115: <p>Your package may conflict with other packages a user might
1.87 wiz 7116: already have installed on his system, e.g. if your package
1.88 wiz 7117: installs the same set of files as another package in the pkgsrc
1.190 wiz 7118: tree or has the same <code class="varname">PKGNAME</code>.</p>
7119: <p>These cases are handled automatically by the packaging tools
7120: at package installation time and do not need to be handled
7121: manually.</p>
7122: <p>In case the conflicts can not be recognized automatically
7123: (e.g., packages using the same config file location but no other
7124: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7125: space-separated list of packages (including version string) your
7126: package conflicts with.</p>
1.232 sevan 7127: <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>
7128: 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.190 wiz 7129: use the same config file, you would set in
7130: <code class="filename">foo/bar/Makefile</code>:</p>
1.87 wiz 7131: <pre class="programlisting">
1.190 wiz 7132: CONFLICTS= baz-[0-9]*
1.222 sevan 7133: </pre>
1.190 wiz 7134: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75 rillig 7135: <pre class="programlisting">
1.190 wiz 7136: CONFLICTS= bar-[0-9]*
1.222 sevan 7137: </pre>
1.75 rillig 7138: </div>
1.148 asau 7139: <div class="sect2">
1.75 rillig 7140: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7141: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7142: <p>There are several reasons why a package might be
1.88 wiz 7143: instructed to not build under certain circumstances. If the
1.87 wiz 7144: package builds and runs on most platforms, the exceptions
1.193 dholland 7145: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7146: the package builds and runs on a small handful of platforms,
7147: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7148: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7149: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7150: (OS-version-platform) that can use glob-style
7151: wildcards.</p>
7152: <p>If a package is not appropriate for some platforms (as
1.225 maya 7153: opposed to merely broken), a different set of variables should be
1.193 dholland 7154: used as this affects failure reporting and statistics.
7155: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7156: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7157: the package is appropriate for only a small handful of platforms
7158: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7159: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7160: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7161: (OS-version-platform) that can use glob-style
7162: wildcards.</p>
1.88 wiz 7163: <p>Some packages are tightly bound to a specific version of an
1.232 sevan 7164: 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.88 wiz 7165: backwards compatible with other versions of the OS, and should be
7166: uploaded to a version specific directory on the FTP server. Mark
7167: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7168: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7169: the package system internals, but may be used in the
7170: future.</p>
1.75 rillig 7171: <p>If the package should be skipped (for example, because it
1.87 wiz 7172: provides functionality already provided by the system), set
1.88 wiz 7173: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7174: the package should fail because some preconditions are not met,
7175: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7176: message.</p>
1.75 rillig 7177: </div>
1.148 asau 7178: <div class="sect2">
1.75 rillig 7179: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7180: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7181: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7182: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7183: be set in the package Makefile. This will be carried into any
7184: binary package that is made from this pkgsrc entry. A
1.128 wiz 7185: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.238 leot 7186: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7187: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7188: </div>
1.148 asau 7189: <div class="sect2">
1.75 rillig 7190: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7191: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7192: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7193: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7194: and after committing that file, ask pkgsrc-security@NetBSD.org to
7195: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7196: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7197: <code class="varname">PKGREVISION</code> should be increased (this is of
7198: course not necessary if the problem is fixed by using a newer
7199: release of the software), and the pattern in the
7200: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7201: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7202: branch, be sure to submit a pullup request!</p>
1.75 rillig 7203: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7204: semi-automatically by a weekly cron job.</p>
1.75 rillig 7205: </div>
1.148 asau 7206: <div class="sect2">
1.75 rillig 7207: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7208: <a name="bumping-pkgrevision"></a>19.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 7209: <p>When making fixes to an existing package it can be useful
1.87 wiz 7210: to change the version number in <code class="varname">PKGNAME</code>. To
7211: avoid conflicting with future versions by the original author, a
1.128 wiz 7212: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 7213: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7214: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7215: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7216: <pre class="programlisting">
1.100 rillig 7217: DISTNAME= foo-17.42
7218: PKGREVISION= 9
1.222 sevan 7219: </pre>
1.75 rillig 7220: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7221: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7222: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7223: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7224: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7225: <p>When a new release of the package is released, the
1.87 wiz 7226: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7227: minor release of the above package, things should be like:</p>
1.75 rillig 7228: <pre class="programlisting">
1.100 rillig 7229: DISTNAME= foo-17.43
1.222 sevan 7230: </pre>
1.87 wiz 7231: <p><code class="varname">PKGREVISION</code> should be incremented for any
7232: non-trivial change in the resulting binary package. Without a
7233: <code class="varname">PKGREVISION</code> bump, someone with the previous
7234: version installed has no way of knowing that their package is out
7235: of date. Thus, changes without increasing
7236: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7237: trivial that no reasonable person would want to upgrade", and this
7238: is the rough test for when increasing
7239: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7240: changes that do not merit increasing
7241: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7242: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7243: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 7244: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 7245: or comments in Makefile.</p></li>
1.128 wiz 7246: <li class="listitem"><p>
1.100 rillig 7247: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 7248: <li class="listitem"><p>
1.100 rillig 7249: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 7250: <li class="listitem"><p>
1.100 rillig 7251: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7252: </ul></div>
1.87 wiz 7253: <p>Examples of changes that do merit an increase to
7254: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7255: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7256: <li class="listitem"><p>
1.100 rillig 7257: Security fixes</p></li>
1.128 wiz 7258: <li class="listitem"><p>
1.100 rillig 7259: Changes or additions to a patch file</p></li>
1.128 wiz 7260: <li class="listitem"><p>
1.100 rillig 7261: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 7262: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 7263: </ul></div>
1.78 rillig 7264: <p>PKGREVISION must also be incremented when dependencies have ABI
7265: changes.</p>
1.75 rillig 7266: </div>
1.148 asau 7267: <div class="sect2">
1.79 rillig 7268: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7269: <a name="fixes.subst"></a>19.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 7270: <p>When you want to replace the same text in multiple files
1.87 wiz 7271: or when the replacement text varies, patches alone cannot help.
7272: This is where the SUBST framework comes in. It provides an
7273: easy-to-use interface for replacing text in files.
7274: Example:</p>
7275: <pre class="programlisting">
1.100 rillig 7276: SUBST_CLASSES+= fix-paths
7277: SUBST_STAGE.fix-paths= pre-configure
7278: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7279: SUBST_FILES.fix-paths= src/*.c
7280: SUBST_FILES.fix-paths+= scripts/*.sh
7281: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7282: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.222 sevan 7283: </pre>
1.79 rillig 7284: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 7285: that are used to identify the different SUBST blocks that are
7286: defined. The SUBST framework is heavily used by pkgsrc, so it is
7287: important to always use the <code class="literal">+=</code> operator with
7288: this variable. Otherwise some substitutions may be
7289: skipped.</p>
1.79 rillig 7290: <p>The remaining variables of each SUBST block are
1.87 wiz 7291: parameterized with the identifier from the first line
7292: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7293: parameters to a function call.</p>
1.79 rillig 7294: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 7295: which the replacement will take place. All combinations of
7296: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7297: <code class="literal">post-</code> together with a phase name are
7298: possible, though only few are actually used. Most commonly used
7299: are <code class="literal">post-patch</code> and
7300: <code class="literal">pre-configure</code>. Of these two,
7301: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 7302: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 7303: have the state after applying the patches but before making any
7304: other changes. This is especially useful when you are debugging
7305: a package in order to create new patches for it. Similarly,
7306: <code class="literal">post-build</code> is preferred over
7307: <code class="literal">pre-install</code>, because the install phase should
7308: generally be kept as simple as possible. When you use
7309: <code class="literal">post-build</code>, you have the same files in the
7310: working directory that will be installed later, so you can check
7311: if the substitution has succeeded.</p>
1.79 rillig 7312: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 7313: that is printed just before the substitution is done.</p>
1.79 rillig 7314: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 7315: globbing patterns that specifies the files in which the
7316: substitution will take place. The patterns are interpreted
7317: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 7318: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.238 leot 7319: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87 wiz 7320: command should be prefixed with <code class="literal">-e</code>, so that
7321: all SUBST blocks look uniform.</p>
1.79 rillig 7322: <p>There are some more variables, but they are so seldomly
1.87 wiz 7323: used that they are only documented in the
7324: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 7325: </div>
1.75 rillig 7326: </div>
1.148 asau 7327: <div class="sect1">
1.75 rillig 7328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218 rillig 7329: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 7330: <div class="sect2">
1.75 rillig 7331: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7332: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 7333: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 7334: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 7335: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7336: with the name of each file to download as an argument, expecting
7337: it to output the URL of the directory from which to download
1.232 sevan 7338: 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.87 wiz 7339: example of this usage.</p>
1.75 rillig 7340: <p>If the download can't be automated, because the user must
1.87 wiz 7341: submit personal information to apply for a password, or must pay
7342: for the source, or whatever, you can set
7343: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7344: displayed to the user before aborting the build. Example:</p>
7345: <pre class="programlisting">
1.100 rillig 7346: FETCH_MESSAGE= "Please download the files"
7347: FETCH_MESSAGE+= " "${DISTFILES:Q}
7348: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 7349: </pre>
1.75 rillig 7350: </div>
1.148 asau 7351: <div class="sect2">
1.75 rillig 7352: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7353: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 7354: <p>Sometimes authors of a software package make some
1.87 wiz 7355: modifications after the software was released, and they put up a
7356: new distfile without changing the package's version number. If a
7357: package is already in pkgsrc at that time, the checksum will
7358: no longer match. The contents of the new distfile should be
7359: compared against the old one before changing anything, to make
7360: sure the distfile was really updated on purpose, and that
7361: no trojan horse or so crept in.
1.97 rillig 7362: Please mention that the distfiles were compared and what was found
1.159 rodent 7363: in your commit message.</p>
1.220 wiz 7364: <p>Then, the correct way to work around this is to set
7365: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7366: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7367: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7368: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 7369: <code class="varname">PATCHFILES</code> for this package will be put in that
1.220 wiz 7370: 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.87 wiz 7371: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 7372: including the <code class="filename">nbX</code> suffix) or a date stamp can
7373: be appended, like
7374: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.159 rodent 7375: <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>
7376: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 7377: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7378: path in the filenames.
1.159 rodent 7379: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 7380: Furthermore, a mail to the package's authors seems appropriate
7381: telling them that changing distfiles after releases without
7382: changing the file names is not good practice.</p>
1.75 rillig 7383: </div>
1.199 tnn 7384: <div class="sect2">
7385: <div class="titlepage"><div><div><h3 class="title">
7386: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.200 tnn 7387: <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:
7388: </p>
1.199 tnn 7389: <div class="sect3">
7390: <div class="titlepage"><div><div><h4 class="title">
7391: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
7392: <p>
7393: 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.
7394: </p>
7395: <pre class="programlisting">
7396: DISTNAME= exampleproject-1.0
1.200 tnn 7397: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7398: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7399: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 7400: EXTRACT_SUFX= .zip
7401: </pre>
7402: </div>
7403: <div class="sect3">
7404: <div class="titlepage"><div><div><h4 class="title">
7405: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
7406: <p>
7407: 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.
7408: </p>
7409: <pre class="programlisting">
7410: DISTNAME= example-1.0
1.217 jnemeth 7411: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.200 tnn 7412: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7413: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 7414: </pre>
1.199 tnn 7415: </div>
7416: <div class="sect3">
7417: <div class="titlepage"><div><div><h4 class="title">
7418: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
7419: <p>
7420: 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.
7421: </p>
7422: <pre class="programlisting">
7423: DISTNAME= offensive-1.6
1.200 tnn 7424: PKGNAME= ${DISTNAME:S/offensive/proper/}
7425: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7426: GITHUB_PROJECT= exampleproject
7427: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7428: EXTRACT_SUFX= .zip
1.222 sevan 7429: </pre>
1.199 tnn 7430: </div>
7431: </div>
1.75 rillig 7432: </div>
1.148 asau 7433: <div class="sect1">
1.75 rillig 7434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218 rillig 7435: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 7436: <div class="sect2">
1.75 rillig 7437: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7438: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 7439: <p>pkgsrc supports many different machines, with different
1.87 wiz 7440: object formats like a.out and ELF, and varying abilities to do
7441: shared library and dynamic loading at all. To accompany this,
7442: varying commands and options have to be passed to the
7443: compiler, linker, etc. to get the Right Thing, which can be
7444: pretty annoying especially if you don't have all the machines
7445: at your hand to test things. The
1.232 sevan 7446: <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.128 wiz 7447: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 7448: both static and dynamic libraries from a set of source files,
7449: thus being platform-independent.</p>
7450: <p>Here's how to use libtool in a package in seven simple
7451: steps:</p>
1.128 wiz 7452: <div class="orderedlist"><ol class="orderedlist" type="1">
7453: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 7454: Makefile.</p></li>
1.128 wiz 7455: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7456: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 7457: add it to the definition of <code class="varname">CC</code>, if only
7458: libraries are being built in a given Makefile. This one command
7459: will build both PIC and non-PIC library objects, so you need not
7460: have separate shared and non-shared library rules.</p></li>
1.128 wiz 7461: <li class="listitem">
1.75 rillig 7462: <p>For the linking of the library, remove any
1.128 wiz 7463: <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
7464: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 7465: <pre class="programlisting">
1.100 rillig 7466: ${LIBTOOL} --mode=link \
7467: ${CC} -o ${.TARGET:.a=.la} \
7468: ${OBJS:.o=.lo} \
7469: -rpath ${PREFIX}/lib \
7470: -version-info major:minor
1.222 sevan 7471: </pre>
1.75 rillig 7472: <p>Note that the library is changed to have a
1.87 wiz 7473: <code class="filename">.la</code> extension, and the objects are
7474: changed to have a <code class="filename">.lo</code>
7475: extension. Change <code class="varname">OBJS</code> as
7476: necessary. This automatically creates all of the
7477: <code class="filename">.a</code>,
7478: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7479: necessary) in the build directory. Be sure to include
1.128 wiz 7480: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 7481: minor are zero, as libtool will otherwise strip off the
7482: shared library version.</p>
1.75 rillig 7483: <p>From the libtool manual:</p>
7484: <pre class="programlisting">
1.100 rillig 7485: So, libtool library versions are described by three integers:
1.69 rillig 7486:
1.100 rillig 7487: CURRENT
7488: The most recent interface number that this library implements.
1.69 rillig 7489:
1.100 rillig 7490: REVISION
7491: The implementation number of the CURRENT interface.
1.69 rillig 7492:
1.100 rillig 7493: AGE
7494: The difference between the newest and oldest interfaces that
7495: this library implements. In other words, the library implements
7496: all the interface numbers in the range from number `CURRENT -
7497: AGE' to `CURRENT'.
1.1 grant 7498:
1.100 rillig 7499: If two libraries have identical CURRENT and AGE numbers, then the
7500: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 7501: </pre>
1.128 wiz 7502: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 7503: different results for a.out and ELF (excluding symlinks)
7504: in only one case. An ELF library of the form
1.128 wiz 7505: <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.87 wiz 7506: will have a symlink of
1.128 wiz 7507: <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.87 wiz 7508: on an a.out platform. This is handled
7509: automatically.</p>
1.128 wiz 7510: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 7511: directory of the library being built.</p>
1.76 rillig 7512: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 7513: <code class="filename">.la</code> file, the other files will be
7514: added automatically.</p>
1.75 rillig 7515: </li>
1.128 wiz 7516: <li class="listitem">
1.76 rillig 7517: <p>When linking shared object (<code class="filename">.so</code>)
1.238 leot 7518: 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.1"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 7519: shared libraries, use <span class="quote">“<span class="quote">-module
7520: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 7521: tacked on.</p>
1.76 rillig 7522: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 7523: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 7524: </li>
1.128 wiz 7525: <li class="listitem">
1.75 rillig 7526: <p>When linking programs that depend on these libraries
1.87 wiz 7527: <span class="emphasis"><em>before</em></span> they are installed, preface
1.238 leot 7528: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-7.1"><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.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 7529: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 7530: libraries (static or shared), but please be aware that
7531: libtool will not allow you to specify a relative path in
1.128 wiz 7532: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 7533: expects you to change that argument to be the
7534: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 7535: <pre class="programlisting">
1.100 rillig 7536: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 7537: </pre>
1.75 rillig 7538: <p>should be changed to:</p>
7539: <pre class="programlisting">
1.100 rillig 7540: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 7541: </pre>
1.75 rillig 7542: <p>and it will do the right thing with the libraries.</p>
7543: </li>
1.128 wiz 7544: <li class="listitem">
1.238 leot 7545: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
7546: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 7547: --mode=install</span>”</span>, and change the library name to
1.87 wiz 7548: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 7549: <pre class="programlisting">
1.126 jakllsch 7550: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 7551: </pre>
1.76 rillig 7552: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 7553: shared library, any needed symlinks, and run
1.238 leot 7554: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 7555: </li>
1.128 wiz 7556: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 7557: the <code class="filename">.la</code>
7558: file (this is a change from previous behaviour).</p></li>
1.75 rillig 7559: </ol></div>
7560: </div>
1.148 asau 7561: <div class="sect2">
1.75 rillig 7562: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7563: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 7564: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 7565: package Makefile. This will override the package's own libtool
7566: in most cases. For older libtool using packages, libtool is
7567: made by ltconfig script during the do-configure step; you can
1.110 hubertf 7568: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 7569: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 7570: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 7571: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 7572: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7573: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 7574: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 7575: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 7576: libraries built and installed, then use
7577: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 7578: <p>If your package makes use of the platform-independent library
1.87 wiz 7579: for loading dynamic shared objects, that comes with libtool
7580: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7581: <p>Some packages use libtool incorrectly so that the package
7582: may not work or build in some circumstances. Some of the more
7583: common errors are:</p>
1.148 asau 7584: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7585: <li class="listitem">
1.75 rillig 7586: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 7587: executable or library. This in itself isn't a problem if one of two things
7588: has been done:</p>
1.128 wiz 7589: <div class="orderedlist"><ol class="orderedlist" type="1">
7590: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 7591: <code class="filename">libfoo.la</code>, not
7592: <code class="filename">foo.la</code></p></li>
1.128 wiz 7593: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 7594: </ol></div>
7595: </li>
1.128 wiz 7596: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 7597: The function lt_dlinit() should be called and the macro
7598: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7599: executables.</p></li>
1.75 rillig 7600: </ul></div>
7601: </div>
1.148 asau 7602: <div class="sect2">
1.75 rillig 7603: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7604: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 7605: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 7606: to regenerate the configure script and Makefile.in makefile
7607: templates, then they should be executed in a pre-configure
7608: target.</p>
1.75 rillig 7609: <p>For packages that need only autoconf:</p>
7610: <pre class="programlisting">
1.100 rillig 7611: AUTOCONF_REQD= 2.50 # if default version is not good enough
7612: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7613: ...
1.1 grant 7614:
1.100 rillig 7615: pre-configure:
7616: cd ${WRKSRC} && autoconf
1.1 grant 7617:
1.100 rillig 7618: ...
1.222 sevan 7619: </pre>
1.75 rillig 7620: <p>and for packages that need automake and autoconf:</p>
7621: <pre class="programlisting">
1.100 rillig 7622: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7623: USE_TOOLS+= automake # use "automake14" for automake-1.4
7624: ...
7625:
7626: pre-configure:
7627: set -e; cd ${WRKSRC}; \
7628: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 7629:
1.100 rillig 7630: ...
1.222 sevan 7631: </pre>
1.75 rillig 7632: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 7633: require GNU Make.</p>
1.75 rillig 7634: <p>There are times when the configure process makes
1.87 wiz 7635: additional changes to the generated files, which then causes
7636: the build process to try to re-execute the automake sequence.
7637: This is prevented by touching various files in the configure
7638: stage. If this causes problems with your package you can set
7639: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7640: Makefile.</p>
1.75 rillig 7641: </div>
7642: </div>
1.148 asau 7643: <div class="sect1">
1.75 rillig 7644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7645: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 7646: <div class="sect2">
1.87 wiz 7647: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7648: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 7649: <p>Compilers for the C, C++, and Fortran languages comes with
7650: the NetBSD base system. By default, pkgsrc assumes that a package
7651: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 7652: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 7653: <p>To declare which language's compiler a package needs, set
7654: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 7655: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7656: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7657: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 7658: written in C++, usually need a C compiler for the configure
7659: phase.</p>
7660: </div>
1.148 asau 7661: <div class="sect2">
1.87 wiz 7662: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7663: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 7664: <p>If a program is written in Java, use the Java framework in
7665: pkgsrc. The package must include
7666: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7667: provides the following variables:</p>
1.148 asau 7668: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7669: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 7670: dependency on the JDK is added. If
1.128 wiz 7671: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 7672: there is only a runtime dependency on the JDK. The default is
1.128 wiz 7673: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 7674: JDK.</p></li>
1.128 wiz 7675: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 7676: a package needs a Java2 implementation. The supported values
1.128 wiz 7677: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7678: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7679: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7680: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 7681: above. This variable is not set by default.</p></li>
1.130 wiz 7682: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7683: automatically set to the runtime location of the used Java
7684: implementation dependency. It may be used to set
7685: <code class="varname">JAVA_HOME</code> to a good value if the program
7686: needs this variable to be defined.
7687: </p></li>
1.87 wiz 7688: </ul></div>
7689: </div>
1.148 asau 7690: <div class="sect2">
1.87 wiz 7691: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7692: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 7693: <p>If your package contains interpreted perl scripts, add
1.128 wiz 7694: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 7695: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7696: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7697: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 7698: that you want adjusted. Every occurrence of
7699: <code class="filename">*/bin/perl</code> in a she-bang line will be
7700: replaced with the full path to the perl executable.</p>
1.87 wiz 7701: <p>If a particular version of perl is needed, set the
7702: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 7703: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 7704: <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.87 wiz 7705: about handling perl modules.</p>
7706: </div>
1.148 asau 7707: <div class="sect2">
1.87 wiz 7708: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 7709: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
7710: <p><code class="varname">REPLACE_SH</code>,
7711: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7712: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7713: hash bangs in files. Please use the appropriate one, prefering
7714: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 7715: Each should contain a list of scripts, relative to
7716: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7717: occurrence of the matching shell in a she-bang line will be
7718: replaced with the full path to the shell executable.
1.147 wiz 7719: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7720: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7721: </div>
1.148 asau 7722: <div class="sect2">
1.147 wiz 7723: <div class="titlepage"><div><div><h3 class="title">
7724: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 7725: <p>Currently, there is no special handling for other languages
7726: in pkgsrc. If a compiler package provides a
7727: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7728: just add a (build) dependency on the appropriate compiler
7729: package.</p>
7730: </div>
7731: </div>
1.148 asau 7732: <div class="sect1">
1.87 wiz 7733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218 rillig 7734: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 7735: <p>The most common failures when building a package are that
7736: some platforms do not provide certain header files, functions or
7737: libraries, or they provide the functions in a library that the
7738: original package author didn't know. To work around this, you
7739: can rewrite the source code in most cases so that it does not
7740: use the missing functions or provides a replacement function.</p>
1.148 asau 7741: <div class="sect2">
1.77 rillig 7742: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7743: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 7744: <p>If a package already comes with a GNU configure script, the
7745: preferred way to fix the build failure is to change the
7746: configure script, not the code. In the other cases, you can
7747: utilize the C preprocessor, which defines certain macros
7748: depending on the operating system and hardware architecture it
7749: compiles for. These macros can be queried using for example
7750: <code class="varname">#if defined(__i386)</code>. Almost every operating
7751: system, hardware architecture and compiler has its own macro.
7752: For example, if the macros <code class="varname">__GNUC__</code>,
7753: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7754: are all defined, you know that you are using NetBSD on an i386
7755: compatible CPU, and your compiler is GCC.</p>
7756: <p>The list of the following macros for hardware and
7757: operating system depends on the compiler that is used. For
7758: example, if you want to conditionally compile code on Solaris,
7759: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7760: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 7761: <div class="sect3">
1.75 rillig 7762: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 7763: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 7764: <p>To distinguish between 4.4 BSD-derived systems and the
7765: rest of the world, you should use the following code.</p>
7766: <pre class="programlisting">
1.100 rillig 7767: #include <sys/param.h>
7768: #if (defined(BSD) && BSD >= 199306)
7769: /* BSD-specific code goes here */
7770: #else
7771: /* non-BSD-specific code goes here */
7772: #endif
1.75 rillig 7773: </pre>
1.77 rillig 7774: <p>If this distinction is not fine enough, you can also test
7775: for the following macros.</p>
1.75 rillig 7776: <pre class="programlisting">
1.151 obache 7777: Cygwin __CYGWIN__
7778: DragonFly __DragonFly__
1.100 rillig 7779: FreeBSD __FreeBSD__
1.151 obache 7780: Haiku __HAIKU__
1.100 rillig 7781: Interix __INTERIX
7782: IRIX __sgi (TODO: get a definite source for this)
7783: Linux linux, __linux, __linux__
1.193 dholland 7784: Mac OS X __APPLE__
1.151 obache 7785: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7786: Minix3 __minix
1.100 rillig 7787: NetBSD __NetBSD__
7788: OpenBSD __OpenBSD__
7789: Solaris sun, __sun
1.75 rillig 7790: </pre>
7791: </div>
1.148 asau 7792: <div class="sect3">
1.75 rillig 7793: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 7794: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 7795: <pre class="programlisting">
1.100 rillig 7796: i386 i386, __i386, __i386__
7797: MIPS __mips
7798: SPARC sparc, __sparc
1.75 rillig 7799: </pre>
7800: </div>
1.148 asau 7801: <div class="sect3">
1.75 rillig 7802: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 7803: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 7804: <pre class="programlisting">
1.100 rillig 7805: GCC __GNUC__ (major version), __GNUC_MINOR__
7806: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7807: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7808: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 7809: </pre>
7810: </div>
7811: </div>
1.148 asau 7812: <div class="sect2">
1.78 rillig 7813: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7814: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 7815: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 7816: combinations of compiler version and architecture and almost
7817: always relation to optimisation being enabled. Common symptoms
7818: are gcc internal errors or never finishing compiling a
1.78 rillig 7819: file.</p>
7820: <p>Typically, a workaround involves testing the
7821: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7822: optimisation for that combination of file,
1.198 tnn 7823: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7824: <p>This used to be a big problem in the past, but is rarely
7825: needed now as compiler technology has matured. If you still need
7826: to add a compiler specific workaround, please do so in the file
7827: <code class="filename">hacks.mk</code> and describe the symptom and
7828: compiler version as detailed as possible.</p>
1.78 rillig 7829: </div>
1.148 asau 7830: <div class="sect2">
1.78 rillig 7831: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 7832: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
7833: </h3></div></div></div>
1.92 rillig 7834: <p>This error message often means that a package did not
1.78 rillig 7835: link to a shared library it needs. The following functions are
7836: known to cause this error message over and over.</p>
7837: <div class="informaltable">
1.216 tnn 7838: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 7839: <colgroup>
7840: <col>
7841: <col>
7842: <col>
7843: </colgroup>
7844: <thead><tr>
7845: <th>Function</th>
7846: <th>Library</th>
7847: <th>Affected platforms</th>
7848: </tr></thead>
7849: <tbody>
7850: <tr>
7851: <td>accept, bind, connect</td>
7852: <td>-lsocket</td>
7853: <td>Solaris</td>
7854: </tr>
7855: <tr>
7856: <td>crypt</td>
7857: <td>-lcrypt</td>
7858: <td>DragonFly, NetBSD</td>
7859: </tr>
7860: <tr>
7861: <td>dlopen, dlsym</td>
7862: <td>-ldl</td>
7863: <td>Linux</td>
7864: </tr>
7865: <tr>
7866: <td>gethost*</td>
7867: <td>-lnsl</td>
7868: <td>Solaris</td>
7869: </tr>
7870: <tr>
7871: <td>inet_aton</td>
7872: <td>-lresolv</td>
7873: <td>Solaris</td>
7874: </tr>
7875: <tr>
7876: <td>nanosleep, sem_*, timer_*</td>
7877: <td>-lrt</td>
7878: <td>Solaris</td>
7879: </tr>
7880: <tr>
7881: <td>openpty</td>
7882: <td>-lutil</td>
7883: <td>Linux</td>
7884: </tr>
7885: </tbody>
7886: </table>
7887: </div>
7888: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 7889: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
7890: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 7891: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 7892: bmake</strong></span>.</p>
1.148 asau 7893: <div class="sect3">
1.92 rillig 7894: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 7895: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 7896: <p>When you are using the SunPro compiler, there is another
7897: possibility. That compiler cannot handle the following code:</p>
7898: <pre class="programlisting">
1.100 rillig 7899: extern int extern_func(int);
1.93 rillig 7900:
1.100 rillig 7901: static inline int
7902: inline_func(int x)
7903: {
1.92 rillig 7904: return extern_func(x);
1.100 rillig 7905: }
1.93 rillig 7906:
1.100 rillig 7907: int main(void)
7908: {
1.92 rillig 7909: return 0;
1.100 rillig 7910: }
1.92 rillig 7911: </pre>
7912: <p>It generates the code for <code class="function">inline_func</code> even if
7913: that function is never used. This code then refers to
7914: <code class="function">extern_func</code>, which can usually not be resolved. To
7915: solve this problem you can try to tell the package to disable inlining
7916: of functions.</p>
7917: </div>
1.87 wiz 7918: </div>
1.148 asau 7919: <div class="sect2">
1.87 wiz 7920: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7921: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 7922: <p>Sometimes packages fail to build because the compiler runs
7923: into an operating system specific soft limit. With the
7924: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204 wiz 7925: to unlimit the resources. Currently, the allowed values are any combination of
7926: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
7927: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.87 wiz 7928: Setting this variable is similar to running the shell builtin
1.110 hubertf 7929: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 7930: segment size or maximum stack size of a process, respectively, to
7931: their hard limits.</p>
1.78 rillig 7932: </div>
1.75 rillig 7933: </div>
1.148 asau 7934: <div class="sect1">
1.75 rillig 7935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218 rillig 7936: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 7937: <div class="sect2">
1.75 rillig 7938: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7939: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 7940: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 7941: with some operating systems cannot create more than one
7942: directory at a time. As such, you should call
7943: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
7944: <pre class="programlisting">
1.100 rillig 7945: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7946: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 7947: </pre>
1.128 wiz 7948: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
7949: dir2</code></span>”</span> to the
1.87 wiz 7950: <code class="varname">INSTALLATION_DIRS</code> variable, which will
7951: automatically do the right thing.</p>
1.75 rillig 7952: </div>
1.148 asau 7953: <div class="sect2">
1.75 rillig 7954: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7955: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 7956: <p>In general, documentation should be installed into
1.87 wiz 7957: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7958: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
7959: includes the version number of the package).</p>
1.84 wiz 7960: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 7961: directory where HTML documentation is installed with the
1.128 wiz 7962: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 7963: is needed because otherwise the documentation ends up in
7964: <code class="filename">${PREFIX}/share/doc/html</code> or other
7965: places.</p>
7966: <p>An exception to the above is that library API documentation
1.232 sevan 7967: 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.87 wiz 7968: browsers (devhelp) should be left at their default location, which
7969: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
7970: documentation can be recognized from files ending in
7971: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
7972: (It is also acceptable to install such files in
7973: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7974: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
7975: <code class="filename">.devhelp*</code> file must be directly in that
7976: directory then, no additional subdirectory level is allowed in
7977: this case. This is usually achieved by using
1.128 wiz 7978: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 7979: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
7980: though.)</p>
1.75 rillig 7981: </div>
1.148 asau 7982: <div class="sect2">
1.75 rillig 7983: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7984: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 7985: <p>Certain packages, most of them in the games category, install
1.87 wiz 7986: a score file that allows all users on the system to record their
7987: highscores. In order for this to work, the binaries need to be
7988: installed setgid and the score files owned by the appropriate
1.142 wiz 7989: group and/or owner (traditionally the "games" user/group). Set
7990: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 7991: following variables, documented in more detail in
7992: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 7993: behaviour: <code class="varname">GAMEDATAMODE</code>,
7994: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 7995: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
7996: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
7997: <code class="varname">GAMEDATA_PERMS</code> and
7998: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
7999: <p>An example that illustrates some of the variables described above is
8000: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8001: used to properly set directory permissions of the directory where the
8002: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8003: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8004: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8005: binary:</p>
8006: <pre class="programlisting">
1.223 rillig 8007: USE_GAMESGROUP= yes
1.210 leot 8008:
1.223 rillig 8009: BUILD_DEFS+= VARBASE
1.210 leot 8010:
1.223 rillig 8011: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8012: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8013: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 8014: </pre>
1.210 leot 8015: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8016: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8017: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8018: needed to be accessed by setgid games and
8019: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 8020: <p>A package should therefore never hard code file ownership or
1.210 leot 8021: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8022: or alternatively on <code class="varname">INSTALL_GAME</code>,
8023: <code class="varname">INSTALL_GAME_DATA</code> and
8024: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 8025: </div>
1.148 asau 8026: <div class="sect2">
1.75 rillig 8027: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8028: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8029: <p><code class="varname">DESTDIR</code> support means that a package
8030: installs into a staging directory, not the final location of the
8031: files. Then a binary package is created which can be used for
8032: installation as usual. There are two ways: Either the package must
1.128 wiz 8033: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8034: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8036: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 8037: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8038: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 8039: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8040: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8041: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8042: the inclusion.</p></li>
1.128 wiz 8043: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8044: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8045: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8046: automatically. Many manual rules and pre/post-install often are
8047: incorrect; fix them.</p></li>
1.128 wiz 8048: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8049: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8050: <li class="listitem"><p>In general, packages should support
1.103 wiz 8051: <code class="varname">UNPRIVILEGED</code> to be able to use
8052: DESTDIR.</p></li>
8053: </ul></div>
8054: </div>
1.148 asau 8055: <div class="sect2">
1.103 wiz 8056: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8057: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8058: <p>Your package may also contain scripts with hardcoded paths to
8059: other interpreters besides (or as well as) perl. To correct the
8060: full pathname to the script interpreter, you need to set the
8061: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8062: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8063: <pre class="programlisting">
1.100 rillig 8064: REPLACE_INTERPRETER+= tcl
8065: REPLACE.tcl.old= .*/bin/tclsh
8066: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8067: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8068: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 8069: </pre>
1.148 asau 8070: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8071: <h3 class="title">Note</h3>
8072: <p>Before March 2006, these variables were called
1.87 wiz 8073: <code class="varname">_REPLACE.*</code> and
8074: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8075: </div>
8076: </div>
1.148 asau 8077: <div class="sect2">
1.75 rillig 8078: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8079: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8080: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8081: the Makefile fragment
8082: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8083: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8084: configuration for such modules as well as various hooks to tune
8085: this configuration. See comments in this file for
8086: details.</p>
1.75 rillig 8087: <p>Perl5 modules will install into different places depending
1.87 wiz 8088: on the version of perl used during the build process. To
8089: address this, pkgsrc will append lines to the
8090: <code class="filename">PLIST</code> corresponding to the files listed in
8091: the installed <code class="filename">.packlist</code> file generated by
8092: most perl5 modules. This is invoked by defining
8093: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8094: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8095: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8096: e.g.:</p>
1.75 rillig 8097: <pre class="programlisting">
1.153 wiz 8098: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 8099: </pre>
1.153 wiz 8100: <p>The perl5 config variables
8101: <code class="varname">installarchlib</code>,
8102: <code class="varname">installscript</code>,
8103: <code class="varname">installvendorbin</code>,
8104: <code class="varname">installvendorscript</code>,
8105: <code class="varname">installvendorarch</code>,
8106: <code class="varname">installvendorlib</code>,
8107: <code class="varname">installvendorman1dir</code>, and
8108: <code class="varname">installvendorman3dir</code> represent those
8109: locations in which components of perl5 modules may be installed,
8110: provided as variable with uppercase and prefixed with
8111: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8112: and may be used by perl5 packages that don't have a packlist.
8113: These variables are also substituted for in the
8114: <code class="filename">PLIST</code> as uppercase prefixed with
8115: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8116: </div>
1.148 asau 8117: <div class="sect2">
1.75 rillig 8118: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8119: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8120: <p>Some packages install info files or use the
1.128 wiz 8121: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8122: commands. <code class="varname">INFO_FILES</code> should be defined in
8123: the package Makefile so that <code class="filename">INSTALL</code> and
8124: <code class="filename">DEINSTALL</code> scripts will be generated to
8125: handle registration of the info files in the Info directory
1.128 wiz 8126: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8127: files registration is either provided by the system, or by a
8128: special purpose package automatically added as dependency if
8129: needed.</p>
1.75 rillig 8130: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8131: <code class="filename">${PREFIX}</code> where info files are primarily
8132: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8133: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8134: <p>The info files for the package should be listed in the
1.87 wiz 8135: package <code class="filename">PLIST</code>; however any split info files
8136: need not be listed.</p>
1.128 wiz 8137: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8138: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8139: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8140: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8141: should be noted with the <code class="varname">TEXINFO_REQD</code>
8142: variable in the package <code class="filename">Makefile</code>. By
8143: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8144: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8145: does not match the required minimum, a build dependency on the
1.232 sevan 8146: <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.87 wiz 8147: be added automatically.</p>
1.75 rillig 8148: <p>The build and installation process of the software provided
1.87 wiz 8149: by the package should not use the
1.110 hubertf 8150: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8151: info files is the task of the package
8152: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8153: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8154: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8155: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8156: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8157: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8158: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8159: no effect except the logging of a message. The script overriding
1.110 hubertf 8160: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8161: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8162: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8163: </div>
1.148 asau 8164: <div class="sect2">
1.75 rillig 8165: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8166: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8167: <p>All packages that install manual pages should install them
1.87 wiz 8168: into the same directory, so that there is one common place to look
8169: for them. In pkgsrc, this place is
8170: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8171: should be used in packages. The default for
8172: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8173: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8174: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8175: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8176: <h3 class="title">Note</h3>
1.87 wiz 8177: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8178: is far from complete.</p>
1.75 rillig 8179: </div>
1.81 rillig 8180: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8181: <code class="filename">man/</code> as the top level directory for the man
8182: page file entries, and the pkgsrc framework will convert as
8183: needed. In all other places, the correct
8184: <code class="varname">PKGMANDIR</code> must be used.</p>
8185: <p>Packages that are
8186: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8187: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8188: <code class="filename">./configure</code>
8189: --mandir switch to set where the man pages should be installed.
8190: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8191: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8192: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8193: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8194: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8195: Or if the <code class="filename">./configure</code> script uses
8196: a non-standard use of --mandir, you can set
8197: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8198: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.87 wiz 8199: information on installation of compressed manual pages.</p>
1.75 rillig 8200: </div>
1.148 asau 8201: <div class="sect2">
1.75 rillig 8202: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8203: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8204: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8205: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8206: you need to take some extra steps to make sure they get registered
8207: in the database:</p>
1.128 wiz 8208: <div class="orderedlist"><ol class="orderedlist" type="1">
8209: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8210: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8211: takes care of rebuilding the GConf database at installation and
1.87 wiz 8212: deinstallation time, and tells the package where to install
1.107 rillig 8213: GConf data files using some standard configure arguments. It
1.87 wiz 8214: also disallows any access to the database directly from the
8215: package.</p></li>
1.128 wiz 8216: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8217: <code class="filename">.schemas</code> files under
8218: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8219: installed under <code class="filename">${PREFIX}/etc</code>, you will
8220: need to manually patch the package.</p></li>
1.128 wiz 8221: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8222: directory, as they will be handled automatically. See
1.194 bsiegert 8223: <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.128 wiz 8224: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8225: your <code class="filename">Makefile</code> with a list of all
8226: <code class="filename">.schemas</code> files installed by the package, if
8227: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8228: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8229: your <code class="filename">Makefile</code> with a
8230: list of all <code class="filename">.entries</code> files installed by the
8231: package, if any. Names must not contain any directories in
8232: them.</p></li>
1.75 rillig 8233: </ol></div>
8234: </div>
1.148 asau 8235: <div class="sect2">
1.75 rillig 8236: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 8237: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8238: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8239: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8240: get registered in the database:</p>
1.128 wiz 8241: <div class="orderedlist"><ol class="orderedlist" type="1">
8242: <li class="listitem"><p>Include
1.119 mishka 8243: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8244: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8245: takes care of rebuilding the scrollkeeper database at
8246: installation and deinstallation time, and disallows any access
8247: to it directly from the package.</p></li>
1.128 wiz 8248: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8249: <code class="filename">libdata/scrollkeeper</code> directory, as they
8250: will be handled automatically.</p></li>
1.128 wiz 8251: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 8252: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8253: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 8254: </ol></div>
8255: </div>
1.148 asau 8256: <div class="sect2">
1.75 rillig 8257: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8258: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8259: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8260: the fonts database in the directory where they get installed at
8261: installation and deinstallation time. This can be automatically
8262: done by using the pkginstall framework.</p>
1.75 rillig 8263: <p>You can list the directories where fonts are installed in the
1.87 wiz 8264: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8265: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 8266: <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.87 wiz 8267: Also make sure that the database file
8268: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8269: <p>Note that you should not create new directories for fonts;
1.87 wiz 8270: instead use the standard ones to avoid that the user needs to
8271: manually configure his X server to find them.</p>
1.75 rillig 8272: </div>
1.148 asau 8273: <div class="sect2">
1.75 rillig 8274: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8275: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8276: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8277: take some extra steps to get them registered in the GTK2 database
8278: properly:</p>
1.128 wiz 8279: <div class="orderedlist"><ol class="orderedlist" type="1">
8280: <li class="listitem"><p>Include
1.87 wiz 8281: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8282: <code class="filename">buildlink3.mk</code> file. This takes care of
8283: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 8284: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 8285: your package installs GTK2 immodules.</p></li>
1.128 wiz 8286: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 8287: GTK2 loaders.</p></li>
1.128 wiz 8288: <li class="listitem">
1.87 wiz 8289: <p>Patch the package to not touch any of the GTK2
8290: databases directly. These are:</p>
1.148 asau 8291: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8292: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8293: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8294: </ul></div>
8295: </li>
1.128 wiz 8296: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 8297: any entries under the <code class="filename">libdata/gtk-2.0</code>
8298: directory, as they will be handled automatically.</p></li>
1.75 rillig 8299: </ol></div>
8300: </div>
1.148 asau 8301: <div class="sect2">
1.75 rillig 8302: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8303: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8304: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8305: registered in system-wide catalogs (like DTDs, sub-catalogs,
8306: etc.), you need to take some extra steps:</p>
1.128 wiz 8307: <div class="orderedlist"><ol class="orderedlist" type="1">
8308: <li class="listitem"><p>Include
1.87 wiz 8309: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8310: your <code class="filename">Makefile</code>, which takes care of
8311: registering those files in system-wide catalogs at
8312: installation and deinstallation time.</p></li>
1.128 wiz 8313: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8314: any SGML catalogs installed by the package.</p></li>
1.128 wiz 8315: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 8316: any XML catalogs installed by the package.</p></li>
1.128 wiz 8317: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 8318: to be added to the SGML catalog. These come in groups of
8319: three strings; see xmlcatmgr(1) for more information
8320: (specifically, arguments recognized by the 'add' action).
8321: Note that you will normally not use this variable.</p></li>
1.128 wiz 8322: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 8323: to be added to the XML catalog. These come in groups of three
8324: strings; see xmlcatmgr(1) for more information (specifically,
8325: arguments recognized by the 'add' action). Note that you will
8326: normally not use this variable.</p></li>
1.75 rillig 8327: </ol></div>
8328: </div>
1.148 asau 8329: <div class="sect2">
1.75 rillig 8330: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8331: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 8332: <p>If a package provides extensions to the MIME database by
1.87 wiz 8333: installing <code class="filename">.xml</code> files inside
8334: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8335: need to take some extra steps to ensure that the database is kept
8336: consistent with respect to these new files:</p>
1.128 wiz 8337: <div class="orderedlist"><ol class="orderedlist" type="1">
8338: <li class="listitem"><p>Include
1.87 wiz 8339: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8340: (avoid using the <code class="filename">buildlink3.mk</code> file from
8341: this same directory, which is reserved for inclusion from
8342: other <code class="filename">buildlink3.mk</code> files). It takes
8343: care of rebuilding the MIME database at installation and
8344: deinstallation time, and disallows any access to it directly
8345: from the package.</p></li>
1.128 wiz 8346: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8347: <code class="filename">share/mime</code> directory,
8348: <span class="emphasis"><em>except</em></span> for files saved under
8349: <code class="filename">share/mime/packages</code>. The former are
8350: handled automatically by
8351: the update-mime-database program, but the latter are
8352: package-dependent and must be removed by the package that
8353: installed them in the first place.</p></li>
1.128 wiz 8354: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 8355: from the PLIST. They will be handled by the shared-mime-info
8356: package.</p></li>
1.75 rillig 8357: </ol></div>
8358: </div>
1.148 asau 8359: <div class="sect2">
1.75 rillig 8360: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8361: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 8362: <p>If a package uses intltool during its build, add
8363: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 8364: which forces it to use the intltool package provided by pkgsrc,
8365: instead of the one bundled with the distribution file.</p>
1.75 rillig 8366: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 8367: latest available version; this way, the package benefits of any
8368: bug fixes that may have appeared since it was released.</p>
1.75 rillig 8369: </div>
1.148 asau 8370: <div class="sect2">
1.75 rillig 8371: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8372: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 8373: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 8374: the startup directory by default, but you can enable it, by adding
8375: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 8376: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 8377: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8378: it will automatically remove the scripts when the package is
8379: deinstalled.</p>
1.75 rillig 8380: </div>
1.148 asau 8381: <div class="sect2">
1.75 rillig 8382: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8383: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 8384: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 8385: the <code class="filename">ls-R</code> database of the tree needs to be
8386: updated.</p>
1.148 asau 8387: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8388: <h3 class="title">Note</h3>
1.125 wiz 8389: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 8390: packages should install files
1.125 wiz 8391: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8392: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 8393: </div>
1.128 wiz 8394: <div class="orderedlist"><ol class="orderedlist" type="1">
8395: <li class="listitem"><p>Include
1.125 wiz 8396: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 8397: takes care of rebuilding the <code class="filename">ls-R</code>
8398: database at installation and deinstallation time.</p></li>
1.128 wiz 8399: <li class="listitem">
1.75 rillig 8400: <p>If your package installs files into a texmf
1.87 wiz 8401: tree other than the one
1.125 wiz 8402: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8403: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 8404: trees that need database update.</p>
1.75 rillig 8405: <p>If your package also installs font map files that need
1.110 hubertf 8406: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 8407: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 8408: set <code class="varname">TEX_MAP_FILES</code> and/or
8409: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 8410: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 8411: be run automatically at installation/deinstallation to
8412: enable/disable font map files for TeX output
8413: drivers.</p>
1.75 rillig 8414: </li>
1.128 wiz 8415: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 8416: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 8417: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 8418: </ol></div>
8419: </div>
1.148 asau 8420: <div class="sect2">
1.85 jmmv 8421: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8422: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 8423: emulation</h3></div></div></div>
8424: <p>There are some packages that provide libraries and
8425: executables for running binaries from a one operating system
8426: on a different one (if the latter supports it). One example
8427: is running Linux binaries on NetBSD.</p>
1.232 sevan 8428: <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.87 wiz 8429: helps in extracting and packaging Linux rpm packages.</p>
8430: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 8431: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 8432: if all libraries for each installed executable can be found by
8433: the dynamic linker. Since the standard dynamic linker is run,
8434: this fails for emulation packages, because the libraries used
8435: by the emulation are not in the standard directories.</p>
8436: </div>
1.148 asau 8437: <div class="sect2">
1.87 wiz 8438: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8439: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 8440: <p>If a package installs images under the
1.87 wiz 8441: <code class="filename">share/icons/hicolor</code> and/or updates the
8442: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8443: database, you need to take some extra steps to make sure that the
8444: shared theme directory is handled appropriately and that the cache
8445: database is rebuilt:</p>
1.128 wiz 8446: <div class="orderedlist"><ol class="orderedlist" type="1">
8447: <li class="listitem"><p>Include
1.87 wiz 8448: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 8449: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 8450: entry that refers to the theme cache.</p></li>
1.128 wiz 8451: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 8452: directories from the <code class="filename">share/icons/hicolor</code>
8453: hierarchy because they will be handled automatically.</p></li>
8454: </ol></div>
8455: <p>The best way to verify that the PLIST is correct with
8456: respect to the last two points is to regenerate it using
1.110 hubertf 8457: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 8458: </div>
1.148 asau 8459: <div class="sect2">
1.85 jmmv 8460: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8461: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 8462: <p>If a package installs <code class="filename">.desktop</code> files
8463: under <code class="filename">share/applications</code> and these include
1.159 rodent 8464: MIME information (MimeType key), you need to take extra steps to
8465: ensure that they are registered into the MIME database:</p>
1.128 wiz 8466: <div class="orderedlist"><ol class="orderedlist" type="1">
8467: <li class="listitem"><p>Include
1.85 jmmv 8468: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 8469: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 8470: <code class="filename">share/applications/mimeinfo.cache</code> file.
8471: It will be handled automatically.</p></li>
8472: </ol></div>
8473: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 8474: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 8475: print-PLIST</strong></span>.</p>
1.75 rillig 8476: </div>
8477: </div>
1.148 asau 8478: <div class="sect1">
1.87 wiz 8479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8480: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 8481: <p>In some cases one does not have the time to solve a problem
1.125 wiz 8482: immediately. In this case, one can plainly mark a package as broken. For
8483: this, one just sets the variable <code class="varname">BROKEN</code> to the
8484: reason why the package is broken (similar to the
8485: <code class="varname">RESTRICTED</code> variable). A user trying to build
8486: the package will immediately be shown this message, and the build
8487: will not be even tried.</p>
8488: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 8489: intervals.</p>
8490: </div>
1.75 rillig 8491: </div>
1.148 asau 8492: <div class="chapter">
1.75 rillig 8493: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 8494: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 8495: <p>To check out all the gotchas when building a package, here are
8496: the steps that I do in order to get a package working. Please note
8497: this is basically the same as what was explained in the previous
8498: sections, only with some debugging aids.</p>
1.148 asau 8499: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8500: <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>
8501: <li class="listitem">
1.232 sevan 8502: <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.88 wiz 8503: create a directory for a new package, change into it, then run
1.110 hubertf 8504: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 8505: <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>
8506: <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>
8507: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8508: </li>
1.128 wiz 8509: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8510: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8511: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8512: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 8513: configure step to the package's
8514: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 8515: <li class="listitem">
1.75 rillig 8516: <p>Make the package compile, doing multiple rounds of</p>
8517: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8518: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8519: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8520: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8521: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8522: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8523: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 8524: <p>Doing this step as non-root user will ensure that no files
8525: are modified that shouldn't be, especially during the build
1.110 hubertf 8526: phase. <span class="command"><strong>mkpatches</strong></span>,
8527: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.232 sevan 8528: 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.88 wiz 8529: package.</p>
1.75 rillig 8530: </li>
1.128 wiz 8531: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
8532: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
8533: <li class="listitem">
1.76 rillig 8534: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 8535: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8536: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8537: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8538: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8539: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 8540: <p>You usually need to be <code class="username">root</code> to do
8541: this. Look if there are any files left:</p>
1.75 rillig 8542: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8543: <p>If this reveals any files that are missing in
1.88 wiz 8544: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 8545: </li>
1.128 wiz 8546: <li class="listitem">
1.88 wiz 8547: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8548: package again and make a binary package:</p>
1.75 rillig 8549: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8550: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8551: </li>
1.128 wiz 8552: <li class="listitem">
1.75 rillig 8553: <p>Delete the installed package:</p>
1.88 wiz 8554: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75 rillig 8555: </li>
1.128 wiz 8556: <li class="listitem">
1.110 hubertf 8557: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 8558: command, which shouldn't find anything now:</p>
1.75 rillig 8559: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8560: </li>
1.128 wiz 8561: <li class="listitem">
1.75 rillig 8562: <p>Reinstall the binary package:</p>
1.93 rillig 8563: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75 rillig 8564: </li>
1.128 wiz 8565: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8566: <li class="listitem">
1.232 sevan 8567: <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.88 wiz 8568: reports:</p>
1.75 rillig 8569: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8570: </li>
1.128 wiz 8571: <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.75 rillig 8572: </ul></div>
8573: </div>
1.148 asau 8574: <div class="chapter">
1.75 rillig 8575: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 8576: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 8577: <div class="toc">
8578: <p><b>Table of Contents</b></p>
1.210 leot 8579: <dl class="toc">
1.106 rillig 8580: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
8581: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8582: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.243 wiz 8583: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
8584: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
8585: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
8586: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
8587: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 8588: </dl>
8589: </div>
1.148 asau 8590: <div class="sect1">
1.75 rillig 8591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8592: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 8593: <p>Our policy is that we accept binaries only from pkgsrc
8594: developers to guarantee that the packages don't contain any
8595: trojan horses etc. This is not to annoy anyone but rather to
8596: protect our users! You're still free to put up your home-made
8597: binary packages and tell the world where to get them. NetBSD
8598: developers doing bulk builds and wanting to upload them please
1.174 asau 8599: 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
8600: builds)</i></a>.</p>
1.75 rillig 8601: </div>
1.148 asau 8602: <div class="sect1">
1.75 rillig 8603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8604: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 8605: <p>First, check that your package is complete, compiles and
1.110 hubertf 8606: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.238 leot 8607: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 8608: archive that contains all files that make up the package.
1.87 wiz 8609: Finally, send this package to the pkgsrc bug tracking system,
1.238 leot 8610: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 8611: that, go to the web page
1.110 hubertf 8612: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 8613: which contains some instructions and a link to a form where you
8614: can submit packages. The
1.232 sevan 8615: <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.124 snj 8616: also available as a substitute for either of the above two tools.
8617: </p>
1.87 wiz 8618: <p>In the form of the problem report, the category should be
1.128 wiz 8619: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 8620: and version number, and the description field should contain a
8621: short description of your package (contents of the COMMENT
8622: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 8623: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 8624: <p>If you want to submit several packages, please send a
8625: separate PR for each one, it's easier for us to track things
8626: that way.</p>
8627: <p>Alternatively, you can also import new packages into
1.128 wiz 8628: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.215 wiz 8629: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.75 rillig 8630: for details.</p>
8631: </div>
1.148 asau 8632: <div class="sect1">
1.75 rillig 8633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8634: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 8635: <p>Please note all package additions, updates, moves, and
1.93 rillig 8636: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 8637: important to keep this file up to date and conforming to the
8638: existing format, because it will be used by scripts to
1.110 hubertf 8639: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 8640: sites. Additionally, check the
1.76 rillig 8641: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 8642: for the package you updated or removed, in case it was mentioned
8643: there.</p>
8644: <p>When the <code class="varname">PKGREVISION</code> of a package is
8645: bumped, the change should appear in
1.93 rillig 8646: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 8647: related or otherwise relevant. Mass bumps that result from a
8648: dependency being updated should not be mentioned. In all other
8649: cases it's the developer's decision.</p>
8650: <p>There is a make target that helps in creating proper
1.110 hubertf 8651: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 8652: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8653: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 8654: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 8655: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 8656: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8657: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 8658: For new packages, or package moves or removals, set the
8659: <code class="varname">CTYPE</code> variable on the command line to "Added",
8660: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 8661: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 8662: not the same as your NetBSD login name. The target also automatically
8663: removes possibly existing entries for the package in the
8664: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 8665: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 8666: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 8667: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8668: makes the cvs commands use the main repository.
8669: </p>
1.75 rillig 8670: </div>
1.148 asau 8671: <div class="sect1">
1.75 rillig 8672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.243 wiz 8673: <a name="commit-messages"></a>21.4. Commit Messages</h2></div></div></div>
8674: <p>For several years, there have been mirrors of pkgsrc in
8675: fossil, git, and hg. Standard practise when using these tools is to
8676: make the first line of a commit message function as a summary that
8677: can be read without the rest, such as is commonly done with "git log
8678: --oneline". For this reason, we have the following guidelines for
8679: pkgsrc commit messages:</p>
8680: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8681: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 8682: big picture in 65 characters or less. When a commit is for one
1.243 wiz 8683: package, include the name of the package. For updates, include the
8684: version to which it is updated.</p></li>
8685: <li class="listitem"><p>Leave the next line empty.</p></li>
8686: <li class="listitem"><p>Then come the details for the commit (changes in that
8687: package, reason for a change) and any relevant PRs. Wrap this
8688: section.</p></li>
8689: </ul></div>
8690: <p>Here is an example:
8691: </p>
8692: <pre class="programlisting">
8693: libxslt: update to 1.0.30
8694:
8695: Changes since 1.0.29:
8696: ...
8697: </pre>
8698: <p>
8699: </p>
8700: <p>Here is another example:
8701: </p>
8702: <pre class="programlisting">
8703: mk/bsd.pkg.mk: enable SSP by default on NetBSD
8704:
8705: (rationale)
8706: </pre>
8707: <p>
8708: </p>
8709: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
8710: allowed on the pkgsrc repository to change commit messages.</p>
8711: </div>
8712: <div class="sect1">
8713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8714: <a name="committing-importing"></a>21.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 8715: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 8716: access to the pkgsrc repository.</p>
8717: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8718: Start by adding the directory and then files in the directory. Don't
8719: forget to add the new package to the category's
8720: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8721: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8722: <pre class="programlisting">
8723: <code class="prompt">$</code> cd .../pkgsrc/category
8724: <code class="prompt">$</code> cvs add pkgname
8725: <code class="prompt">$</code> cd pkgname
8726: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8727: <code class="prompt">$</code> cvs add patches/p*
8728: <code class="prompt">$</code> cvs status | less
1.141 wiz 8729: <code class="prompt">$</code> cvs commit
1.140 wiz 8730: <code class="prompt">$</code> cd ..
8731: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 8732: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 8733: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 8734: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 8735: </pre>
1.87 wiz 8736: <p>The commit message of the initial import should include part of the
1.76 rillig 8737: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 8738: what the package is/does.</p>
1.140 wiz 8739: <p>Also mention the new package in
8740: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8741: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8742: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 8743: </div>
1.148 asau 8744: <div class="sect1">
1.75 rillig 8745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.243 wiz 8746: <a name="updating-package"></a>21.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 8747: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 8748: changes between old and new versions into the commit log when updating
1.87 wiz 8749: a package. There are various reasons for this:</p>
1.148 asau 8750: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8751: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 8752: or its information may be overwritten by newer information.</p></li>
1.128 wiz 8753: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 8754: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 8755: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 8756: repository is very useful for people who read the pkgsrc-changes mailing
8757: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 8758: the package.</p></li>
1.75 rillig 8759: </ul></div>
1.87 wiz 8760: <p>Please also recognize that, just because a new version of a package
1.75 rillig 8761: has been released, it should not automatically be upgraded in the CVS
8762: repository. We prefer to be conservative in the packages that are
8763: included in pkgsrc - development or beta packages are not really the
8764: best thing for most places in which pkgsrc is used. Please use your
8765: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 8766: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 8767: </div>
1.148 asau 8768: <div class="sect1">
1.75 rillig 8769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.243 wiz 8770: <a name="renaming-package"></a>21.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 8771: <p>Renaming packages is not recommended.</p>
8772: <p>When renaming packages, be sure to fix any references to old name
8773: in other Makefiles, options, buildlink files, etc.</p>
8774: <p>Also When renaming a package, please define
8775: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8776: pattern(s) of the previous package name.
8777: This may be repeated for multiple renames.
8778: The new package would be an exact replacement.
8779: </p>
1.128 wiz 8780: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 8781: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8782: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8783: not be an exact replacement but is a suggestion for the replaced
8784: functionality.</p>
8785: </div>
1.148 asau 8786: <div class="sect1">
1.122 reed 8787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.243 wiz 8788: <a name="moving-package"></a>21.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 8789: <p>It is preferred that packages are not renamed or moved, but if needed
8790: please follow these steps.
8791: </p>
1.128 wiz 8792: <div class="orderedlist"><ol class="orderedlist" type="1">
8793: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8794: <li class="listitem">
1.75 rillig 8795: <p>Remove all CVS dirs.</p>
1.87 wiz 8796: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 8797: <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>
1.87 wiz 8798: <p>and use that for further work.</p>
1.75 rillig 8799: </li>
1.128 wiz 8800: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8801: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8802: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8803: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 8804: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8805: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8806: for doing an update using pkgsrc building; for example, it can
1.238 leot 8807: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122 reed 8808: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8809: new <code class="varname">PKGPATH</code> for that moved package. Note that
8810: it may have multiple matches, so the tool should also check on the
8811: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8812: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8813: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 8814: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 8815: place.</p></li>
1.128 wiz 8816: <li class="listitem">
1.75 rillig 8817: <p>Check if any package depends on it:
8818: </p>
8819: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8820: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8821: </li>
1.128 wiz 8822: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8823: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8824: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8825: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8826: <li class="listitem">
1.75 rillig 8827: <p>Commit the changed and removed files:</p>
8828: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 8829: <p>(and any packages from step 5, of course).</p>
1.75 rillig 8830: </li>
8831: </ol></div>
8832: </div>
8833: </div>
1.148 asau 8834: <div class="chapter">
1.75 rillig 8835: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 8836: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 8837: <p>This section contains the answers to questions that may
8838: arise when you are writing a package. If you don't find your
8839: question answered here, first have a look in the other chapters,
8840: and if you still don't have the answer, ask on the
8841: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 8842: <div class="qandaset">
1.246 ! leot 8843: <a name="idm79766320"></a><dl>
1.106 rillig 8844: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 8845: MAKEFLAGS, .MAKEFLAGS and
8846: MAKE_FLAGS?</a>
8847: </dt>
1.106 rillig 8848: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 8849: MAKE, GMAKE and
8850: MAKE_PROGRAM?</a>
8851: </dt>
1.106 rillig 8852: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 8853: CC, PKG_CC and
8854: PKGSRC_COMPILER?</a>
8855: </dt>
1.106 rillig 8856: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 8857: BUILDLINK_LDFLAGS,
8858: BUILDLINK_LDADD and
8859: BUILDLINK_LIBS?</a>
8860: </dt>
1.106 rillig 8861: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 8862: VARNAME=BUILDLINK_PREFIX.foo
8863: say it's empty?</a>
8864: </dt>
1.106 rillig 8865: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 8866: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
8867: don't understand the := inside
8868: it.</a>
8869: </dt>
1.106 rillig 8870: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 8871: developers?</a>
8872: </dt>
1.106 rillig 8873: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 8874: documentation?</a>
8875: </dt>
1.106 rillig 8876: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 8877: do?</a>
8878: </dt>
1.75 rillig 8879: </dl>
1.148 asau 8880: <table border="0" style="width: 100%;">
8881: <colgroup>
1.75 rillig 8882: <col align="left" width="1%">
1.128 wiz 8883: <col>
1.148 asau 8884: </colgroup>
1.75 rillig 8885: <tbody>
1.148 asau 8886: <tr class="question">
1.75 rillig 8887: <td align="left" valign="top">
1.246 ! leot 8888: <a name="devfaq.makeflags"></a><a name="idm79765936"></a><p><b>22.1.</b></p>
1.75 rillig 8889: </td>
8890: <td align="left" valign="top"><p>What is the difference between
8891: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
8892: <code class="varname">MAKE_FLAGS</code>?</p></td>
8893: </tr>
8894: <tr class="answer">
1.91 rillig 8895: <td align="left" valign="top"></td>
1.75 rillig 8896: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.238 leot 8897: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 8898: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
8899: the <code class="varname">MAKE_PROGRAM</code> when building the
8900: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
8901: </tr>
1.148 asau 8902: <tr class="question">
1.75 rillig 8903: <td align="left" valign="top">
1.246 ! leot 8904: <a name="devfaq.make"></a><a name="idm79761968"></a><p><b>22.2.</b></p>
1.75 rillig 8905: </td>
8906: <td align="left" valign="top"><p>What is the difference between
8907: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
8908: <code class="varname">MAKE_PROGRAM</code>?</p></td>
8909: </tr>
8910: <tr class="answer">
1.91 rillig 8911: <td align="left" valign="top"></td>
1.75 rillig 8912: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.238 leot 8913: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 8914: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
8915: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
8916: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
8917: Make program that is used for building the
8918: package.</p></td>
8919: </tr>
1.148 asau 8920: <tr class="question">
1.75 rillig 8921: <td align="left" valign="top">
1.246 ! leot 8922: <a name="devfaq.cc"></a><a name="idm79757488"></a><p><b>22.3.</b></p>
1.75 rillig 8923: </td>
8924: <td align="left" valign="top"><p>What is the difference between
8925: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
8926: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
8927: </tr>
8928: <tr class="answer">
1.91 rillig 8929: <td align="left" valign="top"></td>
1.75 rillig 8930: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
8931: compiler, which can be configured by the pkgsrc user.
8932: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
8933: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
8934: path to a compiler, but the type of compiler that should be
1.76 rillig 8935: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 8936: information about the latter variable.</p></td>
8937: </tr>
1.148 asau 8938: <tr class="question">
1.75 rillig 8939: <td align="left" valign="top">
1.246 ! leot 8940: <a name="devfaq.bl3flags"></a><a name="idm79753392"></a><p><b>22.4.</b></p>
1.75 rillig 8941: </td>
8942: <td align="left" valign="top"><p>What is the difference between
8943: <code class="varname">BUILDLINK_LDFLAGS</code>,
8944: <code class="varname">BUILDLINK_LDADD</code> and
8945: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
8946: </tr>
8947: <tr class="answer">
1.91 rillig 8948: <td align="left" valign="top"></td>
1.75 rillig 8949: <td align="left" valign="top"><p>[FIXME]</p></td>
8950: </tr>
1.148 asau 8951: <tr class="question">
1.75 rillig 8952: <td align="left" valign="top">
1.246 ! leot 8953: <a name="devfaq.bl3prefix"></a><a name="idm79751216"></a><p><b>22.5.</b></p>
1.75 rillig 8954: </td>
1.110 hubertf 8955: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 8956: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
8957: say it's empty?</p></td>
8958: </tr>
8959: <tr class="answer">
1.91 rillig 8960: <td align="left" valign="top"></td>
1.75 rillig 8961: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 8962: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
8963: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 8964: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 8965: command.</p></td>
8966: </tr>
1.148 asau 8967: <tr class="question">
1.78 rillig 8968: <td align="left" valign="top">
1.246 ! leot 8969: <a name="devfaq.master_sites"></a><a name="idm79739824"></a><p><b>22.6.</b></p>
1.78 rillig 8970: </td>
8971: <td align="left" valign="top"><p>What does
1.220 wiz 8972: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
8973: don't understand the <code class="code">:=</code> inside
1.78 rillig 8974: it.</p></td>
8975: </tr>
8976: <tr class="answer">
1.91 rillig 8977: <td align="left" valign="top"></td>
1.220 wiz 8978: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
8979: assignment operator, although it looks like it.
1.78 rillig 8980: Instead, it is a degenerate form of
1.220 wiz 8981: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.238 leot 8982: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220 wiz 8983: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 8984: case of <code class="varname">MASTER_SITE_*</code>,
8985: <em class="replaceable"><code>old_string</code></em> is the empty string and
8986: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 8987: <code class="code">package/</code>. That's where the
8988: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 8989: together.</p></td>
8990: </tr>
1.148 asau 8991: <tr class="question">
1.78 rillig 8992: <td align="left" valign="top">
1.246 ! leot 8993: <a name="devfaq.mailinglists"></a><a name="idm79732912"></a><p><b>22.7.</b></p>
1.78 rillig 8994: </td>
8995: <td align="left" valign="top"><p>Which mailing lists are there for package
8996: developers?</p></td>
8997: </tr>
8998: <tr class="answer">
1.91 rillig 8999: <td align="left" valign="top"></td>
1.148 asau 9000: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9001: <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.78 rillig 9002: <dd><p>This is a list for technical discussions related
9003: to pkgsrc development, e.g. soliciting feedback for changes to
9004: pkgsrc infrastructure, proposed new features, questions related
9005: to porting pkgsrc to a new platform, advice for maintaining a
9006: package, patches that affect many packages, help requests moved
9007: from pkgsrc-users when an infrastructure bug is found,
9008: etc.</p></dd>
1.110 hubertf 9009: <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.78 rillig 9010: <dd><p>All bug reports in category "pkg" sent with
1.238 leot 9011: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 9012: directly; use one of the other mailing
9013: lists.</p></dd>
9014: </dl></div></td>
9015: </tr>
1.148 asau 9016: <tr class="question">
1.80 rillig 9017: <td align="left" valign="top">
1.246 ! leot 9018: <a name="devfaq.documentation"></a><a name="idm79729200"></a><p><b>22.8.</b></p>
1.80 rillig 9019: </td>
9020: <td align="left" valign="top"><p>Where is the pkgsrc
9021: documentation?</p></td>
9022: </tr>
9023: <tr class="answer">
1.91 rillig 9024: <td align="left" valign="top"></td>
1.80 rillig 9025: <td align="left" valign="top">
9026: <p>There are many places where you can find
9027: documentation about pkgsrc:</p>
1.148 asau 9028: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9029: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9030: of chapters that explain large parts of pkgsrc, but some
9031: chapters tend to be outdated. Which ones they are is hard to
9032: say.</p></li>
1.128 wiz 9033: <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.80 rillig 9034: about certain features, announcements of new parts of the pkgsrc
9035: infrastructure and sometimes even announcements that a certain
9036: feature has been marked as obsolete. The benefit here is that
9037: each message has a date appended to it.</p></li>
1.128 wiz 9038: <li class="listitem"><p>Many of the files in the
1.80 rillig 9039: <code class="filename">mk/</code> directory start with a comment that
9040: describes the purpose of the file and how it can be used by the
1.92 rillig 9041: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9042: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9043: help</strong></span>.</p></li>
1.128 wiz 9044: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9045: information, but they tend to be highly abbreviated, especially
9046: for actions that occur often. Some contain a detailed
9047: description of what has changed, but they are geared towards the
9048: other pkgsrc developers, not towards an average pkgsrc user.
9049: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9050: don't know what has been before, these messages may not be worth
9051: too much to you.</p></li>
1.128 wiz 9052: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9053: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9054: mind of the developer who wrote the code. To get this
1.110 hubertf 9055: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9056: to see who has written it and ask on the
9057: <code class="literal">tech-pkg</code> mailing list, so that others can
9058: find your questions later (see above). To be sure that the
9059: developer in charge reads the mail, you may CC him or
9060: her.</p></li>
9061: </ul></div>
9062: </td>
9063: </tr>
1.148 asau 9064: <tr class="question">
1.92 rillig 9065: <td align="left" valign="top">
1.246 ! leot 9066: <a name="devfaq.too-much-time"></a><a name="idm79722672"></a><p><b>22.9.</b></p>
1.92 rillig 9067: </td>
9068: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9069: do?</p></td>
9070: </tr>
9071: <tr class="answer">
9072: <td align="left" valign="top"></td>
9073: <td align="left" valign="top">
1.93 rillig 9074: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9075: anyway.</p>
1.148 asau 9076: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9077: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.232 sevan 9078: <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.92 rillig 9079: will tell you about newer versions of installed packages that are
9080: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9081: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9082: — it contains a list of suggested new packages and a list of
1.92 rillig 9083: cleanups and enhancements for pkgsrc that would be nice to
9084: have.</p></li>
1.128 wiz 9085: <li class="listitem"><p>Review packages for which review was requested on
1.180 wiz 9086: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92 rillig 9087: mailing list.</p></li>
9088: </ul></div>
9089: </td>
9090: </tr>
1.75 rillig 9091: </tbody>
9092: </table>
9093: </div>
9094: </div>
1.148 asau 9095: <div class="chapter">
1.85 jmmv 9096: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9097: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9098: <div class="toc">
9099: <p><b>Table of Contents</b></p>
1.210 leot 9100: <dl class="toc">
1.106 rillig 9101: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9102: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9103: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9104: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9105: </dl>
9106: </div>
1.110 hubertf 9107: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9108: site</a>:</p>
9109: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9110: environment, an intuitive and attractive desktop for users, and the
9111: GNOME development platform, an extensive framework for building
9112: applications that integrate into the rest of the desktop.</p></blockquote></div>
9113: <p>pkgsrc provides a seamless way to automatically build and install
9114: a complete GNOME environment <span class="emphasis"><em>under many different
9115: platforms</em></span>. We can say with confidence that pkgsrc is one of
9116: the most advanced build and packaging systems for GNOME due to its
9117: included technologies buildlink3, the wrappers and tools framework and
9118: automatic configuration file management. Lots of efforts are put into
9119: achieving a completely clean deinstallation of installed software
9120: components.</p>
1.110 hubertf 9121: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9122: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9123: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9124: pkgsrc as its preferred packaging system, contributing lots of
9125: portability fixes to make GNOME build and install under it.</p>
9126: <p>This chapter is aimed at pkgsrc developers and other people
9127: interested in helping our GNOME porting and packaging efforts. It
9128: provides instructions on how to manage the existing packages and some
9129: important information regarding their internals.</p>
1.148 asau 9130: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9131: <h3 class="title">We need your help!</h3>
9132: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9133: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9134: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9135: work</a> list! There is still a long way to go to get a
9136: fully-functional GNOME desktop under NetBSD and we need your help to
9137: achieve it!</p>
9138: </div>
1.148 asau 9139: <div class="sect1">
1.85 jmmv 9140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9141: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9142: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9143: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232 sevan 9144: <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.85 jmmv 9145: the core GNOME desktop environment. It only includes the necessary
9146: bits to get it to boot correctly, although it may lack important
9147: functionality for daily operation. The idea behind this package is
9148: to let end users build their own configurations on top of this one,
9149: first installing this meta package to achieve a functional setup and
9150: then adding individual applications.</p></li>
1.232 sevan 9151: <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.85 jmmv 9152: complete installation of the GNOME platform and desktop as defined
9153: by the GNOME project; this is based on the components distributed in
9154: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9155: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9156: official FTP server. Developer-only tools found in those
9157: directories are not installed unless required by some other
9158: component to work properly. Similarly, packages from the bindings
9159: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9160: in unless required as a dependency for an end-user component. This
1.232 sevan 9161: 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>
9162: <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.85 jmmv 9163: Installs all the tools required to build a GNOME component when
9164: fetched from the CVS repository. These are required to let the
1.110 hubertf 9165: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9166: </ul></div>
9167: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9168: sorted in a way that eases updates: a package may depend on other
9169: packages listed before it but not on any listed after it. It is very
9170: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9171: change it to alphabetical sorting!</em></span></p>
9172: </div>
1.148 asau 9173: <div class="sect1">
1.85 jmmv 9174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9175: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9176: <p>Almost all GNOME applications are written in C and use a common
9177: set of tools as their build system. Things get different with the new
9178: bindings to other languages (such as Python), but the following will
9179: give you a general idea on the minimum required tools:</p>
1.148 asau 9180: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9181: <li class="listitem">
1.85 jmmv 9182: <p>Almost all GNOME applications use the GNU Autotools as their
9183: build system. As a general rule you will need to tell this to your
9184: package:</p>
1.100 rillig 9185: <pre class="programlisting">
9186: GNU_CONFIGURE=yes
1.85 jmmv 9187: USE_LIBTOOL=yes
1.100 rillig 9188: USE_TOOLS+=gmake
9189: </pre>
1.85 jmmv 9190: </li>
1.128 wiz 9191: <li class="listitem">
1.85 jmmv 9192: <p>If the package uses pkg-config to detect dependencies, add this
9193: tool to the list of required utilities:</p>
1.222 sevan 9194: <pre class="programlisting">
9195: USE_TOOLS+=pkg-config
9196: </pre>
1.232 sevan 9197: <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.85 jmmv 9198: the end of the build process to ensure that you did not miss to
9199: specify any dependency in your package and that the version
9200: requirements are all correct.</p>
9201: </li>
1.128 wiz 9202: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9203: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9204: to handle dependencies and to force the package to use the latest
9205: available version.</p></li>
1.128 wiz 9206: <li class="listitem">
1.85 jmmv 9207: <p>If the package uses gtk-doc (a documentation generation
9208: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9209: tool is rather big and the distfile should come with pregenerated
9210: documentation anyway; if it does not, it is a bug that you ought to
9211: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9212: the default):</p>
1.222 sevan 9213: <pre class="programlisting">
9214: CONFIGURE_ARGS+=--disable-gtk-doc
9215: </pre>
1.89 rillig 9216: <p>The default location of installed HTML files
9217: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9218: and should not be changed unless the package insists on installing
9219: them somewhere else. Otherwise programs as
1.110 hubertf 9220: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9221: do that with an entry similar to:</p>
1.222 sevan 9222: <pre class="programlisting">
9223: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9224: </pre>
1.85 jmmv 9225: </li>
9226: </ul></div>
9227: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9228: files under the installation prefix to maintain databases. In this
9229: context, shared means that those exact same directories and files are
9230: used among several different packages, leading to conflicts in the
9231: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9232: handle the most common cases, so you have to forget about using
9233: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9234: omitting shared files from them. If you find yourself doing those,
9235: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9236: <p>The following table lists the common situations that result in
9237: using shared directories or files. For each of them, the appropriate
9238: solution is given. After applying the solution be sure to
9239: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9240: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9241: <div class="table">
1.106 rillig 9242: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.216 tnn 9243: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9244: <colgroup>
9245: <col>
9246: <col>
9247: </colgroup>
9248: <thead><tr>
9249: <th>If the package...</th>
9250: <th>Then...</th>
9251: </tr></thead>
9252: <tbody>
9253: <tr>
9254: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9255: <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.85 jmmv 9256: </tr>
9257: <tr>
9258: <td>Installs icons under the
9259: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9260: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9261: <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.85 jmmv 9262: </tr>
9263: <tr>
9264: <td>Installs files under
9265: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9266: <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.85 jmmv 9267: </tr>
9268: <tr>
9269: <td>Installs <code class="filename">.desktop</code> files under
9270: <code class="filename">share/applications</code> and these include MIME
9271: information.</td>
1.110 hubertf 9272: <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.85 jmmv 9273: </tr>
9274: </tbody>
1.91 rillig 9275: </table></div>
1.85 jmmv 9276: </div>
1.91 rillig 9277: <br class="table-break">
1.85 jmmv 9278: </div>
1.148 asau 9279: <div class="sect1">
1.85 jmmv 9280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9281: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9282: <p>When seeing GNOME as a whole, there are two kinds of
9283: updates:</p>
1.148 asau 9284: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9285: <dt><span class="term">Major update</span></dt>
9286: <dd>
9287: <p>Given that there is still a very long way for GNOME 3 (if it
9288: ever appears), we consider a major update one that goes from a
9289: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9290: where <code class="literal">Y</code> is even and greater than
9291: <code class="literal">X</code>. These are hard to achieve because they
9292: introduce lots of changes in the components' code and almost all
9293: GNOME distfiles are updated to newer versions. Some of them can
9294: even break API and ABI compatibility with the previous major
9295: version series. As a result, the update needs to be done all at
9296: once to minimize breakage.</p>
9297: <p>A major update typically consists of around 80 package
9298: updates and the addition of some new ones.</p>
9299: </dd>
9300: <dt><span class="term">Minor update</span></dt>
9301: <dd>
9302: <p>We consider a minor update one that goes from a
9303: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9304: one where <code class="literal">Y</code> is greater than
9305: <code class="literal">X</code>. These are easy to achieve because they do
9306: not update all GNOME components, can be done in an incremental way
9307: and do not break API nor ABI compatibility.</p>
9308: <p>A minor update typically consists of around 50 package
9309: updates, although the numbers here may vary a lot.</p>
9310: </dd>
9311: </dl></div>
9312: <p>In order to update the GNOME components in pkgsrc to a new stable
9313: release (either major or minor), the following steps should be
9314: followed:</p>
1.128 wiz 9315: <div class="orderedlist"><ol class="orderedlist" type="1">
9316: <li class="listitem">
1.85 jmmv 9317: <p>Get a list of all the tarballs that form the new release by
9318: using the following commands. These will leave the full list of the
1.120 snj 9319: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 9320: file:</p>
1.88 wiz 9321: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9322: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9323: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9324: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9325: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9326: awk '{ print $9 }' >>list.txt</code></strong></pre>
9327: </li>
1.128 wiz 9328: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 9329: bump their version to the release you are updating them to. The
9330: three meta packages should be always consistent with versioning.
9331: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9332: in them.</p></li>
1.128 wiz 9333: <li class="listitem">
1.85 jmmv 9334: <p>For each meta package, update all its
9335: <code class="varname">DEPENDS</code> lines to match the latest versions as
9336: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9337: newer version (even if found in the FTP) because the meta packages
9338: are supposed to list the exact versions that form a specific GNOME
9339: release. Exceptions are permitted here if a newer version solves a
9340: serious issue in the overall desktop experience; these typically
9341: come in the form of a revision bump in pkgsrc, not in newer versions
9342: from the developers.</p>
9343: <p>Packages not listed in the <code class="filename">list.txt</code> file
9344: should be updated to the latest version available (if found in
9345: pkgsrc). This is the case, for example, of the dependencies on the
1.232 sevan 9346: 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.85 jmmv 9347: </li>
1.128 wiz 9348: <li class="listitem">
1.85 jmmv 9349: <p>Generate a patch from the modified meta packages and extract the
9350: list of "new" lines. This will provide you an outline on what
9351: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9352: <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>
1.85 jmmv 9353: </li>
1.128 wiz 9354: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 9355: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 9356: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 9357: of <code class="filename">todo.txt</code> and update the packages listed in
9358: it in order. For major desktop updates none of these should be
1.93 rillig 9359: committed until the entire set is completed because there are chances
1.85 jmmv 9360: of breaking not-yet-updated packages.</p></li>
1.128 wiz 9361: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 9362: the tree one by one with appropriate log messages. At the end,
9363: commit the three meta package updates and all the corresponding
9364: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9365: <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>
9366: </ol></div>
9367: </div>
1.148 asau 9368: <div class="sect1">
1.85 jmmv 9369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9370: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9371: <p>GNOME is a very big component in pkgsrc which approaches 100
9372: packages. Please, it is very important that you always, always,
9373: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 9374: 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.85 jmmv 9375: their attention on portability issues and to ensure that future versions
9376: can be built out-of-the box on NetBSD. The less custom patches in
9377: pkgsrc, the easier further updates are. Those developers in charge of
9378: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 9379: <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.85 jmmv 9380: Bugzilla</a>. Not all components use these to track bugs, but most
9381: of them do. Do not be short on your reports: always provide detailed
9382: explanations of the current failure, how it can be improved to achieve
9383: maximum portability and, if at all possible, provide a patch against CVS
9384: head. The more verbose you are, the higher chances of your patch being
9385: accepted.</p>
9386: <p>Also, please avoid using preprocessor magic to fix portability
9387: issues. While the FreeBSD GNOME people are doing a great job in porting
9388: GNOME to their operating system, the official GNOME sources are now
9389: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9390: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 9391: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 9392: details.</p>
9393: </div>
9394: </div>
1.75 rillig 9395: </div>
1.148 asau 9396: <div class="part">
1.75 rillig 9397: <div class="titlepage"><div><div><h1 class="title">
9398: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 9399: <div class="partintro">
1.75 rillig 9400: <div></div>
9401: <p>This part of the guide deals with everything
9402: from the infrastructure that is behind the interfaces described
9403: in the developer's guide. A casual package maintainer should not
9404: need anything from this part.</p>
9405: <div class="toc">
9406: <p><b>Table of Contents</b></p>
1.210 leot 9407: <dl class="toc">
1.106 rillig 9408: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 9409: <dd><dl>
1.106 rillig 9410: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9411: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9412: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 9413: <dd><dl>
1.106 rillig 9414: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9415: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 9416: </dl></dd>
1.106 rillig 9417: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9418: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9419: <dd><dl>
1.106 rillig 9420: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9421: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 9422: </dl></dd>
1.106 rillig 9423: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 9424: <dd><dl>
1.128 wiz 9425: <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>
9426: <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.75 rillig 9427: </dl></dd>
9428: </dl></dd>
1.106 rillig 9429: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 9430: <dd><dl>
1.219 rillig 9431: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9432: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75 rillig 9433: <dd><dl>
1.219 rillig 9434: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9435: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75 rillig 9436: </dl></dd>
9437: </dl></dd>
1.106 rillig 9438: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.219 rillig 9439: <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.75 rillig 9440: </dl>
9441: </div>
9442: </div>
1.148 asau 9443: <div class="chapter">
1.75 rillig 9444: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9445: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 9446: <div class="toc">
9447: <p><b>Table of Contents</b></p>
1.210 leot 9448: <dl class="toc">
1.106 rillig 9449: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9450: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9451: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 9452: <dd><dl>
1.106 rillig 9453: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9454: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 9455: </dl></dd>
1.106 rillig 9456: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9457: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9458: <dd><dl>
1.106 rillig 9459: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9460: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 9461: </dl></dd>
1.106 rillig 9462: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 9463: <dd><dl>
1.128 wiz 9464: <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>
9465: <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.75 rillig 9466: </dl></dd>
9467: </dl>
9468: </div>
9469: <p>The pkgsrc infrastructure consists of many small Makefile
9470: fragments. Each such fragment needs a properly specified
9471: interface. This chapter explains how such an interface looks
9472: like.</p>
1.148 asau 9473: <div class="sect1">
1.75 rillig 9474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9475: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 9476: <p>Whenever a variable is defined in the pkgsrc
9477: infrastructure, the location and the way of definition provide
9478: much information about the intended use of that variable.
9479: Additionally, more documentation may be found in a header
9480: comment or in this pkgsrc guide.</p>
9481: <p>A special file is
9482: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9483: variables that are intended to be user-defined. They are either
9484: defined using the <code class="literal">?=</code> operator or they are
9485: left undefined because defining them to anything would
1.128 wiz 9486: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 9487: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9488: file.</p>
9489: <p>Outside this file, the following conventions apply:
9490: Variables that are defined using the <code class="literal">?=</code>
9491: operator may be overridden by a package.</p>
9492: <p>Variables that are defined using the <code class="literal">=</code>
9493: operator may be used read-only at run-time.</p>
9494: <p>Variables whose name starts with an underscore must not be
9495: accessed outside the pkgsrc infrastructure at all. They may
9496: change without further notice.</p>
1.148 asau 9497: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 9498: <h3 class="title">Note</h3>
9499: <p>These conventions are currently not applied
9500: consistently to the complete pkgsrc
9501: infrastructure.</p>
9502: </div>
9503: </div>
1.148 asau 9504: <div class="sect1">
1.81 rillig 9505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9506: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 9507: <p>All variables that contain lists of things should default
9508: to being empty. Two examples that do not follow this rule are
9509: <code class="varname">USE_LANGUAGES</code> and
9510: <code class="varname">DISTFILES</code>. These variables cannot simply be
9511: modified using the <code class="literal">+=</code> operator in package
9512: <code class="filename">Makefile</code>s (or other files included by
9513: them), since there is no guarantee whether the variable is
9514: already set or not, and what its value is. In the case of
1.128 wiz 9515: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 9516: the default value and just define it as in the following
9517: example.</p>
9518: <pre class="programlisting">
1.100 rillig 9519: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 9520: </pre>
9521: <p>Because of the selection of this default value, the same
9522: value appears in many package Makefiles. Similarly for
9523: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 9524: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 9525: doesn't stand out. Nevertheless it is mentioned in many
9526: files.</p>
9527: </div>
1.148 asau 9528: <div class="sect1">
1.81 rillig 9529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9530: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 9531: <div class="sect2">
1.75 rillig 9532: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9533: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 9534: <p>Variable evaluation takes place either at load time or at
9535: runtime, depending on the context in which they occur. The
9536: contexts where variables are evaluated at load time are:</p>
1.148 asau 9537: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9538: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 9539: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 9540: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 9541: <code class="literal">.for</code>,</p></li>
1.128 wiz 9542: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 9543: </ul></div>
9544: <p>A special exception are references to the iteration
9545: variables of <code class="literal">.for</code> loops, which are expanded
9546: inline, no matter in which context they appear.</p>
9547: <p>As the values of variables may change during load time,
9548: care must be taken not to evaluate them by accident. Typical
9549: examples for variables that should not be evaluated at load time
9550: are <code class="varname">DEPENDS</code> and
9551: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9552: clear, here is an example:</p>
9553: <pre class="programlisting">
1.100 rillig 9554: CONFIGURE_ARGS= # none
9555: CFLAGS= -O
9556: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 9557:
1.100 rillig 9558: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 9559:
1.100 rillig 9560: CFLAGS+= -Wall
1.222 sevan 9561: </pre>
1.75 rillig 9562: <p>This code shows how the use of the <code class="literal">:=</code>
9563: operator can quickly lead to unexpected results. The first
9564: paragraph is fairly common code. The second paragraph evaluates
9565: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9566: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9567: <code class="literal">-Wall</code> is appended to the
9568: <code class="varname">CFLAGS</code>, but this addition will not appear in
9569: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9570: paragraphs from above typically occur in completely unrelated
9571: files.</p>
9572: </div>
1.148 asau 9573: <div class="sect2">
1.75 rillig 9574: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9575: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 9576: <p>After all the files have been loaded, the values of the
9577: variables cannot be changed anymore. Variables that are used in
9578: the shell commands are expanded at this point.</p>
9579: </div>
9580: </div>
1.148 asau 9581: <div class="sect1">
1.75 rillig 9582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9583: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 9584: <p>There are many ways in which the definition and use of a
1.218 rillig 9585: variable can be restricted in order to detect bugs and violations
9586: of the (mostly unwritten) policies. A package can be checked with
9587: <code class="literal">pkglint -Wall</code> to see whether it meets these
9588: rules.</p>
1.78 rillig 9589: </div>
1.148 asau 9590: <div class="sect1">
1.78 rillig 9591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9592: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 9593: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 9594: of the following classes. Cases where a file falls into more
9595: than one class should be avoided as it often leads to subtle
9596: bugs.</p>
1.148 asau 9597: <div class="sect2">
1.75 rillig 9598: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9599: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 9600: <p>In a traditional imperative programming language some of
1.76 rillig 9601: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 9602: procedures. They take some input parameters and—after
9603: inclusion—provide a result in output parameters. Since all
1.76 rillig 9604: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 9605: care must be taken not to use parameter names that have already
9606: another meaning. For example, <code class="varname">PKGNAME</code> is a
9607: bad choice for a parameter name.</p>
9608: <p>Procedures are completely evaluated at preprocessing time.
9609: That is, when calling a procedure all input parameters must be
9610: completely resolvable. For example,
9611: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9612: parameter since it is very likely that further text will be
9613: added after calling the procedure, which would effectively apply
9614: the procedure to only a part of the variable. Also, references
1.218 rillig 9615: to other variables will be modified after calling the
1.75 rillig 9616: procedure.</p>
9617: <p>A procedure can declare its output parameters either as
9618: suitable for use in preprocessing directives or as only
9619: available at runtime. The latter alternative is for variables
9620: that contain references to other runtime variables.</p>
9621: <p>Procedures shall be written such that it is possible to
9622: call the procedure more than once. That is, the file must not
9623: contain multiple-inclusion guards.</p>
9624: <p>Examples for procedures are
1.76 rillig 9625: <code class="filename">mk/bsd.options.mk</code> and
9626: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 9627: that the parameters are evaluated at load time, they should be
9628: assigned using the <code class="literal">:=</code> operator, which should
9629: be used only for this purpose.</p>
9630: </div>
1.148 asau 9631: <div class="sect2">
1.75 rillig 9632: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9633: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 9634: <p>Action files take some input parameters and may define
9635: runtime variables. They shall not define loadtime variables.
9636: There are action files that are included implicitly by the
9637: pkgsrc infrastructure, while other must be included
9638: explicitly.</p>
9639: <p>An example for action files is
1.76 rillig 9640: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 9641: </div>
9642: </div>
1.148 asau 9643: <div class="sect1">
1.81 rillig 9644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9645: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 9646: <p>Package <code class="filename">Makefile</code>s usually consist of
9647: a set of variable definitions, and include the file
9648: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9649: Before that, they may also include various other
9650: <code class="filename">*.mk</code> files if they need to query the
9651: availability of certain features like the type of compiler or
9652: the X11 implementation. Due to the heavy use of preprocessor
9653: directives like <code class="literal">.if</code> and
9654: <code class="literal">.for</code>, the order in which the files are loaded
9655: matters.</p>
9656: <p>This section describes at which point the various files
9657: are loaded and gives reasons for that order.</p>
1.148 asau 9658: <div class="sect2">
1.81 rillig 9659: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9660: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 9661: </h3></div></div></div>
9662: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 9663: is to define some essential variables like
9664: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9665: <code class="varname">MACHINE_ARCH</code>.</p>
9666: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 9667: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 9668: After that, those variables
1.81 rillig 9669: that have not been overridden by the user are loaded from
9670: <code class="filename">mk/defaults/mk.conf</code>.</p>
9671: <p>After the user settings, the system settings and platform
9672: settings are loaded, which may override the user
9673: settings.</p>
9674: <p>Then, the tool definitions are loaded. The tool wrappers
9675: are not yet in effect. This only happens when building a
9676: package, so the proper variables must be used instead of the
9677: direct tool names.</p>
9678: <p>As the last steps, some essential variables from the
9679: wrapper and the package system flavor are loaded, as well as the
9680: variables that have been cached in earlier phases of a package
9681: build.</p>
9682: </div>
1.148 asau 9683: <div class="sect2">
1.81 rillig 9684: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9685: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 9686: </h3></div></div></div>
1.81 rillig 9687: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9688: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9689: loaded, which fill default values for those variables that have
1.93 rillig 9690: not been defined by the package. These variables may later
1.81 rillig 9691: be used even in unrelated files.</p>
9692: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9693: provides the target <code class="literal">error-check</code> that is added
9694: as a special dependency to all other targets that use
9695: <code class="varname">DELAYED_ERROR_MSG</code> or
9696: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9697: <p>Then, the package-specific hacks from
9698: <code class="filename">hacks.mk</code> are included.</p>
9699: <p>Then, various other files follow. Most of them don't have
9700: any dependencies on what they need to have included before or
9701: after them, though some do.</p>
9702: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9703: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9704: restricts the use of these variables to all the files that have
9705: been included before. Appearances in later files will be
9706: silently ignored.</p>
9707: <p>Then, the files for the main targets are included, in the
9708: order of later execution, though the actual order should not
9709: matter.</p>
9710: <p>At last, some more files are included that don't set any
9711: interesting variables but rather just define make targets to be
9712: executed.</p>
9713: </div>
9714: </div>
1.75 rillig 9715: </div>
1.148 asau 9716: <div class="chapter">
1.75 rillig 9717: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9718: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 9719: <div class="toc">
9720: <p><b>Table of Contents</b></p>
1.210 leot 9721: <dl class="toc">
1.219 rillig 9722: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9723: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75 rillig 9724: <dd><dl>
1.219 rillig 9725: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9726: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75 rillig 9727: </dl></dd>
9728: </dl>
9729: </div>
9730: <p>The pkgsrc infrastructure consists of a large codebase,
9731: and there are many corners where every little bit of a file is
9732: well thought out, making pkgsrc likely to fail as soon as
9733: anything is changed near those parts. To prevent most changes
9734: from breaking anything, a suite of regression tests should go
9735: along with every important part of the pkgsrc infrastructure.
9736: This chapter describes how regression tests work in pkgsrc and
9737: how you can add new tests.</p>
1.148 asau 9738: <div class="sect1">
1.75 rillig 9739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219 rillig 9740: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.232 sevan 9741: <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.110 hubertf 9742: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 9743: can simply run that command, which will run all tests in the
1.76 rillig 9744: <code class="filename">regress</code> category.</p>
1.75 rillig 9745: </div>
1.148 asau 9746: <div class="sect1">
1.75 rillig 9747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219 rillig 9748: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.76 rillig 9749: <p>Every directory in the <code class="filename">regress</code>
9750: category that contains a file called <code class="filename">spec</code>
1.75 rillig 9751: is considered a regression test. This file is a shell program
1.110 hubertf 9752: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 9753: The following functions can be overridden to suit your
9754: needs.</p>
1.148 asau 9755: <div class="sect2">
1.75 rillig 9756: <div class="titlepage"><div><div><h3 class="title">
1.219 rillig 9757: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 9758: <p>These functions do not take any parameters. Although they
9759: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9760: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9761: question</a> for details.</p>
1.148 asau 9762: <div class="variablelist"><dl class="variablelist">
1.218 rillig 9763: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 9764: <dd><p>This function prepares the environment for the
9765: test. By default it does nothing.</p></dd>
1.218 rillig 9766: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9767: <dd>
9768: <p>This function runs the actual test. By default,
1.75 rillig 9769: it calls <code class="varname">TEST_MAKE</code> with the arguments
9770: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9771: error messages into the file
1.218 rillig 9772: <code class="varname">TEST_OUTFILE</code>.</p>
9773: <p>When defining this function, make sure that all output that
9774: needs to be checked is written to the correct output file.
9775: Example:</p>
9776: <pre class="programlisting">
9777: do_test() {
1.223 rillig 9778: echo "Example output"
1.218 rillig 9779: } 1>$TEST_OUTFILE 2>&1
9780: </pre>
9781: </dd>
9782: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9783: <dd>
9784: <p>This function is run after the test and is
1.75 rillig 9785: typically used to compare the actual output from the one that is
9786: expected. It can make use of the various helper functions from
1.218 rillig 9787: the next section. Example:</p>
9788: <pre class="programlisting">
9789: check_result() {
1.223 rillig 9790: exit_status 0
9791: output_require "Example"
9792: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9793: output_prohibit "no such file or directory"
1.218 rillig 9794: }
9795: </pre>
9796: </dd>
9797: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 9798: <dd><p>This function cleans everything up after the
9799: test has been run. By default it does nothing.</p></dd>
9800: </dl></div>
9801: </div>
1.148 asau 9802: <div class="sect2">
1.75 rillig 9803: <div class="titlepage"><div><div><h3 class="title">
1.219 rillig 9804: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.148 asau 9805: <div class="variablelist"><dl class="variablelist">
1.218 rillig 9806: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 9807: <dd><p>This function compares the exitcode of the
1.218 rillig 9808: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 9809: If they differ, the test will fail.</p></dd>
1.218 rillig 9810: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9811: <dd>
9812: <p>This function checks for each of its parameters
9813: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 9814: extended regular expression. If it does not, the test will
1.218 rillig 9815: fail. Example:</p>
9816: <pre class="programlisting">
1.219 rillig 9817: output_require "looks fine"
9818: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 9819: </pre>
9820: </dd>
1.75 rillig 9821: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9822: <dd><p>This function checks for each of its parameters
1.110 hubertf 9823: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 9824: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9825: If any of the regular expressions matches, the test will
9826: fail.</p></dd>
9827: </dl></div>
9828: </div>
9829: </div>
9830: </div>
1.148 asau 9831: <div class="chapter">
1.75 rillig 9832: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9833: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 9834: <div class="toc">
9835: <p><b>Table of Contents</b></p>
1.219 rillig 9836: <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.75 rillig 9837: </div>
9838: <p>The pkgsrc system has already been ported to many
9839: operating systems, hardware architectures and compilers. This
9840: chapter explains the necessary steps to make pkgsrc even more
9841: portable.</p>
1.148 asau 9842: <div class="sect1">
1.75 rillig 9843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9844: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 9845: <p>To port pkgsrc to a new operating system (called
9846: <code class="literal">MyOS</code> in this example), you need to touch the
9847: following files:</p>
1.148 asau 9848: <div class="variablelist"><dl class="variablelist">
1.93 rillig 9849: <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>
1.75 rillig 9850: <dd><p>This file contains some basic definitions, for
9851: example the name of the C
9852: compiler.</p></dd>
1.76 rillig 9853: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 9854: <dd><p>Insert code that defines the variables
9855: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
9856: <code class="varname">LOWER_OS_VERSION</code>,
9857: <code class="varname">LOWER_VENDOR</code>,
9858: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
9859: <code class="varname">APPEND_ELF</code>, and the other variables that
9860: appear in this file.</p></dd>
1.93 rillig 9861: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 9862: <dd><p>This file contains the platform-specific
9863: definitions that are used by pkgsrc. Start by copying one of the
9864: other files and edit it to your
9865: needs.</p></dd>
1.93 rillig 9866: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 9867: <dd><p>This file defines the paths to all the tools
9868: that are needed by one or the other package in pkgsrc, as well
9869: as by pkgsrc itself. Find out where these tools are on your
9870: platform and add them.</p></dd>
9871: </dl></div>
9872: <p>Now, you should be able to build some basic packages, like
1.232 sevan 9873: <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.75 rillig 9874: </div>
9875: </div>
9876: </div>
1.148 asau 9877: <div class="appendix">
9878: <div class="titlepage"><div><div><h1 class="title">
9879: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 9880: <div class="toc">
9881: <p><b>Table of Contents</b></p>
1.210 leot 9882: <dl class="toc">
1.75 rillig 9883: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
9884: <dd><dl>
9885: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
9886: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
9887: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 9888: <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.75 rillig 9889: </dl></dd>
9890: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
9891: </dl>
9892: </div>
9893: <p>We checked to find a piece of software that wasn't in the packages
9894: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 9895: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 9896: present in the tree is beyond us, but it's useful for the purposes of
9897: this exercise.</p>
1.148 asau 9898: <div class="sect1">
1.75 rillig 9899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9900: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 9901: <div class="sect2">
1.75 rillig 9902: <div class="titlepage"><div><div><h3 class="title">
9903: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
9904: <pre class="programlisting">
1.100 rillig 9905: # $NetBSD$
9906: #
1.1 grant 9907:
1.100 rillig 9908: DISTNAME= bison-1.25
9909: CATEGORIES= devel
9910: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 9911:
1.136 dholland 9912: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 9913: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
9914: COMMENT= GNU yacc clone
1.1 grant 9915:
1.100 rillig 9916: GNU_CONFIGURE= yes
1.152 wiz 9917: INFO_FILES= yes
1.1 grant 9918:
1.100 rillig 9919: .include "../../mk/bsd.pkg.mk"
1.1 grant 9920: </pre>
1.75 rillig 9921: </div>
1.148 asau 9922: <div class="sect2">
1.75 rillig 9923: <div class="titlepage"><div><div><h3 class="title">
9924: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
9925: <pre class="programlisting">
1.100 rillig 9926: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.238 leot 9927: 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.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 9928: of the NetBSD source tree is beyond me.
1.1 grant 9929: </pre>
1.75 rillig 9930: </div>
1.148 asau 9931: <div class="sect2">
1.75 rillig 9932: <div class="titlepage"><div><div><h3 class="title">
9933: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
9934: <pre class="programlisting">
1.100 rillig 9935: @comment $NetBSD$
9936: bin/bison
9937: man/man1/bison.1.gz
9938: share/bison.simple
9939: share/bison.hairy
1.1 grant 9940: </pre>
1.75 rillig 9941: </div>
1.148 asau 9942: <div class="sect2">
1.75 rillig 9943: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 9944: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 9945: </h3></div></div></div>
1.75 rillig 9946: <p>The NetBSD package system comes with
1.232 sevan 9947: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 9948: which helps to check the contents of these
9949: files. After installation it is quite easy to use, just change to the
9950: directory of the package you wish to examine and execute
1.110 hubertf 9951: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 9952: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
9953: looks fine.</pre>
9954: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 9955: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 9956: -Wall</strong></span> for a very thorough check.</p>
9957: </div>
9958: </div>
1.148 asau 9959: <div class="sect1">
1.75 rillig 9960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9961: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
9962: <p>Create the directory where the package lives,
9963: plus any auxiliary directories:</p>
9964: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
9965: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
9966: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
9967: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 9968: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 9969: <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.75 rillig 9970: then continue with fetching the distfile:</p>
9971: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 9972: >> bison-1.25.tar.gz doesn't seem to exist on this system.
9973: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
9974: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9975: ftp: Error retrieving file: 500 Internal error
9976:
9977: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
9978: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9979: ftp: Error retrieving file: 500 Internal error
9980:
9981: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
9982: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 9983: Successfully retrieved file.</pre>
9984: <p>Generate the checksum of the distfile into
1.76 rillig 9985: <code class="filename">distinfo</code>:</p>
1.88 wiz 9986: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 9987: <p>Now compile:</p>
9988: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 9989: >> Checksum OK for bison-1.25.tar.gz.
9990: ===> Extracting for bison-1.25
9991: ===> Patching for bison-1.25
9992: ===> Ignoring empty patch directory
9993: ===> Configuring for bison-1.25
9994: creating cache ./config.cache
9995: checking for gcc... cc
9996: checking whether we are using GNU C... yes
9997: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
9998: checking how to run the C preprocessor... cc -E
9999: checking for minix/config.h... no
10000: checking for POSIXized ISC... no
10001: checking whether cross-compiling... no
10002: checking for ANSI C header files... yes
10003: checking for string.h... yes
10004: checking for stdlib.h... yes
10005: checking for memory.h... yes
10006: checking for working const... yes
10007: checking for working alloca.h... no
10008: checking for alloca... yes
10009: checking for strerror... yes
10010: updating cache ./config.cache
10011: creating ./config.status
10012: creating Makefile
10013: ===> Building for bison-1.25
10014: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.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 allocate.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 closure.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 conflicts.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 derives.c
1.68 rillig 10019: 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
1.1 grant 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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.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 reduce.c
10030: 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
10031: 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
10032: 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
10033: 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
10034: 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
10035: 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
10036: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10037: rm -f bison.s1
1.75 rillig 10038: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10039: <p>Everything seems OK, so install the files:</p>
10040: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10041: >> Checksum OK for bison-1.25.tar.gz.
10042: ===> Installing for bison-1.25
10043: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10044: rm -f /usr/pkg/bin/bison
10045: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10046: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10047: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10048: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10049: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10050: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10051: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10052: ===> Registering installation for bison-1.25</pre>
10053: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10054: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10055: binary package, do this now:</p>
10056: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10057: >> Checksum OK for bison-1.25.tar.gz.
10058: ===> Building package for bison-1.25
10059: Creating package bison-1.25.tgz
10060: Registering depends:.
1.75 rillig 10061: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10062: <p>Now that you don't need the source and object files
10063: any more, clean up:</p>
10064: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10065: ===> Cleaning for bison-1.25</pre>
10066: </div>
10067: </div>
1.148 asau 10068: <div class="appendix">
10069: <div class="titlepage"><div><div><h1 class="title">
10070: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10071: <div class="toc">
10072: <p><b>Table of Contents</b></p>
1.210 leot 10073: <dl class="toc">
1.75 rillig 10074: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10075: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10076: </dl>
10077: </div>
1.148 asau 10078: <div class="sect1">
1.75 rillig 10079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10080: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10081: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10082: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10083: => figlet221.tar.gz doesn't seem to exist on this system.
10084: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10085: => [172219 bytes]
10086: Connected to ftp.plig.net.
10087: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10088: 331 Guest login ok, send your complete e-mail address as password.
10089: 230-You are user #5 of 500 simultaneous users allowed.
10090: 230-
1.68 rillig 10091: 230- ___ _ _ _
10092: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10093: 230- | _| _| . |_| . | | | . |_| . | _| . |
10094: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10095: 230- |_| |_| |___| |___|
10096: 230-
10097: 230-** Welcome to ftp.plig.org **
10098: 230-
10099: 230-Please note that all transfers from this FTP site are logged. If you
10100: 230-do not like this, please disconnect now.
10101: 230-
1.120 snj 10102: 230-This archive is available via
1.1 grant 10103: 230-
10104: 230-HTTP: http://ftp.plig.org/
10105: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10106: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10107: 230-
10108: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10109: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10110: 230-
10111: 230-
10112: 230 Logged in anonymously.
10113: Remote system type is UNIX.
10114: Using binary mode to transfer files.
10115: 200 Type okay.
10116: 250 "/pub" is new cwd.
10117: 250-"/pub/figlet" is new cwd.
10118: 250-
10119: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10120: 250-
1.75 rillig 10121: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10122: 250-
10123: 250-The official FIGlet web page is:
1.75 rillig 10124: 250- http://www.figlet.org/
1.1 grant 10125: 250-
10126: 250-If you have questions, please mailto:info@figlet.org. If you want to
10127: 250-contribute a font or something else, you can email us.
1.68 rillig 10128: 250
1.1 grant 10129: 250 "/pub/figlet/program" is new cwd.
10130: 250 "/pub/figlet/program/unix" is new cwd.
10131: local: figlet221.tar.gz remote: figlet221.tar.gz
10132: 502 Unimplemented command.
10133: 227 Entering Passive Mode (195,40,6,41,246,104)
10134: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10135: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10136: 226 Transfer completed.
10137: 172219 bytes received in 00:02 (75.99 KB/s)
10138: 221 Goodbye.
10139: => Checksum OK for figlet221.tar.gz.
10140: ===> Extracting for figlet-2.2.1nb2
10141: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10142: ===> Patching for figlet-2.2.1nb2
10143: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10144: ===> Overriding tools for figlet-2.2.1nb2
10145: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10146: ===> Configuring for figlet-2.2.1nb2
10147: ===> Building for figlet-2.2.1nb2
10148: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10149: chmod a+x figlet
10150: gcc -O2 -o chkfont chkfont.c
10151: => Unwrapping files-to-be-installed.
1.14 xtraeme 10152: <code class="prompt">#</code>
1.75 rillig 10153: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10154: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10155: ===> Installing for figlet-2.2.1nb2
10156: install -d -o root -g wheel -m 755 /usr/pkg/bin
10157: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10158: mkdir -p /usr/pkg/share/figlet
10159: cp figlet /usr/pkg/bin
10160: cp chkfont /usr/pkg/bin
10161: chmod 555 figlist showfigfonts
10162: cp figlist /usr/pkg/bin
10163: cp showfigfonts /usr/pkg/bin
10164: cp fonts/*.flf /usr/pkg/share/figlet
10165: cp fonts/*.flc /usr/pkg/share/figlet
10166: cp figlet.6 /usr/pkg/man/man6
10167: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10168: <code class="prompt">#</code></pre>
10169: </div>
1.148 asau 10170: <div class="sect1">
1.75 rillig 10171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10172: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10173: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10174: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10175: ===> Packaging figlet-2.2.1nb2
10176: ===> Building binary package for figlet-2.2.1nb2
10177: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10178: Using SrcDir value of /usr/pkg
1.68 rillig 10179: Registering depends:.
1.75 rillig 10180: <code class="prompt">#</code></pre>
10181: </div>
10182: </div>
1.148 asau 10183: <div class="appendix">
10184: <div class="titlepage"><div><div><h1 class="title">
10185: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10186: <div class="toc">
10187: <p><b>Table of Contents</b></p>
1.210 leot 10188: <dl class="toc">
1.128 wiz 10189: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10190: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10191: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10192: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10193: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10194: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10195: source packages</a></span></dt>
10196: </dl>
10197: </div>
10198: <p>As in other big projects, the directory layout of pkgsrc
10199: is quite complex for newbies. This chapter explains where you
10200: find things on the FTP server. The base directory on
1.110 hubertf 10201: <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.89 rillig 10202: On other servers it may be different, but inside this directory,
10203: everything should look the same, no matter on which server you
10204: are. This directory contains some subdirectories, which are
10205: explained below.</p>
1.148 asau 10206: <div class="sect1">
1.76 rillig 10207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10208: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10209: <p>The directory <code class="filename">distfiles</code> contains lots
10210: of archive files from all pkgsrc packages, which are mirrored
10211: here. The subdirectories are called after their package names
10212: and are used when the distributed files have names that don't
10213: explicitly contain a version number or are otherwise too generic
10214: (for example <code class="filename">release.tar.gz</code>).</p>
10215: </div>
1.148 asau 10216: <div class="sect1">
1.76 rillig 10217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10218: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10219: <p>This directory contains things that individual pkgsrc
10220: developers find worth publishing.</p>
10221: </div>
1.148 asau 10222: <div class="sect1">
1.76 rillig 10223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10224: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10225: <p>This directory contains binary packages for the various
10226: platforms that are supported by pkgsrc.
10227: 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.148 asau 10228: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10229: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10230: operating system for which the packages have been built. The
1.110 hubertf 10231: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10232: command, so it may differ from the one you are used to
10233: hear.</p></li>
1.128 wiz 10234: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10235: architecture of the platform for which the packages have been
1.110 hubertf 10236: built. It also includes the <code class="varname">ABI</code> (Application
10237: Binary Interface) for platforms that have several of
10238: them.</p></li>
1.128 wiz 10239: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10240: the operating system. For version numbers that change often (for
10241: example NetBSD-current), the often-changing part should be
10242: replaced with an <code class="literal">x</code>, for example
10243: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10244: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10245: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10246: for a stable branch, or <code class="literal">head</code> for packages
10247: built from the HEAD branch. The latter should only be used when
10248: the packages are updated on a regular basis. Otherwise the date
10249: from checking out pkgsrc should be appended, for example
10250: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10251: </ul></div>
10252: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10253: can quickly click through the directories on the
10254: server and find the best binary packages for their machines. Since they
10255: usually know the operating system and the hardware architecture, OPSYS
10256: and ARCH are placed first. After these choices, they can select the
10257: best combination of OSVERSION and TAG together, since it is usually the
10258: case that packages stay compatible between different version of the
10259: operating system.</p>
10260: <p>In each of these directories, there is a
10261: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10262: <code class="filename">All</code> which contains all binary packages.
10263: Besides that, there are various category directories that
10264: contain symbolic links to the real binary packages.</p>
10265: </div>
1.148 asau 10266: <div class="sect1">
1.76 rillig 10267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10268: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10269: <p>Here are the reports from bulk builds, for those who want
10270: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10271: 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.108 rillig 10272: </div>
1.148 asau 10273: <div class="sect1">
1.108 rillig 10274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10275: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10276: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10277: source packages</h2></div></div></div>
1.128 wiz 10278: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10279: that is the files that define how to create binary packages from
10280: source archives.</p>
10281: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10282: snapshot of the CVS repository, which is updated regularly. The
10283: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10284: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10285: <p>In the directories for the quarterly branches, there is an
10286: additional file called
1.126 jakllsch 10287: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76 rillig 10288: which contains the state of pkgsrc when it was branched.</p>
10289: </div>
1.75 rillig 10290: </div>
1.148 asau 10291: <div class="appendix">
10292: <div class="titlepage"><div><div><h1 class="title">
10293: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 10294: <div class="toc">
10295: <p><b>Table of Contents</b></p>
1.210 leot 10296: <dl class="toc">
1.79 rillig 10297: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10298: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10299: </dl>
10300: </div>
1.79 rillig 10301: <p>This section contains information on editing the pkgsrc
10302: guide itself.</p>
1.148 asau 10303: <div class="sect1">
1.75 rillig 10304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10305: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10306: <p>The pkgsrc guide's source code is stored in
10307: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10308: are created from it:</p>
1.148 asau 10309: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10310: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10311: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10312: <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>
10313: <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.79 rillig 10314: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 10315: <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.79 rillig 10316: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10317: </ul></div>
10318: </div>
1.148 asau 10319: <div class="sect1">
1.75 rillig 10320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10321: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10322: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 10323: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 10324: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 10325: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 10326: documentation) installed. These are automatically installed when
1.232 sevan 10327: 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.148 asau 10328: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 10329: right directory. All further steps will take place
10330: here.</p></li>
1.148 asau 10331: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 10332: <code class="filename">files/</code>.</p></li>
1.148 asau 10333: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 10334: guide for valid XML and to build the final output files. If you
10335: get any errors at this stage, you can just edit the files, as
10336: there are only symbolic links in the working directory, pointing
10337: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 10338: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 10339: commit)</strong></span></p></li>
1.148 asau 10340: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 10341: regenerate the output files with the proper RCS
10342: Ids.</p></li>
1.148 asau 10343: <li class="step">
1.110 hubertf 10344: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 10345: commit the files in both <code class="filename">pkgsrc/doc</code> and
10346: <code class="filename">htdocs</code>.</p>
1.148 asau 10347: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 10348: <h3 class="title">Note</h3>
10349: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 10350: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10351: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 10352: directory.</p>
10353: </div>
10354: </li>
1.79 rillig 10355: </ol></div>
1.75 rillig 10356: </div>
10357: </div>
10358: </div></body>
1.1 grant 10359: </html>
CVSweb <webmaster@jp.NetBSD.org>