Annotation of pkgsrc/doc/pkgsrc.html, revision 1.258
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.250 leot 33: <div><p class="copyright">Copyright © 1994-2018 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.32 2018/01/01 01:26:07 jakllsch 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.250 leot 491: <li class="listitem"><p><a href="https://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.250 leot 493: <li class="listitem"><p><a href="https://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.250 leot 495: <li class="listitem"><p><a href="https://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.250 leot 497: <li class="listitem"><p><a href="https://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.250 leot 545: find such bugs: Static analysis tools (<a href="https://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.258 ! leot 930: <code class="literal">2018Q4</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.258 ! leot 956: <p>The tar file for the stable branch 2018Q4 is in the
! 957: directory <code class="filename">pkgsrc-2018Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249 leot 958: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112 weinem 959: <pre class="screen">
1.258 ! leot 960: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q4/pkgsrc.tar.gz</code></strong></pre>
1.188 snj 961: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 962: or your web browser.</p>
1.112 weinem 963: <p>Then, extract it with:</p>
1.188 snj 964: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 965: <p>This will create the directory <code class="filename">pkgsrc/</code>
966: in <code class="filename">/usr/</code> and all the package source will be
967: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
968: <p>To download pkgsrc-current, run:</p>
969: <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 970: </div>
1.148 asau 971: <div class="sect2">
1.75 rillig 972: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 973: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
974: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.258 ! leot 975: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2018Q4 -P pkgsrc</code></strong>
1.128 wiz 976: </pre>
977: <p>This will create the directory <code class="filename">pkgsrc/</code>
978: in your <code class="filename">/usr/</code> directory and all the package source
979: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
980: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 981: <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 982: </pre>
1.188 snj 983: <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 984: <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 985: <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 986: </pre>
987: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
988: For Bourne shells, you can set it in your <code class="filename">.profile</code>
989: or better globally in <code class="filename">/etc/profile</code>:</p>
990: <pre class="programlisting">
991: # set CVS remote shell command
992: CVS_RSH=ssh
993: export CVS_RSH
994: </pre>
995: <p>By default, CVS doesn't do things like most people would expect it to do.
996: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
997: in your home directory and saving the following lines to it.
998: This file will save you lots of headache and some bug reports, so we strongly recommend it.
999: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1000: <pre class="programlisting">
1001: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1002: cvs -q -z2
1.101 rillig 1003: checkout -P
1.103 wiz 1004: update -dP
1005: diff -upN
1.101 rillig 1006: rdiff -u
1.128 wiz 1007: release -d
1.101 rillig 1008: </pre>
1.75 rillig 1009: </div>
1010: </div>
1.148 asau 1011: <div class="sect1">
1.75 rillig 1012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1013: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1014: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1015: (which also works if you have first installed it via a tar
1016: file). It saves bandwidth and hard disk activity, compared to
1017: downloading the tar file again.</p>
1.148 asau 1018: <div class="sect2">
1.75 rillig 1019: <div class="titlepage"><div><div><h3 class="title">
1020: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1021: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1022: <h3 class="title">Warning</h3>
1.77 rillig 1023: <p>When updating from a tar file, you first need to
1024: completely remove the old pkgsrc directory. Otherwise those
1025: files that have been removed from pkgsrc in the mean time will
1026: not be removed on your local disk, resulting in inconsistencies.
1027: When removing the old files, any changes that you have done to
1028: the pkgsrc files will be lost after updating. Therefore updating
1029: via CVS is strongly recommended.</p>
1.75 rillig 1030: </div>
1.82 rillig 1031: <p>Note that by default the distfiles and the binary packages
1032: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1033: before updating. You can also configure pkgsrc to store distfiles
1034: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1035: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1036: 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 1037: <p>To update pkgsrc from a tar file, download the tar file as
1038: explained above. Then, make sure that you have not made any
1039: changes to the files in the pkgsrc directory. Remove the pkgsrc
1040: directory and extract the new tar file. Done.</p>
1041: </div>
1.148 asau 1042: <div class="sect2">
1.75 rillig 1043: <div class="titlepage"><div><div><h3 class="title">
1044: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1045: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1046: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1047: </pre>
1048: <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>
1049: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1050: </pre>
1.148 asau 1051: <div class="sect3">
1.75 rillig 1052: <div class="titlepage"><div><div><h4 class="title">
1053: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1054: <p>When updating pkgsrc, the CVS program keeps track of the
1055: branch you selected. But if you, for whatever reason, want to
1056: switch from the stable branch to the current one, you can do it
1.128 wiz 1057: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1058: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1059: back to the stable branch, add the
1.258 ! leot 1060: <span class="quote">“<span class="quote">-rpkgsrc-2018Q4</span>”</span> option.</p>
1.75 rillig 1061: </div>
1.148 asau 1062: <div class="sect3">
1.75 rillig 1063: <div class="titlepage"><div><div><h4 class="title">
1064: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1065: <p>When you update pkgsrc, the CVS program will only touch
1066: those files that are registered in the CVS repository. That
1067: means that any packages that you created on your own will stay
1068: unmodified. If you change files that are managed by CVS, later
1069: updates will try to merge your changes with those that have been
1070: done by others. See the CVS manual, chapter
1.128 wiz 1071: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1072: </div>
1073: </div>
1074: </div>
1075: </div>
1.148 asau 1076: <div class="chapter">
1.75 rillig 1077: <div class="titlepage"><div><div><h2 class="title">
1078: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1079: <div class="toc">
1080: <p><b>Table of Contents</b></p>
1.210 leot 1081: <dl class="toc">
1.82 rillig 1082: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1083: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 1084: </dl>
1085: </div>
1.148 asau 1086: <div class="sect1">
1.75 rillig 1087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1088: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1089: <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 1090: </div>
1.148 asau 1091: <div class="sect1">
1.82 rillig 1092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1093: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1094: <p>pkgsrc can be bootstrapped for use in two different modes:
1095: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1096: to privileged one all programs are installed under one particular user
1.149 asau 1097: and cannot utilise privileged operations (packages don't create
1098: special users and all special file permissions like setuid are ignored).
1099: </p>
1.82 rillig 1100: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1101: <pre class="screen">
1.167 asau 1102: <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 1103: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1104: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1105: </pre>
1.149 asau 1106: <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>
1107: <p>By default, in privileged mode pkgsrc uses
1108: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1109: where programs will be installed in,
1.230 sevan 1110: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 asau 1111: directory where pkgsrc will do its internal bookkeeping,
1112: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1113: where packages install their persistent data.
1114: In unprivileged mode pkgsrc uses
1115: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230 sevan 1116: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 asau 1117: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1118: </p>
1119: <p>You can change default layout using command-line arguments.
1120: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1121: </p>
1.148 asau 1122: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1123: <h3 class="title">Note</h3>
1.110 hubertf 1124: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1125: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1126: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1127: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1128: </div>
1.149 asau 1129: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1130: <h3 class="title">Note</h3>
1131: <p>It is possible to bootstrap multiple instances of pkgsrc
1132: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1133: corresponding to the installation you're working with to build
1134: and install packages.
1135: </p>
1136: </div>
1.75 rillig 1137: </div>
1138: </div>
1.148 asau 1139: <div class="chapter">
1.75 rillig 1140: <div class="titlepage"><div><div><h2 class="title">
1141: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1142: <div class="toc">
1143: <p><b>Table of Contents</b></p>
1.210 leot 1144: <dl class="toc">
1.75 rillig 1145: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1146: <dd><dl>
1147: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1148: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1149: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1150: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1151: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1152: <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>
1153: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75 rillig 1154: </dl></dd>
1155: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1156: <dd><dl>
1157: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1158: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1159: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1160: </dl></dd>
1161: </dl>
1162: </div>
1163: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1164: is to only install the package tools and to use binary packages
1.128 wiz 1165: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1166: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1167: of pkgsrc, too. Then you are able to build your own packages,
1168: and you can still use binary packages from someone else.</p>
1.148 asau 1169: <div class="sect1">
1.75 rillig 1170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1171: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1172: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1173: server and its mirrors, there are collections of binary packages,
1174: ready to be installed. These binary packages have been built using the
1175: default settings for the directories, that is:</p>
1.148 asau 1176: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1177: <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>
1178: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1179: <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 1180: </ul></div>
1181: <p>If you cannot use these directories for whatever reasons (maybe
1182: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1183: 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 1184: <div class="sect2">
1.75 rillig 1185: <div class="titlepage"><div><div><h3 class="title">
1186: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1187: <p>To install binary packages, you first need to know from where
1188: to get them. The first place where you should look is on the main
1.110 hubertf 1189: 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 1190: <p>This directory contains binary packages for multiple
1191: platforms. First, select your operating system. (Ignore the
1192: directories with version numbers attached to it, they just exist for
1193: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1194: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1195: <p>In this directory, you often find a file called
1196: <code class="filename">bootstrap.tar.gz</code> which contains the package
1197: management tools. If the file is missing, it is likely that your
1198: operating system already provides those tools. Download the file and
1199: extract it in the <code class="filename">/</code> directory. It will create
1200: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230 sevan 1201: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1202: </div>
1.148 asau 1203: <div class="sect2">
1.75 rillig 1204: <div class="titlepage"><div><div><h3 class="title">
1205: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1206: <p>In the directory from the last section, there is a
1.196 wiz 1207: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1208: binary packages that are available for the platform, excluding those
1209: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1210: medium you are using).</p>
1.109 rillig 1211: <p>To install packages directly from an FTP or HTTP server, run
1212: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1213: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1214: <pre class="screen">
1215: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196 wiz 1216: <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 1217: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1218: </pre>
1219: <p>Instead of URLs, you can also use local paths, for example if
1220: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1221: repository. If you want to install packages from multiple sources,
1222: you can separate them by a semicolon in
1223: <code class="varname">PKG_PATH</code>.</p>
1224: <p>After these preparations, installing a package is very
1225: easy:</p>
1226: <pre class="screen">
1.230 sevan 1227: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1228: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.109 rillig 1229: </pre>
1.75 rillig 1230: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1231: package in question will be installed, too, assuming they are
1232: present where you install from.</p>
1.128 wiz 1233: <p>Adding packages might install vulnerable packages.
1234: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1235: regularly, especially after installing new packages, and verify
1236: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1237: <p>After you've installed packages, be sure to have
1.88 wiz 1238: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1239: <code class="varname">PATH</code> so you can actually start the just
1240: installed program.</p>
1.75 rillig 1241: </div>
1.148 asau 1242: <div class="sect2">
1.75 rillig 1243: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1244: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1245: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1246: installed from source code or from a binary package. The
1.110 hubertf 1247: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1248: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1249: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1250: name can be given with or without version number. Wildcards can
1251: also be used to deinstall a set of packages, for example
1252: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1253: so that the shell does not expand them before
1254: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1255: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1256: removes all the packages that require the package in question
1257: and then removes the package itself. For example:
1.82 rillig 1258:
1.88 wiz 1259: </p>
1.82 rillig 1260: <pre class="screen">
1.88 wiz 1261: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1262: </pre>
1.82 rillig 1263: <p>
1264:
1.88 wiz 1265: will remove jpeg and all the packages that used it; this allows
1266: upgrading the jpeg package.</p>
1.82 rillig 1267: </div>
1.148 asau 1268: <div class="sect2">
1.82 rillig 1269: <div class="titlepage"><div><div><h3 class="title">
1270: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1271: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1272: installed packages or binary package files.</p>
1.82 rillig 1273: </div>
1.148 asau 1274: <div class="sect2">
1.82 rillig 1275: <div class="titlepage"><div><div><h3 class="title">
1276: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1277: <p>
1.88 wiz 1278: The NetBSD Security-Officer and Packages Groups maintain a list of
1279: known security vulnerabilities to packages which are (or have been)
1280: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1281: 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 1282: </p>
1.82 rillig 1283: <p>
1.125 wiz 1284: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1285: this list can be downloaded
1286: automatically, and a security audit of all packages installed on a system
1287: can take place.
1288: </p>
1.82 rillig 1289: <p>
1.125 wiz 1290: There are two components to auditing. The first
1291: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1292: is for downloading
1.88 wiz 1293: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1294: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1295: installed packages are vulnerable. If a package is vulnerable, you
1296: will see output similar to the following:
1297: </p>
1.82 rillig 1298: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1299: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1300: <p>
1.125 wiz 1301: You may wish to have the
1.110 hubertf 1302: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1303: file downloaded daily so that
1304: it remains current. This may be done by adding an appropriate entry
1.257 leot 1305: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1306: </p>
1307: <pre class="screen">
1.233 sevan 1308: # Download vulnerabilities file
1.230 sevan 1309: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 sevan 1310: # Audit the installed packages and email results to root
1311: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1312: root >/dev/null 2>&1
1.125 wiz 1313: </pre>
1314: <p>
1.230 sevan 1315: will update the vulnerability list every day at 3AM, followed by an audit
1316: at 3:09AM. The result of the audit are then emailed to root.
1.125 wiz 1317:
1.230 sevan 1318: On NetBSD this may be accomplished instead by adding the following
1319: line to <code class="filename">/etc/daily.conf</code>:
1320: </p>
1321: <pre class="screen">
1322: fetch_pkg_vulnerabilities=YES
1323: </pre>
1324: <p>
1325: to fetch the vulnerability list from the daily security script. The system
1326: is set to audit the packages by default but can be set explicitly, if
1.235 yyamano 1327: desired (not required), by adding the following line to
1.230 sevan 1328: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1329: </p>
1330: <pre class="screen">
1.230 sevan 1331: check_pkg_vulnerabilities=YES
1.125 wiz 1332: </pre>
1333: <p>
1.257 leot 1334: see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-8.0"><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-8.0"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88 wiz 1335: </p>
1.82 rillig 1336: </div>
1.148 asau 1337: <div class="sect2">
1.82 rillig 1338: <div class="titlepage"><div><div><h3 class="title">
1339: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1340: <p>
1.250 leot 1341: Install <a href="https://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 1342: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1343: argument to check if your packages are up-to-date, e.g.
1344: </p>
1345: <pre class="screen">
1346: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1347: ...
1.88 wiz 1348: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1349: </pre>
1.110 hubertf 1350: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1351: package on your system and rebuild any dependencies.
1352: </p>
1.82 rillig 1353: </div>
1.148 asau 1354: <div class="sect2">
1.82 rillig 1355: <div class="titlepage"><div><div><h3 class="title">
1356: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1357: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1358: administrative functions on the package system.</p>
1.82 rillig 1359: </div>
1.75 rillig 1360: </div>
1.148 asau 1361: <div class="sect1">
1.75 rillig 1362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1363: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1364: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1365: directory now contains a set of packages, organized into
1366: categories. You can browse the online index of packages, or run
1.110 hubertf 1367: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1368: directory to build local <code class="filename">README.html</code> files for
1.250 leot 1369: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88 wiz 1370: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1371: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1372: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1373: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1374: different <code class="varname">LOCALBASE</code> definitions on the same
1375: system (inside a chroot is an exception). </p>
1376: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1377: 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 1378: instructions how to create your own packages.</p>
1.148 asau 1379: <div class="sect2">
1.75 rillig 1380: <div class="titlepage"><div><div><h3 class="title">
1381: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1382: <p>To build packages from source, you need a working C
1.88 wiz 1383: compiler. On NetBSD, you need to install the
1.128 wiz 1384: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1385: sets. If you want to build X11-related packages, the
1.128 wiz 1386: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1387: sets are required, too.</p>
1.75 rillig 1388: </div>
1.148 asau 1389: <div class="sect2">
1.75 rillig 1390: <div class="titlepage"><div><div><h3 class="title">
1391: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1392: <p>The first step for building a package is downloading the
1.88 wiz 1393: distfiles (i.e. the unmodified source). If they have not yet been
1394: downloaded, pkgsrc will fetch them automatically.</p>
1395: <p>If you have all files that you need in the
1396: <code class="filename">distfiles</code> directory,
1397: you don't need to connect. If the distfiles are on CD-ROM, you can
1398: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1399: </p>
1.82 rillig 1400: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1401: <p>
1.110 hubertf 1402: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1403: <p>By default a list of distribution sites will be randomly
1404: intermixed to prevent huge load on servers which holding popular
1405: packages (for example, SourceForge.net mirrors). Thus, every
1406: time when you need to fetch yet another distfile all the mirrors
1407: will be tried in new (random) order. You can turn this feature
1408: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1409: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1410: <p>You can overwrite some of the major distribution sites to
1411: fit to sites that are close to your own. By setting one or two
1412: variables you can modify the order in which the master sites are
1413: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1414: delimited list of domain suffixes.
1415: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1416: contains a whitespace delimited list of regular expressions. It
1417: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1418: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1419: some examples. This may save some of your bandwidth and
1420: time.</p>
1.75 rillig 1421: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1422: if you want to keep the settings, by editing the
1.110 hubertf 1423: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1424: and adding the definitions there.</p>
1.82 rillig 1425: <p>
1.88 wiz 1426: If a package depends on many other packages (such as
1.250 leot 1427: <a href="https://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 1428: alternate between periods of
1429: downloading source, and compiling. To ensure you have all the source
1430: downloaded initially you can run the command:
1431: </p>
1.82 rillig 1432: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1433: <p>
1.88 wiz 1434: which will output and run a set of shell commands to fetch the
1435: necessary files into the <code class="filename">distfiles</code> directory. You can
1436: also choose to download the files manually.
1437: </p>
1.75 rillig 1438: </div>
1.148 asau 1439: <div class="sect2">
1.75 rillig 1440: <div class="titlepage"><div><div><h3 class="title">
1441: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1442: <p>
1.88 wiz 1443: Once the software has downloaded, any patches will be applied, then it
1444: will be compiled for you. This may take some time depending on your
1445: computer, and how many other packages the software depends on and their
1446: compile time.
1447: </p>
1.148 asau 1448: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1449: <h3 class="title">Note</h3>
1450: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1451: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1452: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1453: </div>
1.87 wiz 1454: <p>For example, type</p>
1.88 wiz 1455: <pre class="screen">
1456: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1457: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1458: </pre>
1.75 rillig 1459: <p>at the shell prompt to build the various components of the
1.88 wiz 1460: package.</p>
1.82 rillig 1461: <p>The next stage is to actually install the newly compiled
1.88 wiz 1462: program onto your system. Do this by entering:
1.82 rillig 1463:
1.88 wiz 1464: </p>
1.82 rillig 1465: <pre class="screen">
1.88 wiz 1466: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1467: </pre>
1.82 rillig 1468: <p>
1469:
1.88 wiz 1470: while you are still in the directory for whatever package you
1471: are installing.</p>
1.82 rillig 1472: <p>Installing the package on your system may require you to
1.88 wiz 1473: be root. However, pkgsrc has a
1474: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1475: to only become root for the actual installation step.</p>
1.82 rillig 1476: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1477: You can now enter:
1.82 rillig 1478:
1.88 wiz 1479: </p>
1.82 rillig 1480: <pre class="screen">
1.88 wiz 1481: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1482: </pre>
1.82 rillig 1483: <p>
1484:
1.88 wiz 1485: to remove the compiled files in the work directory, as you shouldn't need
1486: them any more. If other packages were also added to your system
1487: (dependencies) to allow your program to compile, you can tidy these up
1488: also with the command:</p>
1.82 rillig 1489: <pre class="screen">
1.88 wiz 1490: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1491: </pre>
1.75 rillig 1492: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 1493: 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 1494: <p>The program is installed under the default root of the
1495: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1496: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1497: variable in your environment, and it will use that value as the
1498: root of your packages tree. So, to use
1499: <code class="filename">/usr/local</code>, set
1500: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1501: Please note that you should use a directory which is dedicated to
1502: packages and not shared with other programs (i.e., do not try and
1503: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1504: to add any of your own files or directories (such as
1505: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1506: <code class="filename">pkgsrc/</code>) below the
1507: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1508: conflicts between programs and other files installed by the
1509: package system and whatever else may have been installed
1510: there.</p>
1.110 hubertf 1511: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1512: alter some configuration options at build time. Have a look at
1513: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1514: of what will be set there by default. Environment variables such
1515: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1516: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1517: set them each time you want to use pkgsrc.</p>
1.128 wiz 1518: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1519: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1520: or being installed. This may be for debugging purposes, or out of
1521: simple curiosity. A number of utility values have been added to
1522: help with this.</p>
1.128 wiz 1523: <div class="orderedlist"><ol class="orderedlist" type="1">
1524: <li class="listitem">
1.257 leot 1525: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 1526: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1527: information will be displayed. For example,</p>
1.75 rillig 1528: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1529: <p>will show all the commands that are invoked, up to and
1.128 wiz 1530: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1531: </li>
1.128 wiz 1532: <li class="listitem">
1.257 leot 1533: <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-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1534: definition, then the <code class="varname">VARNAME</code> definition
1535: should be used, in conjunction with the show-var
1.257 leot 1536: 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-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1537: variable <code class="varname">LOCALBASE</code>:</p>
1538: <pre class="screen">
1539: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1540: /usr/pkg
1541: <code class="prompt">%</code>
1.88 wiz 1542: </pre>
1.75 rillig 1543: </li>
1544: </ol></div>
1545: <p>If you want to install a binary package that you've either
1.88 wiz 1546: created yourself (see next section), that you put into
1547: pkgsrc/packages manually or that is located on a remote FTP
1548: server, you can use the "bin-install" target. This target will
1.257 leot 1549: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 1550: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1551: sites searched is kept in the variable
1552: <code class="varname">BINPKG_SITES</code>, which defaults to
1.257 leot 1553: 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-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 1554: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1555: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1556: details.</p>
1557: <p>A final word of warning: If you set up a system that has a
1558: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1559: set that before any packages are installed, as you cannot use
1560: several directories for the same purpose. Doing so will result in
1561: pkgsrc not being able to properly detect your installed packages,
1562: and fail miserably. Note also that precompiled binary packages are
1563: usually built with the default <code class="varname">LOCALBASE</code> of
1564: <code class="filename">/usr/pkg</code>, and that you should
1565: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1566: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 1567: </div>
1568: </div>
1569: </div>
1.148 asau 1570: <div class="chapter">
1.75 rillig 1571: <div class="titlepage"><div><div><h2 class="title">
1572: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
1573: <div class="toc">
1574: <p><b>Table of Contents</b></p>
1.210 leot 1575: <dl class="toc">
1.75 rillig 1576: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
1577: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 1578: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 1579: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 1580: <dd><dl>
1.103 wiz 1581: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 1582: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1583: <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 1584: </dl></dd>
1.103 wiz 1585: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
1586: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 1587: </dl>
1588: </div>
1.104 rillig 1589: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 1590: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1591: that file depends on the installation. On NetBSD, when you use
1.257 leot 1592: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 1593: <code class="filename">/etc/</code>. In all other cases the default location is
1594: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1595: bootstrap program to install the binary packages.</p>
1596: <p>The format of the configuration file is that of the usual
1597: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1598: is done by setting variables in this file. Note that you can define all
1599: kinds of variables, and no special error checking (for example for
1.223 rillig 1600: spelling mistakes) takes place.</p>
1.148 asau 1601: <div class="sect1">
1.75 rillig 1602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1603: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.223 rillig 1604: <p>The following variables apply to all
1.89 rillig 1605: pkgsrc packages. A complete list of the variables that can be
1606: configured by the user is available in
1607: <code class="filename">mk/defaults/mk.conf</code>, together with some
1608: comments that describe each variable's intent.</p>
1.148 asau 1609: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1610: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1611: packages will be installed. The default is
1.76 rillig 1612: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1613: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 1614: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1615: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 1616: installed. The default is
1.76 rillig 1617: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1618: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1619: X11 is installed on the system. The default is
1.194 bsiegert 1620: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1621: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1622: downloaded copies of the original source distributions used
1623: for building pkgsrc packages. The default is
1.76 rillig 1624: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1625: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1626: database about installed packages is stored. The default is
1.230 sevan 1627: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1628: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1629: If set, override the packages'
1630: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1631: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1632: Backup location(s) for distribution files and patch files
1633: if not found locally or in
1.76 rillig 1634: <code class="filename">${MASTER_SITES}</code> or
1635: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1636: The defaults is
1637: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1638: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 1639: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1640: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 1641: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1642: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1643: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 1644: List of acceptable licenses. License names are case-sensitive.
1645: Whenever you try to build a package whose license is not in this
1646: list, you will get an error message. If the license condition is
1647: simple enough, the error message will include specific
1648: instructions on how to change this variable.</p></li>
1.75 rillig 1649: </ul></div>
1650: </div>
1.148 asau 1651: <div class="sect1">
1.75 rillig 1652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1653: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1654: <p>
1.75 rillig 1655: </p>
1.148 asau 1656: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1657: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1658: directory for the binary packages. The default is
1.76 rillig 1659: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1660: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1661: The top level directory where, if defined, the separate
1662: working directories will get created, and symbolically
1.76 rillig 1663: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1664: This is useful for building packages on several
1.76 rillig 1665: architectures, then <code class="filename">${PKGSRCDIR}</code>
1666: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 1667: is local to every architecture. (It should be noted that
1668: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 1669: — it is an internal definition which refers to the
1.75 rillig 1670: root of the pkgsrc tree. It is possible to have many
1671: pkgsrc tree instances.)</p></li>
1.128 wiz 1672: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1673: Directory for local patches that aren't part of pkgsrc.
1.219 rillig 1674: 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 1675: information.</p></li>
1.128 wiz 1676: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1677: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1678: BSD-style Makefile. If this is not set,
1679: <code class="varname">MAKECONF</code> is set to
1.76 rillig 1680: <code class="filename">/dev/null</code> to avoid picking up
1681: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75 rillig 1682: </ul></div>
1683: </div>
1.148 asau 1684: <div class="sect1">
1.75 rillig 1685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 1686: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.256 maya 1687: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
1688: By default, binary packages of built packages are
1689: preserved in <code class="varname">PACKAGES</code>/All. Setting
1690: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1691: <p>Packages have to support installation into a
1.103 wiz 1692: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1693: to be built, before the actual filesystem is touched. DESTDIR
1694: support exists in two variations:</p>
1.148 asau 1695: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1696: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 1697: installation and packaging is still run as root.</p></li>
1698: <li class="listitem"><p>Full DESTDIR support can run the complete
1699: build, installation and packaging as normal user. Root
1700: privileges are only needed to add packages.</p></li>
1701: </ul></div>
1.103 wiz 1702: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1703: clean</code></strong> needs to be run as root.</p>
1.118 imil 1704: <p>Considering the <code class="filename">foo/bar</code> package,
1705: DESTDIR full support can be tested using the following commands
1706:
1707: </p>
1708: <pre class="programlisting">
1709: <code class="prompt">$</code> id
1710: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1711: <code class="prompt">$</code> mkdir $HOME/packages
1712: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1713: </pre>
1714: <p>
1715:
1716: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1717: should be needed
1718:
1719: </p>
1720: <pre class="programlisting">
1.174 asau 1721: <code class="prompt">$</code> make stage-install
1.118 imil 1722: </pre>
1723: <p>
1724:
1725: Create a package without root privileges
1726:
1727: </p>
1728: <pre class="programlisting">
1.174 asau 1729: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1730: </pre>
1731: <p>
1732:
1733: For the following command, you must be able to gain root
1.257 leot 1734: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 1735:
1736: </p>
1737: <pre class="programlisting">
1.174 asau 1738: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 1739: </pre>
1740: <p>
1741:
1742: Then, as a simple user
1743:
1744: </p>
1745: <pre class="programlisting">
1746: <code class="prompt">$</code> make clean
1747: </pre>
1748: <p>
1749:
1750: </p>
1.103 wiz 1751: </div>
1.148 asau 1752: <div class="sect1">
1.103 wiz 1753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1754: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1755: <div class="sect2">
1.78 rillig 1756: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 1757: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 1758: <p>By default, pkgsrc will use GCC to build packages. This may be
1759: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 1760: <div class="variablelist"><dl class="variablelist">
1.89 rillig 1761: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1762: <dd>
1763: <p>This is a list of values specifying the chain of
1764: compilers to invoke when building packages. Valid values
1765: are:</p>
1.148 asau 1766: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 1767: <li class="listitem"><p><code class="varname">ccc</code>:
1768: Compaq C Compilers (Tru64)</p></li>
1769: <li class="listitem"><p><code class="varname">ccache</code>:
1770: compiler cache (chainable)</p></li>
1771: <li class="listitem"><p><code class="varname">clang</code>:
1772: Clang C and Objective-C compiler</p></li>
1.128 wiz 1773: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1774: distributed C/C++ (chainable)</p></li>
1.174 asau 1775: <li class="listitem"><p><code class="varname">f2c</code>:
1776: Fortran 77 to C compiler (chainable)</p></li>
1777: <li class="listitem"><p><code class="varname">icc</code>:
1778: Intel C++ Compiler (Linux)</p></li>
1779: <li class="listitem"><p><code class="varname">ido</code>:
1780: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 1781: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1782: GNU C/C++ Compiler</p></li>
1.174 asau 1783: <li class="listitem"><p><code class="varname">hp</code>:
1784: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1785: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1786: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1787: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1788: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1789: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1790: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1791: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1792: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1793: </ul></div>
1794: <p>The default is
1.128 wiz 1795: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 1796: <code class="varname">ccache</code> and/or
1797: <code class="varname">distcc</code> with an appropriate
1798: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 1799: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1800: variable should always be terminated with a value for
1801: a real compiler. Note that only one real compiler
1.128 wiz 1802: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1803: is not allowed).</p>
1.89 rillig 1804: </dd>
1805: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1806: <dd><p>This specifies the minimum version of GCC to use
1807: when building packages. If the system GCC doesn't
1808: satisfy this requirement, then pkgsrc will build and
1809: install one of the GCC packages to use instead.</p></dd>
1.225 maya 1810: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
1811: <dd><p>Specifies which version of python to use when several
1812: options are available.</p></dd>
1813: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1814: <dd><p>Specifies the fortran compiler to use.
1815: The default is <code class="varname">g95</code>, and
1816: <code class="varname">gfortran</code> is an alternative.</p></dd>
1817: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1818: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1819: <code class="varname">gfortran</code> is used, this option specifies which
1820: version to use.</p></dd>
1.89 rillig 1821: </dl></div>
1822: </div>
1.148 asau 1823: <div class="sect2">
1.89 rillig 1824: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 1825: <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 1826: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1827: please make sure to use the <code class="literal">+=</code> operator
1828: instead of the <code class="literal">=</code> operator:</p>
1829: <pre class="programlisting">
1.100 rillig 1830: CFLAGS+= -your -flags
1.78 rillig 1831: </pre>
1832: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 1833: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 1834: need to add their own flags. You may want to take a look
1.250 leot 1835: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128 wiz 1836: package if you're interested in optimization specifically
1837: for the current CPU. </p>
1.78 rillig 1838: </div>
1.148 asau 1839: <div class="sect2">
1.88 wiz 1840: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 1841: <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 1842: <p>If you want to pass flags to the linker, both in the configure
1843: step and the build step, you can do this in two ways. Either set
1844: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1845: between the two is that <code class="varname">LIBS</code> will be appended to
1846: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1847: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1848: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1849: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1850: <code class="varname">CFLAGS</code>, if you do not wish to override these
1851: settings, use the <code class="literal">+=</code> operator:</p>
1852: <pre class="programlisting">
1.100 rillig 1853: LDFLAGS+= -your -linkerflags
1.88 wiz 1854: </pre>
1855: </div>
1.78 rillig 1856: </div>
1.148 asau 1857: <div class="sect1">
1.78 rillig 1858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 1859: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 1860: <p>
1.75 rillig 1861: </p>
1.148 asau 1862: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1863: <li class="listitem">
1.75 rillig 1864: <p><code class="varname">PKG_DEVELOPER</code>:
1865: Run some sanity checks that package developers want:
1866: </p>
1.148 asau 1867: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 1868: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 1869: fuzz</p></li>
1.128 wiz 1870: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 1871: binaries will find their shared libs.</p></li>
1.75 rillig 1872: </ul></div>
1873: <p>
1.87 wiz 1874: </p>
1.75 rillig 1875: </li>
1.128 wiz 1876: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 1877: of debugging output which is displayed whilst making and
1878: installing the package. The default value for this is 0,
1879: which will not display the commands as they are executed
1880: (normal, default, quiet operation); the value 1 will display
1881: all shell commands before their invocation, and the value 2
1882: will display both the shell commands before their invocation,
1.223 rillig 1883: as well as their actual execution progress with <span class="command"><strong>set
1884: -x</strong></span>.</p></li>
1.75 rillig 1885: </ul></div>
1886: <p>
1887: </p>
1888: </div>
1.148 asau 1889: <div class="sect1">
1.75 rillig 1890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 1891: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 1892: <p>Some packages have build time options, usually to select
1893: between different dependencies, enable optional support for big
1894: dependencies or enable experimental features.</p>
1.75 rillig 1895: <p>To see which options, if any, a package supports, and which
1.110 hubertf 1896: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 1897: show-options</strong></span>, for example:</p>
1.75 rillig 1898: <pre class="programlisting">
1899: The following options are supported by this package:
1900: ssl Enable SSL support.
1901: Exactly one of the following gecko options is required:
1902: firefox Use firefox as gecko rendering engine.
1903: mozilla Use mozilla as gecko rendering engine.
1904: At most one of the following database options may be selected:
1905: mysql Enable support for MySQL database.
1906: pgsql Enable support for PostgreSQL database.
1.1 grant 1907:
1.75 rillig 1908: These options are enabled by default: firefox
1909: These options are currently enabled: mozilla ssl
1.1 grant 1910: </pre>
1.75 rillig 1911: <p>The following variables can be defined in
1.110 hubertf 1912: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 1913: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1914: which can be used to select or disable options for all packages
1915: that support them, and
1916: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1917: which can be used to select or disable options specifically for
1918: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 1919: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 1920: are disabled. A few examples:</p>
1.75 rillig 1921: <pre class="screen">
1.110 hubertf 1922: <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 1923: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1924: PKG_OPTIONS.kdebase= debug -sasl
1925: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 1926: <p>It is important to note that options that were specifically
1.120 snj 1927: suggested by the package maintainer must be explicitly removed if
1.111 rillig 1928: you do not wish to include the option. If you are unsure you can view
1929: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 1930: <p>The following settings are consulted in the order given, and
1931: the last setting that selects or disables an option is
1932: used:</p>
1.128 wiz 1933: <div class="orderedlist"><ol class="orderedlist" type="1">
1934: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 1935: maintainer</p></li>
1.128 wiz 1936: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 1937: variables (see below)</p></li>
1.128 wiz 1938: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1939: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 1940: </ol></div>
1941: <p>For groups of mutually exclusive options, the last option
1.88 wiz 1942: selected is used, all others are automatically disabled. If an
1943: option of the group is explicitly disabled, the previously
1944: selected option, if any, is used. It is an error if no option
1945: from a required group of options is selected, and building the
1946: package will fail.</p>
1947: <p>Before the options framework was introduced, build options
1948: were selected by setting a variable (often named
1949: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 1950: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 1951: transition to the options framework for the user, these legacy
1952: variables are converted to the appropriate options setting
1953: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1954: automatically. A warning is issued to prompt the user to update
1.110 hubertf 1955: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 1956: directly. Support for the legacy variables will be removed
1957: eventually.</p>
1.75 rillig 1958: </div>
1959: </div>
1.148 asau 1960: <div class="chapter">
1.75 rillig 1961: <div class="titlepage"><div><div><h2 class="title">
1962: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
1963: <div class="toc">
1964: <p><b>Table of Contents</b></p>
1.210 leot 1965: <dl class="toc">
1.75 rillig 1966: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
1967: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1968: </dl>
1969: </div>
1.148 asau 1970: <div class="sect1">
1.75 rillig 1971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1972: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 1973: <p>Once you have built and installed a package, you can create
1974: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.257 leot 1975: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 1976: the same package on a group of hosts and wasting CPU time. It also
1977: provides a simple means for others to install your package, should
1978: you distribute it.</p>
1979: <p>To create a binary package, change into the appropriate
1.110 hubertf 1980: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 1981: package</strong></span>:</p>
1982: <pre class="screen">
1.223 rillig 1983: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1984: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
1985: </pre>
1.87 wiz 1986: <p>This will build and install your package (if not already done),
1987: and then build a binary package from what was installed. You can
1.110 hubertf 1988: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 1989: it. Binary packages are created by default in
1990: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 1991: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.250 leot 1992: continuation of the above <a href="https://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 1993: <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 1994: such a binary package.</p>
1.75 rillig 1995: </div>
1.148 asau 1996: <div class="sect1">
1.75 rillig 1997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1998: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 1999: <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 2000: </div>
2001: </div>
1.148 asau 2002: <div class="chapter">
1.106 rillig 2003: <div class="titlepage"><div><div><h2 class="title">
2004: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2005: builds)</h2></div></div></div>
2006: <div class="toc">
2007: <p><b>Table of Contents</b></p>
1.210 leot 2008: <dl class="toc">
1.180 wiz 2009: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2010: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2011: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2012: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 2013: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2014: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2015: </dl>
2016: </div>
1.180 wiz 2017: <p>For a number of reasons you may want to build binary packages
2018: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2019: For instance, when you have multiple machines that should run the same software,
2020: it is wasted time if they all build their packages themselves from source.
2021: Or you may want to build a list of packages you want and check them before
2022: deploying onto production system.
2023: There is a way of getting a set of binary packages:
1.223 rillig 2024: The bulk build system, or pbulk ("p" stands for "parallel").
2025: This chapter describes how to set it up.</p>
1.148 asau 2026: <div class="sect1">
1.106 rillig 2027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2028: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2029: <p>First of all, you have to decide whether you build all packages
2030: or a limited set of them. Full bulk builds usually consume a lot more resources,
2031: both space and time, than builds for some practical sets of packages.
2032: There exists a number of particularly heavy packages that are not actually
2033: interesting to a wide audience.
2034:
2035: For a limited bulk builds you need to make a list of packages you want to build.
1.223 rillig 2036: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 wiz 2037: </p>
2038: <p>During bulk builds various packages are installed and deinstalled
2039: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2040: so make sure that you don't need any package during the builds.
1.223 rillig 2041: Essentially, you should provide a fresh system, either a chroot environment
1.180 wiz 2042: or something even more restrictive, depending on what the operating system provides,
2043: or dedicate the whole physical machine.
2044: As a useful side effect this makes sure that bulk builds cannot
2045: break anything in your system. There have been numerous cases where
1.106 rillig 2046: certain packages tried to install files outside the
2047: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2048: <code class="filename">/etc</code>.
2049: </p>
1.106 rillig 2050: </div>
1.148 asau 2051: <div class="sect1">
1.106 rillig 2052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2053: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2054: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2055: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2056: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2057: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2058: </ul></div>
1.148 asau 2059: <div class="sect2">
1.116 rillig 2060: <div class="titlepage"><div><div><h3 class="title">
1.180 wiz 2061: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.223 rillig 2062: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 asau 2063: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2064: Configure network access to fetch distribution files.
1.223 rillig 2065: Create a user with name "pbulk".</p>
1.178 asau 2066: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2067: <pre class="screen">
1.181 wiz 2068: <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>
2069: <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>
2070: <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 2071: </pre>
2072: <p>Or any other way that fits (e.g., curl, wget).</p>
2073: <p>Deploy and configure pbulk tools, e.g.:</p>
2074: <pre class="screen">
1.230 sevan 2075: <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 2076: <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>
2077: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2078: </pre>
2079: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2080: <h3 class="title">Note</h3>
2081: <p><code class="filename">mk.conf.frag</code> is a fragment of
2082: <code class="filename">mk.conf</code> that contains settings you want to
2083: apply to packages you build. For instance,</p>
2084: <pre class="programlisting">
1.223 rillig 2085: PKG_DEVELOPER= yes # perform more checks
2086: X11_TYPE= modular # use pkgsrc X11
2087: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2088: # when building all packages)
1.178 asau 2089: </pre>
2090: </div>
2091: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223 rillig 2092: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2093: <pre class="programlisting">
2094: www/firefox
2095: mail/thunderbird
2096: misc/libreoffice4
2097: </pre>
1.179 asau 2098: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2099: and make final amendments, if wanted.</p>
1.178 asau 2100: <p>Start it:</p>
2101: <pre class="screen">
2102: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2103: </pre>
2104: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2105: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2106: </p>
2107: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2108: <h3 class="title">Note</h3>
2109: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2110: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2111: The script is kept small enough for better understanding.</p>
2112: </div>
2113: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2114: <h3 class="title">Note</h3>
2115: <p>The <code class="filename">pbulk.sh</code> script supports running
2116: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2117: </div>
1.106 rillig 2118: </div>
2119: </div>
1.148 asau 2120: <div class="sect1">
1.106 rillig 2121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2122: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2123: <p>A complete bulk build requires lots of disk space. Some of the
2124: disk space can be read-only, some other must be writable. Some can be on
2125: remote filesystems (such as NFS) and some should be local. Some can be
2126: temporary filesystems, others must survive a sudden reboot.</p>
2127: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2128: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2129: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2130: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2131: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2132: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2133: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2134: </ul></div>
2135: </div>
2136: <div class="sect1">
2137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2138: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2139: <p>After your pkgsrc bulk-build has completed, you may wish to
2140: create a CD-ROM set of the resulting binary packages to assist
2141: in installing packages on other machines. The
1.250 leot 2142: <a href="https://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 2143: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2144: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2145: way that keeps all the dependencies for a given package on the same
2146: CD as that package.</p>
1.148 asau 2147: <div class="sect2">
1.75 rillig 2148: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2149: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2150: <p>Complete documentation for cdpack is found in the cdpack(1)
2151: man page. The following short example assumes that the binary
2152: packages are left in
2153: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2154: sufficient disk space exists in <code class="filename">/u2</code> to
2155: hold the ISO 9660 images.</p>
2156: <pre class="screen">
2157: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2158: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2159: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2160: </pre>
2161: <p>If you wish to include a common set of files
2162: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2163: etc.) on each CD in the collection, then you need to create a
2164: directory which contains these files. e.g.</p>
2165: <pre class="screen">
2166: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2167: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2168: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2169: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2170: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2171: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2172: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2173: </pre>
1.75 rillig 2174: <p>Now create the images:</p>
2175: <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 2176: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2177: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2178: in their root directories.</p>
1.75 rillig 2179: </div>
2180: </div>
2181: </div>
1.148 asau 2182: <div class="chapter">
1.75 rillig 2183: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2184: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2185: <div class="toc">
2186: <p><b>Table of Contents</b></p>
1.210 leot 2187: <dl class="toc">
1.128 wiz 2188: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2189: <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 2190: </dl>
2191: </div>
2192: <p>The files that are installed by pkgsrc are organized in a way that
2193: is similar to what you find in the <code class="filename">/usr</code> directory
2194: of the base system. But some details are different. This is because
2195: pkgsrc initially came from FreeBSD and had adopted its file system
2196: hierarchy. Later it was largely influenced by NetBSD. But no matter
2197: which operating system you are using pkgsrc with, you can expect the
2198: same layout for pkgsrc.</p>
1.91 rillig 2199: <p>There are mainly four root directories for pkgsrc, which are all
2200: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2201: When pkgsrc has been installed as root, the default locations
2202: are:</p>
2203: <pre class="programlisting">
1.100 rillig 2204: LOCALBASE= /usr/pkg
2205: PKG_SYSCONFBASE= /usr/pkg/etc
2206: VARBASE= /var
1.231 sevan 2207: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 2208: </pre>
2209: <p>In unprivileged mode (when pkgsrc has been installed as any other
2210: user), the default locations are:</p>
2211: <pre class="programlisting">
1.100 rillig 2212: LOCALBASE= ${HOME}/pkg
2213: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2214: VARBASE= ${HOME}/pkg/var
1.231 sevan 2215: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2216: </pre>
2217: <p>What these four directories are for, and what they look like is
2218: explained below.</p>
1.148 asau 2219: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2220: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2221: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2222: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2223: the well-known subdirectories like <code class="filename">bin</code>,
2224: <code class="filename">include</code>, <code class="filename">lib</code>,
2225: <code class="filename">share</code> and
2226: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2227: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2228: <code class="filename">/var</code> in the base system. Some programs (especially
2229: games, network daemons) need write access to it during normal
2230: operation.</p></li>
1.128 wiz 2231: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2232: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2233: 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 2234: itself.</p></li>
2235: </ul></div>
1.148 asau 2236: <div class="sect1">
1.90 rillig 2237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2238: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2239: </h2></div></div></div>
1.90 rillig 2240: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2241: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2242: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2243: <dt><span class="term"><code class="filename">bin</code></span></dt>
2244: <dd><p>Contains executable programs that are intended to be
2245: directly used by the end user.</p></dd>
2246: <dt><span class="term"><code class="filename">emul</code></span></dt>
2247: <dd><p>Contains files for the emulation layers of various other
2248: operating systems, especially for
2249: NetBSD.</p></dd>
2250: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2251: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2252: <dd><p>Contains
2253: the configuration files.</p></dd>
2254: <dt><span class="term"><code class="filename">include</code></span></dt>
2255: <dd><p>Contains headers for the C and C++ programming
2256: languages.</p></dd>
2257: <dt><span class="term"><code class="filename">info</code></span></dt>
2258: <dd><p>Contains GNU info files of various
2259: packages.</p></dd>
2260: <dt><span class="term"><code class="filename">lib</code></span></dt>
2261: <dd><p>Contains shared and static
2262: libraries.</p></dd>
2263: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2264: <dd><p>Contains data files that don't change after
2265: installation. Other data files belong into
2266: <code class="filename">${VARBASE}</code>.</p></dd>
2267: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2268: <dd><p>Contains programs that are not intended to be used by
2269: end users, such as helper programs or network
2270: daemons.</p></dd>
2271: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2272: <dd><p>Contains programs that are intended to be executed as
2273: CGI scripts by a web server.</p></dd>
2274: <dt><span class="term"><code class="filename">man</code> (the usual value of
2275: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2276: <dd><p>Contains brief
2277: documentation in form of manual pages.</p></dd>
2278: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2279: <dd><p>Contains programs that are intended to be used only by
2280: the super-user.</p></dd>
2281: <dt><span class="term"><code class="filename">share</code></span></dt>
2282: <dd><p>Contains platform-independent data files that don't
2283: change after installation.</p></dd>
2284: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2285: <dd><p>Contains documentation files provided by the
2286: packages.</p></dd>
2287: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2288: <dd><p>Contains example files provided by the packages. Among
2289: others, the original configuration files are saved here and copied to
2290: <code class="filename">${PKG_SYSCONFDIR}</code> during
2291: installation.</p></dd>
2292: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2293: <dd><p>Contains the original files for rc.d
2294: scripts.</p></dd>
2295: <dt><span class="term"><code class="filename">var</code> (the usual location of
2296: <code class="filename">${VARBASE}</code>)</span></dt>
2297: <dd><p>Contains files
2298: that may be modified after
2299: installation.</p></dd>
2300: </dl></div>
2301: </div>
1.148 asau 2302: <div class="sect1">
1.90 rillig 2303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2304: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2305: </h2></div></div></div>
1.148 asau 2306: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2307: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2308: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2309: <dd><p>Contains
2310: information about the currently installed
2311: packages.</p></dd>
2312: <dt><span class="term"><code class="filename">games</code></span></dt>
2313: <dd><p>Contains highscore
2314: files.</p></dd>
2315: <dt><span class="term"><code class="filename">log</code></span></dt>
2316: <dd><p>Contains log files.</p></dd>
2317: <dt><span class="term"><code class="filename">run</code></span></dt>
2318: <dd><p>Contains informational files about daemons that are
2319: currently running.</p></dd>
2320: </dl></div>
2321: </div>
2322: </div>
1.148 asau 2323: <div class="chapter">
1.90 rillig 2324: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2325: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2326: <div class="toc">
2327: <p><b>Table of Contents</b></p>
1.210 leot 2328: <dl class="toc">
1.106 rillig 2329: <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 2330: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2331: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2332: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2333: <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>
2334: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2335: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2336: <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>
2337: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2338: <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 2339: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 2340: <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>
2341: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2342: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2343: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2344: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2345: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2346: <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 2347: </dl>
2348: </div>
2349: <p>This section contains hints, tips & tricks on special things in
2350: pkgsrc that we didn't find a better place for in the previous chapters, and
2351: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2352: <div class="sect1">
1.75 rillig 2353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2354: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2355: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2356: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2357: <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 2358: This is a general purpose list for most issues regarding
2359: pkgsrc, regardless of platform, e.g. soliciting user help
2360: for pkgsrc configuration, unexpected build failures, using
2361: particular packages, upgrading pkgsrc installations,
2362: questions regarding the pkgsrc release branches, etc. General announcements or
2363: proposals for changes that impact the pkgsrc user community,
2364: e.g. major infrastructure changes, new features, package
2365: removals, etc., may also be posted.</p></li>
1.128 wiz 2366: <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 2367: A list where the results of pkgsrc bulk builds are sent and
2368: discussed.</p></li>
1.128 wiz 2369: <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 2370: This list is for those who are interested in getting a
2371: commit message for every change committed to pkgsrc. It is
2372: also available in digest form, meaning one daily message
2373: containing all commit messages for changes to the package
2374: source tree in that 24 hour period.</p></li>
2375: </ul></div>
2376: <p>To subscribe, do:</p>
2377: <pre class="programlisting">
1.100 rillig 2378: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2379: </pre>
2380: <p>Archives for all these mailing lists are available from
1.110 hubertf 2381: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2382: </div>
1.148 asau 2383: <div class="sect1">
1.75 rillig 2384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2385: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2386: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2387: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2388: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 2389: they might be useful, and not to duplicate the documentation that comes
2390: with each package.</p>
2391: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.250 leot 2392: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://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 2393: Symlinks for use by buildlink.</p></li></ul></div>
2394: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2395: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2396: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233 sevan 2397: Calculates various kinds of checksums (including SHA3).</p></li>
1.250 leot 2398: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75 rillig 2399: Compatibility library for pkgsrc tools.</p></li>
1.250 leot 2400: <li class="listitem"><p><a href="https://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 2401: non-BSD systems due to lack of native mtree.</p></li>
1.250 leot 2402: <li class="listitem"><p><a href="https://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 2403: Up-to-date replacement for
1.76 rillig 2404: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2405: systems where pkg_install is not present.</p></li>
2406: </ul></div>
2407: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2408: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2409: <li class="listitem"><p><a href="https://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 2410: Create a binary package from an
1.110 hubertf 2411: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2412: save the old package.</p></li>
1.250 leot 2413: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75 rillig 2414: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2415: from multiple locations. It currently supports the following
2416: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.250 leot 2417: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117 jnemeth 2418: the best compiler flags to optimise code for your current
1.128 wiz 2419: CPU and compiler. </p></li>
1.75 rillig 2420: </ul></div>
2421: <p>Utilities for keeping track of installed packages, being up to date,
2422: etc:</p>
1.148 asau 2423: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2424: <li class="listitem"><p><a href="https://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 2425: update tool similar to apt(1). Download, install, and upgrade
2426: binary packages easily.</p></li>
1.250 leot 2427: <li class="listitem"><p><a href="https://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 2428: packages whose installed versions do not match the latest pkgsrc
2429: entries.</p></li>
1.250 leot 2430: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75 rillig 2431: dependency graphs of packages, to aid in choosing a strategy for
2432: updating.</p></li>
1.250 leot 2433: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2434: graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2435: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112 weinem 2436: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250 leot 2437: <li class="listitem"><p><a href="https://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 2438: does various checks on the complete pkgsrc system.</p></li>
1.250 leot 2439: <li class="listitem"><p><a href="https://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 2440: packages you have installed.</p></li>
2441: </ul></div>
2442: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2443: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2444: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75 rillig 2445: making and maintaining patches for a package (includes pkgdiff,
2446: pkgvi, mkpatches, etc.).</p></li>
1.250 leot 2447: <li class="listitem"><p><a href="https://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 2448: converting to pkgsrc.</p></li>
2449: </ul></div>
2450: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2451: utilities)</p>
1.148 asau 2452: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2453: <li class="listitem"><p><a href="https://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 2454: packages in a chrooted area.</p></li>
1.250 leot 2455: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75 rillig 2456: kernel version for chrooted cross builds.</p></li>
2457: </ul></div>
2458: </div>
1.148 asau 2459: <div class="sect1">
1.75 rillig 2460: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2461: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2462: <p>To install packages from source as a non-root user, download
2463: 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
2464: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2465: --unprivileged</strong></span>.</p>
2466: <p>This will install the binary part of pkgsrc to
2467: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2468: into <code class="filename">~/pkg/etc</code>.</p>
2469: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75 rillig 2470: </div>
1.148 asau 2471: <div class="sect1">
1.75 rillig 2472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2473: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 2474: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2475: enable this feature by adding the option
2476: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 2477: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2478: distfile is found, pkgsrc will try to resume it.</p>
2479: <p>You can also
1.168 wiz 2480: use a different program than the platform default program by changing the
1.117 jnemeth 2481: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2482: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2483: by using the value manual. A value of custom disables the system defaults
2484: and dependency tracking for the fetch program. In that case you have to
2485: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2486: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2487: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 2488: <p>For example, if you want to use
1.117 jnemeth 2489: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2490: like:</p>
2491: <pre class="programlisting">
1.223 rillig 2492: FETCH_USING= wget
1.1 grant 2493: </pre>
1.75 rillig 2494: </div>
1.148 asau 2495: <div class="sect1">
1.75 rillig 2496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2497: <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 2498: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2499: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2500: you will have to add the following line into
1.110 hubertf 2501: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2502: <pre class="programlisting">
1.103 wiz 2503: X11_TYPE=modular
1.1 grant 2504: </pre>
1.75 rillig 2505: </div>
1.148 asau 2506: <div class="sect1">
1.75 rillig 2507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2508: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 2509: <p>If you are sitting behind a firewall which does not allow direct
2510: connections to Internet hosts (i.e. non-NAT), you may specify the
2511: relevant proxy hosts. This is done using an environment variable in the
2512: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 2513: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2514: port 80 as the proxy port number. So the proxy environment variables
2515: are:</p>
2516: <pre class="programlisting">
1.100 rillig 2517: ftp_proxy=ftp://orpheus.amdahl.com:80/
2518: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2519: </pre>
1.75 rillig 2520: </div>
1.148 asau 2521: <div class="sect1">
1.75 rillig 2522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2523: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 2524: <p>Some fetch tools are not prepared to support HTTPS by default
2525: (for example, the one in NetBSD 6.0), or the one installed by the
2526: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2527: dependency graph).</p>
2528: <p>Usually you won't notice, because distribution files are
2529: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2530: be often enough if you are following pkgsrc-current. In that case, set
2531: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2532: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2533: with HTTPS support by default. Of course, these tools need to be
2534: installed before you can use them this way.</p>
2535: </div>
2536: <div class="sect1">
2537: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2538: <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 2539: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2540: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2541: the first available command from the following list:</p>
1.148 asau 2542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2543: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2544: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 2545: </ul></div>
2546: <p>On a default NetBSD installation, this will be
1.76 rillig 2547: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 2548: connections first, and falls back to active connections if the server
2549: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 2550: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2551: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2552: <p>Having that option present will prevent
1.76 rillig 2553: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2554: transfers.</p>
2555: </div>
1.148 asau 2556: <div class="sect1">
1.75 rillig 2557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2558: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 2559: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 2560: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 2561: 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 2562: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 2563: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 2564: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 2565: resulting list to your machine at work/school and use it there. If you
1.257 leot 2566: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 2567: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2568: URL:</p>
2569: <p>At home:</p>
2570: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2571: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2572: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2573: <p>At work:</p>
2574: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 2575: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 2576: home.</p>
2577: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 2578: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2579: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 2580: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 2581: directly by running:</p>
1.75 rillig 2582: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2583: <p>If you even decide to ignore
2584: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2585: by running:</p>
2586: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2587: </div>
1.148 asau 2588: <div class="sect1">
1.75 rillig 2589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2590: <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 2591: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.250 leot 2592: <p>When compiling the <a href="https://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 2593: package, you get the error from make that it doesn't know how to make
1.76 rillig 2594: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 2595: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 2596: the NetBSD base distribution on your machine. It is recommended to do
2597: that to format man pages.</p>
1.250 leot 2598: <p>In the case of the <a href="https://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 2599: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 2600: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 2601: </div>
1.148 asau 2602: <div class="sect1">
1.75 rillig 2603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2604: <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 2605: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 2606: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 2607: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 2608: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2609: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 2610: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 2611: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 2612: -r</strong></span>).</p>
2613: </div>
1.148 asau 2614: <div class="sect1">
1.75 rillig 2615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2616: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 2617: <p>When installing packages as non-root user and using the just-in-time
1.257 leot 2618: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.0"><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 2619: password for each required package installed. To avoid this, the sudo
2620: package can be used, which does password caching over a limited time. To
2621: use it, install sudo (either as binary package or from
1.250 leot 2622: <a href="https://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 2623: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 2624: <span class="emphasis"><em>after</em></span> the definition of the
2625: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 2626: <pre class="programlisting">
1.100 rillig 2627: .if exists(${LOCALBASE}/bin/sudo)
2628: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2629: .endif
1.1 grant 2630: </pre>
1.75 rillig 2631: </div>
1.148 asau 2632: <div class="sect1">
1.75 rillig 2633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2634: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 2635: <p>As the system administrator, you can choose where configuration files
2636: are installed. The default settings make all these files go into
1.76 rillig 2637: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 2638: be suboptimal depending on your expectations (e.g., a read-only,
2639: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2640: configuration of the provided packages).</p>
2641: <p>In order to change the defaults, you can modify the
2642: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 2643: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 2644: directory; some common examples include <code class="filename">/etc</code> or
2645: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 2646: <p>Furthermore, you can change this value on a per-package basis by
2647: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2648: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2649: package you would like to modify, that is, the contents of
2650: <code class="varname">PKGBASE</code>.</p>
2651: <p>Note that after changing these settings, you must rebuild and
2652: reinstall any affected packages.</p>
2653: </div>
1.148 asau 2654: <div class="sect1">
1.75 rillig 2655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2656: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 2657: <p>Please be aware that there can often be bugs in third-party software,
2658: and some of these bugs can leave a machine vulnerable to exploitation by
2659: attackers. In an effort to lessen the exposure, the NetBSD packages team
2660: maintains a database of known-exploits to packages which have at one time
2661: been included in pkgsrc. The database can be downloaded automatically, and
2662: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 2663: do this, refer to the following two tools (installed as part of the
1.250 leot 2664: <a href="https://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 2665: <div class="orderedlist"><ol class="orderedlist" type="1">
2666: <li class="listitem">
1.122 reed 2667: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 2668: download a list of the security vulnerabilities information. This list
1.132 spz 2669: is kept up to date by the pkgsrc security team, and is distributed
2670: from the NetBSD ftp server:</p>
2671: <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 2672: </li>
1.128 wiz 2673: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2674: current machine, checking each known vulnerability. If a
1.75 rillig 2675: vulnerable package is installed, it will be shown by output to stdout,
2676: including a description of the type of vulnerability, and a URL
2677: containing more information.</p></li>
2678: </ol></div>
1.233 sevan 2679: <p>Use of these tools is strongly recommended!
2680: 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
2681: reporting.</p>
2682: <p>If this database is installed, pkgsrc builds will use it to
2683: perform a security check before building any package.</p>
1.75 rillig 2684: </div>
1.148 asau 2685: <div class="sect1">
1.75 rillig 2686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2687: <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 2688: <p>When you add your own preferences to the
2689: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 2690: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 2691: environment variables to the <code class="filename">./configure</code>
1.257 leot 2692: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 2693: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 2694: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 2695: package.</p>
2696: <p>Currently there is no solution to this problem. If you
2697: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 2698: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 2699: directory and then inspect any <code class="filename">Makefile</code> and
2700: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 2701: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 2702: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 2703: programmers write so bad code that it only works for the
2704: specific combination of <code class="varname">CFLAGS</code> they have
2705: chosen.</p>
2706: </div>
1.148 asau 2707: <div class="sect1">
1.80 rillig 2708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2709: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 2710: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 2711: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 2712: case that occurs often is that people only update pkgsrc in
2713: parts, because of performance reasons. Since pkgsrc is one large
2714: system, not a collection of many small systems, there are
2715: sometimes changes that only work when the whole pkgsrc tree is
2716: updated.</p></li>
1.148 asau 2717: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 2718: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2719: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 2720: files.</p></li>
1.148 asau 2721: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 2722: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 2723: verify this.</p></li>
1.218 rillig 2724: <li class="step"><p>If you are a package developer who wants to invest
2725: 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 2726: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 2727: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2728: </ol></div>
2729: </div>
1.148 asau 2730: <div class="sect1">
1.88 wiz 2731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2732: <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 2733: <p>You have modified a file from pkgsrc, and someone else has
2734: modified that same file afterwards in the CVS repository. Both changes
2735: are in the same region of the file, so when you updated pkgsrc, the
2736: <code class="literal">cvs</code> command marked the conflicting changes in the
2737: file. Because of these markers, the file is no longer a valid
2738: <code class="filename">Makefile</code>.</p>
2739: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 2740: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 2741: -dP</strong></span> in that directory to download the current version.</p>
2742: </div>
1.75 rillig 2743: </div>
2744: </div>
1.148 asau 2745: <div class="part">
1.75 rillig 2746: <div class="titlepage"><div><div><h1 class="title">
2747: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 2748: <div class="partintro">
1.77 rillig 2749: <div></div>
2750: <p>This part of the book deals with creating and
1.128 wiz 2751: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 2752: guide on creating a new package. The remaining chapters are more
2753: like a reference manual for pkgsrc.</p>
1.75 rillig 2754: <div class="toc">
2755: <p><b>Table of Contents</b></p>
1.210 leot 2756: <dl class="toc">
1.106 rillig 2757: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 2758: <dd><dl>
1.106 rillig 2759: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 2760: <dd><dl>
1.106 rillig 2761: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.245 wiz 2762: <dt><span class="sect2"><a href="#creating.python-module">10.1.2. Python modules and programs</a></span></dt>
1.91 rillig 2763: </dl></dd>
1.106 rillig 2764: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
2765: <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>
2766: </dl></dd>
2767: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
2768: <dd><dl>
1.128 wiz 2769: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
2770: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219 rillig 2771: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106 rillig 2772: <dd><dl>
2773: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
2774: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
2775: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
2776: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
2777: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
2778: </dl></dd>
2779: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
2780: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
2781: <dd><dl>
2782: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
2783: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
2784: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
2785: </dl></dd>
1.128 wiz 2786: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
2787: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 2788: </dl></dd>
1.128 wiz 2789: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 2790: <dd><dl>
2791: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 2792: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 2793: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
2794: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
2795: <dd><dl>
2796: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228 yyamano 2797: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220 wiz 2798: <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>
2799: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.106 rillig 2800: </dl></dd>
2801: </dl></dd>
2802: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
2803: <dd><dl>
2804: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 2805: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2806: <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 2807: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
2808: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 2809: <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 2810: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 2811: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
2812: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106 rillig 2813: </dl></dd>
2814: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
2815: <dd><dl>
2816: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 2817: <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 2818: <dd><dl>
2819: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 2820: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
2821: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2822: and
2823: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2824: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 2825: </dl></dd>
1.128 wiz 2826: <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 2827: <dd><dl>
1.128 wiz 2828: <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 2829: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
2830: </dl></dd>
2831: </dl></dd>
2832: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
2833: <dd><dl>
2834: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
2835: <dd><dl>
2836: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
2837: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
2838: </dl></dd>
2839: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
2840: <dd><dl>
1.128 wiz 2841: <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 2842: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
2843: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
2844: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
2845: </dl></dd>
2846: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
2847: <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>
2848: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
2849: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
2850: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
2851: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
2852: <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>
2853: </dl></dd>
2854: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
2855: <dd><dl>
2856: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 2857: <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 2858: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 2859: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 2860: </dl></dd>
2861: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
2862: <dd><dl>
2863: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
2864: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
2865: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
2866: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 2867: <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 2868: <dd><dl>
2869: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
2870: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
2871: </dl></dd>
1.128 wiz 2872: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2873: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2874: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2875: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2876: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2877: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2878: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2879: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2880: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2881: <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 2882: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
2883: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
2884: </dl></dd>
2885: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
2886: <dd><dl>
2887: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
2888: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
2889: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
2890: </dl></dd>
2891: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
2892: <dd><dl>
2893: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
2894: <dd><dl>
1.218 rillig 2895: <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>
2896: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
2897: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
2898: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
2899: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
2900: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
2901: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
2902: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
2903: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
2904: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2905: <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 2906: </dl></dd>
1.218 rillig 2907: <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 2908: <dd><dl>
2909: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2910: <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 2911: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106 rillig 2912: </dl></dd>
1.218 rillig 2913: <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 2914: <dd><dl>
2915: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
2916: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2917: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
2918: </dl></dd>
2919: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
2920: <dd><dl>
2921: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
2922: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
2923: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 2924: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
2925: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 2926: </dl></dd>
1.218 rillig 2927: <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 2928: <dd><dl>
2929: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
2930: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 2931: <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 2932: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
2933: </dl></dd>
1.218 rillig 2934: <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 2935: <dd><dl>
2936: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
2937: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
2938: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
2939: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
2940: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2941: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
2942: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
2943: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 2944: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 2945: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 2946: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
2947: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
2948: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
2949: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
2950: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
2951: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
2952: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
2953: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 2954: emulation</a></span></dt>
1.106 rillig 2955: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
2956: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 2957: </dl></dd>
1.106 rillig 2958: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 2959: </dl></dd>
1.106 rillig 2960: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
2961: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 2962: <dd><dl>
1.106 rillig 2963: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
2964: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
2965: <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 2966: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
2967: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
2968: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
2969: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
2970: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 2971: </dl></dd>
2972: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
2973: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
2974: <dd><dl>
2975: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
2976: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
2977: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
2978: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 2979: </dl></dd>
1.75 rillig 2980: </dl>
2981: </div>
1.77 rillig 2982: </div>
1.148 asau 2983: <div class="chapter">
1.77 rillig 2984: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2985: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 2986: <div class="toc">
2987: <p><b>Table of Contents</b></p>
1.210 leot 2988: <dl class="toc">
1.106 rillig 2989: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 2990: <dd><dl>
1.106 rillig 2991: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.245 wiz 2992: <dt><span class="sect2"><a href="#creating.python-module">10.1.2. Python modules and programs</a></span></dt>
1.91 rillig 2993: </dl></dd>
1.106 rillig 2994: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
2995: <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 2996: </dl>
2997: </div>
1.77 rillig 2998: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 2999: most likely have a URL from where you can download the source
3000: code. Starting with this URL, creating a package involves only a
3001: few steps.</p>
1.128 wiz 3002: <div class="procedure"><ol class="procedure" type="1">
1.250 leot 3003: <li class="step"><p>First, install the packages <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="https://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 3004: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3005: category in which you want to place your package. You can also create a
3006: directory of your own (maybe called <code class="filename">local</code>). In that
3007: category directory, create another directory for your package and change
3008: into it.</p></li>
1.148 asau 3009: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3010: you for a URL. Enter the URL of the distribution file (in most cases a
3011: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3012: of your package are created automatically. The distribution file is
3013: extracted automatically to fill in some details in the
3014: <code class="filename">Makefile</code> that would otherwise have to be done
3015: manually.</p></li>
1.148 asau 3016: <li class="step">
1.91 rillig 3017: <p>Examine the extracted files to determine the dependencies of
3018: your package. Ideally, this is mentioned in some
3019: <code class="filename">README</code> file, but things may differ. For each of
3020: these dependencies, look where it exists in pkgsrc, and if there is a
3021: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3022: line to your package <code class="filename">Makefile</code> which includes that
3023: file just before the last line. If the
1.132 spz 3024: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3025: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3026: <p>If you just need binaries from a package, add a
1.91 rillig 3027: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3028: version of the dependency and where it can be found in pkgsrc. This line
3029: should be placed in the third paragraph. If the dependency is only
3030: needed for building the package, but not when using it, use
3031: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3032: Your package may then look like this:</p>
1.77 rillig 3033: <pre class="programlisting">
1.100 rillig 3034: [...]
1.77 rillig 3035:
1.174 asau 3036: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3037: DEPENDS+= screen-[0-9]*:../../misc/screen
3038: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3039:
1.100 rillig 3040: [...]
1.77 rillig 3041:
1.100 rillig 3042: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3043: .include "../../devel/glib2/buildlink3.mk"
3044: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3045: </pre>
3046: </li>
1.148 asau 3047: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3048: 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 3049: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3050: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3051: -e</strong></span>, which outputs additional
3052: explanations.</p></li>
1.148 asau 3053: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3054: 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 3055: over there, you can hopefully continue here.</p></li>
1.148 asau 3056: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3057: directory from the extracted files. Besides these files, a lot of cache
3058: files and other system information has been saved in the working
3059: directory, which may become wrong after you edited the
3060: <code class="filename">Makefile</code>.</p></li>
1.148 asau 3061: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3062: 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 3063: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3064: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3065: everything works.</p></li>
1.148 asau 3066: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3067: contains a list of the files that are installed by the package, is
1.110 hubertf 3068: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3069: >PLIST</strong></span> to generate a probably correct list. Check
3070: the file using your preferred text editor to see if the list of
3071: files looks plausible.</p></li>
1.148 asau 3072: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3073: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3074: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3075: has been registered in the database of installed files, but with an
1.110 hubertf 3076: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3077: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3078: registered with the list of files from
3079: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3080: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3081: package from the set of installed files.</p></li>
1.77 rillig 3082: </ol></div>
1.148 asau 3083: <div class="sect1">
1.91 rillig 3084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3085: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3086: <div class="sect2">
1.91 rillig 3087: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3088: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3089: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3090: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3091: </div>
1.148 asau 3092: <div class="sect2">
1.91 rillig 3093: <div class="titlepage"><div><div><h3 class="title">
1.245 wiz 3094: <a name="creating.python-module"></a>10.1.2. Python modules and programs</h3></div></div></div>
1.118 imil 3095: <p>Python modules and programs packages are easily created using a
3096: set of predefined variables.</p>
3097: <p>
1.171 wiz 3098: If some Python versions are not supported by the software, set the
3099: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3100: that are not supported, e.g.
1.118 imil 3101: </p>
3102: <pre class="programlisting">
1.203 sevan 3103: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.118 imil 3104: </pre>
3105: <p>
1.213 wiz 3106: If the packaged software is a Python module, include one of
3107: <code class="filename">../../lang/python/egg.mk</code>,
3108: <code class="filename">../../lang/python/distutils.mk</code>, or
3109: <code class="filename">../../lang/python/extension.mk</code>.</p>
3110: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3111: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3112: if the packaged software is using setuptools, you only need
3113: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3114: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3115: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3116: so pkgsrc will use this framework.
3117: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3118: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3119: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3120: to the name of the script.</p>
3121: <p>Either way, the package directory should be called
1.128 wiz 3122: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3123: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3124: </p>
3125: <pre class="programlisting">
3126: DISTNAME= foopymodule-1.2.10
3127: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3128: </pre>
1.171 wiz 3129: <p>If it is an application, include
3130: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3131: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3132: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3133: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3134: For example:
1.118 imil 3135: </p>
3136: <pre class="programlisting">
1.142 wiz 3137: REPLACE_PYTHON= *.py
1.118 imil 3138: </pre>
1.171 wiz 3139: <p>Some Python modules have separate distributions for Python-2.x
3140: and Python-3.x support. In pkgsrc this is handled by the
3141: <code class="filename">versioned_dependencies.mk</code> file. Set
3142: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3143: packages that should be depended upon and include
3144: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3145: then the pkgsrc infrastructure will depend on the appropriate package
3146: version. For example:
3147: </p>
3148: <pre class="programlisting">
1.248 wiz 3149: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.171 wiz 3150: </pre>
3151: <p>
3152: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3153: of supported packages.</p>
1.118 imil 3154: </div>
1.91 rillig 3155: </div>
1.148 asau 3156: <div class="sect1">
1.91 rillig 3157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3158: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3159: <div class="sect2">
1.91 rillig 3160: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3161: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3162: <div class="sect3">
1.91 rillig 3163: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3164: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3165: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3166: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3167: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3168: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3169: <pre class="programlisting">
1.100 rillig 3170: <code class="prompt">$</code> mkdir www/nvu
3171: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3172: </pre>
3173: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3174: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3175: <pre class="programlisting">
1.100 rillig 3176: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3177: </pre>
3178: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3179: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3180: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3181: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3182: <code class="varname">COMMENT</code> fields. Then the package
3183: <code class="filename">Makefile</code> looked like that:</p>
3184: <pre class="programlisting">
1.233 sevan 3185: # $NetBSD $
1.100 rillig 3186: #
1.91 rillig 3187:
1.100 rillig 3188: DISTNAME= nvu-1.0-sources
3189: PKGNAME= nvu-1.0
3190: CATEGORIES= www
3191: MASTER_SITES= http://cvs.nvu.com/download/
3192: EXTRACT_SUFX= .tar.bz2
3193:
3194: MAINTAINER= rillig@NetBSD.org
3195: HOMEPAGE= http://cvs.nvu.com/
3196: COMMENT= Web Authoring System
1.91 rillig 3197:
1.100 rillig 3198: # url2pkg-marker (please do not remove this line.)
3199: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3200: </pre>
1.237 wiz 3201: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.233 sevan 3202: this is a workaround to prevent CVS expanding to the filename of the
3203: guide.</p>
1.91 rillig 3204: <p>Then, I quit the editor and watched pkgsrc downloading a large
3205: source archive:</p>
3206: <pre class="programlisting">
1.100 rillig 3207: url2pkg> Running "make makesum" ...
3208: => Required installed package digest>=20010302: digest-20060826 found
3209: => Fetching nvu-1.0-sources.tar.bz2
3210: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3211: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3212: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3213: url2pkg> Running "make extract" ...
3214: => Required installed package digest>=20010302: digest-20060826 found
3215: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3216: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3217: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3218: ===> Installing dependencies for nvu-1.0
3219: ===> Overriding tools for nvu-1.0
3220: ===> Extracting for nvu-1.0
3221: url2pkg> Adjusting the Makefile.
1.91 rillig 3222:
1.100 rillig 3223: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3224:
1.100 rillig 3225: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3226: </pre>
3227: </div>
1.148 asau 3228: <div class="sect3">
1.91 rillig 3229: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3230: <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 3231: <p>Now that the package has been extracted, let's see what's inside
3232: it. The package has a <code class="filename">README.txt</code>, but that only
3233: says something about mozilla, so it's probably useless for seeing what
3234: dependencies this package has. But since there is a GNU configure script
3235: in the package, let's hope that it will complain about everything it
3236: needs.</p>
3237: <pre class="programlisting">
1.100 rillig 3238: <code class="prompt">$</code> bmake
3239: => Required installed package digest>=20010302: digest-20060826 found
3240: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3241: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3242: ===> Patching for nvu-1.0
3243: ===> Creating toolchain wrappers for nvu-1.0
3244: ===> Configuring for nvu-1.0
3245: [...]
3246: configure: error: Perl 5.004 or higher is required.
3247: [...]
3248: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3249: [...]
1.91 rillig 3250: </pre>
3251: <p>That worked quite well. So I opened the package Makefile in my
3252: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3253: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3254: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3255: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3256: from scratch.</p>
3257: <pre class="programlisting">
1.100 rillig 3258: <code class="prompt">$</code> bmake clean
3259: ===> Cleaning for nvu-1.0
3260: <code class="prompt">$</code> bmake
3261: [...]
3262: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3263: GNU Make. You will not be able to build Mozilla without GNU Make.
3264: [...]
1.91 rillig 3265: </pre>
1.128 wiz 3266: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3267: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3268: <pre class="programlisting">
1.100 rillig 3269: [...]
3270: checking for GTK - version >= 1.2.0... no
3271: *** Could not run GTK test program, checking why...
3272: [...]
1.91 rillig 3273: </pre>
3274: <p>Now to the other dependencies. The first question is: Where is the
3275: GTK package hidden in pkgsrc?</p>
3276: <pre class="programlisting">
1.100 rillig 3277: <code class="prompt">$</code> echo ../../*/gtk*
3278: [many packages ...]
3279: <code class="prompt">$</code> echo ../../*/gtk
3280: ../../x11/gtk
3281: <code class="prompt">$</code> echo ../../*/gtk2
3282: ../../x11/gtk2
3283: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3284: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3285: </pre>
3286: <p>The first try was definitely too broad. The second one had exactly
3287: one result, which is very good. But there is one pitfall with GNOME
3288: packages. Before GNOME 2 had been released, there were already many
3289: GNOME 1 packages in pkgsrc. To be able to continue to use these
3290: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3291: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3292: whether this was the case here, and indeed it was.</p>
3293: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3294: file, adding the dependency is very easy. I just inserted an
3295: <code class="literal">.include</code> line before the last line of the package
3296: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3297: <pre class="programlisting">
1.100 rillig 3298: [...]
3299: .include "../../x11/gtk2/buildlink3.mk"
3300: .include "../../mk/bsd.pkg.mk
1.91 rillig 3301: </pre>
1.110 hubertf 3302: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3303: was:</p>
3304: <pre class="programlisting">
1.100 rillig 3305: [...]
3306: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3307: checking for GTK - version >= 1.2.0... no
3308: *** Could not run GTK test program, checking why...
3309: *** The test program failed to compile or link. See the file config.log for the
3310: *** exact error that occured. This usually means GTK was incorrectly installed
3311: *** or that you have moved GTK since it was installed. In the latter case, you
3312: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3313: configure: error: Test for GTK failed.
3314: [...]
1.91 rillig 3315: </pre>
1.128 wiz 3316: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3317: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3318: told me that this package really wanted to have the GNOME 1 version of
3319: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3320: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3321: So I changed the <code class="literal">x11/gtk2</code> to
3322: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3323: and tried again.</p>
3324: <pre class="programlisting">
1.100 rillig 3325: [...]
1.166 jnemeth 3326: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3327: In file included from xpidl.c:42:
3328: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3329: In file included from xpidl.c:42:
3330: xpidl.h:132: error: parse error before "IDL_ns"
3331: [...]
1.91 rillig 3332: </pre>
3333: <p>The package still does not find all of its dependencies. Now the
3334: question is: Which package provides the
3335: <code class="filename">libIDL/IDL.h</code> header file?</p>
3336: <pre class="programlisting">
1.100 rillig 3337: <code class="prompt">$</code> echo ../../*/*idl*
3338: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3339: <code class="prompt">$</code> echo ../../*/*IDL*
3340: ../../net/libIDL
1.91 rillig 3341: </pre>
3342: <p>Let's take the one from the second try. So I included the
3343: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3344: again. But the error didn't change. After digging through some of the
3345: code, I concluded that the build process of the package was broken and
3346: couldn't have ever worked, but since the Mozilla source tree is quite
3347: large, I didn't want to fix it. So I added the following to the package
3348: <code class="filename">Makefile</code> and tried again:</p>
3349: <pre class="programlisting">
1.100 rillig 3350: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.252 leot 3351: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.91 rillig 3352: </pre>
3353: <p>The latter line is needed because the package expects the library
3354: <code class="filename">libIDL.so</code>, but only
3355: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3356: wrapper to rewrite that on the fly.</p>
3357: <p>The next problem was related to a recent change of the FreeType
1.250 leot 3358: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.91 rillig 3359: which patch files were relevant for this issue and copied them to the
3360: <code class="filename">patches</code> directory. Then I retried, fixed the
3361: patches so that they applied cleanly and retried again. This time,
3362: everything worked.</p>
3363: </div>
1.148 asau 3364: <div class="sect3">
1.91 rillig 3365: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3366: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3367: <pre class="programlisting">
1.100 rillig 3368: <code class="prompt">$</code> bmake CHECK_FILES=no install
3369: [...]
3370: <code class="prompt">$</code> bmake print-PLIST >PLIST
3371: <code class="prompt">$</code> bmake deinstall
3372: <code class="prompt">$</code> bmake install
1.91 rillig 3373: </pre>
3374: </div>
3375: </div>
3376: </div>
1.77 rillig 3377: </div>
1.148 asau 3378: <div class="chapter">
1.75 rillig 3379: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3380: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3381: <div class="toc">
3382: <p><b>Table of Contents</b></p>
1.210 leot 3383: <dl class="toc">
1.128 wiz 3384: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3385: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219 rillig 3386: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106 rillig 3387: <dd><dl>
3388: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3389: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3390: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3391: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3392: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3393: </dl></dd>
3394: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3395: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3396: <dd><dl>
3397: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3398: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3399: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3400: </dl></dd>
1.128 wiz 3401: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3402: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 3403: </dl>
3404: </div>
1.87 wiz 3405: <p>Whenever you're preparing a package, there are a number of
3406: files involved which are described in the following
3407: sections.</p>
1.148 asau 3408: <div class="sect1">
1.75 rillig 3409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3410: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 3411: </h2></div></div></div>
1.75 rillig 3412: <p>Building, installation and creation of a binary package are all
1.87 wiz 3413: controlled by the package's <code class="filename">Makefile</code>.
3414: The <code class="filename">Makefile</code> describes various things about
3415: a package, for example from where to get it, how to configure,
3416: build, and install it.</p>
1.76 rillig 3417: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3418: sections that describe the package.</p>
1.75 rillig 3419: <p>In the first section there are the following variables, which
1.87 wiz 3420: should appear exactly in the order given here. The order and
3421: grouping of the variables is mostly historical and has no further
3422: meaning.</p>
1.148 asau 3423: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3424: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3425: distribution file to be downloaded from the package's
3426: website.</p></li>
1.128 wiz 3427: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3428: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3429: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 3430: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3431: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 3432: directory name together with the version number. It must match the
3433: regular expression
3434: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3435: starts with a letter or digit, and contains only letters, digits,
3436: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 3437: <li class="listitem">
1.75 rillig 3438: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 3439: which the package fits in. You can choose any of the top-level
3440: directories of pkgsrc for it.</p>
1.75 rillig 3441: <p>Currently the following values are available for
1.87 wiz 3442: <code class="varname">CATEGORIES</code>. If more than
3443: one is used, they need to be separated by spaces:</p>
1.75 rillig 3444: <pre class="programlisting">
1.100 rillig 3445: archivers cross geography meta-pkgs security
3446: audio databases graphics misc shells
3447: benchmarks devel ham multimedia sysutils
3448: biology editors inputmethod net textproc
3449: cad emulators lang news time
3450: chat finance mail parallel wm
3451: comms fonts math pkgtools www
3452: converters games mbone print x11
3453: </pre>
1.75 rillig 3454: </li>
1.128 wiz 3455: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 3456: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3457: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3458: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 3459: <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 3460: </ul></div>
3461: <p>The second section contains information about separately
1.87 wiz 3462: downloaded patches, if any.
3463: </p>
1.148 asau 3464: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190 wiz 3465: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87 wiz 3466: Name(s) of additional files that contain distribution patches.
3467: There is no default. pkgsrc will look for them at
3468: <code class="varname">PATCH_SITES</code>.
3469: They will automatically be uncompressed before patching if
3470: the names end with <code class="filename">.gz</code> or
3471: <code class="filename">.Z</code>.</p></li>
1.128 wiz 3472: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 3473: Primary location(s) for distribution patch files (see
1.190 wiz 3474: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3475: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.257 leot 3476: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.190 wiz 3477: help find the correct files to patch. It defaults to
3478: <span class="command"><strong>-p0</strong></span>.</p></li>
1.75 rillig 3479: </ul></div>
3480: <p>The third section contains the following variables.
1.87 wiz 3481: </p>
1.148 asau 3482: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3483: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 3484: address of the person who feels responsible for this package,
3485: and who is most likely to look at problems or questions regarding
1.257 leot 3486: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114 jmcneill 3487: Other developers may contact the <code class="varname">MAINTAINER</code>
3488: before making changes to the package, but are not required to
3489: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3490: to yourself. If you really can't maintain the package for future
3491: updates, set it to
1.110 hubertf 3492: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 3493: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 3494: of <code class="varname">MAINTAINER</code> when you do not want other
3495: developers to update or change the package without contacting
3496: you first. A package Makefile should contain one of
3497: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3498: not both. </p></li>
1.128 wiz 3499: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 3500: find more information about the package.</p></li>
1.128 wiz 3501: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 3502: description of the package (should not include the package
3503: name).</p></li>
1.234 leot 3504: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3505: 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 3506: </ul></div>
3507: <p>Other variables that affect the build:
1.87 wiz 3508: </p>
1.148 asau 3509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 3510: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 3511: interesting distribution files of the package are found. The
3512: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3513: works for most packages.</p>
1.75 rillig 3514: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 3515: (most GNU software does, for instance), but extracts itself in
3516: the current directory, you should set
3517: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3518: <p>If a package doesn't create a subdirectory with the
3519: name of <code class="varname">DISTNAME</code> but some different name,
3520: set <code class="varname">WRKSRC</code> to point to the proper name in
3521: <code class="filename">${WRKDIR}</code>, for example
3522: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.250 leot 3523: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://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 3524: <p>The name of the working directory created by pkgsrc is
1.87 wiz 3525: taken from the <code class="varname">WRKDIR_BASENAME</code>
3526: variable. By default, its value is
3527: <code class="filename">work</code>. If you want to use the same
3528: pkgsrc tree for building different kinds of binary packages,
3529: you can change the variable according to your needs. Two
3530: other variables handle common cases of setting
3531: <code class="varname">WRKDIR_BASENAME</code> individually. If
3532: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 3533: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 3534: the host's name is attached to the directory name. If
3535: <code class="varname">OBJMACHINE</code> is defined, the platform name
3536: is attached, which might look like
3537: <code class="filename">work.i386</code> or
3538: <code class="filename">work.sparc</code>.</p>
1.75 rillig 3539: </li></ul></div>
3540: <p>Please pay attention to the following gotchas:</p>
1.148 asau 3541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3542: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 3543: installed in compressed form by the package. For packages using
3544: BSD-style makefiles which honor MANZ, there is
3545: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 3546: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3547: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 3548: below).</p></li>
1.128 wiz 3549: <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 3550: </ul></div>
3551: </div>
1.148 asau 3552: <div class="sect1">
1.75 rillig 3553: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3554: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 3555: </h2></div></div></div>
1.76 rillig 3556: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 3557: digest, or checksum, of each distfile needed for the package. This
3558: ensures that the distfiles retrieved from the Internet have not been
3559: corrupted during transfer or altered by a malign force to introduce
1.219 rillig 3560: a security hole. To provide maximum security, all distfiles are
3561: protected using three different message digest algorithms (SHA1,
3562: RMD160, SHA512), as well as the file size.</p>
1.76 rillig 3563: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 3564: checksums for all the patches found in the
1.258 ! leot 3565: <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>). These checksums ensure that patches
! 3566: are only applied intentionally and that they don't accidentally change,
! 3567: e.g. when merging different changes together. They also make sure that
! 3568: new patches are actually added to CVS and old ones are removed.
! 3569: Too see whether the patches and the <code class="filename">distinfo</code> file
! 3570: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.76 rillig 3571: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219 rillig 3572: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75 rillig 3573: <p>Some packages have different sets of distfiles depending on
1.250 leot 3574: the platform, for example <a href="https://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 3575: <code class="filename">distinfo</code> file and care should be taken when
3576: upgrading such a package to ensure distfile information is not
3577: lost.</p>
1.75 rillig 3578: </div>
1.148 asau 3579: <div class="sect1">
1.75 rillig 3580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219 rillig 3581: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
3582: </h2></div></div></div>
3583: <p>Some packages don't work out-of-the box on the various
3584: platforms that are supported by pkgsrc. These packages need
3585: to be patched to make them work. The patch files can be
1.93 rillig 3586: found in the <code class="filename">patches/</code> directory.</p>
3587: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3588: applied to the files in <code class="varname">WRKSRC</code> directory after
1.219 rillig 3589: extracting them, in alphabetic order.</p>
1.148 asau 3590: <div class="sect2">
1.93 rillig 3591: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3592: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 3593: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 3594: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 3595: problems. (To force patches to apply with fuzz you can set
3596: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 3597: should contain only changes for a single file, and no file should be
1.93 rillig 3598: patched by more than one patch file. This helps to keep future
3599: modifications simple.</p>
3600: <p>Each patch file is structured as follows: In the first line,
3601: there is the RCS Id of the patch itself. The second line should be
3602: empty for aesthetic reasons. After that, there should be a comment for
3603: each change that the patch does. There are a number of standard
3604: cases:</p>
1.148 asau 3605: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3606: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 3607: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 3608: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 3609: platform and other environment (for example, the compiler) that the
3610: patch is needed for.</p></li>
3611: </ul></div>
1.219 rillig 3612: <p>The patch should be commented so that any
1.93 rillig 3613: developer who knows the code of the application can make some use of
3614: the patch. Special care should be taken for the upstream developers,
3615: since we generally want that they accept our patches, so we have less
3616: work in the future.</p>
3617: </div>
1.148 asau 3618: <div class="sect2">
1.93 rillig 3619: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3620: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 3621: <p>One important thing to mention is to pay attention that no RCS
3622: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 3623: later checked into the NetBSD CVS tree. Use the
1.250 leot 3624: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://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 3625: problems.</p>
1.87 wiz 3626: <p>For even more automation, we recommend using
1.110 hubertf 3627: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 3628: whole set of patches. You just have to backup files before you
3629: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 3630: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3631: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 3632: you upgrade a package this way, you can easily compare the new
3633: set of patches with the previously existing one with
1.130 wiz 3634: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3635: are replaced by new files, so carefully check if you want to take all
3636: the changes.</p>
1.87 wiz 3637: <p>When you have finished a package, remember to generate
1.110 hubertf 3638: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 3639: 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 3640: <p>When adding a patch that corrects a problem in the
3641: distfile (rather than e.g. enforcing pkgsrc's view of where
3642: man pages should go), send the patch as a bug report to the
3643: maintainer. This benefits non-pkgsrc users of the package,
3644: and usually makes it possible to remove the patch in future
3645: version.</p>
1.101 rillig 3646: <p>The file names of the patch files are usually of the form
1.130 wiz 3647: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3648: Many packages still use the previous convention
3649: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3650: but new patches should be of the form containing the filename.
1.250 leot 3651: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://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 3652: automatically.</p>
1.93 rillig 3653: </div>
1.148 asau 3654: <div class="sect2">
1.93 rillig 3655: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3656: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 3657: <p>If you want to share patches between multiple packages
3658: in pkgsrc, e.g. because they use the same distfiles, set
3659: <code class="varname">PATCHDIR</code> to the path where the patch files
3660: can be found, e.g.:</p>
3661: <pre class="programlisting">
1.100 rillig 3662: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 3663: </pre>
1.75 rillig 3664: <p>Patch files that are distributed by the author or other
1.87 wiz 3665: maintainers can be listed in
3666: <code class="varname">PATCHFILES</code>.</p>
3667: <p>If it is desired to store any patches that should not be
3668: committed into pkgsrc, they can be kept outside the pkgsrc
3669: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3670: directory tree there is expected to have the same
1.128 wiz 3671: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 3672: patches are expected to be stored inside these dirs (also
3673: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3674: example, if you want to keep a private patch for
3675: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3676: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3677: files in the named directory are expected to be patch files,
3678: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3679: applied</em></span>.</p>
1.93 rillig 3680: </div>
1.148 asau 3681: <div class="sect2">
1.85 jmmv 3682: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3683: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 3684: <p>When fixing a portability issue in the code do not use
3685: preprocessor magic to check for the current operating system nor
3686: platform. Doing so hurts portability to other platforms because
3687: the OS-specific details are not abstracted appropriately.</p>
3688: <p>The general rule to follow is: instead of checking for the
3689: operating system the application is being built on, check for the
3690: specific <span class="emphasis"><em>features</em></span> you need. For example,
3691: instead of assuming that kqueue is available under NetBSD and
3692: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 3693: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 3694: yes, this generally involves patching the
1.110 hubertf 3695: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 3696: that prevents some OSes from adopting interfaces from other OSes
3697: (e.g. Linux implementing kqueue), something that the above checks
3698: cannot take into account.</p>
3699: <p>Of course, checking for features generally involves more
3700: work on the developer's side, but the resulting changes are
1.87 wiz 3701: cleaner and there are chances they will work on many other
1.85 jmmv 3702: platforms. Not to mention that there are higher chances of being
3703: later integrated into the mainstream sources. Remember:
3704: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3705: <p>Some typical examples:</p>
3706: <div class="table">
1.106 rillig 3707: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.216 tnn 3708: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85 jmmv 3709: <colgroup>
3710: <col>
3711: <col>
3712: <col>
3713: </colgroup>
3714: <thead><tr>
3715: <th>Where</th>
3716: <th>Incorrect</th>
3717: <th>Correct</th>
3718: </tr></thead>
3719: <tbody>
3720: <tr>
3721: <td>configure script</td>
3722: <td>
1.100 rillig 3723: <pre class="programlisting">
3724: case ${target_os} in
3725: netbsd*) have_kvm=yes ;;
3726: *) have_kvm=no ;;
3727: esac
3728: </pre>
1.85 jmmv 3729: </td>
3730: <td>
1.100 rillig 3731: <pre class="programlisting">
3732: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3733: </pre>
1.85 jmmv 3734: </td>
3735: </tr>
3736: <tr>
3737: <td>C source file</td>
3738: <td>
1.100 rillig 3739: <pre class="programlisting">
3740: #if defined(__NetBSD__)
3741: # include <sys/event.h>
3742: #endif
3743: </pre>
1.85 jmmv 3744: </td>
3745: <td>
1.100 rillig 3746: <pre class="programlisting">
3747: #if defined(HAVE_SYS_EVENT_H)
3748: # include <sys/event.h>
3749: #endif
3750: </pre>
1.85 jmmv 3751: </td>
3752: </tr>
3753: <tr>
3754: <td>C source file</td>
3755: <td>
1.100 rillig 3756: <pre class="programlisting">
3757: int
3758: monitor_file(...)
3759: {
3760: #if defined(__NetBSD__)
3761: int fd = kqueue();
3762: ...
3763: #else
3764: ...
3765: #endif
3766: }
3767: </pre>
1.85 jmmv 3768: </td>
3769: <td>
1.100 rillig 3770: <pre class="programlisting">
3771: int
3772: monitor_file(...)
3773: {
3774: #if defined(HAVE_KQUEUE)
3775: int fd = kqueue();
3776: ...
3777: #else
1.223 rillig 3778: ...
1.100 rillig 3779: #endif
3780: }
3781: </pre>
1.85 jmmv 3782: </td>
3783: </tr>
3784: </tbody>
1.91 rillig 3785: </table></div>
1.85 jmmv 3786: </div>
1.254 maya 3787: <br class="table-break">
1.85 jmmv 3788: </div>
1.148 asau 3789: <div class="sect2">
1.85 jmmv 3790: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3791: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 3792: <p>Always, always, <span class="strong"><strong>always</strong></span>
3793: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3794: improvements you do to a package to the mainstream developers.
3795: This is the only way to get their attention on portability issues
3796: and to ensure that future versions can be built out-of-the box on
3797: NetBSD. Furthermore, any user that gets newer distfiles will get
3798: the fixes straight from the packaged code.</p>
1.93 rillig 3799: <p>This generally involves cleaning up the patches
3800: (because sometimes the patches that are
1.147 wiz 3801: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 3802: appropriate trackers for the projects and working with the
3803: mainstream authors to accept your changes. It is
3804: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3805: the packages in pkgsrc are kept simple and thus further changes
3806: can be done without much hassle.</p>
1.130 wiz 3807: <p>When you have done this, please add a URL to the upstream
3808: bug report to the patch comment.</p>
1.85 jmmv 3809: <p>Support the idea of free software!</p>
3810: </div>
1.75 rillig 3811: </div>
1.148 asau 3812: <div class="sect1">
1.75 rillig 3813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3814: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 3815: <div class="variablelist"><dl class="variablelist">
1.76 rillig 3816: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 3817: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 3818: any credits where they are due. Please bear in mind that others do not
3819: share your sense of humour (or spelling idiosyncrasies), and that others
3820: will read everything that you write here.</p></dd>
1.76 rillig 3821: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 3822: <dd><p>This file governs the files that are installed on your
3823: system: all the binaries, manual pages, etc. There are other
3824: directives which may be entered in this file, to control the
3825: creation and deletion of directories, and the location of
1.110 hubertf 3826: 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 3827: information.</p></dd>
1.75 rillig 3828: </dl></div>
3829: </div>
1.148 asau 3830: <div class="sect1">
1.75 rillig 3831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3832: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 3833: <div class="sect2">
1.78 rillig 3834: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3835: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 3836: <div class="variablelist"><dl class="variablelist">
1.76 rillig 3837: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 3838: <dd>
1.257 leot 3839: <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-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 3840: First time after package extraction and before files are
3841: moved in place, the second time after the files to install
3842: are moved in place. This can be used to do any custom
3843: procedures not possible with @exec commands in
1.257 leot 3844: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3845: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.0"><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 3846: Please note that you can modify variables in it easily by using
3847: <code class="varname">FILES_SUBST</code> in the package's
3848: <code class="filename">Makefile</code>:</p>
3849: <pre class="programlisting">
3850: FILES_SUBST+= SOMEVAR="somevalue"
3851: </pre>
3852: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3853: <code class="filename">INSTALL</code>. By default, substitution is
3854: performed for <code class="varname">PREFIX</code>,
3855: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3856: <code class="varname">VARBASE</code>, and a few others, type
3857: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3858: complete list.</p>
3859: </dd>
1.76 rillig 3860: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 3861: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 3862: this script's responsibility to clean up any additional messy details
3863: around the package's installation, since all pkg_delete knows is how to
3864: delete the files created in the original distribution.
1.257 leot 3865: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3866: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135 wiz 3867: The same methods to replace variables can be used as for
3868: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 3869: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 3870: <dd>
3871: <p>This file is displayed after installation of the package.
1.87 wiz 3872: Useful for things like legal notices on almost-free
3873: software and hints for updating config files after
3874: installing modules for apache, PHP etc.
3875: Please note that you can modify variables in it easily by using
3876: <code class="varname">MESSAGE_SUBST</code> in the package's
3877: <code class="filename">Makefile</code>:</p>
1.75 rillig 3878: <pre class="programlisting">
1.100 rillig 3879: MESSAGE_SUBST+= SOMEVAR="somevalue"
3880: </pre>
1.128 wiz 3881: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 3882: <code class="filename">MESSAGE</code>. By default, substitution is
3883: performed for <code class="varname">PKGNAME</code>,
3884: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209 sevan 3885: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87 wiz 3886: <code class="varname">PKG_SYSCONFDIR</code>,
3887: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 3888: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 3889: <p>You can display a different or additional files by
3890: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3891: default is <code class="filename">MESSAGE</code>, if the file
3892: exists.</p>
1.75 rillig 3893: </dd>
1.78 rillig 3894: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 3895: <dd>
3896: <p>This file is used by the alternatives framework.
3897: It creates, configures, and destroys generic wrappers used to
3898: run programs with similar interfaces.
3899: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3900: for more information.</p>
3901: <p>Each line of the file contains two filenames, first
3902: the wrapper and then the alternative provided by the package.
3903: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3904: </dd>
1.78 rillig 3905: </dl></div>
3906: </div>
1.148 asau 3907: <div class="sect2">
1.78 rillig 3908: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3909: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 3910: <div class="variablelist"><dl class="variablelist">
1.78 rillig 3911: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3912: <dd><p>This file contains arbitrary things that could
3913: also go into a <code class="filename">Makefile</code>, but its purpose is
3914: to be used by more than one package. This file should only be
3915: used when the packages that will use the file are known in
3916: advance. For other purposes it is often better to write a
3917: <code class="filename">*.mk</code> file and give it a good name that
3918: describes what it does.</p></dd>
3919: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3920: <dd><p>This file contains the dependency information
1.110 hubertf 3921: 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 3922: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3923: <dd><p>This file contains workarounds for compiler bugs
3924: and similar things. It is included automatically by the pkgsrc
3925: infrastructure, so you don't need an extra
3926: <code class="literal">.include</code> line for
3927: it.</p></dd>
3928: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3929: <dd><p>This file contains the code for the
1.110 hubertf 3930: 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 3931: selected by the user. If a package has only one or two options,
3932: it is equally acceptable to put the code directly into the
3933: <code class="filename">Makefile</code>.</p></dd>
3934: </dl></div>
3935: </div>
1.148 asau 3936: <div class="sect2">
1.78 rillig 3937: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3938: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 3939: <div class="variablelist"><dl class="variablelist">
1.78 rillig 3940: <dt><span class="term"><code class="filename">README*</code></span></dt>
3941: <dd><p>These files do not take place in the creation of
3942: a package and thus are purely informative to the package
3943: developer.</p></dd>
3944: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3945: <dd><p>This file contains things that need to be done
3946: to make the package even
3947: better.</p></dd>
1.75 rillig 3948: </dl></div>
3949: </div>
1.78 rillig 3950: </div>
1.148 asau 3951: <div class="sect1">
1.75 rillig 3952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3953: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 3954: </h2></div></div></div>
1.110 hubertf 3955: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 3956: unpacked into the directory denoted by
3957: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 3958: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 3959: directory is also used to keep various timestamp files.
3960: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3961: The default is <code class="filename">${.CURDIR}/work</code>
3962: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3963: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 3964: </div>
1.148 asau 3965: <div class="sect1">
1.75 rillig 3966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3967: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 3968: </h2></div></div></div>
1.75 rillig 3969: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 3970: to configuration or building, you could place these files here and use
1.110 hubertf 3971: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 3972: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 3973: this. Alternatively, you could simply diff the file against
3974: <code class="filename">/dev/null</code> and use the patch mechanism to manage
3975: the creation of this file.</p>
3976: <p>If you want to share files in this way with other
3977: packages, set the <code class="varname">FILESDIR</code> variable to point
3978: to the other package's <code class="filename">files</code> directory,
3979: e.g.:</p>
3980: <pre class="programlisting">
1.100 rillig 3981: FILESDIR=${.CURDIR}/../xemacs/files
3982: </pre>
1.75 rillig 3983: </div>
3984: </div>
1.148 asau 3985: <div class="chapter">
1.75 rillig 3986: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3987: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 3988: <div class="toc">
3989: <p><b>Table of Contents</b></p>
1.210 leot 3990: <dl class="toc">
1.106 rillig 3991: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3992: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3993: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3994: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3995: <dd><dl>
3996: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228 yyamano 3997: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220 wiz 3998: <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>
3999: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.75 rillig 4000: </dl></dd>
4001: </dl>
4002: </div>
1.76 rillig 4003: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4004: each of which forms a well-defined part of the pkgsrc system. Using
1.257 leot 4005: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75 rillig 4006: like pkgsrc requires some discipline to keep the code correct and
4007: understandable.</p>
1.76 rillig 4008: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4009: programming are variables (which are actually macros) and shell
4010: commands. Among these shell commands may even be more complex ones
1.257 leot 4011: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75 rillig 4012: as intended it is necessary to quote all variables correctly when they
4013: are used.</p>
4014: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4015: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4016: with them.</p>
1.148 asau 4017: <div class="sect1">
1.75 rillig 4018: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4019: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4020: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4021: <p>When you are creating a file as a
4022: target of a rule, always write the data to a temporary file first
4023: and finally rename that file. Otherwise there might occur an error
4024: in the middle of generating the file, and when the user runs
1.257 leot 4025: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><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 4026: regenerated properly. Example:</p>
4027: <pre class="programlisting">
1.100 rillig 4028: wrong:
4029: @echo "line 1" > ${.TARGET}
4030: @echo "line 2" >> ${.TARGET}
4031: @false
4032:
4033: correct:
4034: @echo "line 1" > ${.TARGET}.tmp
4035: @echo "line 2" >> ${.TARGET}.tmp
4036: @false
4037: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4038: </pre>
1.110 hubertf 4039: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4040: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4041: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4042: correct</strong></span> gives an error message twice, as expected.</p>
1.257 leot 4043: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4044: <code class="literal">${.TARGET}</code> in case of error, but this only
4045: happens when it is interrupted, for example by pressing
4046: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.257 leot 4047: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4048: </li></ul></div>
4049: </div>
1.148 asau 4050: <div class="sect1">
1.97 rillig 4051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4052: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4053: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4054: can be processed using the five operators ``='', ``+='', ``?='',
1.257 leot 4055: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4056: page.</p>
4057: <p>When a variable's value is parsed from a
1.76 rillig 4058: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4059: backslash character ``\'' are handled specially. If a backslash is
4060: followed by a newline, any whitespace immediately in front of the
4061: backslash, the backslash, the newline, and any whitespace
4062: immediately behind the newline are replaced with a single space. A
4063: backslash character and an immediately following hash character are
4064: replaced with a single hash character. Otherwise, the backslash is
4065: passed as is. In a variable assignment, any hash character that is
1.251 leot 4066: not preceded by a backslash starts a comment that continues up to the
1.75 rillig 4067: end of the logical line.</p>
1.219 rillig 4068: <p>The evaluation of variables either happens immediately or lazy.
4069: It happens immediately when the variable occurs
4070: on the right-hand side of the ``:='' or the ``!='' operator, in a
4071: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4072: In the other cases, it is evaluated lazily.</p>
1.75 rillig 4073: <p>Some of the modifiers split the string into words and then
4074: operate on the words, others operate on the string as a whole. When
1.257 leot 4075: 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-8.0"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.75 rillig 4076: <p>There are several types of variables that should be handled
4077: differently. Strings and two types of lists.</p>
1.148 asau 4078: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4079: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4080: characters. Nevertheless, you should restrict yourself to only
4081: using printable characters. Examples are
4082: <code class="varname">PREFIX</code> and
4083: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4084: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4085: are never exported to any shell command. Their elements are
4086: separated by whitespace. Therefore, the elements themselves cannot
4087: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4088: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4089: Examples are <code class="varname">DEPENDS</code> and
4090: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4091: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4092: may be exported to a shell command. Their elements can contain any
4093: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4094: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4095: <code class="varname">DISTFILES</code> and
4096: <code class="varname">MASTER_SITES</code>.</p></li>
4097: </ul></div>
1.148 asau 4098: <div class="sect2">
1.75 rillig 4099: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4100: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4101: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4102: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4103: are reserved for use by the pkgsrc infrastructure. They shall
4104: not be used by package
1.76 rillig 4105: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4106: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4107: lowercase variable names for the iteration
4108: variables.</p></li>
1.128 wiz 4109: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4110: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4111: <code class="varname">DISTFILES</code>.</p></li>
4112: </ul></div>
4113: </div>
4114: </div>
1.148 asau 4115: <div class="sect1">
1.75 rillig 4116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4117: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.148 asau 4118: <div class="sect2">
1.75 rillig 4119: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4120: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.220 wiz 4121: <p>When adding a string that possibly contains whitespace or quotes to
4122: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4123: modifier.</p>
4124: <p>When adding another list to a list (example 2), it must not be
4125: quoted, since its elements are already quoted.</p>
1.75 rillig 4126: <pre class="programlisting">
1.220 wiz 4127: STRING= foo * bar `date`
4128: LIST= # empty
4129: ANOTHER_LIST= a=b c=d
4130:
4131: LIST+= ${STRING:Q} # 1
4132: LIST+= ${ANOTHER_LIST} # 2
4133: </pre>
1.75 rillig 4134: </div>
1.148 asau 4135: <div class="sect2">
1.75 rillig 4136: <div class="titlepage"><div><div><h3 class="title">
1.228 yyamano 4137: <a name="echo-literal"></a>12.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.220 wiz 4138: <p>Echoing a string containing special characters needs special
4139: work.</p>
1.75 rillig 4140: <pre class="programlisting">
1.100 rillig 4141: STRING= foo bar < > * `date` $$HOME ' "
1.219 rillig 4142: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 grant 4143:
1.100 rillig 4144: all:
4145: echo ${STRING} # 1
1.219 rillig 4146: echo ${STRING:Q} # 2
4147: printf '%s\n' ${STRING:Q}'' # 3
1.220 wiz 4148: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 grant 4149: </pre>
1.220 wiz 4150: <p>Example 1 leads to a syntax error in the shell, as the characters
4151: are just copied.</p>
4152: <p>Example 2 quotes the string so that the shell interprets it
4153: correctly. But the echo command may additionally interpret strings with a
4154: leading dash or those containing backslashes.</p>
1.257 leot 4155: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.252 leot 4156: interprets the format string, but not the next argument. The trailing
4157: single quotes handle the case when the string is empty. In that case, the
4158: :Q modifier would result in an empty string too, which would then be
1.257 leot 4159: skipped by the shell. For <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.252 leot 4160: but other programs may care.</p>
1.220 wiz 4161: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4162: need to be quoted because the quoting has already been done
4163: when adding elements to the list.</p>
1.75 rillig 4164: </div>
1.148 asau 4165: <div class="sect2">
1.75 rillig 4166: <div class="titlepage"><div><div><h3 class="title">
1.220 wiz 4167: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4168: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4169: GNU-style configure script (especially those that call other configure
4170: scripts), it must not have leading or trailing whitespace, since
4171: otherwise the configure script gets confused. To trim leading and
4172: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4173: following example:</p>
1.75 rillig 4174: <pre class="programlisting">
1.100 rillig 4175: CPPFLAGS= # empty
1.220 wiz 4176: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.100 rillig 4177: CPPFLAGS+= ${MY_CPPFLAGS}
4178:
4179: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4180:
4181: all:
4182: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.220 wiz 4183: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 grant 4184: </pre>
1.220 wiz 4185: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4186: trailing whitespace because the <code class="code">+=</code> operator always adds a
4187: space.</p>
4188: </div>
4189: <div class="sect2">
4190: <div class="titlepage"><div><div><h3 class="title">
4191: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4192: <p>When a possibly empty variable is used in a shell program, it may
4193: lead to a syntax error.</p>
4194: <pre class="programlisting">
4195: EGFILES= # empty
4196:
4197: install-examples: # produces a syntax error in the shell
4198: for egfile in ${EGFILES}; do \
4199: echo "Installing $$egfile"; \
4200: done
4201: </pre>
4202: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.257 leot 4203: <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-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.220 wiz 4204: To fix this syntax error, use one of the snippets below.</p>
4205: <pre class="programlisting">
4206: EMPTY= # empty
4207:
4208: install-examples:
4209: for egfile in ${EGFILES} ""; do \
4210: [ -n "$$egfile" ] || continue; \
4211: echo "Installing $$egfile"; \
1.100 rillig 4212: done
1.220 wiz 4213: </pre>
4214: <p>In this case, an empty string is appended to the iteration list (to
4215: prevent the syntax error) and filtered out later.</p>
4216: <pre class="programlisting">
4217: EGFILES= # empty
1.100 rillig 4218:
1.220 wiz 4219: install-examples:
4220: .for egfile in ${EGFILES}
4221: echo "Installing ${egfile}"
1.100 rillig 4222: .endfor
1.1 grant 4223: </pre>
1.220 wiz 4224: <p>This variant only works when <code class="varname">EGFILES</code> does not
4225: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4226: simple whitespace.</p>
4227: <p>To have a shell command test whether a make variable is empty, use
4228: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.75 rillig 4229: </div>
4230: </div>
4231: </div>
1.148 asau 4232: <div class="chapter">
1.75 rillig 4233: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4234: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4235: <div class="toc">
4236: <p><b>Table of Contents</b></p>
1.210 leot 4237: <dl class="toc">
1.106 rillig 4238: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4239: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4240: <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 4241: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4242: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4243: <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 4244: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 4245: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4246: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75 rillig 4247: </dl>
4248: </div>
1.87 wiz 4249: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4250: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4251: the package (relative to the <code class="filename">${PREFIX}</code>
4252: directory it's been installed in) plus some additional statements
1.257 leot 4253: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 4254: This chapter addresses some issues that need attention when
4255: dealing with the <code class="filename">PLIST</code> file (or files, see
4256: below!).</p>
1.148 asau 4257: <div class="sect1">
1.75 rillig 4258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4259: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4260: <p>Be sure to add a RCS ID line as the first thing in any
4261: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4262: <pre class="programlisting">
1.233 sevan 4263: @comment $NetBSD $
1.222 sevan 4264: </pre>
1.235 yyamano 4265: <p>An artificial space has been added between NetBSD and $, this is a
1.233 sevan 4266: workaround here to prevent CVS expanding to the filename of the guide. When
1.238 leot 4267: adding the RCS ID the space should be omitted.</p>
1.75 rillig 4268: </div>
1.148 asau 4269: <div class="sect1">
1.75 rillig 4270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4271: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4272: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4273: to output a PLIST that matches any new files since the package
1.110 hubertf 4274: 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 4275: more information on this target.</p>
1.75 rillig 4276: </div>
1.148 asau 4277: <div class="sect1">
1.75 rillig 4278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 4279: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4280: </h2></div></div></div>
1.87 wiz 4281: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4282: of AWK patterns and actions that are used to filter the output of
4283: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4284: scripting you like to it, but be careful with quoting.</p>
4285: <p>For example, to get all files inside the
4286: <code class="filename">libdata/foo</code> directory removed from the
4287: resulting PLIST:</p>
4288: <pre class="programlisting">
1.100 rillig 4289: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.222 sevan 4290: </pre>
1.75 rillig 4291: </div>
1.148 asau 4292: <div class="sect1">
1.75 rillig 4293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4294: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4295: <p>A number of variables are substituted automatically in
4296: PLISTs when a package is installed on a system. This includes the
4297: following variables:</p>
1.148 asau 4298: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4299: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4300: <dd>
4301: <p>Some packages like emacs and perl embed information
1.87 wiz 4302: about which architecture they were built on into the
4303: pathnames where they install their files. To handle this
4304: case, PLIST will be preprocessed before actually used, and
4305: the symbol
1.128 wiz 4306: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4307: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4308: same is done if the string
4309: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4310: PLIST somewhere - use this on packages that have GNU
4311: autoconf-created configure scripts.</p>
1.148 asau 4312: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4313: <h3 class="title">Legacy note</h3>
4314: <p>There used to be a symbol
1.128 wiz 4315: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4316: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4317: -m</strong></span>, but that's no longer supported and has
4318: been removed.</p>
1.75 rillig 4319: </div>
4320: </dd>
4321: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4322: <dd>
4323: <p>Some packages want to embed the OS name and version
1.87 wiz 4324: into some paths. To do this, use these variables in the
4325: <code class="filename">PLIST</code>:
4326: </p>
1.148 asau 4327: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4328: <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>
4329: <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>
4330: <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 4331: </ul></div>
4332: </dd>
4333: </dl></div>
1.199 tnn 4334: <p>For a list of values which are replaced by
4335: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4336: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4337: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87 wiz 4338: <p>If you want to change other variables not listed above, you
4339: can add variables and their expansions to this variable in the
1.110 hubertf 4340: 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 4341: <pre class="programlisting">
1.100 rillig 4342: PLIST_SUBST+= SOMEVAR="somevalue"
1.222 sevan 4343: </pre>
1.128 wiz 4344: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4345: in the <code class="filename">PLIST</code> with
1.128 wiz 4346: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4347: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4348: the common case of conditionally including some
4349: <code class="filename">PLIST</code> entries. It can be done by adding
4350: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 4351: setting the corresponding <code class="varname">PLIST.foo</code> variable
4352: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 4353: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 4354: in the <code class="filename">PLIST</code> with either
1.128 wiz 4355: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4356: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 4357: For example, in <code class="filename">Makefile</code>:</p>
4358: <pre class="programlisting">
1.223 rillig 4359: PLIST_VARS+= foo
1.119 mishka 4360: .if <em class="replaceable"><code>condition</code></em>
1.223 rillig 4361: PLIST.foo= yes
1.119 mishka 4362: .else
1.222 sevan 4363: </pre>
1.119 mishka 4364: <p>And then in <code class="filename">PLIST</code>:</p>
4365: <pre class="programlisting">
1.233 sevan 4366: @comment $NetBSD $
1.119 mishka 4367: bin/bar
4368: man/man1/bar.1
4369: ${PLIST.foo}bin/foo
4370: ${PLIST.foo}man/man1/foo.1
4371: ${PLIST.foo}share/bar/foo.data
1.222 sevan 4372: </pre>
1.235 yyamano 4373: <p>An artificial space has been added between NetBSD and $, this is a
1.233 sevan 4374: workaround here to prevent CVS expanding to the filename of the guide. When
4375: adding the RCS ID the space should be ommited.</p>
1.75 rillig 4376: </div>
1.148 asau 4377: <div class="sect1">
1.75 rillig 4378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4379: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 4380: <p>Man pages should be installed in compressed form if
1.87 wiz 4381: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4382: and uncompressed otherwise. To handle this in the
1.128 wiz 4383: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 4384: appended/removed automatically for man pages according to
4385: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4386: or not, see above for details. This modification of the
4387: <code class="filename">PLIST</code> file is done on a copy of it, not
4388: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 4389: </div>
1.148 asau 4390: <div class="sect1">
1.75 rillig 4391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4392: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 4393: </h2></div></div></div>
1.76 rillig 4394: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 4395: in generating the binary package, set the variable
4396: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.257 leot 4397: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 4398: important. The default for <code class="varname">PLIST_SRC</code> is
4399: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 4400: </div>
1.148 asau 4401: <div class="sect1">
1.75 rillig 4402: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4403: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 4404: <p>Some packages decide to install a different set of files based on
1.87 wiz 4405: the operating system being used. These differences can be
4406: automatically handled by using the following files:</p>
1.148 asau 4407: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4408: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4409: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4410: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4411: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4412: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 4413: </ul></div>
4414: </div>
1.148 asau 4415: <div class="sect1">
1.75 rillig 4416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197 wiz 4417: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4418: <p>Some packages decide to generate hard-to-guess file names
4419: during installation that are hard to wire down.</p>
4420: <p>In such cases, you can set the
4421: <code class="varname">GENERATE_PLIST</code> variable to shell code
4422: terminated (with a semicolon) that will output PLIST entries which
4423: will be appended to the PLIST</p>
4424: <p>You can find one example in editors/xemacs:</p>
4425: <pre class="programlisting">
1.222 sevan 4426: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4427: </pre>
1.197 wiz 4428: <p>which will append something like
4429: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4430: <code class="filename">PLIST</code>.
4431: </p>
4432: </div>
4433: <div class="sect1">
4434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4435: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128 wiz 4436: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 4437: multiple (and unrelated) packages install files. These
1.125 wiz 4438: directories were problematic because you had to add special
4439: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 4440: centralized package handle them.</p>
1.125 wiz 4441: <p>In pkgsrc, it is now easy: Each package should create
4442: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4443: will remove any directories left empty after uninstalling a
4444: package.</p>
4445: <p>If a package needs an empty directory to work, create
4446: the directory during installation as usual, and also add an
4447: entry to the PLIST:
1.222 sevan 4448:
4449: </p>
1.87 wiz 4450: <pre class="programlisting">
1.125 wiz 4451: @pkgdir path/to/empty/directory
1.222 sevan 4452: </pre>
1.125 wiz 4453: <p>
1.222 sevan 4454:
1.197 wiz 4455: or take a look at <code class="varname">MAKE_DIRS</code> and
4456: <code class="varname">OWN_DIRS</code>.
1.125 wiz 4457: </p>
1.75 rillig 4458: </div>
4459: </div>
1.148 asau 4460: <div class="chapter">
1.75 rillig 4461: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4462: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 4463: <div class="toc">
4464: <p><b>Table of Contents</b></p>
1.210 leot 4465: <dl class="toc">
1.106 rillig 4466: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 4467: <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 4468: <dd><dl>
1.106 rillig 4469: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 4470: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
4471: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4472: and
4473: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4474: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 4475: </dl></dd>
1.128 wiz 4476: <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 4477: <dd><dl>
1.128 wiz 4478: <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 4479: <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 4480: </dl></dd>
4481: </dl>
4482: </div>
4483: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 4484: are seen by a package's configure and build processes. This is implemented
4485: in a two step process:</p>
1.128 wiz 4486: <div class="orderedlist"><ol class="orderedlist" type="1">
4487: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 4488: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4489: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 4490: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 4491: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4492: <code class="option">-L${LOCALBASE}/lib</code> into references to
4493: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4494: native compiler on some operating systems look like GCC, so that
4495: packages that expect GCC won't require modifications to build with
4496: those native compilers.</p></li>
1.75 rillig 4497: </ol></div>
4498: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 4499: package may be built consistently despite what other software may be
4500: installed. Please note that the normal system header and library paths,
4501: e.g. <code class="filename">/usr/include</code>,
4502: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4503: designed to insulate the package build from non-system-supplied
4504: software.</p>
1.148 asau 4505: <div class="sect1">
1.75 rillig 4506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4507: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 4508: <p>The process of converting packages to use the buildlink3
1.128 wiz 4509: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 4510: The things to keep in mind are:</p>
1.128 wiz 4511: <div class="orderedlist"><ol class="orderedlist" type="1">
4512: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 4513: instead of the actual toolchain. Some packages are tricky,
4514: and the only way to know for sure is the check
4515: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4516: wrappers are being invoked.</p></li>
1.128 wiz 4517: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 4518: the package Makefile, e.g. Java VMs, standalone shells,
4519: etc., because the code to symlink files into
4520: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 4521: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 4522: </p></li>
1.128 wiz 4523: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 4524: <code class="filename">buildlink3.mk</code> files that you list in a
4525: package's Makefile are added as dependencies for that package.
4526: </p></li>
1.75 rillig 4527: </ol></div>
1.87 wiz 4528: <p>If a dependency on a particular package is required for its libraries and
4529: headers, then we replace:</p>
1.75 rillig 4530: <pre class="programlisting">
1.100 rillig 4531: DEPENDS+= foo>=1.1.0:../../category/foo
4532: </pre>
1.75 rillig 4533: <p>with</p>
4534: <pre class="programlisting">
1.100 rillig 4535: .include "../../category/foo/buildlink3.mk"
4536: </pre>
1.75 rillig 4537: <p>The buildlink3.mk files usually define the required dependencies.
4538: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 4539: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 4540: <pre class="programlisting">
1.100 rillig 4541: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4542: .include "../../category/foo/buildlink3.mk"
4543: </pre>
1.76 rillig 4544: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 4545: files in <code class="filename">pkgsrc/mk</code>
4546: that handle special package issues:</p>
1.148 asau 4547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4548: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 4549: the native or a pkgsrc Berkeley DB implementation based on
4550: the values of <code class="varname">BDB_ACCEPTED</code> and
4551: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 4552: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 4553: comes with neither Curses nor NCurses, this will take care
1.250 leot 4554: to install the <a href="https://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 4555: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 4556: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4557: adding a dependency on Heimdal or MIT-krb5 for packages that
4558: require a Kerberos 5 implementation.</p></li>
1.128 wiz 4559: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 4560: system-provided Motif installation or adds a dependency on
1.250 leot 4561: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://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 4562: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.239 leot 4563: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
4564: to choose which Motif version will be used.</p></li>
1.161 ryoon 4565: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 4566: system-provided GNU readline or editline (libedit) installation,
1.250 leot 4567: or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
4568: <a href="https://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 4569: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4570: If your package really needs GNU readline library, its Makefile
4571: should include <code class="filename">devel/readline/buildlink3.mk</code>
4572: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 4573: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 4574: variables that may be used by packages that use the
4575: Open Sound System (OSS) API.</p></li>
1.128 wiz 4576: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 4577: any of the Postgres versions in the variable
4578: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4579: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 4580: the file for more information.</p></li>
1.128 wiz 4581: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 4582: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.250 leot 4583: a dependency on <a href="https://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 4584: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 4585: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4586: library.</p></li>
1.75 rillig 4587: </ul></div>
1.76 rillig 4588: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 4589: files provide a more complete
4590: description of how to use them properly.</p>
1.75 rillig 4591: </div>
1.148 asau 4592: <div class="sect1">
1.75 rillig 4593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4594: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 4595: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 4596: included by Makefiles to indicate the need to compile and link
4597: against header files and libraries provided by the package. A
4598: <code class="filename">buildlink3.mk</code> file should always provide
4599: enough information to add the correct type of dependency
4600: relationship and include any other
4601: <code class="filename">buildlink3.mk</code> files that it needs to find
4602: headers and libraries that it needs in turn.</p>
4603: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.250 leot 4604: file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87 wiz 4605: package is highly recommended. For most packages, the following
4606: command will generate a good starting point for
4607: <code class="filename">buildlink3.mk</code> files:</p>
4608: <pre class="screen">
4609: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4610: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4611: </pre>
1.148 asau 4612: <div class="sect2">
1.75 rillig 4613: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4614: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 4615: <p>The following real-life example
1.87 wiz 4616: <code class="filename">buildlink3.mk</code> is taken
4617: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 4618: <pre class="programlisting">
1.120 snj 4619: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 4620:
1.223 rillig 4621: BUILDLINK_TREE+= tiff
1.1 grant 4622:
1.120 snj 4623: .if !defined(TIFF_BUILDLINK3_MK)
4624: TIFF_BUILDLINK3_MK:=
1.87 wiz 4625:
1.223 rillig 4626: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4627: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4628: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 4629:
1.100 rillig 4630: .include "../../devel/zlib/buildlink3.mk"
4631: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 4632: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 4633:
1.223 rillig 4634: BUILDLINK_TREE+= -tiff
1.100 rillig 4635: </pre>
1.87 wiz 4636: <p>The header and footer manipulate
1.120 snj 4637: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 4638: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 4639: the dependency tree.</p>
4640: <p>The main section is protected from multiple inclusion
1.87 wiz 4641: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4642: added. Several important variables are set in the section:</p>
1.148 asau 4643: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4644: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4645: is the actual dependency recorded in the installed
4646: package; this should always be set using
1.110 hubertf 4647: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 4648: we're appending to any pre-existing list of values. This
4649: variable should be set to the first version of the
1.133 wiz 4650: package that had an backwards-incompatible API change.
1.87 wiz 4651: </p></li>
1.128 wiz 4652: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4653: is the location of the <em class="replaceable"><code>pkg</code></em>
4654: pkgsrc directory.</p></li>
1.128 wiz 4655: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4656: (not shown above) controls whether we use
4657: <code class="varname">BUILD_DEPENDS</code> or
4658: <code class="varname">DEPENDS</code> to add the dependency on
4659: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4660: selected by setting
4661: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4662: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 4663: used.</p></li>
1.128 wiz 4664: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4665: and
4666: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4667: (not shown above) are lists of subdirectories of
1.76 rillig 4668: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 4669: to add to the header and library search paths. These
1.128 wiz 4670: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 4671: respectively.</p></li>
1.128 wiz 4672: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4673: (not shown above) is the list of preprocessor flags to add
4674: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 4675: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 4676: should be avoided and instead be handled using
4677: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 4678: above.</p></li>
1.75 rillig 4679: </ul></div>
1.87 wiz 4680: <p>The following variables are all optionally defined within
4681: this second section (protected against multiple inclusion) and
4682: control which package files are symlinked into
4683: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4684: transformed during the symlinking:</p>
1.148 asau 4685: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4686: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4687: (not shown above) is a shell glob pattern relative to
1.76 rillig 4688: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 4689: to be symlinked into
1.76 rillig 4690: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 4691: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 4692: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4693: (not shown above) is a shell pipeline that
4694: outputs to stdout a list of files relative to
4695: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4696: The resulting files are to be symlinked
4697: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4698: this takes the <code class="filename">+CONTENTS</code> of a
4699: <em class="replaceable"><code>pkg</code></em> and filters it through
4700: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 4701: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4702: (not shown above) is a filter command that filters
1.76 rillig 4703: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 4704: relative to
1.76 rillig 4705: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194 bsiegert 4706: on stdout. By default,
1.75 rillig 4707: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 4708: outputs the contents of the <code class="filename">include</code>
4709: and <code class="filename">lib</code> directories in the package
1.194 bsiegert 4710: <code class="filename">+CONTENTS</code>.</p></li>
1.128 wiz 4711: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4712: (not shown above) is a list of sed arguments used to
4713: transform the name of the source filename into a
1.110 hubertf 4714: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 4715: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 4716: </ul></div>
1.120 snj 4717: <p>This section can additionally include any
1.87 wiz 4718: <code class="filename">buildlink3.mk</code> needed for
4719: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4720: Including these <code class="filename">buildlink3.mk</code> files
4721: means that the headers and libraries for these
4722: dependencies are also symlinked into
4723: <code class="filename">${BUILDLINK_DIR}</code>
4724: whenever the <em class="replaceable"><code>pkg</code></em>
4725: <code class="filename">buildlink3.mk</code>
1.120 snj 4726: file is included. Dependencies are only added for directly
4727: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 4728: <p>When providing a <code class="filename">buildlink3.mk</code> and
4729: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 4730: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 4731: header files are automatically exposed when the package is
4732: use.</p>
4733: <p>In particular, if only an executable
4734: (<code class="filename">bin/foo</code>) is linked against a library, that
4735: library does not need to be propagated in the
4736: <code class="filename">buildlink3.mk</code> file.</p>
4737: <p>The following steps should help you decide if a
4738: <code class="filename">buildlink3.mk</code> file needs to be included:
4739: </p>
4740: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4741: <li class="listitem"><p>Look at the installed header files: What
4742: headers do they include? The packages providing these files
4743: must be buildlinked.</p></li>
1.155 wiz 4744: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4745: libraries and look against what other libraries they link.
4746: Some of the packages providing these probably need to be
4747: buildlinked; however, it's not automatic, since e.g. GTK on
4748: some systems pulls in the X libraries, so they will show up in
4749: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 4750: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 4751: used as a hint.</p></li>
1.153 wiz 4752: </ul></div>
4753: <p>
4754: </p>
1.75 rillig 4755: </div>
1.148 asau 4756: <div class="sect2">
1.75 rillig 4757: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 4758: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 4759: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 4760: and
4761: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4762: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4763: <p>These two variables differ in that one describes source
4764: compatibility (API) and the other binary compatibility (ABI).
4765: The difference is that a change in the API breaks compilation of
4766: programs while changes in the ABI stop compiled programs from
4767: running.</p>
4768: <p>Changes to the
1.134 wiz 4769: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 4770: variable in a <code class="filename">buildlink3.mk</code> file happen
4771: very rarely. One possible reason is that all packages depending
4772: on this already need a newer version. In case it is bumped see
4773: the description below.</p>
4774: <p>The most common example of an ABI change is that the major
4775: version of a shared library is increased. In this case,
4776: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4777: should be adjusted to require at least the new package version.
4778: Then the packages that depend on this package need their
4779: <code class="varname">PKGREVISION</code>s increased and, if they have
4780: <code class="filename">buildlink3.mk</code> files, their
4781: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4782: adjusted, too. This is needed so pkgsrc will require the correct
4783: package dependency and not settle for an older one when building
4784: the source.</p>
1.218 rillig 4785: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.133 wiz 4786: more information about dependencies on other packages,
4787: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 4788: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4789: <p>Please take careful consideration before adjusting
4790: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4791: or
4792: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4793: as we don't want to cause unneeded package deletions and
4794: rebuilds. In many cases, new versions of packages work just
4795: fine with older dependencies.</p>
4796: <p>Also it is not needed to set
1.133 wiz 4797: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4798: when it is identical to
1.87 wiz 4799: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 4800: </div>
4801: </div>
1.148 asau 4802: <div class="sect1">
1.75 rillig 4803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4804: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 4805: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 4806: coincide with headers and libraries present in the base system.
1.76 rillig 4807: Aside from a <code class="filename">buildlink3.mk</code> file, these
4808: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 4809: file that includes the necessary checks to decide whether using
4810: the built-in software or the pkgsrc software is
1.87 wiz 4811: appropriate.</p>
4812: <p>The only requirements of a builtin.mk file for
4813: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 4814: <div class="orderedlist"><ol class="orderedlist" type="1">
4815: <li class="listitem"><p>It should set
1.87 wiz 4816: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4817: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 4818: after it is included.</p></li>
1.128 wiz 4819: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 4820: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4821: which is already set before the
4822: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 4823: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 4824: is <span class="emphasis"><em>very</em></span> important and takes careful
4825: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 4826: </ol></div>
1.148 asau 4827: <div class="sect2">
1.75 rillig 4828: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4829: <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 4830: <p>The following is the recommended template for builtin.mk
1.87 wiz 4831: files:</p>
1.75 rillig 4832: <pre class="programlisting">
1.100 rillig 4833: .if !defined(IS_BUILTIN.foo)
4834: #
4835: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4836: # genuinely exists in the system or not.
4837: #
4838: IS_BUILTIN.foo?= no
4839:
4840: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4841: # version can be determined.
4842: #
4843: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4844: BUILTIN_PKG.foo?= foo-1.0
4845: . endif
4846: .endif # IS_BUILTIN.foo
4847:
4848: .if !defined(USE_BUILTIN.foo)
4849: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4850: . if defined(BUILTIN_PKG.foo)
4851: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4852: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4853: USE_BUILTIN.foo!= \
4854: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4855: && ${ECHO} "yes" || ${ECHO} "no"
4856: . endif
4857: . endfor
4858: . endif
4859: .endif # USE_BUILTIN.foo
4860:
4861: CHECK_BUILTIN.foo?= no
4862: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4863: #
4864: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4865: # "yes" or "no".
4866: #
4867: .endif # CHECK_BUILTIN.foo
4868: </pre>
1.87 wiz 4869: <p>The first section sets
4870: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4871: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4872: in the base system. This should not be a base system software
4873: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 4874: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 4875: included as part of the base system. This variable is only
4876: used internally within the <code class="filename">builtin.mk</code>
4877: file.</p>
4878: <p>The second section sets
4879: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4880: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4881: system if it exists (if
4882: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4883: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 4884: within the <code class="filename">builtin.mk</code> file.</p>
4885: <p>The third section sets
4886: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4887: and is <span class="emphasis"><em>required</em></span> in all
4888: <code class="filename">builtin.mk</code> files. The code in this
4889: section must make the determination whether the built-in
4890: software is adequate to satisfy the dependencies listed in
4891: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4892: This is typically done by comparing
4893: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4894: against each of the dependencies in
4895: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4896: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4897: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4898: end of the <code class="filename">builtin.mk</code> file. Note that
4899: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4900: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 4901: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4902: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 4903: that the built-in version of the software is similar enough to
4904: be used as a replacement.</p>
4905: <p>The last section is guarded by
4906: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4907: and includes code that uses the value of
4908: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4909: set in the previous section. This typically includes, e.g.,
4910: adding additional dependency restrictions and listing additional
4911: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4912: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 4913: </div>
1.148 asau 4914: <div class="sect2">
1.75 rillig 4915: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4916: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 4917: <p>When building packages, it's possible to choose whether to set
4918: a global preference for using either the built-in (native)
4919: version or the pkgsrc version of software to satisfy a
4920: dependency. This is controlled by setting
4921: <code class="varname">PREFER_PKGSRC</code> and
4922: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 4923: 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 4924: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4925: use the pkgsrc versions of software, while
4926: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4927: built-in versions. Preferences are determined by the most
4928: specific instance of the package in either
4929: <code class="varname">PREFER_PKGSRC</code> or
4930: <code class="varname">PREFER_NATIVE</code>. If a package is specified
4931: in neither or in both variables, then
4932: <code class="varname">PREFER_PKGSRC</code> has precedence over
4933: <code class="varname">PREFER_NATIVE</code>. For example, to require
4934: using pkgsrc versions of software for all but the most basic
4935: bits on a NetBSD system, you can set:</p>
4936: <pre class="programlisting">
1.100 rillig 4937: PREFER_PKGSRC= yes
4938: PREFER_NATIVE= getopt skey tcp_wrappers
4939: </pre>
1.87 wiz 4940: <p>A package <span class="emphasis"><em>must</em></span> have a
4941: <code class="filename">builtin.mk</code>
4942: file to be listed in <code class="varname">PREFER_NATIVE</code>,
4943: otherwise it is simply ignored in that list.</p>
1.229 sevan 4944: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
4945: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
4946: bootstrap.
4947: Switching between settings globally at a later date can introduce
4948: complications with dependency resolution. This is caused by packages
4949: built with the opposite preference being installed alongside each other.</p>
4950: <pre class="screen">
4951: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
4952: </pre>
1.75 rillig 4953: </div>
4954: </div>
4955: </div>
1.148 asau 4956: <div class="chapter">
1.75 rillig 4957: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4958: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 4959: <div class="toc">
4960: <p><b>Table of Contents</b></p>
1.210 leot 4961: <dl class="toc">
1.106 rillig 4962: <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 4963: <dd><dl>
1.106 rillig 4964: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
4965: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 4966: </dl></dd>
1.106 rillig 4967: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 4968: <dd><dl>
1.128 wiz 4969: <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 4970: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
4971: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
4972: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
4973: </dl></dd>
4974: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
4975: <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>
4976: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
4977: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
4978: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
4979: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
4980: <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 4981: </dl>
4982: </div>
4983: <p>This chapter describes the framework known as
4984: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 4985: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4986: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 4987: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 4988: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 4989: provided that packages are correctly designed.</p></li>
1.128 wiz 4990: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
4991: <li class="listitem"><p>Registration of system users and groups.</p></li>
4992: <li class="listitem"><p>Registration of system shells.</p></li>
4993: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 4994: </ul></div>
4995: <p>The following sections inspect each of the above points in detail.</p>
4996: <p>You may be thinking that many of the things described here could be
4997: easily done with simple code in the package's post-installation target
4998: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
4999: as the code in them is only executed when building from source. Machines
5000: using binary packages could not benefit from it at all (as the code itself
5001: could be unavailable). Therefore, the only way to achieve any of the items
5002: described above is by means of the installation scripts, which are
5003: automatically generated by pkginstall.</p>
1.148 asau 5004: <div class="sect1">
1.75 rillig 5005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5006: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5007: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5008: of files and directories that belong to a package. The names used in it
1.76 rillig 5009: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5010: which means that it cannot register files outside this directory (absolute
5011: path names are not allowed). Despite this restriction, some packages need
5012: to install files outside this location; e.g., under
1.76 rillig 5013: <code class="filename">${VARBASE}</code> or
1.87 wiz 5014: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5015: is to create such files during installation time by using
5016: installation scripts.</p>
5017: <p>The generic installation scripts are shell scripts that can
5018: contain arbitrary code. The list of scripts to execute is taken from
5019: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5020: <code class="filename">INSTALL</code>. A similar variable exists for package
5021: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5022: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5023: commands, so they have the potential to create and manage files
5024: anywhere in the file system.</p>
5025: <p>Using these general installation files is not recommended, but
5026: may be needed in some special cases. One reason for avoiding them is
5027: that the user has to trust the packager that there is no unwanted or
5028: simply erroneous code included in the installation script. Also,
5029: previously there were many similar scripts for the same functionality,
5030: and fixing a common error involved finding and changing all of
5031: them.</p>
5032: <p>The pkginstall framework offers another, standardized way. It
5033: provides generic scripts to abstract the manipulation of such files
5034: and directories based on variables set in the package's
5035: <code class="filename">Makefile</code>. The rest of this section describes
5036: these variables.</p>
1.148 asau 5037: <div class="sect2">
1.75 rillig 5038: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5039: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5040: <p>The following variables can be set to request the creation of
5041: directories anywhere in the file system:</p>
1.148 asau 5042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218 rillig 5043: <li class="listitem">
5044: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5045: contain a list of directories that should be created and should attempt
5046: to be destroyed by the installation scripts. The difference between
5047: the two is that the latter prompts the administrator to remove any
5048: directories that may be left after deinstallation (because they were
1.218 rillig 5049: not empty), while the former does not. Example:</p>
5050: <pre class="programlisting">
5051: MAKE_DIRS+= ${VARBASE}/foo/private
5052: </pre>
5053: </li>
1.128 wiz 5054: <li class="listitem">
1.75 rillig 5055: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5056: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5057: which directories should be created and should attempt to be destroyed
5058: by the installation scripts. Each tuple holds the following values,
5059: separated by spaces: the directory name, its owner, its group and its
5060: numerical mode. For example:</p>
5061: <pre class="programlisting">
1.218 rillig 5062: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5063: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 grant 5064: </pre>
1.75 rillig 5065: <p>The difference between the two is exactly the same as their
5066: non-<code class="varname">PERMS</code> counterparts.</p>
5067: </li>
5068: </ul></div>
5069: </div>
1.148 asau 5070: <div class="sect2">
1.75 rillig 5071: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5072: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5073: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5074: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5075: To overcome this problem, the only solution is to extract the file in the
5076: known place (i.e., inside the installation prefix) and copy it to the
5077: appropriate location during installation (done by the installation scripts
5078: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5079: file</em></span> in the following paragraphs, which describe the variables
5080: that can be used to automatically and consistently handle files outside the
5081: installation prefix:</p>
1.148 asau 5082: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5083: <li class="listitem">
1.75 rillig 5084: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5085: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5086: During installation time, the master file is copied to the target one
5087: if and only if the latter does not exist. Upon deinstallation, the
5088: target file is removed provided that it was not modified by the
5089: installation.</p>
5090: <p>The difference between the two is that the latter prompts the
5091: administrator to remove any files that may be left after
5092: deinstallation (because they were not empty), while the former does
5093: not.</p>
5094: </li>
1.128 wiz 5095: <li class="listitem">
1.75 rillig 5096: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5097: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5098: files as well as their target locations. For each of them, it also
5099: specifies their owner, their group and their numeric permissions, in
5100: this order. For example:</p>
5101: <pre class="programlisting">
1.218 rillig 5102: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5103: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 grant 5104: </pre>
1.75 rillig 5105: <p>The difference between the two is exactly the same as their
5106: non-<code class="varname">PERMS</code> counterparts.</p>
5107: </li>
5108: </ul></div>
5109: </div>
5110: </div>
1.148 asau 5111: <div class="sect1">
1.75 rillig 5112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5113: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5114: <p>Configuration files are special in the sense that they are installed
5115: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5116: need special treatment during installation (most of which is automated by
5117: pkginstall). The main concept you must bear in mind is that files marked
5118: as configuration files are automatically copied to the right place (somewhere
5119: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5120: and only if</em></span> they didn't exist before. Similarly, they will not
5121: be removed if they have local modifications. This ensures that
5122: administrators never lose any custom changes they may have made.</p>
1.148 asau 5123: <div class="sect2">
1.75 rillig 5124: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5125: <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 5126: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5127: specifies where configuration files shall be installed. Its contents are
5128: set based upon the following variables:</p>
1.148 asau 5129: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5130: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5131: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5132: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5133: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5134: Packages must not use it directly.</p></li>
1.128 wiz 5135: <li class="listitem">
1.75 rillig 5136: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5137: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5138: for the package being built shall be installed. The definition of this
5139: variable only makes sense in the package's
1.76 rillig 5140: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5141: <p>As an example, consider the Apache package,
1.250 leot 5142: <a href="https://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 5143: configuration files under the
1.76 rillig 5144: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5145: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5146: Makefile.</p>
5147: </li>
1.128 wiz 5148: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5149: variable that holds this package's configuration directory (if
5150: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5151: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5152: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5153: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5154: directory where the configuration files for the package identified by
5155: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5156: </ul></div>
5157: <p>Based on the above variables, pkginstall determines the value of
5158: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5159: variable that can be used within a package to refer to its configuration
5160: directory. The algorithm used to set its value is basically the
5161: following:</p>
1.128 wiz 5162: <div class="orderedlist"><ol class="orderedlist" type="1">
5163: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5164: its value is used.</p></li>
1.128 wiz 5165: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5166: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5167: <code class="filename">Makefile</code>, the resulting value is
5168: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5169: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5170: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5171: </ol></div>
1.76 rillig 5172: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5173: 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
5174: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5175: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5176: </div>
1.148 asau 5177: <div class="sect2">
1.75 rillig 5178: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5179: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5180: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5181: known place, you need to teach each package where it shall install its
5182: files. In some cases you will have to patch the package Makefiles to
5183: achieve it. If you are lucky, though, it may be as easy as passing an
5184: extra flag to the configuration script; this is the case of GNU Autoconf-
5185: generated files:</p>
5186: <pre class="programlisting">
1.100 rillig 5187: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5188: </pre>
1.75 rillig 5189: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5190: for</em></span> its configuration files, not where they will be originally
5191: installed (although the difference is never explicit,
5192: unfortunately).</p>
5193: </div>
1.148 asau 5194: <div class="sect2">
1.75 rillig 5195: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5196: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5197: <p>As said before, pkginstall automatically handles configuration files.
5198: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5199: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5200: directly</strong></span>. Bad news is that many software installation scripts
5201: will, out of the box, mess with the contents of that directory. So what is
5202: the correct procedure to fix this issue?</p>
5203: <p>You must teach the package (usually by manually patching it) to
5204: install any configuration files under the examples hierarchy,
1.76 rillig 5205: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5206: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5207: has the original copies available.</p>
5208: <p>Once the required configuration files are in place (i.e., under the
5209: examples hierarchy), the pkginstall framework can use them as master copies
5210: during the package installation to update what is in
1.76 rillig 5211: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5212: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5213: 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 5214: about their syntax and their purpose. Here is an example, taken from the
1.250 leot 5215: <a href="https://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 5216: <pre class="programlisting">
1.100 rillig 5217: EGDIR= ${PREFIX}/share/doc/mutt/samples
5218: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5219: </pre>
1.75 rillig 5220: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5221: package and has no meaning outside it.</p>
5222: </div>
1.148 asau 5223: <div class="sect2">
1.75 rillig 5224: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5225: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5226: <p>The automatic copying of config files can be toggled by setting the
5227: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5228: installation.</p>
5229: </div>
5230: </div>
1.148 asau 5231: <div class="sect1">
1.75 rillig 5232: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5233: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5234: <p>System startup scripts are special files because they must be
5235: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5236: 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 5237: can be used. However, pkginstall provides a special mechanism to handle
5238: these files.</p>
5239: <p>In order to provide system startup scripts, the package has
5240: to:</p>
1.128 wiz 5241: <div class="orderedlist"><ol class="orderedlist" type="1">
5242: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5243: the <code class="literal">.sh</code> suffix appended. Considering the
1.250 leot 5244: <a href="https://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 5245: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5246: <li class="listitem">
1.75 rillig 5247: <p>Tell pkginstall to handle it, appending the name of the script,
5248: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5249: Continuing the previous example:</p>
5250: <pre class="programlisting">
1.100 rillig 5251: RCD_SCRIPTS+= cupsd
1.1 grant 5252: </pre>
1.75 rillig 5253: </li>
5254: </ol></div>
5255: <p>Once this is done, pkginstall will do the following steps for each
5256: script in an automated fashion:</p>
1.128 wiz 5257: <div class="orderedlist"><ol class="orderedlist" type="1">
5258: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5259: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5260: variable.</p></li>
1.128 wiz 5261: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5262: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5263: that this master file must be explicitly registered in the
1.76 rillig 5264: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5265: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5266: from the examples hierarchy into the system-wide startup scripts
5267: directory.</p></li>
5268: </ol></div>
1.148 asau 5269: <div class="sect2">
1.75 rillig 5270: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5271: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5272: <p>The automatic copying of config files can be toggled by setting the
5273: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5274: installation. Note that the scripts will be always copied inside the
1.76 rillig 5275: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5276: matter what the value of this variable is.</p>
5277: </div>
5278: </div>
1.148 asau 5279: <div class="sect1">
1.75 rillig 5280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5281: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5282: <p>If a package needs to create special users and/or groups during
5283: installation, it can do so by using the pkginstall framework.</p>
5284: <p>Users can be created by adding entries to the
5285: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5286: syntax:</p>
5287: <pre class="programlisting">
1.100 rillig 5288: user:group
1.1 grant 5289: </pre>
1.87 wiz 5290: <p>Further specification of user details may be done by setting
5291: per-user variables.
5292: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5293: numeric UID for the user.
5294: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5295: user's description or comment.
5296: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5297: user's home directory, and defaults to
5298: <code class="filename">/nonexistent</code> if not specified.
5299: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5300: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5301: not specified.</p>
1.75 rillig 5302: <p>Similarly, groups can be created by adding entries to the
5303: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5304: <pre class="programlisting">
1.100 rillig 5305: group
1.1 grant 5306: </pre>
1.93 rillig 5307: <p>The numeric GID of the group may be set by defining
1.75 rillig 5308: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5309: <p>If a package needs to create the users and groups at an earlier
1.227 wiz 5310: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5311: <code class="literal">configure</code>,<code class="literal">build</code>, or
5312: <code class="literal">pre-install</code> to indicate the phase before which the
5313: users and groups are created. In this case, the numeric UIDs and GIDs
5314: of the created users and groups are automatically hardcoded into the
5315: final installation scripts.</p>
1.75 rillig 5316: </div>
1.148 asau 5317: <div class="sect1">
1.75 rillig 5318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5319: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5320: <p>Packages that install system shells should register them in the shell
1.76 rillig 5321: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5322: administrator. This must be done from the installation scripts to keep
5323: binary packages working on any system. pkginstall provides an easy way to
5324: accomplish this task.</p>
5325: <p>When a package provides a shell interpreter, it has to set the
5326: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5327: add some hooks to the installation scripts to handle it. Consider the
1.250 leot 5328: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75 rillig 5329: <pre class="programlisting">
1.100 rillig 5330: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5331: </pre>
1.148 asau 5332: <div class="sect2">
1.75 rillig 5333: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5334: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5335: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5336: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5337: environment variable to <code class="literal">NO</code>.</p>
5338: </div>
5339: </div>
1.148 asau 5340: <div class="sect1">
1.75 rillig 5341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5342: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5343: <p>Packages that install X11 fonts should update the database files
5344: that index the fonts within each fonts directory. This can easily be
5345: accomplished within the pkginstall framework.</p>
5346: <p>When a package installs X11 fonts, it must list the directories in
5347: which fonts are installed in the
5348: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5349: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5350: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.75 rillig 5351: installation scripts to run the appropriate commands to update the fonts
5352: database files within each of those directories. For convenience, if the
5353: directory path is relative, it is taken to be relative to the package's
1.250 leot 5354: installation prefix. Consider the following example, taken from <a href="https://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 5355: <pre class="programlisting">
1.175 wiz 5356: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5357: </pre>
1.148 asau 5358: <div class="sect2">
1.75 rillig 5359: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5360: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5361: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5362: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5363: environment variable to <code class="literal">NO</code>.</p>
5364: </div>
5365: </div>
5366: </div>
1.148 asau 5367: <div class="chapter">
1.75 rillig 5368: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5369: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 5370: <div class="toc">
5371: <p><b>Table of Contents</b></p>
1.210 leot 5372: <dl class="toc">
1.106 rillig 5373: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 5374: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 5375: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 5376: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 5377: </dl>
5378: </div>
5379: <p>Many packages have the ability to be built to support different
1.76 rillig 5380: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 5381: in pkgsrc that provides generic handling of those options that
5382: determine different ways in which the packages can be built. It's
5383: possible for the user to specify exactly which sets of options will be
5384: built into a package or to allow a set of global default options
5385: apply.</p>
1.107 rillig 5386: <p>There are two broad classes of behaviors that one might want to
5387: control via options. One is whether some particular feature is
5388: enabled in a program that will be built anyway, often by including or
5389: not including a dependency on some other package. The other is
5390: whether or not an additional program will be built as part of the
5391: package. Generally, it is better to make a split package for such
5392: additional programs instead of using options, because it enables
5393: binary packages to be built which can then be added separately. For
5394: example, the foo package might have minimal dependencies (those
5395: packages without which foo doesn't make sense), and then the foo-gfoo
5396: package might include the GTK frontend program gfoo. This is better
5397: than including a gtk option to foo that adds gfoo, because either that
5398: option is default, in which case binary users can't get foo without
5399: gfoo, or not default, in which case they can't get gfoo. With split
5400: packages, they can install foo without having GTK, and later decide to
5401: install gfoo (pulling in GTK at that time). This is an advantage to
5402: source users too, avoiding the need for rebuilds.</p>
5403: <p>Plugins with widely varying dependencies should usually be split
5404: instead of options.</p>
5405: <p>It is often more work to maintain split packages, especially if
5406: the upstream package does not support this. The decision of split
5407: vs. option should be made based on the likelihood that users will want
5408: or object to the various pieces, the size of the dependencies that are
5409: included, and the amount of work.</p>
5410: <p>A further consideration is licensing. Non-free parts, or parts
5411: that depend on non-free dependencies (especially plugins) should
5412: almost always be split if feasible.</p>
1.148 asau 5413: <div class="sect1">
1.75 rillig 5414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5415: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 5416: <p>Global default options are listed in
5417: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5418: that should be built into every package if that option is supported.
1.110 hubertf 5419: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5420: </div>
1.148 asau 5421: <div class="sect1">
1.75 rillig 5422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5423: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 5424: </h2></div></div></div>
1.75 rillig 5425: <p>The following example shows how
1.76 rillig 5426: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 5427: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 5428: <code class="filename">Makefile</code>, or in a file,
5429: e.g. <code class="filename">options.mk</code>, that is included by the
5430: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5431: <pre class="programlisting">
1.100 rillig 5432: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5433: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5434: PKG_OPTIONS_OPTIONAL_GROUPS= database
5435: PKG_OPTIONS_GROUP.database= mysql pgsql
5436: PKG_SUGGESTED_OPTIONS= wibble-foo
5437: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5438: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5439:
5440: .include "../../mk/bsd.prefs.mk"
5441:
5442: # this package was previously named wibble2
5443: .if defined(PKG_OPTIONS.wibble2)
5444: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5445: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5446: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5447: .endif
5448:
5449: .include "../../mk/bsd.options.mk"
5450:
5451: # Package-specific option-handling
5452:
5453: ###
5454: ### FOO support
5455: ###
5456: .if !empty(PKG_OPTIONS:Mwibble-foo)
5457: CONFIGURE_ARGS+= --enable-foo
5458: .endif
5459:
5460: ###
5461: ### LDAP support
5462: ###
5463: .if !empty(PKG_OPTIONS:Mldap)
5464: . include "../../databases/openldap-client/buildlink3.mk"
5465: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5466: .endif
5467:
5468: ###
5469: ### database support
5470: ###
5471: .if !empty(PKG_OPTIONS:Mmysql)
5472: . include "../../mk/mysql.buildlink3.mk"
5473: .endif
5474: .if !empty(PKG_OPTIONS:Mpgsql)
5475: . include "../../mk/pgsql.buildlink3.mk"
5476: .endif
1.75 rillig 5477: </pre>
5478: <p>The first section contains the information about which build
5479: options are supported by the package, and any default options settings
5480: if needed.</p>
1.128 wiz 5481: <div class="orderedlist"><ol class="orderedlist" type="1">
5482: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.257 leot 5483: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75 rillig 5484: options. It should be set to
1.78 rillig 5485: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5486: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5487: at the point where the options are processed.</p></li>
1.128 wiz 5488: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 5489: build options supported by the package.</p></li>
1.128 wiz 5490: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 5491: list of names of groups of mutually exclusive options. The options in
5492: each group are listed in
5493: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5494: The most specific setting of any option from the group takes
5495: precedence over all other options in the group. Options from the
5496: groups will be automatically added to
5497: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 5498: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 5499: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5500: packages will fail if no option from the group is
5501: selected.</p></li>
1.128 wiz 5502: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 5503: of names of sets of options. At least one option from each set must
5504: be selected. The options in each set are listed in
5505: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5506: Options from the sets will be automatically added to
5507: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5508: fail if no option from the set is selected.</p></li>
1.128 wiz 5509: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 5510: build options which are enabled by default.</p></li>
1.128 wiz 5511: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 5512: of
1.128 wiz 5513: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.110 hubertf 5514: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 5515: their option counterparts. Pairs should be added with
1.128 wiz 5516: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 5517: warning will be issued if the user uses a legacy
5518: variable.</p></li>
1.128 wiz 5519: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 5520: of
1.128 wiz 5521: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.75 rillig 5522: pairs that map options that have been renamed to their new
1.128 wiz 5523: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 5524: the listing of global legacy options. A warning will be issued if
5525: the user uses a legacy option.</p></li>
1.128 wiz 5526: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 5527: options implied by deprecated variables used. This can be used for
5528: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5529: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5530: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 5531: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 5532: a list of warnings about deprecated variables or options used, and
5533: what to use instead.</p></li>
5534: </ol></div>
5535: <p>A package should never modify
5536: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5537: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5538: To suggest a default set of options, use
5539: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5540: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 5541: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 5542: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5543: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5544: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5545: happen with platform-specific options if none of them is supported on
5546: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5547: empty list and the package is otherwise treated as not using the
5548: options framework.</p>
1.76 rillig 5549: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 5550: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5551: build options, properly filtered to remove unsupported and duplicate
5552: options.</p>
5553: <p>The remaining sections contain the logic that is specific to
5554: each option. The correct way to check for an option is to check
5555: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5556: <pre class="programlisting">
1.100 rillig 5557: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 5558: </pre>
5559: </div>
1.148 asau 5560: <div class="sect1">
1.75 rillig 5561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5562: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 5563: <p>Options that enable similar features in different packages (like
5564: optional support for a library) should use a common name in all
5565: packages that support it (like the name of the library). If another
5566: package already has an option with the same meaning, use the same
5567: name.</p>
5568: <p>Options that enable features specific to one package, where it's
5569: unlikely that another (unrelated) package has the same (or a similar)
5570: optional feature, should use a name prefixed with
5571: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5572: <p>If a group of related packages share an optional feature
5573: specific to that group, prefix it with the name of the
1.128 wiz 5574: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 5575: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5576: <p>For new options, add a line to
1.76 rillig 5577: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 5578: fields, separated by tab. The first field is the option name, the
5579: second its description. The description should be a whole sentence
5580: (starting with an uppercase letter and ending with a period) that
1.128 wiz 5581: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5582: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 5583: </div>
1.148 asau 5584: <div class="sect1">
1.107 rillig 5585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5586: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 5587: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107 rillig 5588: different dependencies based on the options with which the package was
5589: built. For querying these options, the file
5590: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5591: typical example looks like this:</p>
5592: <pre class="programlisting">
5593: pkgbase := libpurple
5594: .include "../../mk/pkg-build-options.mk"
5595:
5596: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5597: ...
5598: .endif
5599: </pre>
5600: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5601: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5602: options of the libpurple package, which can then be queried like
5603: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5604: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5605: details.</p>
5606: </div>
1.75 rillig 5607: </div>
1.148 asau 5608: <div class="chapter">
1.75 rillig 5609: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5610: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 5611: <div class="toc">
5612: <p><b>Table of Contents</b></p>
1.210 leot 5613: <dl class="toc">
1.106 rillig 5614: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
5615: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
5616: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
5617: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 5618: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 5619: <dd><dl>
5620: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
5621: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
5622: </dl></dd>
1.128 wiz 5623: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5624: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5625: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5626: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5627: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5628: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5629: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5630: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5631: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5632: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 5633: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
5634: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 5635: </dl>
5636: </div>
1.148 asau 5637: <div class="sect1">
1.75 rillig 5638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5639: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 5640: <p>This chapter gives a detailed description on how a package is
1.87 wiz 5641: built. Building a package is separated into different
5642: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5643: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 5644: described in the following sections. Each phase is split into
1.87 wiz 5645: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5646: containing phase, prefixed by one of <code class="varname">pre-</code>,
5647: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5648: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5649: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 5650: <p>Never override the regular targets (like
5651: <code class="varname">fetch</code>), if you have to, override the
5652: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 5653: <p>The basic steps for building a program are always the same. First
1.87 wiz 5654: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5655: the local system and then extracted. After any pkgsrc-specific patches
5656: to compile properly are applied, the software can be configured, then
5657: built (usually by compiling), and finally the generated binaries, etc.
5658: can be put into place on the system.</p>
1.97 rillig 5659: <p>To get more details about what is happening at each step,
5660: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5661: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5662: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 5663: </div>
1.148 asau 5664: <div class="sect1">
1.75 rillig 5665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5666: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 5667: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 5668: the next section, here's a brief discussion on where programs are
5669: installed, and which variables influence this.</p>
1.75 rillig 5670: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 5671: where all files of the final program shall be installed. It is
5672: usually set to <code class="varname">LOCALBASE</code>
5673: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 5674: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 5675: <code class="varname">PREFIX</code> needs to be put
5676: into the various places in the program's source where paths to
1.219 rillig 5677: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.75 rillig 5678: <p>When choosing which of these variables to use,
1.87 wiz 5679: follow the following rules:</p>
1.148 asau 5680: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5681: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 5682: where the current pkg will be installed. When referring to a
5683: pkg's own installation path, use
1.128 wiz 5684: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5685: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 5686: are installed. If you need to construct a -I or -L argument
5687: to the compiler to find includes and libraries installed by
1.128 wiz 5688: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 5689: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5690: installed all packages in <code class="filename">/usr/local</code>. As
5691: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5692: administrator, this variable is a misnomer.</p></li>
1.128 wiz 5693: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 5694: distribution (from xsrc, etc.) is installed. When looking for
5695: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 5696: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.209 sevan 5697: <li class="listitem"><p>X11-based packages using imake must set
5698: <code class="varname">USE_IMAKE</code> to be installed correctly under
5699: <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5700: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.257 leot 5701: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 5702: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5703: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 5704: </ul></div>
5705: </div>
1.148 asau 5706: <div class="sect1">
1.75 rillig 5707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5708: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 5709: <p>When building a package, various directories are used to store
1.87 wiz 5710: source files, temporary files, pkgsrc-internal files, and so on. These
5711: directories are explained here.</p>
1.75 rillig 5712: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 5713: are two common base directories for these relative directories:
5714: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5715: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5716: inside the package itself.</p>
1.148 asau 5717: <div class="variablelist"><dl class="variablelist">
1.75 rillig 5718: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5719: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 5720: root directory. Generally, you don't need
5721: it.</p></dd>
1.97 rillig 5722: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5723: <dd><p>This is an absolute pathname that points to the
5724: current package.</p></dd>
1.75 rillig 5725: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5726: <dd><p>This is a pathname relative to
1.87 wiz 5727: <code class="varname">PKGSRCDIR</code> that points to the current
5728: package.</p></dd>
1.75 rillig 5729: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5730: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 5731: where all work takes place. The distfiles are extracted to this
1.87 wiz 5732: directory. It also contains temporary directories and log files used by
5733: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5734: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 5735: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5736: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 5737: where the distfiles are extracted. It is usually a direct subdirectory
5738: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5739: that isn't hidden. This variable may be changed by a package
5740: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 5741: </dl></div>
1.114 jmcneill 5742: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5743: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 5744: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 5745: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5746: If users would like to have their pkgsrc trees behave in a
5747: read-only manner, then the value of
5748: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5749: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 5750: </div>
1.148 asau 5751: <div class="sect1">
1.75 rillig 5752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5753: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 5754: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 5755: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5756: phase. This will automatically run all phases that are required for this
5757: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 5758: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 5759: the package will be built, but not installed.</p>
1.75 rillig 5760: </div>
1.148 asau 5761: <div class="sect1">
1.75 rillig 5762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5763: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 5764: <p>The first step in building a package is to fetch the
1.88 wiz 5765: distribution files (distfiles) from the sites that are providing
5766: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5767: phase.</p>
1.148 asau 5768: <div class="sect2">
1.81 rillig 5769: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5770: <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 5771: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5772: defines all URLs from where the distfile, whose name is
5773: derived from the <code class="varname">DISTNAME</code> variable, is
5774: fetched. The more complicated cases are described
5775: below.</p>
5776: <p>The variable <code class="varname">DISTFILES</code> specifies
5777: the list of distfiles that have to be fetched. Its value
1.174 asau 5778: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5779: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 5780: so that most packages don't need to define it at all.
5781: <code class="varname">EXTRACT_SUFX</code> is
5782: <code class="literal">.tar.gz</code> by default, but can be changed
5783: freely. Note that if your package requires additional
5784: distfiles to the default one, you cannot just append the
5785: additional filenames using the <code class="literal">+=</code>
5786: operator, but you have write for example:</p>
1.81 rillig 5787: <pre class="programlisting">
1.174 asau 5788: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 5789: </pre>
1.88 wiz 5790: <p>Each distfile is fetched from a list of sites, usually
5791: <code class="varname">MASTER_SITES</code>. If the package has multiple
5792: <code class="varname">DISTFILES</code> or multiple
5793: <code class="varname">PATCHFILES</code> from different sites, you can
5794: set
5795: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5796: to the list of URLs where the file
5797: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5798: (including the suffix) can be found.</p>
5799: <pre class="programlisting">
1.100 rillig 5800: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5801: DISTFILES+= foo-file.tar.gz
5802: SITES.foo-file.tar.gz= \
5803: http://www.somewhere.com/somehow/ \
5804: http://www.somewhereelse.com/mirror/somehow/
5805: </pre>
1.81 rillig 5806: <p>When actually fetching the distfiles, each item from
1.88 wiz 5807: <code class="varname">MASTER_SITES</code> or
5808: <code class="varname">SITES.*</code> gets the name of each distfile
5809: appended to it, without an intermediate slash. Therefore,
5810: all site values have to end with a slash or other separator
5811: character. This allows for example to set
5812: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5813: that gets the name of the distfile as a parameter. In this
5814: case, the definition would look like:</p>
1.81 rillig 5815: <pre class="programlisting">
1.100 rillig 5816: MASTER_SITES= http://www.example.com/download.cgi?file=
5817: </pre>
1.125 wiz 5818: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 5819: In that case the URL is taken as is, fetched and the result
5820: stored under the name of the distfile. You can use this style
5821: for the case when the download URL style does not match the
5822: above common case. For example, if permanent download URL is a
5823: redirector to the real download URL, or the download file name
5824: is offered by an HTTP Content-Disposition header. In the
5825: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5826: created instead of the default
5827: <code class="filename">v1.0.0.tar.gz</code>.</p>
5828: <pre class="programlisting">
5829: DISTNAME= foo-1.0.0
5830: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5831: </pre>
1.81 rillig 5832: <p>There are some predefined values for
1.88 wiz 5833: <code class="varname">MASTER_SITES</code>, which can be used in
5834: packages. The names of the variables should speak for
5835: themselves.</p>
5836: <pre class="programlisting">
1.100 rillig 5837: ${MASTER_SITE_APACHE}
5838: ${MASTER_SITE_BACKUP}
5839: ${MASTER_SITE_CYGWIN}
5840: ${MASTER_SITE_DEBIAN}
5841: ${MASTER_SITE_FREEBSD}
5842: ${MASTER_SITE_FREEBSD_LOCAL}
5843: ${MASTER_SITE_GENTOO}
5844: ${MASTER_SITE_GNOME}
5845: ${MASTER_SITE_GNU}
5846: ${MASTER_SITE_GNUSTEP}
1.174 asau 5847: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 5848: ${MASTER_SITE_IFARCHIVE}
5849: ${MASTER_SITE_KDE}
5850: ${MASTER_SITE_MOZILLA}
1.174 asau 5851: ${MASTER_SITE_MOZILLA_ALL}
5852: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 5853: ${MASTER_SITE_MYSQL}
1.174 asau 5854: ${MASTER_SITE_NETLIB}
1.100 rillig 5855: ${MASTER_SITE_OPENOFFICE}
1.208 ryoon 5856: ${MASTER_SITE_OSDN}
1.100 rillig 5857: ${MASTER_SITE_PERL_CPAN}
5858: ${MASTER_SITE_PGSQL}
1.174 asau 5859: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 5860: ${MASTER_SITE_R_CRAN}
5861: ${MASTER_SITE_SOURCEFORGE}
5862: ${MASTER_SITE_SUNSITE}
5863: ${MASTER_SITE_SUSE}
5864: ${MASTER_SITE_TEX_CTAN}
5865: ${MASTER_SITE_XCONTRIB}
5866: ${MASTER_SITE_XEMACS}
1.174 asau 5867: ${MASTER_SITE_XORG}
1.100 rillig 5868: </pre>
1.88 wiz 5869: <p>Some explanations for the less self-explaining ones:
5870: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 5871: 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 5872: 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 5873: <p>If you choose one of these predefined sites, you may
5874: want to specify a subdirectory of that site. Since these
5875: macros may expand to more than one actual site, you
5876: <span class="emphasis"><em>must</em></span> use the following construct to
5877: specify a subdirectory:</p>
1.81 rillig 5878: <pre class="programlisting">
1.100 rillig 5879: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5880: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5881: </pre>
1.81 rillig 5882: <p>Note the trailing slash after the subdirectory
1.88 wiz 5883: name.</p>
1.81 rillig 5884: </div>
1.148 asau 5885: <div class="sect2">
1.81 rillig 5886: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5887: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 5888: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5889: all the distfiles exist in a local directory
1.93 rillig 5890: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 5891: user). If the files do not exist, they are fetched using
5892: commands of the form</p>
1.75 rillig 5893: <pre class="programlisting">
1.100 rillig 5894: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5895: </pre>
1.88 wiz 5896: <p>where <code class="literal">${site}</code> varies through
5897: several possibilities in turn: first,
5898: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
5899: sites specified in either <code class="varname">SITES.file</code> if
5900: defined, else <code class="varname">MASTER_SITES</code> or
5901: <code class="varname">PATCH_SITES</code>, as applies, then finally the
5902: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 5903: all except the first and the last can be optionally sorted
5904: by the user, via setting either
5905: <code class="varname">MASTER_SORT_RANDOM</code>, and
5906: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 5907: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 5908: <p> The specific command and arguments used depend on the
5909: <code class="varname">FETCH_USING</code> parameter. The example above is
5910: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 5911: <p>The distfiles mirror run by the NetBSD Foundation uses the
5912: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
5913: distfiles, if they are freely distributable. Packages setting
5914: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 5915: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 5916: mirrored.</p>
1.81 rillig 5917: </div>
1.75 rillig 5918: </div>
1.148 asau 5919: <div class="sect1">
1.75 rillig 5920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5921: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 5922: <p>After the distfile(s) are fetched, their checksum is
5923: generated and compared with the checksums stored in the
5924: distinfo file. If the checksums don't match, the build is
5925: aborted. This is to ensure the same distfile is used for
5926: building, and that the distfile wasn't changed, e.g. by some
5927: malign force, deliberately changed distfiles on the master
5928: distribution site or network lossage.</p>
1.75 rillig 5929: </div>
1.148 asau 5930: <div class="sect1">
1.75 rillig 5931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5932: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 5933: <p>When the distfiles are present on the local system, they
1.88 wiz 5934: need to be extracted, as they usually come in the form of some
5935: compressed archive format.</p>
1.75 rillig 5936: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 5937: extracted. If you only need some of them, you can set the
5938: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
5939: files.</p>
5940: <p>Extracting the files is usually done by a little
1.93 rillig 5941: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 5942: already knows how to extract various archive formats, so most
5943: likely you will not need to change anything here. But if you
5944: need, the following variables may help you:</p>
1.148 asau 5945: <div class="variablelist"><dl class="variablelist">
1.75 rillig 5946: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
5947: <dd><p>Use these variables to override the default
1.88 wiz 5948: options for an extract command, which are defined in
1.93 rillig 5949: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 5950: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
5951: <dd><p>This variable can be set to
1.114 jmcneill 5952: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
5953: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 5954: absolute pathname pointing to the command with which tar
1.114 jmcneill 5955: archives should be extracted. It is preferred to choose bsdtar over gtar
5956: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 5957: </dl></div>
1.88 wiz 5958: <p>If the <code class="filename">extract</code> program doesn't
5959: serve your needs, you can also override the
5960: <code class="varname">EXTRACT_CMD</code> variable, which holds the
5961: command used for extracting the files. This command is
5962: executed in the <code class="filename">${WRKSRC}</code>
5963: directory. During execution of this command, the shell
5964: variable <code class="varname">extract_file</code> holds the absolute
5965: pathname of the file that is going to be extracted.</p>
1.75 rillig 5966: <p>And if that still does not suffice, you can override the
1.88 wiz 5967: <code class="varname">do-extract</code> target in the package
5968: Makefile.</p>
1.75 rillig 5969: </div>
1.148 asau 5970: <div class="sect1">
1.75 rillig 5971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5972: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 5973: <p>After extraction, all the patches named by the
1.88 wiz 5974: <code class="varname">PATCHFILES</code>, those present in the patches
5975: subdirectory of the package as well as in
5976: $LOCALPATCHES/$PKGPATH (e.g.
5977: <code class="filename">/usr/local/patches/graphics/png</code>) are
5978: applied. Patchfiles ending in <code class="filename">.Z</code> or
5979: <code class="filename">.gz</code> are uncompressed before they are
5980: applied, files ending in <code class="filename">.orig</code> or
5981: <code class="filename">.rej</code> are ignored. Any special options to
1.257 leot 5982: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.219 rillig 5983: <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.257 leot 5984: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 5985: it fail if the patches apply with some lines of fuzz. Please
5986: fix (regen) the patches so that they apply cleanly. The
5987: rationale behind this is that patches that don't apply cleanly
5988: may end up being applied in the wrong place, and cause severe
5989: harm there.</p>
1.75 rillig 5990: </div>
1.148 asau 5991: <div class="sect1">
1.75 rillig 5992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5993: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 5994: <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 5995: </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.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6000: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6001: linkers. The following variables can be used to tweak the
6002: wrappers.</p>
1.148 asau 6003: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6004: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6005: <dd><p>The command used to print progress
1.88 wiz 6006: messages. Does nothing by default. Set to
6007: <code class="literal">${ECHO}</code> to see the progress
6008: messages.</p></dd>
1.75 rillig 6009: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6010: <dd><p>This variable can be set to
1.88 wiz 6011: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6012: depending on whether you want additional information in the
6013: wrapper log file.</p></dd>
1.75 rillig 6014: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6015: <dd><p>This variable can be set to
1.88 wiz 6016: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6017: on whether the wrapper should use its cache, which will
6018: improve the speed. The default value is
6019: <code class="literal">yes</code>, but is forced to
6020: <code class="literal">no</code> if the platform does not support
6021: it.</p></dd>
1.75 rillig 6022: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6023: <dd><p>A list of reordering commands. A reordering
6024: command has the form
6025: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6026: It ensures that that
6027: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6028: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6029: </p></dd>
1.75 rillig 6030: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6031: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6032: investigate further]</p></dd>
1.75 rillig 6033: </dl></div>
6034: </div>
1.148 asau 6035: <div class="sect1">
1.75 rillig 6036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6037: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6038: <p>Most pieces of software need information on the header
6039: files, system calls, and library routines which are available
6040: on the platform they run on. The process of determining this
6041: information is known as configuration, and is usually
6042: automated. In most cases, a script is supplied with the
6043: distfiles, and its invocation results in generation of header
6044: files, Makefiles, etc.</p>
6045: <p>If the package contains a configure script, this can be
6046: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6047: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6048: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6049: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6050: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6051: <pre class="programlisting">
1.100 rillig 6052: .for d in ${CONFIGURE_DIRS}
6053: cd ${WRKSRC} \
6054: && cd ${d} \
6055: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6056: .endfor
6057: </pre>
1.88 wiz 6058: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6059: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6060: <code class="varname">WRKSRC</code>. In each of these directories, the
6061: configure script is run with the environment
6062: <code class="varname">CONFIGURE_ENV</code> and arguments
6063: <code class="varname">CONFIGURE_ARGS</code>. The variables
6064: <code class="varname">CONFIGURE_ENV</code>,
6065: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6066: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6067: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6068: package.</p>
1.144 wiz 6069: <p>If the program uses the Perl way of configuration (mainly Perl
6070: modules, but not only), i.e. a file called
6071: <code class="filename">Makefile.PL</code>, it should include
6072: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6073: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6074: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6075: <p>If the program uses an <code class="filename">Imakefile</code>
6076: for configuration, the appropriate steps can be invoked by
6077: setting <code class="varname">USE_IMAKE</code> to
1.209 sevan 6078: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6079: You can add variables to xmkmf's environment by adding them to the
1.97 rillig 6080: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6081: <p>If the program uses <code class="filename">cmake</code>
6082: for configuration, the appropriate steps can be invoked by
1.128 wiz 6083: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6084: You can add variables to cmake's environment by adding them to the
6085: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6086: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6087: The top directory argument is given by the
6088: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6089: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6090: <p>If there is no configure step at all, set
1.128 wiz 6091: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6092: </div>
1.148 asau 6093: <div class="sect1">
1.75 rillig 6094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6095: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6096: <p>For building a package, a rough equivalent of the
6097: following code is executed.</p>
1.75 rillig 6098: <pre class="programlisting">
1.100 rillig 6099: .for d in ${BUILD_DIRS}
6100: cd ${WRKSRC} \
6101: && cd ${d} \
6102: && env ${MAKE_ENV} \
6103: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6104: -f ${MAKE_FILE} \
6105: ${BUILD_TARGET}
6106: .endfor
6107: </pre>
1.88 wiz 6108: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6109: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6110: <code class="varname">WRKSRC</code>. In each of these directories,
6111: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6112: <code class="varname">MAKE_ENV</code> and arguments
6113: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6114: <code class="varname">MAKE_ENV</code>,
6115: <code class="varname">BUILD_MAKE_FLAGS</code>,
6116: <code class="varname">MAKE_FILE</code> and
6117: <code class="varname">BUILD_TARGET</code> may all be changed by the
6118: package.</p>
1.75 rillig 6119: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6120: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6121: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6122: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6123: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6124: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6125: <p>If there is no build step at all, set
1.128 wiz 6126: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6127: </div>
1.148 asau 6128: <div class="sect1">
1.75 rillig 6129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6130: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6131: <p>[TODO]</p>
6132: </div>
1.148 asau 6133: <div class="sect1">
1.75 rillig 6134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6135: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6136: <p>Once the build stage has completed, the final step is to
1.88 wiz 6137: install the software in public directories, so users can
6138: access the programs and files.</p>
1.75 rillig 6139: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6140: equivalent of the following code is executed. Additionally,
6141: before and after this code, much magic is performed to do
6142: consistency checks, registering the package, and so on.</p>
6143: <pre class="programlisting">
1.100 rillig 6144: .for d in ${INSTALL_DIRS}
6145: cd ${WRKSRC} \
6146: && cd ${d} \
6147: && env ${MAKE_ENV} \
6148: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6149: -f ${MAKE_FILE} \
6150: ${INSTALL_TARGET}
6151: .endfor
6152: </pre>
1.75 rillig 6153: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6154: <span class="emphasis"><em>build</em></span> phase.
6155: <code class="varname">INSTALL_DIRS</code> defaults to
6156: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6157: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6158: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6159: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6160: defined.</p>
1.75 rillig 6161: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6162: variables are useful. They are all variations of the
1.257 leot 6163: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 6164: permissions preset. <code class="varname">INSTALL</code> is the plain
6165: install command. The specialized variants, together with their
6166: intended use, are:</p>
1.148 asau 6167: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6168: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6169: <dd><p>directories that contain
6170: binaries</p></dd>
1.75 rillig 6171: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6172: <dd><p>directories that contain
6173: scripts</p></dd>
1.75 rillig 6174: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6175: <dd><p>directories that contain shared and static
6176: libraries</p></dd>
1.75 rillig 6177: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6178: <dd><p>directories that contain data
6179: files</p></dd>
1.75 rillig 6180: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6181: <dd><p>directories that contain man
6182: pages</p></dd>
1.210 leot 6183: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6184: <dd><p>directories that contain data files for games
6185: </p></dd>
1.75 rillig 6186: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6187: <dd><p>binaries that can be stripped from debugging
6188: symbols</p></dd>
1.75 rillig 6189: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6190: <dd><p>binaries that cannot be
6191: stripped</p></dd>
1.75 rillig 6192: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6193: <dd><p>game
6194: binaries</p></dd>
1.75 rillig 6195: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6196: <dd><p>shared and static
6197: libraries</p></dd>
1.75 rillig 6198: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6199: <dd><p>data files</p></dd>
6200: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6201: <dd><p>data files for
6202: games</p></dd>
1.75 rillig 6203: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6204: <dd><p>man pages</p></dd>
6205: </dl></div>
6206: <p>Some other variables are:</p>
1.148 asau 6207: <div class="variablelist"><dl class="variablelist">
1.216 tnn 6208: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.257 leot 6209: <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-8.0"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.216 tnn 6210: when installing binaries. Any debugging sections and symbols present in
6211: binaries will be preserved.
6212: </p></dd>
1.75 rillig 6213: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6214: <dd><p>A list of directories relative to
1.88 wiz 6215: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6216: beginning of the <span class="emphasis"><em>install</em></span> phase.
6217: The package is supposed to create all needed directories itself
6218: before installing files to it and list all other directories here.
6219: </p></dd>
1.75 rillig 6220: </dl></div>
1.97 rillig 6221: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6222: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6223: mostly relevant for packages in the <code class="filename">regress</code>
6224: category.</p>
1.75 rillig 6225: </div>
1.148 asau 6226: <div class="sect1">
1.75 rillig 6227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6228: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6229: <p>Once the install stage has completed, a binary package of
6230: the installed files can be built. These binary packages can be
6231: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6232: the <span class="command"><strong>make bin-install</strong></span> or by using
6233: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6234: <p>By default, the binary packages are created in
6235: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6236: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6237: one for each category in the <code class="varname">CATEGORIES</code>
6238: variable. <code class="varname">PACKAGES</code> defaults to
6239: <code class="filename">pkgsrc/packages</code>.</p>
6240: </div>
1.148 asau 6241: <div class="sect1">
1.88 wiz 6242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6243: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6244: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6245: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6246: to clean the work directories of all dependencies too, use
1.110 hubertf 6247: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6248: </div>
1.148 asau 6249: <div class="sect1">
1.75 rillig 6250: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6251: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6252: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6253: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6254: <dd><p>For any of the main targets described in the
6255: previous section, two auxiliary targets exist with
1.128 wiz 6256: <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 6257: prefix for the main target's name. These targets are
1.88 wiz 6258: invoked before and after the main target is called,
6259: allowing extra configuration or installation steps be
6260: performed from a package's Makefile, for example, which
6261: a program's configure script or install target
6262: omitted.</p></dd>
1.75 rillig 6263: <dt><span class="term">do-*</span></dt>
1.88 wiz 6264: <dd><p>Should one of the main targets do the wrong thing,
6265: and should there be no variable to fix this, you can
6266: redefine it with the do-* target. (Note that redefining
6267: the target itself instead of the do-* target is a bad
6268: idea, as the pre-* and post-* targets won't be called
6269: anymore, etc.) You will not usually need to do
6270: this.</p></dd>
1.75 rillig 6271: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6272: <dd>
1.110 hubertf 6273: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6274: you noticed some file was not installed properly, you
6275: can repeat the installation with this target, which will
1.128 wiz 6276: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6277: <p>This is the default value of
6278: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6279: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6280: package</strong></span>, where the defaults are
1.128 wiz 6281: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6282: respectively.</p>
6283: </dd>
1.75 rillig 6284: <dt><span class="term">deinstall</span></dt>
6285: <dd>
1.257 leot 6286: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 6287: current directory, effectively de-installing the
6288: package. The following variables can be used to tune the
6289: behaviour:</p>
1.148 asau 6290: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6291: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.257 leot 6292: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 6293: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6294: <dd><p>Remove all packages that require (depend on)
6295: the given package. This can be used to remove any
6296: packages that may have been pulled in by a given
1.110 hubertf 6297: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6298: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6299: <code class="filename">pkgsrc/x11/kde</code>, this is
6300: likely to remove whole KDE. Works by adding
1.257 leot 6301: <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-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 6302: command line.</p></dd>
1.75 rillig 6303: </dl></div>
6304: </dd>
1.88 wiz 6305: <dt><span class="term">bin-install</span></dt>
6306: <dd><p>Install a binary package from local disk and via FTP
6307: from a list of sites (see the
6308: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6309: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6310: available anywhere. The arguments given to
1.110 hubertf 6311: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6312: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6313: operation, etc.</p></dd>
1.205 wiz 6314: <dt><span class="term">install-clean</span></dt>
6315: <dd><p>This target removes the state files for the "install" and later
6316: phases so that the "install" target may be re-invoked. This can be
6317: used after editing the PLIST to install the package without
6318: rebuilding it.</p></dd>
6319: <dt><span class="term">build-clean</span></dt>
6320: <dd><p>This target removes the state files for the "build" and later
6321: phases so that the "build" target may be re-invoked.</p></dd>
1.75 rillig 6322: <dt><span class="term">update</span></dt>
6323: <dd>
1.88 wiz 6324: <p>This target causes the current package to be
6325: updated to the latest version. The package and all
6326: depending packages first get de-installed, then current
6327: versions of the corresponding packages get compiled and
6328: installed. This is similar to manually noting which
6329: packages are currently installed, then performing a
1.110 hubertf 6330: series of <span class="command"><strong>make deinstall</strong></span> and
6331: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 6332: <code class="varname">UPDATE_TARGET</code> is set to) for these
6333: packages.</p>
1.128 wiz 6334: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 6335: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 6336: update</strong></span> was interrupted for some reason.
6337: However, in this case, make sure you don't call
1.110 hubertf 6338: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 6339: list of dependent packages in <code class="varname">WRKDIR</code>.
6340: Otherwise, you lose the ability to automatically update
6341: the current package along with the dependent packages
6342: you have installed.</p>
1.110 hubertf 6343: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 6344: update</strong></span> will only work as long as the package
6345: tree remains unchanged. If the source code for one of
6346: the packages to be updated has been changed, resuming
1.110 hubertf 6347: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 6348: fail!</p>
6349: <p>The following variables can be used either on the
1.110 hubertf 6350: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6351: alter the behaviour of <span class="command"><strong>make
1.88 wiz 6352: update</strong></span>:</p>
1.148 asau 6353: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6354: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 6355: <dd><p>Install target to recursively use for the
6356: updated package and the dependent packages.
6357: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 6358: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 6359: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 6360: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6361: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6362: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 6363: endless loop!</p></dd>
1.75 rillig 6364: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 6365: <dd><p>Don't clean up after updating. Useful if
6366: you want to leave the work sources of the updated
6367: packages around for inspection or other purposes.
6368: Be sure you eventually clean up the source tree
1.128 wiz 6369: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 6370: or you may run into troubles with old source code
6371: still lying around on your next
1.110 hubertf 6372: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 6373: update</strong></span>.</p></dd>
1.75 rillig 6374: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 6375: <dd><p>Deinstall each package before installing
6376: (making <code class="varname">DEPENDS_TARGET</code>). This
6377: may be necessary if the
1.128 wiz 6378: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 6379: called after interrupting a running <span class="command"><strong>make
1.88 wiz 6380: update</strong></span>.</p></dd>
1.75 rillig 6381: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 6382: <dd><p>Allows you to disable recursion and hardcode
6383: the target for packages. The default is
1.128 wiz 6384: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 6385: facilitating a recursive update of prerequisite
6386: packages. Only set
6387: <code class="varname">DEPENDS_TARGET</code> if you want to
6388: disable recursive updates. Use
6389: <code class="varname">UPDATE_TARGET</code> instead to just
6390: set a specific target for each package to be
1.110 hubertf 6391: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 6392: (see above).</p></dd>
1.75 rillig 6393: </dl></div>
6394: </dd>
6395: <dt><span class="term">clean-update</span></dt>
6396: <dd>
1.88 wiz 6397: <p>Clean the source tree for all packages that would
1.110 hubertf 6398: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 6399: from the current directory. This target should not be
6400: used if the current package (or any of its depending
6401: packages) have already been de-installed (e.g., after
1.110 hubertf 6402: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 6403: some packages you intended to update. As a rule of
6404: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 6405: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 6406: and only if you have a dirty package tree (e.g., if you
6407: used <code class="varname">NOCLEAN</code>).</p>
6408: <p>If you are unsure about whether your tree is
1.110 hubertf 6409: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 6410: clean</strong></span> at the top of the tree, or use the
6411: following sequence of commands from the directory of the
6412: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 6413: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 6414: time, otherwise you lose all the packages you wanted to
6415: update!):</p>
1.87 wiz 6416: <pre class="screen">
6417: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 6418: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 6419: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6420: </pre>
1.88 wiz 6421: <p>The following variables can be used either on the
1.110 hubertf 6422: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6423: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 6424: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6425: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 6426: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 6427: reconstruct the list of directories to update for
1.110 hubertf 6428: this package. Only use this if <span class="command"><strong>make
1.88 wiz 6429: update</strong></span> successfully installed all
6430: packages you wanted to update. Normally, this is
1.110 hubertf 6431: done automatically on <span class="command"><strong>make
1.88 wiz 6432: update</strong></span>, but may have been suppressed by
6433: the <code class="varname">NOCLEAN</code> variable (see
6434: above).</p></dd>
1.75 rillig 6435: </dl></div>
6436: </dd>
1.88 wiz 6437: <dt><span class="term">replace</span></dt>
6438: <dd>
6439: <p>Update the installation of the current package. This
6440: differs from update in that it does not replace dependent
1.250 leot 6441: packages. You will need to install <a href="https://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 6442: target to work.</p>
6443: <p><span class="emphasis"><em>Be careful when using this
6444: target!</em></span> There are no guarantees that dependent
6445: packages will still work, in particular they will most
1.110 hubertf 6446: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 6447: library package whose shared library major version changed
6448: between your installed version and the new one. For this
6449: reason, this target is not officially supported and only
6450: recommended for advanced users.</p>
6451: </dd>
1.75 rillig 6452: <dt><span class="term">info</span></dt>
1.257 leot 6453: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 6454: package. You can use this to check which version of a
6455: package is installed.</p></dd>
6456: <dt><span class="term">index</span></dt>
6457: <dd>
6458: <p>This is a top-level command, i.e. it should be used in
6459: the <code class="filename">pkgsrc</code> directory. It creates a
6460: database of all packages in the local pkgsrc tree, including
6461: dependencies, comment, maintainer, and some other useful
6462: information. Individual entries are created by running
1.110 hubertf 6463: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 6464: directories. This index file is saved as
6465: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 6466: verbose format by running <span class="command"><strong>make
1.88 wiz 6467: print-index</strong></span>. You can search in it with
1.110 hubertf 6468: <span class="command"><strong>make search
1.88 wiz 6469: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6470: extract a list of all packages that depend on a particular
1.110 hubertf 6471: one by running <span class="command"><strong>make show-deps
1.88 wiz 6472: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6473: <p>Running this command takes a very long time, some
6474: hours even on fast machines!</p>
6475: </dd>
1.75 rillig 6476: <dt><span class="term">readme</span></dt>
1.88 wiz 6477: <dd>
6478: <p>This target generates a
6479: <code class="filename">README.html</code> file, which can be
1.250 leot 6480: viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://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 6481: contain references to any packages which are in the
6482: <code class="varname">PACKAGES</code> directory on the local
6483: host. The generated files can be made to refer to URLs
6484: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6485: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6486: wanted to generate <code class="filename">README.html</code>
6487: files which pointed to binary packages on the local
6488: machine, in the directory
6489: <code class="filename">/usr/packages</code>, set
6490: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6491: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6492: <code class="varname">${PACKAGES}</code> directory and its
6493: subdirectories will be searched for all the binary
6494: packages.</p>
6495: <p>The target can be run at the toplevel or in category
6496: directories, in which case it descends recursively.</p>
6497: </dd>
1.75 rillig 6498: <dt><span class="term">readme-all</span></dt>
1.88 wiz 6499: <dd><p>This is a top-level command, run it in
6500: <code class="filename">pkgsrc</code>. Use this target to create a
6501: file <code class="filename">README-all.html</code> which contains a
6502: list of all packages currently available in the NetBSD
6503: Packages Collection, together with the category they belong
6504: to and a short description. This file is compiled from the
6505: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 6506: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 6507: readme</strong></span>.</p></dd>
1.75 rillig 6508: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 6509: <dd><p>This is very much the same as the
1.128 wiz 6510: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 6511: used when generating a pkgsrc tree to be written to a
6512: CD-ROM. This target also produces
6513: <code class="filename">README.html</code> files, and can be made
6514: to refer to URLs based on
6515: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 6516: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 6517: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 6518: <dd><p>This target shows which distfiles and patchfiles
6519: are needed to build the package
6520: (<code class="varname">ALLFILES</code>, which contains all
6521: <code class="varname">DISTFILES</code> and
1.87 wiz 6522: <code class="varname">PATCHFILES</code>, but not
6523: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 6524: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 6525: <dd><p>This target shows nothing if the package is not
6526: installed. If a version of this package is installed,
6527: but is not the version provided in this version of
6528: pkgsrc, then a warning message is displayed. This target
6529: can be used to show which of your installed packages are
6530: downlevel, and so the old versions can be deleted, and
6531: the current ones added.</p></dd>
1.75 rillig 6532: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 6533: <dd><p>This target shows the directory in the pkgsrc
6534: hierarchy from which the package can be built and
6535: installed. This may not be the same directory as the one
6536: from which the package was installed. This target is
6537: intended to be used by people who may wish to upgrade
6538: many packages on a single host, and can be invoked from
6539: the top-level pkgsrc Makefile by using the
1.128 wiz 6540: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 6541: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 6542: <dd><p>This target shows which installed packages match
6543: the current package's <code class="varname">DEPENDS</code>. Useful
6544: if out of date dependencies are causing build
6545: problems.</p></dd>
1.205 wiz 6546: <dt><span class="term">print-build-depends-list</span></dt>
6547: <dd><p>This target shows the list of packages that the current package
6548: depends on for building.</p></dd>
6549: <dt><span class="term">print-run-depends-list</span></dt>
6550: <dd><p>This target shows the list of packages that the current package
6551: depends on for running.</p></dd>
1.75 rillig 6552: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 6553: <dd><p>After a package is installed, check all its
6554: binaries and (on ELF platforms) shared libraries to see
6555: if they find the shared libs they need. Run by default
1.110 hubertf 6556: 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 6557: <dt><span class="term">print-PLIST</span></dt>
6558: <dd>
1.128 wiz 6559: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 6560: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 6561: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 6562: -newer work/.extract_done</strong></span>. An attempt is made
6563: to care for shared libs etc., but it is
1.87 wiz 6564: <span class="emphasis"><em>strongly</em></span> recommended to review the
6565: result before putting it into
6566: <code class="filename">PLIST</code>. On upgrades, it's useful to
6567: diff the output of this command against an already
6568: existing <code class="filename">PLIST</code> file.</p>
1.257 leot 6569: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 6570: other methods that don't update file access times, be
6571: sure to add these files manually to your
1.128 wiz 6572: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6573: -newer</span>”</span> command used by this target won't catch
1.87 wiz 6574: them!</p>
1.128 wiz 6575: <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 6576: information on this target.</p>
1.75 rillig 6577: </dd>
6578: <dt><span class="term">bulk-package</span></dt>
6579: <dd>
1.88 wiz 6580: <p>Used to do bulk builds. If an appropriate binary
6581: package already exists, no action is taken. If not, this
6582: target will compile, install and package it (and its
6583: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 6584: 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
6585: builds)</i></a>).
1.88 wiz 6586: After creating the binary package, the sources, the
6587: just-installed package and its required packages are
6588: removed, preserving free disk space.</p>
6589: <p><span class="emphasis"><em>Beware that this target may deinstall
6590: all packages installed on a system!</em></span></p>
1.75 rillig 6591: </dd>
6592: <dt><span class="term">bulk-install</span></dt>
6593: <dd>
1.88 wiz 6594: <p>Used during bulk-installs to install required
6595: packages. If an up-to-date binary package is available,
1.257 leot 6596: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110 hubertf 6597: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 6598: but the installed binary won't be removed.</p>
1.88 wiz 6599: <p>A binary package is considered
1.128 wiz 6600: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.257 leot 6601: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148 asau 6602: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6603: <li class="listitem"><p>None of the package's files
1.88 wiz 6604: (<code class="filename">Makefile</code>, ...) were modified
6605: since it was built.</p></li>
1.128 wiz 6606: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 6607: packages were modified since it was built.</p></li>
1.75 rillig 6608: </ul></div>
1.88 wiz 6609: <p><span class="emphasis"><em>Beware that this target may deinstall
6610: all packages installed on a system!</em></span></p>
1.75 rillig 6611: </dd>
6612: </dl></div>
6613: </div>
6614: </div>
1.148 asau 6615: <div class="chapter">
1.75 rillig 6616: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6617: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 6618: <div class="toc">
6619: <p><b>Table of Contents</b></p>
1.210 leot 6620: <dl class="toc">
1.106 rillig 6621: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
6622: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
6623: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.75 rillig 6624: </dl>
6625: </div>
1.87 wiz 6626: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 6627: by pkgsrc and also for individual packages to define what commands
6628: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
6629: or for later run-time of an installed packaged (such as
6630: <code class="varname">DEPENDS</code>).
6631: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 6632: package will not be used.</p>
6633: <p>When building a package, the replacement tools are
1.75 rillig 6634: made available in a directory (as symlinks or wrapper scripts)
6635: that is early in the executable search path. Just like the buildlink
1.87 wiz 6636: system, this helps with consistent builds.</p>
6637: <p>A tool may be needed to help build a specific package. For example,
6638: perl, GNU make (gmake) or yacc may be needed.</p>
6639: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 6640: tool may be inefficient for building a package with pkgsrc.
6641: For example, a package may need GNU awk, bison (instead of
1.87 wiz 6642: yacc) or a better sed.</p>
6643: <p>The tools used by a package can be listed by running
1.110 hubertf 6644: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6645: <div class="sect1">
1.75 rillig 6646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6647: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 6648: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 6649: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 6650: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6651: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 6652: These can be seen by running:
1.110 hubertf 6653: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 6654: <p>If a package needs a specific program to build
1.75 rillig 6655: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 6656: to define the tools needed.</p>
1.75 rillig 6657: </div>
1.148 asau 6658: <div class="sect1">
1.75 rillig 6659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6660: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 6661: <p>In the following examples, the :run means that it is needed at
6662: run-time (and becomes a DEPENDS).
1.75 rillig 6663: The default is a build dependency which can be set with
6664: :build. (So in this example, it is the same as gmake:build
1.87 wiz 6665: and pkg-config:build.)</p>
1.75 rillig 6666: <pre class="programlisting">
6667: USE_TOOLS+= gmake perl:run pkg-config
6668: </pre>
1.87 wiz 6669: <p>When using the tools framework, a
1.75 rillig 6670: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6671: which contains the full path to the appropriate tool. For example,
1.128 wiz 6672: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 6673: on Linux systems.</p>
6674: <p>If you always need a pkgsrc version of the
1.75 rillig 6675: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6676: </p>
6677: </div>
1.148 asau 6678: <div class="sect1">
1.75 rillig 6679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6680: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 6681: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 6682: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 6683: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 6684: the name of the common tools. For example:</p>
6685: <pre class="programlisting">
6686: .if exists(/usr/bin/bzcat)
6687: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6688: .elif exists(/usr/bin/bzip2)
6689: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6690: .endif
1.69 rillig 6691:
1.75 rillig 6692: TOOLS_PLATFORM.true?= true # shell builtin
6693: </pre>
6694: </div>
6695: </div>
1.148 asau 6696: <div class="chapter">
1.75 rillig 6697: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6698: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 6699: <div class="toc">
6700: <p><b>Table of Contents</b></p>
1.210 leot 6701: <dl class="toc">
1.106 rillig 6702: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 6703: <dd><dl>
1.218 rillig 6704: <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>
6705: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
6706: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
6707: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
6708: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
6709: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
6710: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
6711: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
6712: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
6713: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6714: <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 6715: </dl></dd>
1.218 rillig 6716: <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 6717: <dd><dl>
6718: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6719: <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 6720: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106 rillig 6721: </dl></dd>
1.218 rillig 6722: <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 6723: <dd><dl>
6724: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
6725: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6726: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
6727: </dl></dd>
6728: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
6729: <dd><dl>
6730: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
6731: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
6732: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 6733: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
6734: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 6735: </dl></dd>
1.218 rillig 6736: <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 6737: <dd><dl>
6738: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
6739: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 6740: <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 6741: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
6742: </dl></dd>
1.218 rillig 6743: <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 6744: <dd><dl>
6745: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
6746: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
6747: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
6748: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
6749: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6750: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
6751: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
6752: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 6753: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 6754: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 6755: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
6756: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
6757: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
6758: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
6759: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
6760: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
6761: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
6762: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 6763: emulation</a></span></dt>
1.106 rillig 6764: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
6765: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 6766: </dl></dd>
1.106 rillig 6767: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 6768: </dl>
6769: </div>
1.148 asau 6770: <div class="sect1">
1.75 rillig 6771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6772: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.78 rillig 6773: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 6774: different platforms. As a result, it is important to ensure,
6775: where possible, that packages in pkgsrc are portable. This
6776: chapter mentions some particular details you should pay
6777: attention to while working on pkgsrc.</p>
1.148 asau 6778: <div class="sect2">
1.78 rillig 6779: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 6780: <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 6781: </h3></div></div></div>
1.78 rillig 6782: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 6783: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 6784: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 6785: want to use those variables in the preprocessor directives of
1.257 leot 6786: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 6787: <code class="literal">.for</code>), you need to include the file
6788: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6789: loads the user preferences.</p>
1.78 rillig 6790: <p>But note that some variables may not be completely defined
1.219 rillig 6791: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6792: included, as they may contain references to variables that are
6793: not yet defined. In shell commands (the lines in
6794: <code class="filename">Makefile</code> that are indented with a tab) this
6795: is no problem, since variables are only expanded when they are
6796: used. But in the preprocessor directives mentioned above and in
6797: dependency lines (of the form <code class="literal">target:
6798: dependencies</code>) the variables are expanded at load
6799: time.</p>
1.148 asau 6800: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 6801: <h3 class="title">Note</h3>
1.218 rillig 6802: <p>To check whether a variable can be used at load time,
6803: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 6804: </div>
6805: </div>
1.148 asau 6806: <div class="sect2">
1.78 rillig 6807: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 6808: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.88 wiz 6809: <p>Occasionally, packages require interaction from the user,
6810: and this can be in a number of ways:</p>
1.148 asau 6811: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6812: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 6813: interaction such as entering username/password or accepting a
6814: license on a web page.</p></li>
1.128 wiz 6815: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 6816: passwords.</p></li>
1.128 wiz 6817: <li class="listitem"><p>help to configure the package before it is built</p></li>
6818: <li class="listitem"><p>help during the build process</p></li>
6819: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 6820: </ul></div>
1.218 rillig 6821: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6822: variable to define which stages need interaction. This should be
6823: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 6824: <pre class="programlisting">
1.100 rillig 6825: INTERACTIVE_STAGE= configure install
1.222 sevan 6826: </pre>
1.88 wiz 6827: <p>The user can then decide to skip this package by setting the
1.218 rillig 6828: <code class="varname">BATCH</code> variable. Packages that require interaction
6829: are also excluded from bulk builds.</p>
1.75 rillig 6830: </div>
1.148 asau 6831: <div class="sect2">
1.75 rillig 6832: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 6833: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 6834: <p>Authors of software can choose the licence under which software
6835: can be copied. The Free Software Foundation has declared some
6836: licenses "Free", and the Open Source Initiative has a definition of
6837: "Open Source".</p>
6838: <p>By default, pkgsrc allows packages with Free or Open Source
6839: licenses to be built. To allow packages with other licenses to be
6840: built as well, the pkgsrc user needs to add these licenses to the
6841: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6842: that this variable only affects which packages may be
6843: <span class="emphasis"><em>built</em></span>, while the license terms often also
6844: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 6845: <p>One might want to only install packages with a BSD license,
1.218 rillig 6846: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 6847: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 6848: user can override the default by setting the
6849: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 6850: of "+=". The licenses accepted by default are defined in the
6851: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6852: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 6853: <p>The license tag mechanism is intended to address
1.87 wiz 6854: copyright-related issues surrounding building, installing and
6855: using a package, and not to address redistribution issues (see
6856: <code class="varname">RESTRICTED</code> and
1.222 sevan 6857: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 6858: Packages with redistribution restrictions should set these
6859: tags.</p>
1.98 wiz 6860: <p>Denoting that a package may be copied according to a
6861: particular license is done by placing the license in
1.87 wiz 6862: <code class="filename">pkgsrc/licenses</code> and setting the
6863: <code class="varname">LICENSE</code> variable to a string identifying the
1.250 leot 6864: license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87 wiz 6865: <pre class="programlisting">
1.100 rillig 6866: LICENSE= xv-license
1.222 sevan 6867: </pre>
1.87 wiz 6868: <p>When trying to build, the user will get a notice that the
1.98 wiz 6869: package is covered by a license which has not been placed in the
6870: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 6871: <pre class="programlisting">
1.100 rillig 6872: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6873: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6874: ===> To view the license, enter "/usr/bin/make show-license".
6875: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6876: ===> ACCEPTABLE_LICENSES+=xv-license
6877: *** Error code 1
1.222 sevan 6878: </pre>
1.110 hubertf 6879: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 6880: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 6881: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 6882: convey to pkgsrc that it should not in the future fail because of
6883: that license:</p>
1.78 rillig 6884: <pre class="programlisting">
1.100 rillig 6885: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 6886: </pre>
6887: <p>The use of <code class="varname">LICENSE=shareware</code>,
6888: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
6889: is deprecated because it does not crisply refer to a particular
6890: license text. Another problem with such usage is that it does not
6891: enable a user to tell pkgsrc to proceed for a single package
6892: without also telling pkgsrc to proceed for all packages with that
6893: tag.</p>
6894: <div class="sect3">
6895: <div class="titlepage"><div><div><h4 class="title">
6896: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 6897: <p>When adding a package with a new license, the following steps
6898: are required:</p>
6899: <div class="orderedlist"><ol class="orderedlist" type="1">
6900: <li class="listitem">
1.222 sevan 6901: <p>Check whether the license qualifies as Free or Open
6902: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
6903: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
6904: Open Source Initiative</a>. If this is the case, the filename in
6905: <code class="filename">pkgsrc/licenses/</code> does not need the
6906: <code class="filename">-license</code> suffix, and the license name should be
6907: added to:</p>
1.154 rodent 6908: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6909: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
6910: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
6911: </ul></div>
6912: </li>
6913: <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>
6914: </ol></div>
1.222 sevan 6915: </div>
6916: <div class="sect3">
6917: <div class="titlepage"><div><div><h4 class="title">
6918: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 6919: <p>When the license changes (in a way other than formatting),
1.222 sevan 6920: make sure that the new license has a different name (e.g.,
1.98 wiz 6921: append the version number if it exists, or the date). Just
6922: because a user told pkgsrc to build programs under a previous
6923: version of a license does not mean that pkgsrc should build
1.99 rillig 6924: programs under the new licenses. The higher-level point is that
1.98 wiz 6925: pkgsrc does not evaluate licenses for reasonableness; the only
6926: test is a mechanistic test of whether a particular text has been
1.222 sevan 6927: approved by either of two bodies (FSF or OSI).</p>
6928: </div>
1.75 rillig 6929: </div>
1.148 asau 6930: <div class="sect2">
1.75 rillig 6931: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 6932: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 6933: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 6934: By declaring the restrictions, package tools can
1.98 wiz 6935: automatically refrain from e.g. placing binary packages on FTP
6936: sites.</p>
1.222 sevan 6937: <p>There are four possible restrictions, which are
1.98 wiz 6938: the cross product of sources (distfiles) and binaries not being
6939: placed on FTP sites and CD-ROMs. Because this is rarely the exact
6940: language in any license, and because non-Free licenses tend to be
6941: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 6942: CD-ROM.
6943:
6944: "FTP" means making the source or binary file available over the
6945: Internet at no charge.
6946:
6947: "CD-ROM" means making the source or binary available on some kind of
6948: media, together with other source and binary packages, which is sold
6949: for a distribution charge.
1.98 wiz 6950: </p>
6951: <p>In order to encode these restrictions, the package system
1.87 wiz 6952: defines five make variables that can be set to note these
6953: restrictions:</p>
1.148 asau 6954: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6955: <li class="listitem">
1.75 rillig 6956: <p><code class="varname">RESTRICTED</code></p>
6957: <p>This variable should be set whenever a restriction
1.87 wiz 6958: exists (regardless of its kind). Set this variable to a
1.98 wiz 6959: string containing the reason for the restriction. It should
6960: be understood that those wanting to understand the restriction
6961: will have to read the license, and perhaps seek advice of
6962: counsel.</p>
1.75 rillig 6963: </li>
1.128 wiz 6964: <li class="listitem">
1.75 rillig 6965: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 6966: <p>Binaries may not be placed on CD-ROM containing other
6967: binary packages, for which a distribution charge may be made.
6968: In this case, set this variable to
6969: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 6970: </li>
1.128 wiz 6971: <li class="listitem">
1.75 rillig 6972: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 6973: <p>Binaries may not made available on the Internet without
6974: charge. In this case, set this variable to
6975: <code class="varname">${RESTRICTED}</code>. If this variable is set,
6976: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 6977: </li>
1.128 wiz 6978: <li class="listitem">
1.75 rillig 6979: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 6980: <p>Distfiles may not be placed on CD-ROM, together with
6981: other distfiles, for which a fee may be charged. In this
6982: case, set this variable to <code class="varname">${RESTRICTED}</code>.
6983: </p>
1.75 rillig 6984: </li>
1.128 wiz 6985: <li class="listitem">
1.75 rillig 6986: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 6987: <p>Distfiles may not made available via FTP at no charge.
6988: In this case, set this variable to
6989: <code class="varname">${RESTRICTED}</code>. If this variable is set,
6990: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 6991: </li>
6992: </ul></div>
1.222 sevan 6993: <p>Please note that packages will be removed from pkgsrc when the
6994: distfiles are not distributable and cannot be obtained for a period
6995: of one full quarter branch. Packages with manual/interactive fetch
6996: must have a maintainer and it is his/her responsibility to ensure
6997: this.</p>
1.75 rillig 6998: </div>
1.148 asau 6999: <div class="sect2">
1.75 rillig 7000: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7001: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.75 rillig 7002: <p>Your package may depend on some other package being present
1.88 wiz 7003: - and there are various ways of expressing this dependency.
7004: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7005: <code class="varname">DEPENDS</code> definitions, the
7006: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7007: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7008: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7009: 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 7010: <p>The basic difference between the two variables is as
1.87 wiz 7011: follows: The <code class="varname">DEPENDS</code> definition registers
7012: that pre-requisite in the binary package so it will be pulled in
7013: when the binary package is later installed, whilst the
7014: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7015: dependency that is only needed for building the package.</p>
1.75 rillig 7016: <p>This means that if you only need a package present whilst
1.87 wiz 7017: you are building, it should be noted as a
7018: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7019: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7020: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7021: <pre class="programlisting">
1.100 rillig 7022: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7023: </pre>
1.128 wiz 7024: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7025: may include any of the wildcard version numbers recognized by
1.257 leot 7026: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7027: <div class="orderedlist"><ol class="orderedlist" type="1">
7028: <li class="listitem">
1.75 rillig 7029: <p>If your package needs another package's binaries or
1.160 wiz 7030: libraries to build and run, and if that package has a
1.87 wiz 7031: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7032: <pre class="programlisting">
1.100 rillig 7033: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7034: </pre>
1.75 rillig 7035: </li>
1.128 wiz 7036: <li class="listitem">
1.160 wiz 7037: <p>If your package needs another package's binaries or
7038: libraries only for building, and if that package has a
7039: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7040: <pre class="programlisting">
7041: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7042: </pre>
1.160 wiz 7043: <p>but set
7044: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7045: to make it a build dependency only. This case is rather
7046: rare.</p>
7047: </li>
7048: <li class="listitem">
1.132 spz 7049: <p>If your package needs binaries from another package to build,
7050: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7051: <pre class="programlisting">
1.132 spz 7052: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.222 sevan 7053: </pre>
1.75 rillig 7054: </li>
1.132 spz 7055: <li class="listitem"><p>If your package needs a library with which to link and
7056: there is no <code class="filename">buildlink3.mk</code> file
7057: available, create one. Using
7058: <code class="varname">DEPENDS</code> won't be sufficient because the
7059: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7060: <li class="listitem">
1.132 spz 7061: <p>If your package needs some executable to be able to run
7062: correctly and if there's no
7063: <code class="filename">buildlink3.mk</code> file, this is specified
7064: using the <code class="varname">DEPENDS</code> variable. The
1.250 leot 7065: <a href="https://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 7066: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7067: when it runs, and that is specified:</p>
1.75 rillig 7068: <pre class="programlisting">
1.242 wiz 7069: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7070: </pre>
1.132 spz 7071: </li>
7072: <li class="listitem">
7073: <p>You can use wildcards in package dependencies. Note that
7074: such wildcard dependencies are retained when creating binary
7075: packages. The dependency is checked when installing the binary
7076: package and any package which matches the pattern will be
7077: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7078: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7079: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7080: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7081: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7082: <p>Wildcards can also be used to specify that a package
1.87 wiz 7083: will only build against a certain minimum version of a
7084: pre-requisite:</p>
1.75 rillig 7085: <pre class="programlisting">
1.132 spz 7086: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7087: </pre>
1.132 spz 7088: <p>This means that the package will build using version 6.0
7089: of ImageMagick or newer. Such a dependency may be warranted
7090: if, for example, the command line options of an executable
7091: have changed.</p>
7092: <p>If you need to depend on minimum versions of libraries,
7093: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7094: <p>For security fixes, please update the package
1.218 rillig 7095: 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 7096: information.</p>
1.75 rillig 7097: </li>
7098: </ol></div>
7099: <p>If your package needs files from another package to build,
1.87 wiz 7100: add the relevant distribution files to
7101: <code class="varname">DISTFILES</code>, so they will be extracted
1.250 leot 7102: automatically. See the <a href="https://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 7103: (It relies on the jpeg sources being present in source form
7104: during the build.)</p>
1.75 rillig 7105: </div>
1.148 asau 7106: <div class="sect2">
1.75 rillig 7107: <div class="titlepage"><div><div><h3 class="title">
1.218 rillig 7108: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7109: <p>Your package may conflict with other packages a user might
1.87 wiz 7110: already have installed on his system, e.g. if your package
1.88 wiz 7111: installs the same set of files as another package in the pkgsrc
1.190 wiz 7112: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255 leot 7113: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/README.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
7114: and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
7115: install the same shared library, thus you set in
7116: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7117: <pre class="programlisting">
7118: CONFLICTS= Xaw-Xpm-[0-9]*
7119: </pre>
7120: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7121: <pre class="programlisting">
7122: CONFLICTS= libXaw3d-[0-9]*
7123: </pre>
1.257 leot 7124: <p><a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255 leot 7125: that conflict with existing packages and abort. However, in many
7126: situations this is too late in the process. Binary package managers
7127: will not know about the conflict until they attempt to install the
7128: package after already downloading it and all its dependencies.
7129: Users may also waste time building a package and its dependencies
7130: only to find out at the end that it conflicts with another package
7131: they have installed.</p>
7132: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7133: should be added in all cases where it is known that packages conflict
7134: with each other. These <code class="varname">CONFLICTS</code> entries are
1.257 leot 7135: exported in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255 leot 7136: managers to inform users that packages cannot be installed onto
7137: the target system.</p>
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.250 leot 7164: operating system, e.g. LKMs or <a href="https://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.257 leot 7186: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.0"><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.257 leot 7319: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-8.0"><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.250 leot 7338: it. <a href="https://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.250 leot 7446: <a href="https://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.257 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-8.0"><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.257 leot 7528: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-8.0"><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-8.0"><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.257 leot 7545: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.0"><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-8.0"><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.257 leot 7554: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-8.0"><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.250 leot 7967: generated with the <a href="https://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.250 leot 8146: <a href="https://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.250 leot 8428: <p>The <a href="https://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.250 leot 8502: <p>Install <a href="https://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.250 leot 8528: from the <a href="https://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.250 leot 8567: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="https://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.257 leot 8607: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.0"><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.257 leot 8610: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.0"><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.250 leot 8615: <a href="https://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.257 leot 8807: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.0"><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.258 ! leot 8843: <a name="idm80162000"></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.258 ! leot 8888: <a name="devfaq.makeflags"></a><a name="idm80161616"></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.257 leot 8897: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><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.258 ! leot 8904: <a name="devfaq.make"></a><a name="idm80157520"></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.257 leot 8913: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><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.258 ! leot 8922: <a name="devfaq.cc"></a><a name="idm80153168"></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.258 ! leot 8940: <a name="devfaq.bl3flags"></a><a name="idm80148944"></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.258 ! leot 8953: <a name="devfaq.bl3prefix"></a><a name="idm80146768"></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.258 ! leot 8969: <a name="devfaq.master_sites"></a><a name="idm80143568"></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.257 leot 8982: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><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.258 ! leot 8993: <a name="devfaq.mailinglists"></a><a name="idm80136784"></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.257 leot 9011: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.0"><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.258 ! leot 9018: <a name="devfaq.documentation"></a><a name="idm80132944"></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.258 ! leot 9066: <a name="devfaq.too-much-time"></a><a name="idm80110032"></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.250 leot 9078: <a href="https://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.250 leot 9144: <li class="listitem"><p><a href="https://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.250 leot 9151: <li class="listitem"><p><a href="https://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.250 leot 9161: package "extends" <a href="https://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="https://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.250 leot 9197: <p>Also use <a href="https://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.250 leot 9346: GNU Autotools in the <a href="https://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.250 leot 9741: <p>You first need to install the <a href="https://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.250 leot 9873: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://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.257 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-8.0"><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.250 leot 9947: <a href="https://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.250 leot 10327: you install the <a href="https://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>