Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.128
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.128 ! jnemeth 33: <div><p class="copyright">Copyright © 1994-2017 The NetBSD Foundation, Inc</p></div>
! 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.31 2017/07/30 22:07:39 jnemeth Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.100 leot 48: <dl class="toc">
1.1 dsieger 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
1.51 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: </dl></dd>
81: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
82: <dd><dl>
83: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
84: <dd><dl>
85: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
86: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
88: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
89: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
90: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
91: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
92: </dl></dd>
93: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
94: <dd><dl>
95: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
96: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
97: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
98: </dl></dd>
99: </dl></dd>
100: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
101: <dd><dl>
102: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
103: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 104: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 105: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 106: <dd><dl>
1.4 rillig 107: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 108: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
109: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 110: </dl></dd>
1.4 rillig 111: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
112: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 113: </dl></dd>
114: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
115: <dd><dl>
116: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
117: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 118: </dl></dd>
119: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
120: builds)</a></span></dt>
1.1 dsieger 121: <dd><dl>
1.71 wiz 122: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
123: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
124: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
125: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 126: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
127: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 128: </dl></dd>
129: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
130: <dd><dl>
1.23 wiz 131: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
132: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 133: </dl></dd>
134: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
135: <dd><dl>
136: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 137: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
138: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
139: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
140: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
141: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
142: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
143: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
144: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
145: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 146: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 147: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
148: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
149: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
150: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
151: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
152: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
153: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 154: </dl></dd>
155: </dl></dd>
156: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
157: <dd><dl>
1.6 rillig 158: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 159: <dd><dl>
1.6 rillig 160: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 161: <dd><dl>
1.6 rillig 162: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121 sevan 163: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 & KDE4 applications</a></span></dt>
1.17 imil 164: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 165: </dl></dd>
1.6 rillig 166: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
167: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
168: </dl></dd>
169: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
170: <dd><dl>
1.23 wiz 171: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
172: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 173: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 174: <dd><dl>
175: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
176: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
177: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
178: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
179: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
180: </dl></dd>
181: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
182: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
183: <dd><dl>
184: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
185: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
186: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
187: </dl></dd>
1.23 wiz 188: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
189: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 190: </dl></dd>
1.23 wiz 191: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 192: <dd><dl>
193: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 194: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 195: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
196: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
197: <dd><dl>
198: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117 sevan 199: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108 rillig 200: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
201: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 202: </dl></dd>
203: </dl></dd>
204: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
205: <dd><dl>
206: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 207: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
208: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 209: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
210: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 211: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 212: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 213: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
214: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 215: </dl></dd>
216: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
217: <dd><dl>
218: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 219: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 220: <dd><dl>
221: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 222: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
223: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
224: and
225: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
226: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 227: </dl></dd>
1.23 wiz 228: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 229: <dd><dl>
1.23 wiz 230: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 231: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
232: </dl></dd>
233: </dl></dd>
234: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
235: <dd><dl>
236: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
237: <dd><dl>
238: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
239: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
240: </dl></dd>
241: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
242: <dd><dl>
1.23 wiz 243: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 244: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
245: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
246: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
247: </dl></dd>
248: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
249: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
250: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
251: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
252: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
253: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
254: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
255: </dl></dd>
256: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
257: <dd><dl>
258: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 259: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 260: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 261: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 262: </dl></dd>
263: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
264: <dd><dl>
265: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
266: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
267: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
268: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 269: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 270: <dd><dl>
271: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
272: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
273: </dl></dd>
1.23 wiz 274: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
275: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
276: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
277: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
279: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
280: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
281: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
282: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
283: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 284: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
285: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
286: </dl></dd>
287: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
290: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
291: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
292: </dl></dd>
293: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
294: <dd><dl>
295: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
296: <dd><dl>
1.108 rillig 297: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
298: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
299: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
300: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
301: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
302: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
303: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
304: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
305: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
306: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
307: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.6 rillig 308: </dl></dd>
1.108 rillig 309: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 310: <dd><dl>
311: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
312: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.88 tnn 313: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 314: </dl></dd>
1.108 rillig 315: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 316: <dd><dl>
317: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
318: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
319: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
320: </dl></dd>
321: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
322: <dd><dl>
323: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
324: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
325: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 326: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
327: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 328: </dl></dd>
1.108 rillig 329: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 330: <dd><dl>
331: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
332: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 333: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 334: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
335: </dl></dd>
1.108 rillig 336: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 337: <dd><dl>
338: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
339: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
340: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
341: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
342: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
343: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
344: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
345: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 346: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 347: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 348: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
349: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
350: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
351: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
352: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
353: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
354: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
355: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 356: emulation</a></span></dt>
1.6 rillig 357: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
358: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 359: </dl></dd>
1.6 rillig 360: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 361: </dl></dd>
1.6 rillig 362: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
363: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 364: <dd><dl>
1.6 rillig 365: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
366: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
367: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 368: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 369: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 370: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
371: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 372: </dl></dd>
373: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
374: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
375: <dd><dl>
376: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
377: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
378: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
379: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 380: </dl></dd>
381: </dl></dd>
382: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
383: <dd><dl>
1.6 rillig 384: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 385: <dd><dl>
1.6 rillig 386: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
387: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
388: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 389: <dd><dl>
1.6 rillig 390: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
391: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 392: </dl></dd>
1.6 rillig 393: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
394: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 395: <dd><dl>
1.6 rillig 396: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
397: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 398: </dl></dd>
1.6 rillig 399: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 400: <dd><dl>
1.23 wiz 401: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
402: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 403: </dl></dd>
404: </dl></dd>
1.6 rillig 405: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 406: <dd><dl>
1.108 rillig 407: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
408: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 409: <dd><dl>
1.108 rillig 410: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
411: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 412: </dl></dd>
413: </dl></dd>
1.6 rillig 414: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 415: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 416: </dl></dd>
417: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
418: <dd><dl>
419: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
420: <dd><dl>
421: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
422: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
423: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 424: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 425: </dl></dd>
426: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
427: </dl></dd>
428: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
429: <dd><dl>
430: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
431: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
432: </dl></dd>
433: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
434: <dd><dl>
1.23 wiz 435: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
436: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
437: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
438: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
439: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
440: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 441: source packages</a></span></dt>
442: </dl></dd>
443: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
444: <dd><dl>
445: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
446: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
447: </dl></dd>
448: </dl>
449: </div>
450: <div class="list-of-tables">
451: <p><b>List of Tables</b></p>
452: <dl>
453: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
454: </dt>
1.6 rillig 455: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 456: </dt>
1.6 rillig 457: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 458: </dt>
459: </dl>
460: </div>
1.41 asau 461: <div class="chapter">
462: <div class="titlepage"><div><div><h1 class="title">
463: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 464: <div class="toc">
465: <p><b>Table of Contents</b></p>
1.100 leot 466: <dl class="toc">
1.1 dsieger 467: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
468: <dd><dl>
469: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
470: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
471: </dl></dd>
472: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
473: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
474: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
475: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
476: </dl>
477: </div>
1.41 asau 478: <div class="sect1">
1.1 dsieger 479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
480: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
481: <p>There is a lot of software freely available for Unix-based
482: systems, which is usually available in form of the source code. Before
483: such software can be used, it needs to be configured to the local
484: system, compiled and installed, and this is exactly what The NetBSD
485: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
486: to handle binary packages, so that not every user has to build the
487: packages for himself, which is a time-costly task.</p>
488: <p>pkgsrc currently contains several thousand packages,
489: including:</p>
1.41 asau 490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 491: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 492: web server</p></li>
1.120 sevan 493: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 494: web browser</p></li>
1.120 sevan 495: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 496: Desktop Environment</p></li>
1.120 sevan 497: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 498: Desktop Environment</p></li>
499: </ul></div>
1.108 rillig 500: <p>… just to name a few.</p>
1.1 dsieger 501: <p>pkgsrc has built-in support for handling varying dependencies,
502: such as pthreads and X11, and extended features such as IPv6 support on
503: a range of platforms.</p>
1.41 asau 504: <div class="sect2">
1.1 dsieger 505: <div class="titlepage"><div><div><h3 class="title">
506: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
507: <p>
508: pkgsrc provides the following key features:
509: </p>
1.41 asau 510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 511: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 512: and installation of binary packages. The source and latest
513: patches are retrieved from a master or mirror download site, checksum
514: verified, then built on your system. Support for binary-only
515: distributions is available for both native platforms and NetBSD
516: emulated platforms.</p></li>
1.23 wiz 517: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 518: including binaries, libraries, man pages and other
519: documentation.</p></li>
1.104 sevan 520: <li class="listitem"><p>Tracking of package dependencies automatically, including when
521: performing updates, to ensure required packages are installed. The
522: configuration files of various packages are handled automatically during
523: updates, so local changes are preserved.</p></li>
1.23 wiz 524: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 525: consists of highly portable code. This allows the greatest speed of
1.25 spz 526: development when porting to a new platform. This portability also
1.1 dsieger 527: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
528: platforms</em></span>.</p></li>
1.23 wiz 529: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 530: international encryption requirements and build-time options for a
531: large number of packages are all set in a simple, central
532: configuration file.</p></li>
1.23 wiz 533: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 534: freely available under a BSD license, so you may extend and adapt
535: pkgsrc to your needs. Support for local packages and patches is
536: available right out of the box, so you can configure it specifically
537: for your environment.</p></li>
538: </ul></div>
539: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 541: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 542: — That means, if a package contains bugs, it's better to find
1.1 dsieger 543: them and to complain about them rather than to just install the package
544: and hope that it works. There are numerous checks in pkgsrc that try to
1.120 sevan 545: find such bugs: Static analysis tools (<a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 546: of shell scripts), and post-installation checks (installed files,
547: references to shared libraries, script interpreters).</p></li>
1.23 wiz 548: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 549: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 550: pkgsrc has been ported to many operating systems. Care is taken that
551: packages behave the same on all platforms.</p></li>
552: </ul></div>
553: </div>
1.41 asau 554: <div class="sect2">
1.1 dsieger 555: <div class="titlepage"><div><div><h3 class="title">
556: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
557: <p>pkgsrc consists of both a source distribution and a binary
558: distribution for these operating systems. After retrieving the required
559: source or binaries, you can be up and running with pkgsrc in just
560: minutes!</p>
561: <p>pkgsrc was derived from FreeBSD's ports system, and
562: initially developed for NetBSD only. Since then, pkgsrc has
563: grown a lot, and now supports the following platforms:</p>
564: <div class="table">
565: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 566: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 567: <colgroup>
568: <col>
569: <col>
1.92 sevan 570: <col>
1.1 dsieger 571: </colgroup>
572: <thead><tr>
573: <th>Platform</th>
574: <th>Date Support Added</th>
1.92 sevan 575: <th>Notes</th>
1.1 dsieger 576: </tr></thead>
577: <tbody>
578: <tr>
1.10 hubertf 579: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 580: <td align="center">Aug 1997</td>
1.92 sevan 581: <td class="auto-generated"> </td>
1.1 dsieger 582: </tr>
583: <tr>
1.10 hubertf 584: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 585: <td align="center">Mar 1999</td>
1.93 sevan 586: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 587: </tr>
588: <tr>
1.10 hubertf 589: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 590: <td align="center">Jun 1999</td>
1.93 sevan 591: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 592: </tr>
593: <tr>
594: <td>
1.118 sevan 595: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 596: </td>
597: <td align="center">Oct 2001</td>
1.93 sevan 598: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1 dsieger 599: </tr>
600: <tr>
1.10 hubertf 601: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 602: <td align="center">Nov 2002</td>
1.93 sevan 603: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 604: </tr>
605: <tr>
1.10 hubertf 606: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 607: <td align="center">Nov 2002</td>
1.93 sevan 608: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 609: </tr>
610: <tr>
1.10 hubertf 611: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 612: <td align="center">Dec 2002</td>
1.92 sevan 613: <td>
1.93 sevan 614: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
615: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92 sevan 616: </td>
1.1 dsieger 617: </tr>
618: <tr>
619: <td>BSD/OS</td>
620: <td align="center">Dec 2003</td>
1.92 sevan 621: <td class="auto-generated"> </td>
1.1 dsieger 622: </tr>
623: <tr>
1.10 hubertf 624: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 625: <td align="center">Dec 2003</td>
1.93 sevan 626: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 627: </tr>
628: <tr>
629: <td>
1.10 hubertf 630: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 631: (Microsoft Windows Services for Unix)
632: </td>
633: <td align="center">Mar 2004</td>
1.93 sevan 634: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 635: </tr>
636: <tr>
1.10 hubertf 637: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 638: <td align="center">Oct 2004</td>
1.92 sevan 639: <td class="auto-generated"> </td>
1.1 dsieger 640: </tr>
641: <tr>
1.10 hubertf 642: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 643: <td align="center">Nov 2004</td>
1.93 sevan 644: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 645: </tr>
646: <tr>
1.10 hubertf 647: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 648: <td align="center">Apr 2007</td>
1.93 sevan 649: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 650: </tr>
1.23 wiz 651: <tr>
652: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
653: <td align="center">Sep 2010</td>
1.93 sevan 654: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 655: </tr>
1.45 obache 656: <tr>
657: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 658: <td align="center">Jan 2011</td>
1.92 sevan 659: <td class="auto-generated"> </td>
1.45 obache 660: </tr>
661: <tr>
662: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
663: <td align="center">Nov 2011</td>
1.93 sevan 664: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 665: </tr>
666: <tr>
667: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
668: <td align="center">Mar 2013</td>
1.93 sevan 669: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 670: </tr>
1.58 ryoon 671: <tr>
672: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
673: <td align="center">Jul 2013</td>
1.93 sevan 674: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58 ryoon 675: </tr>
1.104 sevan 676: <tr>
677: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
678: <td align="center">Jun 2014</td>
679: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
680: </tr>
1.1 dsieger 681: </tbody>
682: </table></div>
683: </div>
684: <br class="table-break">
685: </div>
686: </div>
1.41 asau 687: <div class="sect1">
1.1 dsieger 688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
689: <a name="overview"></a>1.2. Overview</h2></div></div></div>
690: <p>This document is divided into three parts. The first,
1.10 hubertf 691: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 692: describes how one can use one of the packages in the Package
693: Collection, either by installing a precompiled binary package,
694: or by building one's own copy using the NetBSD package system.
1.10 hubertf 695: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 696: package so it can be easily built by other NetBSD users without
697: knowing about the package's building details. The third part,
1.10 hubertf 698: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 699: is intended for those who want to understand how pkgsrc is
700: implemented.</p>
701: <p>This document is available in various formats:
1.10 hubertf 702: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 703: </div>
1.41 asau 704: <div class="sect1">
1.1 dsieger 705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
706: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 707: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
708: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 709: terminology used within this document.</p>
1.41 asau 710: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 711: <dt><span class="term">Package</span></dt>
712: <dd><p>A set of files and building instructions
713: that describe what's necessary
714: to build a certain piece of software using
715: pkgsrc. Packages are traditionally stored under
1.123 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.1 dsieger 719: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 720: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 721: is part of the NetBSD operating system and can be bootstrapped
722: to run on non-NetBSD operating systems as well. It handles
723: building (compiling), installing, and removing of
724: packages.</p></dd>
725: <dt><span class="term">Distfile</span></dt>
726: <dd><p>This term describes the file or files that are
727: provided by the author of the piece of software to
728: distribute his work. All the changes necessary to build on
729: NetBSD are reflected in the corresponding package. Usually
730: the distfile is in the form of a compressed tar-archive,
731: but other types are possible, too. Distfiles are usually
732: stored below
733: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
734: <dt><span class="term">Port</span></dt>
735: <dd><p>This is the term used by FreeBSD and OpenBSD people
736: for what we call a package.
1.23 wiz 737: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 738: architecture.</p></dd>
739: <dt><span class="term">Precompiled/binary package</span></dt>
740: <dd>
741: <p>A set of binaries built with pkgsrc from a distfile
742: and stuffed together in a single <code class="filename">.tgz</code>
743: file so it can be installed on machines of the same
744: machine architecture without the need to
745: recompile. Packages are usually generated in
746: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 747: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 748: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 749: especially in the context of precompiled packages.</p>
750: </dd>
751: <dt><span class="term">Program</span></dt>
752: <dd><p>The piece of software to be installed which will be
753: constructed from all the files in the distfile by the
754: actions defined in the corresponding package.</p></dd>
755: </dl></div>
1.41 asau 756: <div class="sect2">
1.1 dsieger 757: <div class="titlepage"><div><div><h3 class="title">
758: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 759: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 760: <dt><span class="term">pkgsrc users</span></dt>
761: <dd>
762: <p>The
763: pkgsrc users are people who use the packages provided by pkgsrc.
764: Typically they are system administrators. The people using the
1.23 wiz 765: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
766: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 767: <p>There are two kinds of pkgsrc users: Some only want to
768: install pre-built binary packages. Others build the pkgsrc
769: packages from source, either for installing them directly or for
1.10 hubertf 770: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 771: documentation.</p>
772: </dd>
773: <dt><span class="term">package maintainers</span></dt>
774: <dd><p>A
1.10 hubertf 775: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 776: <dt><span class="term">infrastructure developers</span></dt>
777: <dd><p>These people are involved in all those files
778: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 779: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 780: too.</p></dd>
781: </dl></div>
782: </div>
783: </div>
1.41 asau 784: <div class="sect1">
1.1 dsieger 785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
786: <a name="typography"></a>1.4. Typography</h2></div></div></div>
787: <p>When giving examples for commands, shell prompts are used to
788: show if the command should/can be issued as root, or if
1.23 wiz 789: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 790: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
791: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
792: bourne shell and derivatives.</p>
1.1 dsieger 793: </div>
794: </div>
1.41 asau 795: <div class="part">
1.1 dsieger 796: <div class="titlepage"><div><div><h1 class="title">
797: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
798: <div class="toc">
799: <p><b>Table of Contents</b></p>
1.100 leot 800: <dl class="toc">
1.1 dsieger 801: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
802: <dd><dl>
803: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
804: <dd><dl>
1.51 asau 805: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 806: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 807: </dl></dd>
808: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
811: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
812: </dl></dd>
813: </dl></dd>
814: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
815: <dd><dl>
816: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
817: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
818: </dl></dd>
819: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
820: <dd><dl>
821: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
824: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
825: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
826: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
827: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
828: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
829: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
830: </dl></dd>
831: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
832: <dd><dl>
833: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
834: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
835: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
836: </dl></dd>
837: </dl></dd>
838: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
839: <dd><dl>
840: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
841: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 842: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 843: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 844: <dd><dl>
1.4 rillig 845: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 846: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
847: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 848: </dl></dd>
1.4 rillig 849: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
850: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 851: </dl></dd>
852: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
853: <dd><dl>
854: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
855: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 856: </dl></dd>
857: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
858: builds)</a></span></dt>
1.1 dsieger 859: <dd><dl>
1.71 wiz 860: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
861: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
862: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
863: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 864: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
865: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 866: </dl></dd>
867: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
868: <dd><dl>
1.23 wiz 869: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
870: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 871: </dl></dd>
872: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
873: <dd><dl>
874: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 875: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
876: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
877: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
878: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
879: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
880: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
881: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
882: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
883: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 884: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 885: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
886: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
887: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
888: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
889: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
890: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
891: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 892: </dl></dd>
893: </dl>
894: </div>
1.41 asau 895: <div class="chapter">
1.1 dsieger 896: <div class="titlepage"><div><div><h2 class="title">
897: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
898: <div class="toc">
899: <p><b>Table of Contents</b></p>
1.100 leot 900: <dl class="toc">
1.1 dsieger 901: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
902: <dd><dl>
1.51 asau 903: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 904: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 905: </dl></dd>
906: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
907: <dd><dl>
908: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
909: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
910: </dl></dd>
911: </dl>
912: </div>
913: <p>Before you download and extract the files, you need to decide
914: where you want to extract them. When using pkgsrc as root user, pkgsrc
915: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
916: free to install the sources and binary packages wherever you want in
917: your filesystem, provided that the pathname does not contain white-space
918: or other characters that are interpreted specially by the shell and some
919: other programs. A safe bet is to use only letters, digits, underscores
920: and dashes.</p>
1.41 asau 921: <div class="sect1">
1.1 dsieger 922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
923: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
924: <p>Before you download any pkgsrc files, you should decide
925: whether you want the <span class="emphasis"><em>current</em></span> branch or the
926: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
927: quarterly basis from the current branch and only gets modified
928: for security updates. The names of the stable branches are built
929: from the year and the quarter, for example
1.118 sevan 930: <code class="literal">2016Q4</code>.</p>
1.1 dsieger 931: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 932: want to download pkgsrc. You can get it as a tar file or via CVS.
933: Both ways are described here.</p>
1.51 asau 934: <p>Note that tar archive contains CVS working copy.
935: Thus you can switch to using CVS at any later time.</p>
1.41 asau 936: <div class="sect2">
1.1 dsieger 937: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 938: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 939: <p>The primary download location for all pkgsrc files is
1.51 asau 940: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
941: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
942: (it points to the same location).
943: There are a number of subdirectories for different purposes,
944: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
945: <p>The tar archive for the current branch is in the directory
946: <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.118 sevan 947: It is autogenerated weekly.</p>
1.51 asau 948: <p>To save download time we provide bzip2- and
949: xz-compressed archives which are published at
950: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
951: and
952: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
953: respectively.
954: </p>
955: <p>You can fetch the same files using FTP.</p>
1.118 sevan 956: <p>The tar file for the stable branch 2016Q4 is in the
957: directory <code class="filename">pkgsrc-2016Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2016Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.12 weinem 958: <p>To download a pkgsrc stable tarball, run:</p>
959: <pre class="screen">
1.59 jnemeth 960: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.22 jakllsch 961: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 962: stable branch to be downloaded, for example,
1.118 sevan 963: <span class="quote">“<span class="quote">pkgsrc-2016Q4</span>”</span>.</p>
1.78 snj 964: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 965: or your web browser.</p>
1.12 weinem 966: <p>Then, extract it with:</p>
1.78 snj 967: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 968: <p>This will create the directory <code class="filename">pkgsrc/</code>
969: in <code class="filename">/usr/</code> and all the package source will be
970: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
971: <p>To download pkgsrc-current, run:</p>
972: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 973: </div>
1.41 asau 974: <div class="sect2">
1.1 dsieger 975: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 976: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
977: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 978: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.23 wiz 979: </pre>
980: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.118 sevan 981: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2016Q4</span>”</span></p>
1.23 wiz 982: <p>This will create the directory <code class="filename">pkgsrc/</code>
983: in your <code class="filename">/usr/</code> directory and all the package source
984: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
985: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 986: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 987: </pre>
1.78 snj 988: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 989: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 990: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 991: </pre>
992: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
993: For Bourne shells, you can set it in your <code class="filename">.profile</code>
994: or better globally in <code class="filename">/etc/profile</code>:</p>
995: <pre class="programlisting">
996: # set CVS remote shell command
997: CVS_RSH=ssh
998: export CVS_RSH
999: </pre>
1000: <p>By default, CVS doesn't do things like most people would expect it to do.
1001: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1002: in your home directory and saving the following lines to it.
1003: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1004: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1005: <pre class="programlisting">
1006: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1007: cvs -q -z2
1.2 rillig 1008: checkout -P
1.4 rillig 1009: update -dP
1010: diff -upN
1.2 rillig 1011: rdiff -u
1.23 wiz 1012: release -d
1.2 rillig 1013: </pre>
1.1 dsieger 1014: </div>
1015: </div>
1.41 asau 1016: <div class="sect1">
1.1 dsieger 1017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1018: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1019: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1020: (which also works if you have first installed it via a tar
1021: file). It saves bandwidth and hard disk activity, compared to
1022: downloading the tar file again.</p>
1.41 asau 1023: <div class="sect2">
1.1 dsieger 1024: <div class="titlepage"><div><div><h3 class="title">
1025: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1026: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1027: <h3 class="title">Warning</h3>
1028: <p>When updating from a tar file, you first need to
1029: completely remove the old pkgsrc directory. Otherwise those
1030: files that have been removed from pkgsrc in the mean time will
1031: not be removed on your local disk, resulting in inconsistencies.
1032: When removing the old files, any changes that you have done to
1033: the pkgsrc files will be lost after updating. Therefore updating
1034: via CVS is strongly recommended.</p>
1035: </div>
1036: <p>Note that by default the distfiles and the binary packages
1037: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1038: before updating. You can also configure pkgsrc to store distfiles
1039: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1040: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1041: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1042: <p>To update pkgsrc from a tar file, download the tar file as
1043: explained above. Then, make sure that you have not made any
1044: changes to the files in the pkgsrc directory. Remove the pkgsrc
1045: directory and extract the new tar file. Done.</p>
1046: </div>
1.41 asau 1047: <div class="sect2">
1.1 dsieger 1048: <div class="titlepage"><div><div><h3 class="title">
1049: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1050: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1051: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1052: </pre>
1053: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1054: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1055: </pre>
1.41 asau 1056: <div class="sect3">
1.1 dsieger 1057: <div class="titlepage"><div><div><h4 class="title">
1058: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1059: <p>When updating pkgsrc, the CVS program keeps track of the
1060: branch you selected. But if you, for whatever reason, want to
1061: switch from the stable branch to the current one, you can do it
1.23 wiz 1062: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1063: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1064: back to the stable branch, add the
1.118 sevan 1065: <span class="quote">“<span class="quote">-rpkgsrc-2016Q4</span>”</span> option.</p>
1.1 dsieger 1066: </div>
1.41 asau 1067: <div class="sect3">
1.1 dsieger 1068: <div class="titlepage"><div><div><h4 class="title">
1069: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1070: <p>When you update pkgsrc, the CVS program will only touch
1071: those files that are registered in the CVS repository. That
1072: means that any packages that you created on your own will stay
1073: unmodified. If you change files that are managed by CVS, later
1074: updates will try to merge your changes with those that have been
1075: done by others. See the CVS manual, chapter
1.23 wiz 1076: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1077: </div>
1078: </div>
1079: </div>
1080: </div>
1.41 asau 1081: <div class="chapter">
1.1 dsieger 1082: <div class="titlepage"><div><div><h2 class="title">
1083: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1084: <div class="toc">
1085: <p><b>Table of Contents</b></p>
1.100 leot 1086: <dl class="toc">
1.1 dsieger 1087: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1088: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1089: </dl>
1090: </div>
1.41 asau 1091: <div class="sect1">
1.1 dsieger 1092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1093: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1094: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.1 dsieger 1095: </div>
1.41 asau 1096: <div class="sect1">
1.1 dsieger 1097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1098: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1099: <p>pkgsrc can be bootstrapped for use in two different modes:
1100: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1101: to privileged one all programs are installed under one particular user
1.43 asau 1102: and cannot utilise privileged operations (packages don't create
1103: special users and all special file permissions like setuid are ignored).
1104: </p>
1.1 dsieger 1105: <p>Installing the bootstrap kit from source should be as simple as:</p>
1106: <pre class="screen">
1.60 asau 1107: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1108: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1109: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1110: </pre>
1.43 asau 1111: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1112: <p>By default, in privileged mode pkgsrc uses
1113: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1114: where programs will be installed in,
1.118 sevan 1115: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1116: directory where pkgsrc will do its internal bookkeeping,
1117: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1118: where packages install their persistent data.
1119: In unprivileged mode pkgsrc uses
1120: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1121: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1122: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1123: </p>
1124: <p>You can change default layout using command-line arguments.
1125: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1126: </p>
1.41 asau 1127: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1128: <h3 class="title">Note</h3>
1.10 hubertf 1129: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1130: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1131: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1132: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1133: </div>
1.43 asau 1134: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1135: <h3 class="title">Note</h3>
1136: <p>It is possible to bootstrap multiple instances of pkgsrc
1137: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1138: corresponding to the installation you're working with to build
1139: and install packages.
1140: </p>
1141: </div>
1.1 dsieger 1142: </div>
1143: </div>
1.41 asau 1144: <div class="chapter">
1.1 dsieger 1145: <div class="titlepage"><div><div><h2 class="title">
1146: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1147: <div class="toc">
1148: <p><b>Table of Contents</b></p>
1.100 leot 1149: <dl class="toc">
1.1 dsieger 1150: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1151: <dd><dl>
1152: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1153: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1154: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1155: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1156: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1157: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1158: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1159: </dl></dd>
1160: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1161: <dd><dl>
1162: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1163: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1164: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1165: </dl></dd>
1166: </dl>
1167: </div>
1168: <p>Basically, there are two ways of using pkgsrc. The first
1169: is to only install the package tools and to use binary packages
1.23 wiz 1170: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1171: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1172: of pkgsrc, too. Then you are able to build your own packages,
1173: and you can still use binary packages from someone else.</p>
1.41 asau 1174: <div class="sect1">
1.1 dsieger 1175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1176: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1177: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1178: server and its mirrors, there are collections of binary packages,
1179: ready to be installed. These binary packages have been built using the
1180: default settings for the directories, that is:</p>
1.41 asau 1181: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1182: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1183: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1184: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1185: </ul></div>
1186: <p>If you cannot use these directories for whatever reasons (maybe
1187: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1188: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1189: <div class="sect2">
1.1 dsieger 1190: <div class="titlepage"><div><div><h3 class="title">
1191: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1192: <p>To install binary packages, you first need to know from where
1193: to get them. The first place where you should look is on the main
1.10 hubertf 1194: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1195: <p>This directory contains binary packages for multiple
1196: platforms. First, select your operating system. (Ignore the
1197: directories with version numbers attached to it, they just exist for
1198: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1199: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1200: <p>In this directory, you often find a file called
1201: <code class="filename">bootstrap.tar.gz</code> which contains the package
1202: management tools. If the file is missing, it is likely that your
1203: operating system already provides those tools. Download the file and
1204: extract it in the <code class="filename">/</code> directory. It will create
1205: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1206: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1207: </div>
1.41 asau 1208: <div class="sect2">
1.1 dsieger 1209: <div class="titlepage"><div><div><h3 class="title">
1210: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1211: <p>In the directory from the last section, there is a
1.85 wiz 1212: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1213: binary packages that are available for the platform, excluding those
1214: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1215: medium you are using).</p>
1.9 rillig 1216: <p>To install packages directly from an FTP or HTTP server, run
1217: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1218: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1219: <pre class="screen">
1220: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85 wiz 1221: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.9 rillig 1222: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1223: </pre>
1224: <p>Instead of URLs, you can also use local paths, for example if
1225: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1226: repository. If you want to install packages from multiple sources,
1227: you can separate them by a semicolon in
1228: <code class="varname">PKG_PATH</code>.</p>
1229: <p>After these preparations, installing a package is very
1230: easy:</p>
1231: <pre class="screen">
1.118 sevan 1232: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1.9 rillig 1233: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1.118 sevan 1234: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9 rillig 1235: </pre>
1.1 dsieger 1236: <p>Note that any prerequisite packages needed to run the
1237: package in question will be installed, too, assuming they are
1238: present where you install from.</p>
1.23 wiz 1239: <p>Adding packages might install vulnerable packages.
1240: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1241: regularly, especially after installing new packages, and verify
1242: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1243: <p>After you've installed packages, be sure to have
1244: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1245: <code class="varname">PATH</code> so you can actually start the just
1246: installed program.</p>
1247: </div>
1.41 asau 1248: <div class="sect2">
1.1 dsieger 1249: <div class="titlepage"><div><div><h3 class="title">
1250: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1251: <p>To deinstall a package, it does not matter whether it was
1252: installed from source code or from a binary package. The
1.10 hubertf 1253: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1254: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1255: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1256: name can be given with or without version number. Wildcards can
1257: also be used to deinstall a set of packages, for example
1258: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1259: so that the shell does not expand them before
1260: <code class="literal">pkg_delete</code> sees them.</p>
1261: <p>The <code class="option">-r</code> option is very powerful: it
1262: removes all the packages that require the package in question
1263: and then removes the package itself. For example:
1264:
1265: </p>
1266: <pre class="screen">
1267: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1268: </pre>
1269: <p>
1270:
1271: will remove jpeg and all the packages that used it; this allows
1272: upgrading the jpeg package.</p>
1273: </div>
1.41 asau 1274: <div class="sect2">
1.1 dsieger 1275: <div class="titlepage"><div><div><h3 class="title">
1276: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1277: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1278: installed packages or binary package files.</p>
1279: </div>
1.41 asau 1280: <div class="sect2">
1.1 dsieger 1281: <div class="titlepage"><div><div><h3 class="title">
1282: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1283: <p>
1284: The NetBSD Security-Officer and Packages Groups maintain a list of
1285: known security vulnerabilities to packages which are (or have been)
1286: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1287: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1 dsieger 1288: </p>
1289: <p>
1.22 jakllsch 1290: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1291: this list can be downloaded
1292: automatically, and a security audit of all packages installed on a system
1293: can take place.
1294: </p>
1295: <p>
1.22 jakllsch 1296: There are two components to auditing. The first
1297: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1298: is for downloading
1.1 dsieger 1299: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1300: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1301: installed packages are vulnerable. If a package is vulnerable, you
1302: will see output similar to the following:
1303: </p>
1304: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1305: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1306: <p>
1.22 jakllsch 1307: You may wish to have the
1.10 hubertf 1308: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1309: file downloaded daily so that
1310: it remains current. This may be done by adding an appropriate entry
1.125 leot 1311: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1312: </p>
1313: <pre class="screen">
1.121 sevan 1314: # Download vulnerabilities file
1.118 sevan 1315: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1316: # Audit the installed packages and email results to root
1317: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1318: root >/dev/null 2>&1
1.22 jakllsch 1319: </pre>
1320: <p>
1.118 sevan 1321: will update the vulnerability list every day at 3AM, followed by an audit
1322: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1323:
1.118 sevan 1324: On NetBSD this may be accomplished instead by adding the following
1325: line to <code class="filename">/etc/daily.conf</code>:
1326: </p>
1327: <pre class="screen">
1328: fetch_pkg_vulnerabilities=YES
1329: </pre>
1330: <p>
1331: to fetch the vulnerability list from the daily security script. The system
1332: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1333: desired (not required), by adding the following line to
1.118 sevan 1334: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1335: </p>
1336: <pre class="screen">
1.118 sevan 1337: check_pkg_vulnerabilities=YES
1.22 jakllsch 1338: </pre>
1339: <p>
1.125 leot 1340: see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1341: </p>
1342: </div>
1.41 asau 1343: <div class="sect2">
1.1 dsieger 1344: <div class="titlepage"><div><div><h3 class="title">
1345: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1346: <p>
1.120 sevan 1347: Install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1348: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1349: argument to check if your packages are up-to-date, e.g.
1350: </p>
1351: <pre class="screen">
1352: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1353: ...
1354: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1355: </pre>
1.10 hubertf 1356: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1357: package on your system and rebuild any dependencies.
1358: </p>
1359: </div>
1.41 asau 1360: <div class="sect2">
1.1 dsieger 1361: <div class="titlepage"><div><div><h3 class="title">
1362: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1363: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1364: administrative functions on the package system.</p>
1365: </div>
1366: </div>
1.41 asau 1367: <div class="sect1">
1.1 dsieger 1368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1369: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1370: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1371: directory now contains a set of packages, organized into
1372: categories. You can browse the online index of packages, or run
1.10 hubertf 1373: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1374: directory to build local <code class="filename">README.html</code> files for
1.120 sevan 1375: all packages, viewable with any web browser such as <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1376: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1377: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1378: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1379: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1380: different <code class="varname">LOCALBASE</code> definitions on the same
1381: system (inside a chroot is an exception). </p>
1382: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1383: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1384: instructions how to create your own packages.</p>
1.41 asau 1385: <div class="sect2">
1.1 dsieger 1386: <div class="titlepage"><div><div><h3 class="title">
1387: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1388: <p>To build packages from source, you need a working C
1389: compiler. On NetBSD, you need to install the
1.23 wiz 1390: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1391: sets. If you want to build X11-related packages, the
1.23 wiz 1392: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1393: sets are required, too.</p>
1394: </div>
1.41 asau 1395: <div class="sect2">
1.1 dsieger 1396: <div class="titlepage"><div><div><h3 class="title">
1397: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1398: <p>The first step for building a package is downloading the
1399: distfiles (i.e. the unmodified source). If they have not yet been
1400: downloaded, pkgsrc will fetch them automatically.</p>
1401: <p>If you have all files that you need in the
1402: <code class="filename">distfiles</code> directory,
1403: you don't need to connect. If the distfiles are on CD-ROM, you can
1404: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1405: </p>
1406: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1407: <p>
1.10 hubertf 1408: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1409: <p>By default a list of distribution sites will be randomly
1410: intermixed to prevent huge load on servers which holding popular
1411: packages (for example, SourceForge.net mirrors). Thus, every
1412: time when you need to fetch yet another distfile all the mirrors
1413: will be tried in new (random) order. You can turn this feature
1414: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1415: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1416: <p>You can overwrite some of the major distribution sites to
1417: fit to sites that are close to your own. By setting one or two
1418: variables you can modify the order in which the master sites are
1419: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1420: delimited list of domain suffixes.
1421: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1422: contains a whitespace delimited list of regular expressions. It
1423: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1424: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1425: some examples. This may save some of your bandwidth and
1426: time.</p>
1427: <p>You can change these settings either in your shell's environment, or,
1428: if you want to keep the settings, by editing the
1.10 hubertf 1429: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1430: and adding the definitions there.</p>
1431: <p>
1432: If a package depends on many other packages (such as
1.120 sevan 1433: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.1 dsieger 1434: alternate between periods of
1435: downloading source, and compiling. To ensure you have all the source
1436: downloaded initially you can run the command:
1437: </p>
1438: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1439: <p>
1440: which will output and run a set of shell commands to fetch the
1441: necessary files into the <code class="filename">distfiles</code> directory. You can
1442: also choose to download the files manually.
1443: </p>
1444: </div>
1.41 asau 1445: <div class="sect2">
1.1 dsieger 1446: <div class="titlepage"><div><div><h3 class="title">
1447: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1448: <p>
1449: Once the software has downloaded, any patches will be applied, then it
1450: will be compiled for you. This may take some time depending on your
1451: computer, and how many other packages the software depends on and their
1452: compile time.
1453: </p>
1.41 asau 1454: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1455: <h3 class="title">Note</h3>
1456: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1457: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1458: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1459: </div>
1460: <p>For example, type</p>
1461: <pre class="screen">
1462: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1463: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1464: </pre>
1465: <p>at the shell prompt to build the various components of the
1466: package.</p>
1467: <p>The next stage is to actually install the newly compiled
1468: program onto your system. Do this by entering:
1469:
1470: </p>
1471: <pre class="screen">
1472: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1473: </pre>
1474: <p>
1475:
1476: while you are still in the directory for whatever package you
1477: are installing.</p>
1478: <p>Installing the package on your system may require you to
1479: be root. However, pkgsrc has a
1480: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1481: to only become root for the actual installation step.</p>
1482: <p>That's it, the software should now be installed and setup for use.
1483: You can now enter:
1484:
1485: </p>
1486: <pre class="screen">
1487: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1488: </pre>
1489: <p>
1490:
1491: to remove the compiled files in the work directory, as you shouldn't need
1492: them any more. If other packages were also added to your system
1493: (dependencies) to allow your program to compile, you can tidy these up
1494: also with the command:</p>
1495: <pre class="screen">
1496: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1497: </pre>
1498: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1499: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 1500: <p>The program is installed under the default root of the
1501: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1502: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1503: variable in your environment, and it will use that value as the
1504: root of your packages tree. So, to use
1505: <code class="filename">/usr/local</code>, set
1506: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1507: Please note that you should use a directory which is dedicated to
1508: packages and not shared with other programs (i.e., do not try and
1509: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1510: to add any of your own files or directories (such as
1511: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1512: <code class="filename">pkgsrc/</code>) below the
1513: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1514: conflicts between programs and other files installed by the
1515: package system and whatever else may have been installed
1516: there.</p>
1.10 hubertf 1517: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1518: alter some configuration options at build time. Have a look at
1519: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1520: of what will be set there by default. Environment variables such
1521: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1522: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1523: set them each time you want to use pkgsrc.</p>
1.23 wiz 1524: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1525: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1526: or being installed. This may be for debugging purposes, or out of
1527: simple curiosity. A number of utility values have been added to
1528: help with this.</p>
1.23 wiz 1529: <div class="orderedlist"><ol class="orderedlist" type="1">
1530: <li class="listitem">
1.125 leot 1531: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1532: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1533: information will be displayed. For example,</p>
1534: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1535: <p>will show all the commands that are invoked, up to and
1.23 wiz 1536: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1537: </li>
1.23 wiz 1538: <li class="listitem">
1.125 leot 1539: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1540: definition, then the <code class="varname">VARNAME</code> definition
1541: should be used, in conjunction with the show-var
1.125 leot 1542: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1543: variable <code class="varname">LOCALBASE</code>:</p>
1544: <pre class="screen">
1545: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1546: /usr/pkg
1547: <code class="prompt">%</code>
1548: </pre>
1549: </li>
1550: </ol></div>
1551: <p>If you want to install a binary package that you've either
1552: created yourself (see next section), that you put into
1553: pkgsrc/packages manually or that is located on a remote FTP
1554: server, you can use the "bin-install" target. This target will
1.125 leot 1555: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1556: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1557: sites searched is kept in the variable
1558: <code class="varname">BINPKG_SITES</code>, which defaults to
1.125 leot 1559: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1560: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1561: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1562: details.</p>
1563: <p>A final word of warning: If you set up a system that has a
1564: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1565: set that before any packages are installed, as you cannot use
1566: several directories for the same purpose. Doing so will result in
1567: pkgsrc not being able to properly detect your installed packages,
1568: and fail miserably. Note also that precompiled binary packages are
1569: usually built with the default <code class="varname">LOCALBASE</code> of
1570: <code class="filename">/usr/pkg</code>, and that you should
1571: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1572: <code class="varname">LOCALBASE</code>.</p>
1573: </div>
1574: </div>
1575: </div>
1.41 asau 1576: <div class="chapter">
1.1 dsieger 1577: <div class="titlepage"><div><div><h2 class="title">
1578: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
1579: <div class="toc">
1580: <p><b>Table of Contents</b></p>
1.100 leot 1581: <dl class="toc">
1.1 dsieger 1582: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
1583: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 1584: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 1585: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 1586: <dd><dl>
1.4 rillig 1587: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 1588: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1589: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 1590: </dl></dd>
1.4 rillig 1591: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
1592: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1593: </dl>
1594: </div>
1.4 rillig 1595: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1596: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1597: that file depends on the installation. On NetBSD, when you use
1.125 leot 1598: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 1599: <code class="filename">/etc/</code>. In all other cases the default location is
1600: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1601: bootstrap program to install the binary packages.</p>
1602: <p>The format of the configuration file is that of the usual
1603: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1604: is done by setting variables in this file. Note that you can define all
1605: kinds of variables, and no special error checking (for example for
1.112 rillig 1606: spelling mistakes) takes place.</p>
1.41 asau 1607: <div class="sect1">
1.1 dsieger 1608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1609: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.112 rillig 1610: <p>The following variables apply to all
1.1 dsieger 1611: pkgsrc packages. A complete list of the variables that can be
1612: configured by the user is available in
1613: <code class="filename">mk/defaults/mk.conf</code>, together with some
1614: comments that describe each variable's intent.</p>
1.41 asau 1615: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1616: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1617: packages will be installed. The default is
1618: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1619: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1620: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1621: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1622: installed. The default is
1623: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1624: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1625: X11 is installed on the system. The default is
1.84 wiz 1626: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1627: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1628: downloaded copies of the original source distributions used
1629: for building pkgsrc packages. The default is
1630: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1631: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1632: database about installed packages is stored. The default is
1.118 sevan 1633: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1634: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1635: If set, override the packages'
1636: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1637: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1638: Backup location(s) for distribution files and patch files
1639: if not found locally or in
1640: <code class="filename">${MASTER_SITES}</code> or
1641: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1642: The defaults is
1643: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1644: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1645: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1646: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1647: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1648: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1649: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1650: List of acceptable licenses. License names are case-sensitive.
1651: Whenever you try to build a package whose license is not in this
1652: list, you will get an error message. If the license condition is
1653: simple enough, the error message will include specific
1654: instructions on how to change this variable.</p></li>
1.1 dsieger 1655: </ul></div>
1656: </div>
1.41 asau 1657: <div class="sect1">
1.1 dsieger 1658: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1659: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1660: <p>
1.1 dsieger 1661: </p>
1.41 asau 1662: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1663: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1664: directory for the binary packages. The default is
1665: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1666: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1667: The top level directory where, if defined, the separate
1668: working directories will get created, and symbolically
1669: linked to from <code class="filename">${WRKDIR}</code> (see below).
1670: This is useful for building packages on several
1671: architectures, then <code class="filename">${PKGSRCDIR}</code>
1672: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1673: is local to every architecture. (It should be noted that
1674: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1675: — it is an internal definition which refers to the
1.1 dsieger 1676: root of the pkgsrc tree. It is possible to have many
1677: pkgsrc tree instances.)</p></li>
1.23 wiz 1678: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1679: Directory for local patches that aren't part of pkgsrc.
1.108 rillig 1680: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1681: information.</p></li>
1.23 wiz 1682: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1683: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1684: BSD-style Makefile. If this is not set,
1685: <code class="varname">MAKECONF</code> is set to
1686: <code class="filename">/dev/null</code> to avoid picking up
1687: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 1688: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 1689: By default, dependencies are only installed, and no binary
1690: package is created for them. You can set this variable to
1.66 asau 1691: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 1692: packages after installing dependencies. Please note that the
1.84 wiz 1693: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 1694: <code class="literal">yes</code> to preserve binary packages when
1695: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 1696: </ul></div>
1697: </div>
1.41 asau 1698: <div class="sect1">
1.1 dsieger 1699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 1700: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.107 jnemeth 1701: <p>Packages have to support installation into a
1.4 rillig 1702: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1703: to be built, before the actual filesystem is touched. DESTDIR
1704: support exists in two variations:</p>
1.41 asau 1705: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1706: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1707: installation and packaging is still run as root.</p></li>
1708: <li class="listitem"><p>Full DESTDIR support can run the complete
1709: build, installation and packaging as normal user. Root
1710: privileges are only needed to add packages.</p></li>
1711: </ul></div>
1.4 rillig 1712: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1713: clean</code></strong> needs to be run as root.</p>
1.17 imil 1714: <p>Considering the <code class="filename">foo/bar</code> package,
1715: DESTDIR full support can be tested using the following commands
1716:
1717: </p>
1718: <pre class="programlisting">
1719: <code class="prompt">$</code> id
1720: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1721: <code class="prompt">$</code> mkdir $HOME/packages
1722: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1723: </pre>
1724: <p>
1725:
1726: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1727: should be needed
1728:
1729: </p>
1730: <pre class="programlisting">
1.66 asau 1731: <code class="prompt">$</code> make stage-install
1.17 imil 1732: </pre>
1733: <p>
1734:
1735: Create a package without root privileges
1736:
1737: </p>
1738: <pre class="programlisting">
1.66 asau 1739: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1740: </pre>
1741: <p>
1742:
1743: For the following command, you must be able to gain root
1.125 leot 1744: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1745:
1746: </p>
1747: <pre class="programlisting">
1.66 asau 1748: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1749: </pre>
1750: <p>
1751:
1752: Then, as a simple user
1753:
1754: </p>
1755: <pre class="programlisting">
1756: <code class="prompt">$</code> make clean
1757: </pre>
1758: <p>
1759:
1760: </p>
1.4 rillig 1761: </div>
1.41 asau 1762: <div class="sect1">
1.4 rillig 1763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1764: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1765: <div class="sect2">
1.1 dsieger 1766: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1767: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1768: <p>By default, pkgsrc will use GCC to build packages. This may be
1769: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1770: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1771: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1772: <dd>
1773: <p>This is a list of values specifying the chain of
1774: compilers to invoke when building packages. Valid values
1775: are:</p>
1.41 asau 1776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1777: <li class="listitem"><p><code class="varname">ccc</code>:
1778: Compaq C Compilers (Tru64)</p></li>
1779: <li class="listitem"><p><code class="varname">ccache</code>:
1780: compiler cache (chainable)</p></li>
1781: <li class="listitem"><p><code class="varname">clang</code>:
1782: Clang C and Objective-C compiler</p></li>
1.23 wiz 1783: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1784: distributed C/C++ (chainable)</p></li>
1.66 asau 1785: <li class="listitem"><p><code class="varname">f2c</code>:
1786: Fortran 77 to C compiler (chainable)</p></li>
1787: <li class="listitem"><p><code class="varname">icc</code>:
1788: Intel C++ Compiler (Linux)</p></li>
1789: <li class="listitem"><p><code class="varname">ido</code>:
1790: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1791: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1792: GNU C/C++ Compiler</p></li>
1.66 asau 1793: <li class="listitem"><p><code class="varname">hp</code>:
1794: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1795: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1796: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1797: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1798: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1799: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1800: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1801: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1802: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1803: </ul></div>
1804: <p>The default is
1.23 wiz 1805: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1806: <code class="varname">ccache</code> and/or
1807: <code class="varname">distcc</code> with an appropriate
1808: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1809: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1810: variable should always be terminated with a value for
1811: a real compiler. Note that only one real compiler
1.23 wiz 1812: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1813: is not allowed).</p>
1814: </dd>
1815: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1816: <dd><p>This specifies the minimum version of GCC to use
1817: when building packages. If the system GCC doesn't
1818: satisfy this requirement, then pkgsrc will build and
1819: install one of the GCC packages to use instead.</p></dd>
1.114 maya 1820: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
1821: <dd><p>Specifies which version of python to use when several
1822: options are available.</p></dd>
1823: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1824: <dd><p>Specifies the fortran compiler to use.
1825: The default is <code class="varname">g95</code>, and
1826: <code class="varname">gfortran</code> is an alternative.</p></dd>
1827: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1828: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1829: <code class="varname">gfortran</code> is used, this option specifies which
1830: version to use.</p></dd>
1.1 dsieger 1831: </dl></div>
1832: </div>
1.41 asau 1833: <div class="sect2">
1.1 dsieger 1834: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1835: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1836: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1837: please make sure to use the <code class="literal">+=</code> operator
1838: instead of the <code class="literal">=</code> operator:</p>
1839: <pre class="programlisting">
1840: CFLAGS+= -your -flags
1841: </pre>
1842: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1843: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1844: need to add their own flags. You may want to take a look
1.120 sevan 1845: at the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 1846: package if you're interested in optimization specifically
1847: for the current CPU. </p>
1.1 dsieger 1848: </div>
1.41 asau 1849: <div class="sect2">
1.1 dsieger 1850: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 1851: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1852: <p>If you want to pass flags to the linker, both in the configure
1853: step and the build step, you can do this in two ways. Either set
1854: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1855: between the two is that <code class="varname">LIBS</code> will be appended to
1856: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1857: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1858: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1859: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1860: <code class="varname">CFLAGS</code>, if you do not wish to override these
1861: settings, use the <code class="literal">+=</code> operator:</p>
1862: <pre class="programlisting">
1863: LDFLAGS+= -your -linkerflags
1864: </pre>
1865: </div>
1866: </div>
1.41 asau 1867: <div class="sect1">
1.1 dsieger 1868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1869: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1870: <p>
1.1 dsieger 1871: </p>
1.41 asau 1872: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1873: <li class="listitem">
1.1 dsieger 1874: <p><code class="varname">PKG_DEVELOPER</code>:
1875: Run some sanity checks that package developers want:
1876: </p>
1.41 asau 1877: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1878: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1879: fuzz</p></li>
1.23 wiz 1880: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1881: binaries will find their shared libs.</p></li>
1882: </ul></div>
1883: <p>
1884: </p>
1885: </li>
1.23 wiz 1886: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1887: of debugging output which is displayed whilst making and
1888: installing the package. The default value for this is 0,
1889: which will not display the commands as they are executed
1890: (normal, default, quiet operation); the value 1 will display
1891: all shell commands before their invocation, and the value 2
1892: will display both the shell commands before their invocation,
1.112 rillig 1893: as well as their actual execution progress with <span class="command"><strong>set
1894: -x</strong></span>.</p></li>
1.1 dsieger 1895: </ul></div>
1896: <p>
1897: </p>
1898: </div>
1.41 asau 1899: <div class="sect1">
1.1 dsieger 1900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 1901: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1902: <p>Some packages have build time options, usually to select
1903: between different dependencies, enable optional support for big
1904: dependencies or enable experimental features.</p>
1905: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1906: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1907: show-options</strong></span>, for example:</p>
1908: <pre class="programlisting">
1909: The following options are supported by this package:
1910: ssl Enable SSL support.
1911: Exactly one of the following gecko options is required:
1912: firefox Use firefox as gecko rendering engine.
1913: mozilla Use mozilla as gecko rendering engine.
1914: At most one of the following database options may be selected:
1915: mysql Enable support for MySQL database.
1916: pgsql Enable support for PostgreSQL database.
1917:
1918: These options are enabled by default: firefox
1919: These options are currently enabled: mozilla ssl
1920: </pre>
1921: <p>The following variables can be defined in
1.10 hubertf 1922: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1923: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1924: which can be used to select or disable options for all packages
1925: that support them, and
1926: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1927: which can be used to select or disable options specifically for
1928: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1929: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1930: are disabled. A few examples:</p>
1931: <pre class="screen">
1.10 hubertf 1932: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 1933: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1934: PKG_OPTIONS.kdebase= debug -sasl
1935: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1936: <p>It is important to note that options that were specifically
1.18 snj 1937: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1938: you do not wish to include the option. If you are unsure you can view
1939: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1940: <p>The following settings are consulted in the order given, and
1941: the last setting that selects or disables an option is
1942: used:</p>
1.23 wiz 1943: <div class="orderedlist"><ol class="orderedlist" type="1">
1944: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1945: maintainer</p></li>
1.23 wiz 1946: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1947: variables (see below)</p></li>
1.23 wiz 1948: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1949: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1950: </ol></div>
1951: <p>For groups of mutually exclusive options, the last option
1952: selected is used, all others are automatically disabled. If an
1953: option of the group is explicitly disabled, the previously
1954: selected option, if any, is used. It is an error if no option
1955: from a required group of options is selected, and building the
1956: package will fail.</p>
1957: <p>Before the options framework was introduced, build options
1958: were selected by setting a variable (often named
1959: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 1960: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 1961: transition to the options framework for the user, these legacy
1962: variables are converted to the appropriate options setting
1963: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1964: automatically. A warning is issued to prompt the user to update
1.10 hubertf 1965: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 1966: directly. Support for the legacy variables will be removed
1967: eventually.</p>
1968: </div>
1969: </div>
1.41 asau 1970: <div class="chapter">
1.1 dsieger 1971: <div class="titlepage"><div><div><h2 class="title">
1972: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
1973: <div class="toc">
1974: <p><b>Table of Contents</b></p>
1.100 leot 1975: <dl class="toc">
1.1 dsieger 1976: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
1977: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1978: </dl>
1979: </div>
1.41 asau 1980: <div class="sect1">
1.1 dsieger 1981: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1982: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1983: <p>Once you have built and installed a package, you can create
1984: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.125 leot 1985: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 1986: the same package on a group of hosts and wasting CPU time. It also
1987: provides a simple means for others to install your package, should
1988: you distribute it.</p>
1989: <p>To create a binary package, change into the appropriate
1.10 hubertf 1990: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 1991: package</strong></span>:</p>
1992: <pre class="screen">
1.112 rillig 1993: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1994: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
1995: </pre>
1.1 dsieger 1996: <p>This will build and install your package (if not already done),
1997: and then build a binary package from what was installed. You can
1.10 hubertf 1998: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 1999: it. Binary packages are created by default in
2000: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2001: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.120 sevan 2002: continuation of the above <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.10 hubertf 2003: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2004: such a binary package.</p>
2005: </div>
1.41 asau 2006: <div class="sect1">
1.1 dsieger 2007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2008: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2009: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.6 rillig 2010: </div>
2011: </div>
1.41 asau 2012: <div class="chapter">
1.6 rillig 2013: <div class="titlepage"><div><div><h2 class="title">
2014: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2015: builds)</h2></div></div></div>
2016: <div class="toc">
2017: <p><b>Table of Contents</b></p>
1.100 leot 2018: <dl class="toc">
1.71 wiz 2019: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2020: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2021: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2022: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2023: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2024: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2025: </dl>
2026: </div>
1.71 wiz 2027: <p>For a number of reasons you may want to build binary packages
2028: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2029: For instance, when you have multiple machines that should run the same software,
2030: it is wasted time if they all build their packages themselves from source.
2031: Or you may want to build a list of packages you want and check them before
2032: deploying onto production system.
2033: There is a way of getting a set of binary packages:
1.112 rillig 2034: The bulk build system, or pbulk ("p" stands for "parallel").
2035: This chapter describes how to set it up.</p>
1.41 asau 2036: <div class="sect1">
1.6 rillig 2037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2038: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2039: <p>First of all, you have to decide whether you build all packages
2040: or a limited set of them. Full bulk builds usually consume a lot more resources,
2041: both space and time, than builds for some practical sets of packages.
2042: There exists a number of particularly heavy packages that are not actually
2043: interesting to a wide audience.
2044:
2045: For a limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2046: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2047: </p>
2048: <p>During bulk builds various packages are installed and deinstalled
2049: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2050: so make sure that you don't need any package during the builds.
1.112 rillig 2051: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2052: or something even more restrictive, depending on what the operating system provides,
2053: or dedicate the whole physical machine.
2054: As a useful side effect this makes sure that bulk builds cannot
2055: break anything in your system. There have been numerous cases where
1.6 rillig 2056: certain packages tried to install files outside the
2057: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2058: <code class="filename">/etc</code>.
2059: </p>
1.6 rillig 2060: </div>
1.41 asau 2061: <div class="sect1">
1.6 rillig 2062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2063: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2064: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2065: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2066: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2067: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2068: </ul></div>
1.41 asau 2069: <div class="sect2">
1.15 rillig 2070: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2071: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.112 rillig 2072: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2073: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2074: Configure network access to fetch distribution files.
1.112 rillig 2075: Create a user with name "pbulk".</p>
1.68 asau 2076: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2077: <pre class="screen">
1.72 wiz 2078: <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>
2079: <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>
2080: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68 asau 2081: </pre>
2082: <p>Or any other way that fits (e.g., curl, wget).</p>
2083: <p>Deploy and configure pbulk tools, e.g.:</p>
2084: <pre class="screen">
1.118 sevan 2085: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.68 asau 2086: <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>
2087: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2088: </pre>
2089: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2090: <h3 class="title">Note</h3>
2091: <p><code class="filename">mk.conf.frag</code> is a fragment of
2092: <code class="filename">mk.conf</code> that contains settings you want to
2093: apply to packages you build. For instance,</p>
2094: <pre class="programlisting">
1.112 rillig 2095: PKG_DEVELOPER= yes # perform more checks
2096: X11_TYPE= modular # use pkgsrc X11
2097: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2098: # when building all packages)
1.68 asau 2099: </pre>
2100: </div>
2101: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2102: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2103: <pre class="programlisting">
2104: www/firefox
2105: mail/thunderbird
2106: misc/libreoffice4
2107: </pre>
1.69 asau 2108: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2109: and make final amendments, if wanted.</p>
1.68 asau 2110: <p>Start it:</p>
2111: <pre class="screen">
2112: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2113: </pre>
2114: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2115: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2116: </p>
2117: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2118: <h3 class="title">Note</h3>
2119: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2120: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2121: The script is kept small enough for better understanding.</p>
2122: </div>
2123: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2124: <h3 class="title">Note</h3>
2125: <p>The <code class="filename">pbulk.sh</code> script supports running
2126: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2127: </div>
1.6 rillig 2128: </div>
2129: </div>
1.41 asau 2130: <div class="sect1">
1.6 rillig 2131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2132: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2133: <p>A complete bulk build requires lots of disk space. Some of the
2134: disk space can be read-only, some other must be writable. Some can be on
2135: remote filesystems (such as NFS) and some should be local. Some can be
2136: temporary filesystems, others must survive a sudden reboot.</p>
2137: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2138: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2139: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2140: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2141: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2142: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2143: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2144: </ul></div>
2145: </div>
2146: <div class="sect1">
2147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2148: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2149: <p>After your pkgsrc bulk-build has completed, you may wish to
2150: create a CD-ROM set of the resulting binary packages to assist
2151: in installing packages on other machines. The
1.120 sevan 2152: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1 dsieger 2153: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2154: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2155: way that keeps all the dependencies for a given package on the same
2156: CD as that package.</p>
1.41 asau 2157: <div class="sect2">
1.1 dsieger 2158: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2159: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2160: <p>Complete documentation for cdpack is found in the cdpack(1)
2161: man page. The following short example assumes that the binary
2162: packages are left in
2163: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2164: sufficient disk space exists in <code class="filename">/u2</code> to
2165: hold the ISO 9660 images.</p>
2166: <pre class="screen">
2167: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2168: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2169: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2170: </pre>
2171: <p>If you wish to include a common set of files
2172: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2173: etc.) on each CD in the collection, then you need to create a
2174: directory which contains these files. e.g.</p>
2175: <pre class="screen">
2176: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2177: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2178: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2179: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2180: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2181: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2182: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2183: </pre>
2184: <p>Now create the images:</p>
2185: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2186: <p>Each image will contain <code class="filename">README</code>,
2187: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2188: in their root directories.</p>
2189: </div>
2190: </div>
2191: </div>
1.41 asau 2192: <div class="chapter">
1.1 dsieger 2193: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2194: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2195: <div class="toc">
2196: <p><b>Table of Contents</b></p>
1.100 leot 2197: <dl class="toc">
1.23 wiz 2198: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2199: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 2200: </dl>
2201: </div>
2202: <p>The files that are installed by pkgsrc are organized in a way that
2203: is similar to what you find in the <code class="filename">/usr</code> directory
2204: of the base system. But some details are different. This is because
2205: pkgsrc initially came from FreeBSD and had adopted its file system
2206: hierarchy. Later it was largely influenced by NetBSD. But no matter
2207: which operating system you are using pkgsrc with, you can expect the
2208: same layout for pkgsrc.</p>
2209: <p>There are mainly four root directories for pkgsrc, which are all
2210: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2211: When pkgsrc has been installed as root, the default locations
2212: are:</p>
2213: <pre class="programlisting">
2214: LOCALBASE= /usr/pkg
2215: PKG_SYSCONFBASE= /usr/pkg/etc
2216: VARBASE= /var
1.119 sevan 2217: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2218: </pre>
2219: <p>In unprivileged mode (when pkgsrc has been installed as any other
2220: user), the default locations are:</p>
2221: <pre class="programlisting">
2222: LOCALBASE= ${HOME}/pkg
2223: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2224: VARBASE= ${HOME}/pkg/var
1.119 sevan 2225: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2226: </pre>
2227: <p>What these four directories are for, and what they look like is
2228: explained below.</p>
1.41 asau 2229: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2230: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2231: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2232: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2233: the well-known subdirectories like <code class="filename">bin</code>,
2234: <code class="filename">include</code>, <code class="filename">lib</code>,
2235: <code class="filename">share</code> and
2236: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2237: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2238: <code class="filename">/var</code> in the base system. Some programs (especially
2239: games, network daemons) need write access to it during normal
2240: operation.</p></li>
1.23 wiz 2241: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2242: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2243: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 2244: itself.</p></li>
2245: </ul></div>
1.41 asau 2246: <div class="sect1">
1.1 dsieger 2247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2248: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2249: </h2></div></div></div>
2250: <p>The following directories exist in a typical pkgsrc installation
2251: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2252: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2253: <dt><span class="term"><code class="filename">bin</code></span></dt>
2254: <dd><p>Contains executable programs that are intended to be
2255: directly used by the end user.</p></dd>
2256: <dt><span class="term"><code class="filename">emul</code></span></dt>
2257: <dd><p>Contains files for the emulation layers of various other
2258: operating systems, especially for
2259: NetBSD.</p></dd>
2260: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2261: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2262: <dd><p>Contains
2263: the configuration files.</p></dd>
2264: <dt><span class="term"><code class="filename">include</code></span></dt>
2265: <dd><p>Contains headers for the C and C++ programming
2266: languages.</p></dd>
2267: <dt><span class="term"><code class="filename">info</code></span></dt>
2268: <dd><p>Contains GNU info files of various
2269: packages.</p></dd>
2270: <dt><span class="term"><code class="filename">lib</code></span></dt>
2271: <dd><p>Contains shared and static
2272: libraries.</p></dd>
2273: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2274: <dd><p>Contains data files that don't change after
2275: installation. Other data files belong into
2276: <code class="filename">${VARBASE}</code>.</p></dd>
2277: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2278: <dd><p>Contains programs that are not intended to be used by
2279: end users, such as helper programs or network
2280: daemons.</p></dd>
2281: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2282: <dd><p>Contains programs that are intended to be executed as
2283: CGI scripts by a web server.</p></dd>
2284: <dt><span class="term"><code class="filename">man</code> (the usual value of
2285: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2286: <dd><p>Contains brief
2287: documentation in form of manual pages.</p></dd>
2288: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2289: <dd><p>Contains programs that are intended to be used only by
2290: the super-user.</p></dd>
2291: <dt><span class="term"><code class="filename">share</code></span></dt>
2292: <dd><p>Contains platform-independent data files that don't
2293: change after installation.</p></dd>
2294: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2295: <dd><p>Contains documentation files provided by the
2296: packages.</p></dd>
2297: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2298: <dd><p>Contains example files provided by the packages. Among
2299: others, the original configuration files are saved here and copied to
2300: <code class="filename">${PKG_SYSCONFDIR}</code> during
2301: installation.</p></dd>
2302: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2303: <dd><p>Contains the original files for rc.d
2304: scripts.</p></dd>
2305: <dt><span class="term"><code class="filename">var</code> (the usual location of
2306: <code class="filename">${VARBASE}</code>)</span></dt>
2307: <dd><p>Contains files
2308: that may be modified after
2309: installation.</p></dd>
2310: </dl></div>
2311: </div>
1.41 asau 2312: <div class="sect1">
1.1 dsieger 2313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2314: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2315: </h2></div></div></div>
1.41 asau 2316: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2317: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2318: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2319: <dd><p>Contains
2320: information about the currently installed
2321: packages.</p></dd>
2322: <dt><span class="term"><code class="filename">games</code></span></dt>
2323: <dd><p>Contains highscore
2324: files.</p></dd>
2325: <dt><span class="term"><code class="filename">log</code></span></dt>
2326: <dd><p>Contains log files.</p></dd>
2327: <dt><span class="term"><code class="filename">run</code></span></dt>
2328: <dd><p>Contains informational files about daemons that are
2329: currently running.</p></dd>
2330: </dl></div>
2331: </div>
2332: </div>
1.41 asau 2333: <div class="chapter">
1.1 dsieger 2334: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2335: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2336: <div class="toc">
2337: <p><b>Table of Contents</b></p>
1.100 leot 2338: <dl class="toc">
1.6 rillig 2339: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 2340: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2341: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2342: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2343: <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>
2344: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2345: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2346: <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>
2347: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2348: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2349: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2350: <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>
2351: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2352: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2353: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2354: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2355: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2356: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 2357: </dl>
2358: </div>
2359: <p>This section contains hints, tips & tricks on special things in
2360: pkgsrc that we didn't find a better place for in the previous chapters, and
2361: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2362: <div class="sect1">
1.1 dsieger 2363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2364: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2365: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2366: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2367: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 2368: This is a general purpose list for most issues regarding
2369: pkgsrc, regardless of platform, e.g. soliciting user help
2370: for pkgsrc configuration, unexpected build failures, using
2371: particular packages, upgrading pkgsrc installations,
2372: questions regarding the pkgsrc release branches, etc. General announcements or
2373: proposals for changes that impact the pkgsrc user community,
2374: e.g. major infrastructure changes, new features, package
2375: removals, etc., may also be posted.</p></li>
1.23 wiz 2376: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2377: A list where the results of pkgsrc bulk builds are sent and
2378: discussed.</p></li>
1.23 wiz 2379: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2380: This list is for those who are interested in getting a
2381: commit message for every change committed to pkgsrc. It is
2382: also available in digest form, meaning one daily message
2383: containing all commit messages for changes to the package
2384: source tree in that 24 hour period.</p></li>
2385: </ul></div>
2386: <p>To subscribe, do:</p>
2387: <pre class="programlisting">
2388: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2389: </pre>
2390: <p>Archives for all these mailing lists are available from
1.10 hubertf 2391: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2392: </div>
1.41 asau 2393: <div class="sect1">
1.1 dsieger 2394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2395: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2396: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2397: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2398: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2399: they might be useful, and not to duplicate the documentation that comes
2400: with each package.</p>
2401: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.120 sevan 2402: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 2403: Symlinks for use by buildlink.</p></li></ul></div>
2404: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2405: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2406: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121 sevan 2407: Calculates various kinds of checksums (including SHA3).</p></li>
1.120 sevan 2408: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 2409: Compatibility library for pkgsrc tools.</p></li>
1.120 sevan 2410: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 2411: non-BSD systems due to lack of native mtree.</p></li>
1.120 sevan 2412: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 2413: Up-to-date replacement for
2414: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2415: systems where pkg_install is not present.</p></li>
2416: </ul></div>
2417: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2418: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2419: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2420: Create a binary package from an
1.10 hubertf 2421: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2422: save the old package.</p></li>
1.120 sevan 2423: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 2424: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2425: from multiple locations. It currently supports the following
2426: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.120 sevan 2427: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 2428: the best compiler flags to optimise code for your current
1.23 wiz 2429: CPU and compiler. </p></li>
1.1 dsieger 2430: </ul></div>
2431: <p>Utilities for keeping track of installed packages, being up to date,
2432: etc:</p>
1.41 asau 2433: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2434: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65 wiz 2435: update tool similar to apt(1). Download, install, and upgrade
2436: binary packages easily.</p></li>
1.120 sevan 2437: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 2438: packages whose installed versions do not match the latest pkgsrc
2439: entries.</p></li>
1.120 sevan 2440: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 2441: dependency graphs of packages, to aid in choosing a strategy for
2442: updating.</p></li>
1.120 sevan 2443: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2444: graphs from the output of <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2445: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 2446: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.120 sevan 2447: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 2448: does various checks on the complete pkgsrc system.</p></li>
1.120 sevan 2449: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 2450: packages you have installed.</p></li>
2451: </ul></div>
2452: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2453: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2454: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 2455: making and maintaining patches for a package (includes pkgdiff,
2456: pkgvi, mkpatches, etc.).</p></li>
1.120 sevan 2457: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1 dsieger 2458: converting to pkgsrc.</p></li>
2459: </ul></div>
2460: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2461: utilities)</p>
1.41 asau 2462: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 2463: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 2464: packages in a chrooted area.</p></li>
1.120 sevan 2465: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 2466: kernel version for chrooted cross builds.</p></li>
2467: </ul></div>
2468: </div>
1.41 asau 2469: <div class="sect1">
1.1 dsieger 2470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2471: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2472: <p>To install packages from source as a non-root user, download
2473: 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
2474: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2475: --unprivileged</strong></span>.</p>
2476: <p>This will install the binary part of pkgsrc to
2477: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2478: into <code class="filename">~/pkg/etc</code>.</p>
2479: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2480: </div>
1.41 asau 2481: <div class="sect1">
1.1 dsieger 2482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2483: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2484: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2485: enable this feature by adding the option
2486: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2487: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2488: distfile is found, pkgsrc will try to resume it.</p>
2489: <p>You can also
1.61 wiz 2490: use a different program than the platform default program by changing the
1.16 jnemeth 2491: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2492: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2493: by using the value manual. A value of custom disables the system defaults
2494: and dependency tracking for the fetch program. In that case you have to
2495: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2496: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2497: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2498: <p>For example, if you want to use
1.16 jnemeth 2499: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2500: like:</p>
2501: <pre class="programlisting">
1.112 rillig 2502: FETCH_USING= wget
1.1 dsieger 2503: </pre>
2504: </div>
1.41 asau 2505: <div class="sect1">
1.1 dsieger 2506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2507: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 2508: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2509: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2510: you will have to add the following line into
1.10 hubertf 2511: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2512: <pre class="programlisting">
1.4 rillig 2513: X11_TYPE=modular
1.1 dsieger 2514: </pre>
2515: </div>
1.41 asau 2516: <div class="sect1">
1.1 dsieger 2517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2518: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2519: <p>If you are sitting behind a firewall which does not allow direct
2520: connections to Internet hosts (i.e. non-NAT), you may specify the
2521: relevant proxy hosts. This is done using an environment variable in the
2522: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2523: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2524: port 80 as the proxy port number. So the proxy environment variables
2525: are:</p>
2526: <pre class="programlisting">
2527: ftp_proxy=ftp://orpheus.amdahl.com:80/
2528: http_proxy=http://orpheus.amdahl.com:80/
2529: </pre>
2530: </div>
1.41 asau 2531: <div class="sect1">
1.1 dsieger 2532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2533: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2534: <p>Some fetch tools are not prepared to support HTTPS by default
2535: (for example, the one in NetBSD 6.0), or the one installed by the
2536: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2537: dependency graph).</p>
2538: <p>Usually you won't notice, because distribution files are
2539: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2540: be often enough if you are following pkgsrc-current. In that case, set
2541: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2542: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2543: with HTTPS support by default. Of course, these tools need to be
2544: installed before you can use them this way.</p>
2545: </div>
2546: <div class="sect1">
2547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2548: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 2549: <p>This depends on which utility is used to retrieve distfiles. From
2550: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2551: the first available command from the following list:</p>
1.41 asau 2552: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2553: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2554: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2555: </ul></div>
2556: <p>On a default NetBSD installation, this will be
2557: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2558: connections first, and falls back to active connections if the server
2559: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2560: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2561: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2562: <p>Having that option present will prevent
2563: <code class="filename">/usr/bin/ftp</code> from falling back to active
2564: transfers.</p>
2565: </div>
1.41 asau 2566: <div class="sect1">
1.1 dsieger 2567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2568: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2569: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2570: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2571: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 2572: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2573: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2574: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2575: resulting list to your machine at work/school and use it there. If you
1.125 leot 2576: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 2577: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2578: URL:</p>
2579: <p>At home:</p>
2580: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2581: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2582: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2583: <p>At work:</p>
2584: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2585: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2586: home.</p>
2587: <p>If you have a machine running NetBSD, and you want to get
2588: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2589: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2590: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2591: directly by running:</p>
2592: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2593: <p>If you even decide to ignore
2594: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2595: by running:</p>
2596: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2597: </div>
1.41 asau 2598: <div class="sect1">
1.1 dsieger 2599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2600: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2601: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.120 sevan 2602: <p>When compiling the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1 dsieger 2603: package, you get the error from make that it doesn't know how to make
2604: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2605: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2606: the NetBSD base distribution on your machine. It is recommended to do
2607: that to format man pages.</p>
1.120 sevan 2608: <p>In the case of the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1 dsieger 2609: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2610: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2611: </div>
1.41 asau 2612: <div class="sect1">
1.1 dsieger 2613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2614: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 2615: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2616: when you installed your NetBSD machine. Please get and install it, by
2617: extracting it in <code class="filename">/</code>:</p>
2618: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2619: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2620: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2621: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2622: -r</strong></span>).</p>
2623: </div>
1.41 asau 2624: <div class="sect1">
1.1 dsieger 2625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2626: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2627: <p>When installing packages as non-root user and using the just-in-time
1.125 leot 2628: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1 dsieger 2629: password for each required package installed. To avoid this, the sudo
2630: package can be used, which does password caching over a limited time. To
2631: use it, install sudo (either as binary package or from
1.120 sevan 2632: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10 hubertf 2633: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2634: <span class="emphasis"><em>after</em></span> the definition of the
2635: <code class="varname">LOCALBASE</code> variable:</p>
2636: <pre class="programlisting">
2637: .if exists(${LOCALBASE}/bin/sudo)
2638: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2639: .endif
2640: </pre>
2641: </div>
1.41 asau 2642: <div class="sect1">
1.1 dsieger 2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2644: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2645: <p>As the system administrator, you can choose where configuration files
2646: are installed. The default settings make all these files go into
2647: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2648: be suboptimal depending on your expectations (e.g., a read-only,
2649: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2650: configuration of the provided packages).</p>
2651: <p>In order to change the defaults, you can modify the
2652: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2653: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2654: directory; some common examples include <code class="filename">/etc</code> or
2655: <code class="filename">/etc/pkg</code>.</p>
2656: <p>Furthermore, you can change this value on a per-package basis by
2657: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2658: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2659: package you would like to modify, that is, the contents of
2660: <code class="varname">PKGBASE</code>.</p>
2661: <p>Note that after changing these settings, you must rebuild and
2662: reinstall any affected packages.</p>
2663: </div>
1.41 asau 2664: <div class="sect1">
1.1 dsieger 2665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2666: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2667: <p>Please be aware that there can often be bugs in third-party software,
2668: and some of these bugs can leave a machine vulnerable to exploitation by
2669: attackers. In an effort to lessen the exposure, the NetBSD packages team
2670: maintains a database of known-exploits to packages which have at one time
2671: been included in pkgsrc. The database can be downloaded automatically, and
2672: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2673: do this, refer to the following two tools (installed as part of the
1.120 sevan 2674: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23 wiz 2675: <div class="orderedlist"><ol class="orderedlist" type="1">
2676: <li class="listitem">
1.20 snj 2677: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2678: download a list of the security vulnerabilities information. This list
1.25 spz 2679: is kept up to date by the pkgsrc security team, and is distributed
2680: from the NetBSD ftp server:</p>
2681: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.1 dsieger 2682: </li>
1.23 wiz 2683: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2684: current machine, checking each known vulnerability. If a
1.1 dsieger 2685: vulnerable package is installed, it will be shown by output to stdout,
2686: including a description of the type of vulnerability, and a URL
2687: containing more information.</p></li>
2688: </ol></div>
1.121 sevan 2689: <p>Use of these tools is strongly recommended!
2690: 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
2691: reporting.</p>
2692: <p>If this database is installed, pkgsrc builds will use it to
2693: perform a security check before building any package.</p>
1.1 dsieger 2694: </div>
1.41 asau 2695: <div class="sect1">
1.1 dsieger 2696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2697: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 2698: <p>When you add your own preferences to the
2699: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2700: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2701: environment variables to the <code class="filename">./configure</code>
1.125 leot 2702: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 2703: <code class="varname">CFLAGS</code> from the environment variable by
2704: overriding them in the <code class="filename">Makefile</code>s of their
2705: package.</p>
2706: <p>Currently there is no solution to this problem. If you
2707: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2708: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2709: directory and then inspect any <code class="filename">Makefile</code> and
2710: <code class="filename">Makefile.in</code> for whether they define
2711: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2712: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2713: programmers write so bad code that it only works for the
2714: specific combination of <code class="varname">CFLAGS</code> they have
2715: chosen.</p>
2716: </div>
1.41 asau 2717: <div class="sect1">
1.1 dsieger 2718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2719: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2720: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2721: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2722: case that occurs often is that people only update pkgsrc in
2723: parts, because of performance reasons. Since pkgsrc is one large
2724: system, not a collection of many small systems, there are
2725: sometimes changes that only work when the whole pkgsrc tree is
2726: updated.</p></li>
1.41 asau 2727: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2728: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2729: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2730: files.</p></li>
1.41 asau 2731: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2732: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2733: verify this.</p></li>
1.108 rillig 2734: <li class="step"><p>If you are a package developer who wants to invest
2735: some work, have a look at <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.41 asau 2736: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2737: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2738: </ol></div>
2739: </div>
1.41 asau 2740: <div class="sect1">
1.1 dsieger 2741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2742: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 2743: <p>You have modified a file from pkgsrc, and someone else has
2744: modified that same file afterwards in the CVS repository. Both changes
2745: are in the same region of the file, so when you updated pkgsrc, the
2746: <code class="literal">cvs</code> command marked the conflicting changes in the
2747: file. Because of these markers, the file is no longer a valid
2748: <code class="filename">Makefile</code>.</p>
2749: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2750: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2751: -dP</strong></span> in that directory to download the current version.</p>
2752: </div>
2753: </div>
2754: </div>
1.41 asau 2755: <div class="part">
1.1 dsieger 2756: <div class="titlepage"><div><div><h1 class="title">
2757: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2758: <div class="partintro">
1.1 dsieger 2759: <div></div>
2760: <p>This part of the book deals with creating and
1.23 wiz 2761: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2762: guide on creating a new package. The remaining chapters are more
2763: like a reference manual for pkgsrc.</p>
2764: <div class="toc">
2765: <p><b>Table of Contents</b></p>
1.100 leot 2766: <dl class="toc">
1.6 rillig 2767: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2768: <dd><dl>
1.6 rillig 2769: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 2770: <dd><dl>
1.6 rillig 2771: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121 sevan 2772: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 & KDE4 applications</a></span></dt>
1.17 imil 2773: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 2774: </dl></dd>
1.6 rillig 2775: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
2776: <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>
2777: </dl></dd>
2778: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
2779: <dd><dl>
1.23 wiz 2780: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
2781: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 2782: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2783: <dd><dl>
2784: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
2785: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
2786: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
2787: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
2788: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
2789: </dl></dd>
2790: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
2791: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
2792: <dd><dl>
2793: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
2794: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
2795: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
2796: </dl></dd>
1.23 wiz 2797: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
2798: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2799: </dl></dd>
1.23 wiz 2800: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2801: <dd><dl>
2802: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 2803: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 2804: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
2805: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
2806: <dd><dl>
2807: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117 sevan 2808: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108 rillig 2809: <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>
2810: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2811: </dl></dd>
2812: </dl></dd>
2813: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
2814: <dd><dl>
2815: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 2816: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2817: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 2818: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
2819: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 2820: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 2821: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 2822: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
2823: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2824: </dl></dd>
2825: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
2826: <dd><dl>
2827: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 2828: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2829: <dd><dl>
2830: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 2831: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
2832: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2833: and
2834: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2835: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2836: </dl></dd>
1.23 wiz 2837: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 2838: <dd><dl>
1.23 wiz 2839: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 2840: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
2841: </dl></dd>
2842: </dl></dd>
2843: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
2844: <dd><dl>
2845: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
2846: <dd><dl>
2847: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
2848: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
2849: </dl></dd>
2850: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
2851: <dd><dl>
1.23 wiz 2852: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 2853: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
2854: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
2855: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
2856: </dl></dd>
2857: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
2858: <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>
2859: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
2860: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
2861: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
2862: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
2863: <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>
2864: </dl></dd>
2865: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
2866: <dd><dl>
2867: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 2868: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 2869: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 2870: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 2871: </dl></dd>
2872: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
2873: <dd><dl>
2874: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
2875: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
2876: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
2877: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 2878: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 2879: <dd><dl>
2880: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
2881: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
2882: </dl></dd>
1.23 wiz 2883: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2884: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2885: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2886: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2887: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2888: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2889: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2890: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2891: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2892: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 2893: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
2894: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
2895: </dl></dd>
2896: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
2897: <dd><dl>
2898: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
2899: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
2900: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
2901: </dl></dd>
2902: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
2903: <dd><dl>
2904: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
2905: <dd><dl>
1.108 rillig 2906: <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>
2907: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
2908: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
2909: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
2910: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
2911: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
2912: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
2913: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
2914: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
2915: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2916: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.6 rillig 2917: </dl></dd>
1.108 rillig 2918: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 2919: <dd><dl>
2920: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2921: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.88 tnn 2922: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 2923: </dl></dd>
1.108 rillig 2924: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 2925: <dd><dl>
2926: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
2927: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2928: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
2929: </dl></dd>
2930: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
2931: <dd><dl>
2932: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
2933: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
2934: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 2935: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
2936: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 2937: </dl></dd>
1.108 rillig 2938: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 2939: <dd><dl>
2940: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
2941: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 2942: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 2943: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
2944: </dl></dd>
1.108 rillig 2945: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 2946: <dd><dl>
2947: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
2948: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
2949: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
2950: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
2951: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2952: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
2953: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
2954: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 2955: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 2956: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 2957: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
2958: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
2959: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
2960: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
2961: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
2962: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
2963: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
2964: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 2965: emulation</a></span></dt>
1.6 rillig 2966: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
2967: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 2968: </dl></dd>
1.6 rillig 2969: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 2970: </dl></dd>
1.6 rillig 2971: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
2972: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 2973: <dd><dl>
1.6 rillig 2974: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
2975: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
2976: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 2977: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 2978: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 2979: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
2980: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 2981: </dl></dd>
2982: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
2983: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
2984: <dd><dl>
2985: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
2986: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
2987: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
2988: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 2989: </dl></dd>
2990: </dl>
2991: </div>
2992: </div>
1.41 asau 2993: <div class="chapter">
1.1 dsieger 2994: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2995: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 2996: <div class="toc">
2997: <p><b>Table of Contents</b></p>
1.100 leot 2998: <dl class="toc">
1.6 rillig 2999: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3000: <dd><dl>
1.6 rillig 3001: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121 sevan 3002: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 & KDE4 applications</a></span></dt>
1.17 imil 3003: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3004: </dl></dd>
1.6 rillig 3005: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3006: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1 dsieger 3007: </dl>
3008: </div>
3009: <p>When you find a package that is not yet in pkgsrc, you
3010: most likely have a URL from where you can download the source
3011: code. Starting with this URL, creating a package involves only a
3012: few steps.</p>
1.23 wiz 3013: <div class="procedure"><ol class="procedure" type="1">
1.120 sevan 3014: <li class="step"><p>First, install the packages <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.41 asau 3015: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3016: category in which you want to place your package. You can also create a
3017: directory of your own (maybe called <code class="filename">local</code>). In that
3018: category directory, create another directory for your package and change
3019: into it.</p></li>
1.41 asau 3020: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3021: you for a URL. Enter the URL of the distribution file (in most cases a
3022: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3023: of your package are created automatically. The distribution file is
3024: extracted automatically to fill in some details in the
3025: <code class="filename">Makefile</code> that would otherwise have to be done
3026: manually.</p></li>
1.41 asau 3027: <li class="step">
1.1 dsieger 3028: <p>Examine the extracted files to determine the dependencies of
3029: your package. Ideally, this is mentioned in some
3030: <code class="filename">README</code> file, but things may differ. For each of
3031: these dependencies, look where it exists in pkgsrc, and if there is a
3032: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3033: line to your package <code class="filename">Makefile</code> which includes that
3034: file just before the last line. If the
1.25 spz 3035: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3036: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3037: <p>If you just need binaries from a package, add a
1.1 dsieger 3038: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3039: version of the dependency and where it can be found in pkgsrc. This line
3040: should be placed in the third paragraph. If the dependency is only
3041: needed for building the package, but not when using it, use
3042: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3043: Your package may then look like this:</p>
3044: <pre class="programlisting">
3045: [...]
3046:
1.66 asau 3047: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3048: DEPENDS+= screen-[0-9]*:../../misc/screen
3049: DEPENDS+= screen>=4.0:../../misc/screen
3050:
3051: [...]
3052:
3053: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3054: .include "../../devel/glib2/buildlink3.mk"
3055: .include "../../mk/bsd.pkg.mk"
3056: </pre>
3057: </li>
1.41 asau 3058: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3059: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.10 hubertf 3060: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3061: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3062: -e</strong></span>, which outputs additional
3063: explanations.</p></li>
1.41 asau 3064: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3065: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, “Common types of packages”</a>. After you have followed the instructions
1.1 dsieger 3066: over there, you can hopefully continue here.</p></li>
1.41 asau 3067: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3068: directory from the extracted files. Besides these files, a lot of cache
3069: files and other system information has been saved in the working
3070: directory, which may become wrong after you edited the
3071: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3072: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3073: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.41 asau 3074: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3075: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3076: everything works.</p></li>
1.41 asau 3077: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3078: contains a list of the files that are installed by the package, is
1.10 hubertf 3079: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3080: >PLIST</strong></span> to generate a probably correct list. Check
3081: the file using your preferred text editor to see if the list of
3082: files looks plausible.</p></li>
1.41 asau 3083: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3084: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3085: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3086: has been registered in the database of installed files, but with an
1.10 hubertf 3087: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3088: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3089: registered with the list of files from
3090: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3091: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3092: package from the set of installed files.</p></li>
3093: </ol></div>
1.41 asau 3094: <div class="sect1">
1.1 dsieger 3095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3096: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3097: <div class="sect2">
1.1 dsieger 3098: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3099: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3100: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3101: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3102: </div>
1.41 asau 3103: <div class="sect2">
1.1 dsieger 3104: <div class="titlepage"><div><div><h3 class="title">
1.121 sevan 3105: <a name="creating.kde-app"></a>10.1.2. KDE3 & KDE4 applications</h3></div></div></div>
1.66 asau 3106: <p>KDE3 applications should always include
1.1 dsieger 3107: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.121 sevan 3108: settings that are typical of KDE3 packages and KDE4 applications should
3109: always include <code class="filename">meta-pkgs/kde4/kde4.mk</code>, respectively.</p>
1.1 dsieger 3110: </div>
1.41 asau 3111: <div class="sect2">
1.17 imil 3112: <div class="titlepage"><div><div><h3 class="title">
3113: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3114: <p>Python modules and programs packages are easily created using a
3115: set of predefined variables.</p>
3116: <p>
1.63 wiz 3117: If some Python versions are not supported by the software, set the
3118: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3119: that are not supported, e.g.
1.17 imil 3120: </p>
3121: <pre class="programlisting">
1.93 sevan 3122: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3123: </pre>
3124: <p>
1.103 wiz 3125: If the packaged software is a Python module, include one of
3126: <code class="filename">../../lang/python/egg.mk</code>,
3127: <code class="filename">../../lang/python/distutils.mk</code>, or
3128: <code class="filename">../../lang/python/extension.mk</code>.</p>
3129: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3130: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3131: if the packaged software is using setuptools, you only need
3132: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3133: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3134: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3135: so pkgsrc will use this framework.
3136: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3137: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3138: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3139: to the name of the script.</p>
3140: <p>Either way, the package directory should be called
1.23 wiz 3141: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3142: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3143: </p>
3144: <pre class="programlisting">
3145: DISTNAME= foopymodule-1.2.10
3146: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3147: </pre>
1.63 wiz 3148: <p>If it is an application, include
3149: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3150: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3151: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3152: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3153: For example:
1.17 imil 3154: </p>
3155: <pre class="programlisting">
1.35 wiz 3156: REPLACE_PYTHON= *.py
1.17 imil 3157: </pre>
1.63 wiz 3158: <p>Some Python modules have separate distributions for Python-2.x
3159: and Python-3.x support. In pkgsrc this is handled by the
3160: <code class="filename">versioned_dependencies.mk</code> file. Set
3161: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3162: packages that should be depended upon and include
3163: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3164: then the pkgsrc infrastructure will depend on the appropriate package
3165: version. For example:
3166: </p>
3167: <pre class="programlisting">
1.123 wiz 3168: PYTHON_VERSIONED_DEPENDENCIES=gobject
1.63 wiz 3169: </pre>
3170: <p>
3171: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3172: of supported packages.</p>
1.17 imil 3173: </div>
1.1 dsieger 3174: </div>
1.41 asau 3175: <div class="sect1">
1.1 dsieger 3176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3177: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3178: <div class="sect2">
1.1 dsieger 3179: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3180: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3181: <div class="sect3">
1.1 dsieger 3182: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3183: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3184: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3185: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3186: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3187: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3188: <pre class="programlisting">
3189: <code class="prompt">$</code> mkdir www/nvu
3190: <code class="prompt">$</code> cd www/nvu
3191: </pre>
3192: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3193: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3194: <pre class="programlisting">
3195: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3196: </pre>
3197: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3198: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3199: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3200: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3201: <code class="varname">COMMENT</code> fields. Then the package
3202: <code class="filename">Makefile</code> looked like that:</p>
3203: <pre class="programlisting">
1.121 sevan 3204: # $NetBSD $
1.1 dsieger 3205: #
3206:
3207: DISTNAME= nvu-1.0-sources
3208: PKGNAME= nvu-1.0
3209: CATEGORIES= www
3210: MASTER_SITES= http://cvs.nvu.com/download/
3211: EXTRACT_SUFX= .tar.bz2
3212:
3213: MAINTAINER= rillig@NetBSD.org
3214: HOMEPAGE= http://cvs.nvu.com/
3215: COMMENT= Web Authoring System
3216:
3217: # url2pkg-marker (please do not remove this line.)
3218: .include "../../mk/bsd.pkg.mk"
3219: </pre>
1.124 wiz 3220: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121 sevan 3221: this is a workaround to prevent CVS expanding to the filename of the
3222: guide.</p>
1.1 dsieger 3223: <p>Then, I quit the editor and watched pkgsrc downloading a large
3224: source archive:</p>
3225: <pre class="programlisting">
3226: url2pkg> Running "make makesum" ...
3227: => Required installed package digest>=20010302: digest-20060826 found
3228: => Fetching nvu-1.0-sources.tar.bz2
3229: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3230: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3231: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3232: url2pkg> Running "make extract" ...
3233: => Required installed package digest>=20010302: digest-20060826 found
3234: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3235: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3236: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3237: ===> Installing dependencies for nvu-1.0
3238: ===> Overriding tools for nvu-1.0
3239: ===> Extracting for nvu-1.0
3240: url2pkg> Adjusting the Makefile.
3241:
3242: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3243:
3244: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3245: </pre>
3246: </div>
1.41 asau 3247: <div class="sect3">
1.1 dsieger 3248: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3249: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1 dsieger 3250: <p>Now that the package has been extracted, let's see what's inside
3251: it. The package has a <code class="filename">README.txt</code>, but that only
3252: says something about mozilla, so it's probably useless for seeing what
3253: dependencies this package has. But since there is a GNU configure script
3254: in the package, let's hope that it will complain about everything it
3255: needs.</p>
3256: <pre class="programlisting">
3257: <code class="prompt">$</code> bmake
3258: => Required installed package digest>=20010302: digest-20060826 found
3259: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3260: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3261: ===> Patching for nvu-1.0
3262: ===> Creating toolchain wrappers for nvu-1.0
3263: ===> Configuring for nvu-1.0
3264: [...]
3265: configure: error: Perl 5.004 or higher is required.
3266: [...]
3267: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3268: [...]
3269: </pre>
3270: <p>That worked quite well. So I opened the package Makefile in my
3271: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3272: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3273: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3274: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3275: from scratch.</p>
3276: <pre class="programlisting">
3277: <code class="prompt">$</code> bmake clean
3278: ===> Cleaning for nvu-1.0
3279: <code class="prompt">$</code> bmake
3280: [...]
3281: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3282: GNU Make. You will not be able to build Mozilla without GNU Make.
3283: [...]
3284: </pre>
1.23 wiz 3285: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3286: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3287: <pre class="programlisting">
3288: [...]
3289: checking for GTK - version >= 1.2.0... no
3290: *** Could not run GTK test program, checking why...
3291: [...]
3292: </pre>
3293: <p>Now to the other dependencies. The first question is: Where is the
3294: GTK package hidden in pkgsrc?</p>
3295: <pre class="programlisting">
3296: <code class="prompt">$</code> echo ../../*/gtk*
3297: [many packages ...]
3298: <code class="prompt">$</code> echo ../../*/gtk
3299: ../../x11/gtk
3300: <code class="prompt">$</code> echo ../../*/gtk2
3301: ../../x11/gtk2
3302: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3303: ../../x11/gtk2/buildlink3.mk
3304: </pre>
3305: <p>The first try was definitely too broad. The second one had exactly
3306: one result, which is very good. But there is one pitfall with GNOME
3307: packages. Before GNOME 2 had been released, there were already many
3308: GNOME 1 packages in pkgsrc. To be able to continue to use these
3309: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3310: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3311: whether this was the case here, and indeed it was.</p>
3312: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3313: file, adding the dependency is very easy. I just inserted an
3314: <code class="literal">.include</code> line before the last line of the package
3315: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3316: <pre class="programlisting">
3317: [...]
3318: .include "../../x11/gtk2/buildlink3.mk"
3319: .include "../../mk/bsd.pkg.mk
3320: </pre>
1.10 hubertf 3321: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3322: was:</p>
3323: <pre class="programlisting">
3324: [...]
3325: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3326: checking for GTK - version >= 1.2.0... no
3327: *** Could not run GTK test program, checking why...
3328: *** The test program failed to compile or link. See the file config.log for the
3329: *** exact error that occured. This usually means GTK was incorrectly installed
3330: *** or that you have moved GTK since it was installed. In the latter case, you
3331: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3332: configure: error: Test for GTK failed.
3333: [...]
3334: </pre>
1.23 wiz 3335: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3336: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3337: told me that this package really wanted to have the GNOME 1 version of
3338: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3339: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3340: So I changed the <code class="literal">x11/gtk2</code> to
3341: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3342: and tried again.</p>
3343: <pre class="programlisting">
3344: [...]
1.59 jnemeth 3345: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3346: In file included from xpidl.c:42:
3347: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3348: In file included from xpidl.c:42:
3349: xpidl.h:132: error: parse error before "IDL_ns"
3350: [...]
3351: </pre>
3352: <p>The package still does not find all of its dependencies. Now the
3353: question is: Which package provides the
3354: <code class="filename">libIDL/IDL.h</code> header file?</p>
3355: <pre class="programlisting">
3356: <code class="prompt">$</code> echo ../../*/*idl*
3357: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3358: <code class="prompt">$</code> echo ../../*/*IDL*
3359: ../../net/libIDL
3360: </pre>
3361: <p>Let's take the one from the second try. So I included the
3362: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3363: again. But the error didn't change. After digging through some of the
3364: code, I concluded that the build process of the package was broken and
3365: couldn't have ever worked, but since the Mozilla source tree is quite
3366: large, I didn't want to fix it. So I added the following to the package
3367: <code class="filename">Makefile</code> and tried again:</p>
3368: <pre class="programlisting">
3369: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3370: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3371: </pre>
3372: <p>The latter line is needed because the package expects the library
3373: <code class="filename">libIDL.so</code>, but only
3374: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3375: wrapper to rewrite that on the fly.</p>
3376: <p>The next problem was related to a recent change of the FreeType
1.120 sevan 3377: interface. I looked up in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.1 dsieger 3378: which patch files were relevant for this issue and copied them to the
3379: <code class="filename">patches</code> directory. Then I retried, fixed the
3380: patches so that they applied cleanly and retried again. This time,
3381: everything worked.</p>
3382: </div>
1.41 asau 3383: <div class="sect3">
1.1 dsieger 3384: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3385: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3386: <pre class="programlisting">
3387: <code class="prompt">$</code> bmake CHECK_FILES=no install
3388: [...]
3389: <code class="prompt">$</code> bmake print-PLIST >PLIST
3390: <code class="prompt">$</code> bmake deinstall
3391: <code class="prompt">$</code> bmake install
3392: </pre>
3393: </div>
3394: </div>
3395: </div>
3396: </div>
1.41 asau 3397: <div class="chapter">
1.1 dsieger 3398: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3399: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3400: <div class="toc">
3401: <p><b>Table of Contents</b></p>
1.100 leot 3402: <dl class="toc">
1.23 wiz 3403: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3404: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108 rillig 3405: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3406: <dd><dl>
3407: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3408: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3409: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3410: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3411: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3412: </dl></dd>
3413: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3414: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3415: <dd><dl>
3416: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3417: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3418: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3419: </dl></dd>
1.23 wiz 3420: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3421: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3422: </dl>
3423: </div>
3424: <p>Whenever you're preparing a package, there are a number of
3425: files involved which are described in the following
3426: sections.</p>
1.41 asau 3427: <div class="sect1">
1.1 dsieger 3428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3429: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3430: </h2></div></div></div>
3431: <p>Building, installation and creation of a binary package are all
3432: controlled by the package's <code class="filename">Makefile</code>.
3433: The <code class="filename">Makefile</code> describes various things about
3434: a package, for example from where to get it, how to configure,
3435: build, and install it.</p>
3436: <p>A package <code class="filename">Makefile</code> contains several
3437: sections that describe the package.</p>
3438: <p>In the first section there are the following variables, which
3439: should appear exactly in the order given here. The order and
3440: grouping of the variables is mostly historical and has no further
3441: meaning.</p>
1.41 asau 3442: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3443: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3444: distribution file to be downloaded from the package's
3445: website.</p></li>
1.23 wiz 3446: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3447: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3448: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3449: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3450: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3451: directory name together with the version number. It must match the
3452: regular expression
3453: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3454: starts with a letter or digit, and contains only letters, digits,
3455: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3456: <li class="listitem">
1.1 dsieger 3457: <p><code class="varname">CATEGORIES</code> is a list of categories
3458: which the package fits in. You can choose any of the top-level
3459: directories of pkgsrc for it.</p>
3460: <p>Currently the following values are available for
3461: <code class="varname">CATEGORIES</code>. If more than
3462: one is used, they need to be separated by spaces:</p>
3463: <pre class="programlisting">
3464: archivers cross geography meta-pkgs security
3465: audio databases graphics misc shells
3466: benchmarks devel ham multimedia sysutils
3467: biology editors inputmethod net textproc
3468: cad emulators lang news time
3469: chat finance mail parallel wm
3470: comms fonts math pkgtools www
3471: converters games mbone print x11
3472: </pre>
3473: </li>
1.23 wiz 3474: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3475: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3476: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3477: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 3478: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.1 dsieger 3479: </ul></div>
3480: <p>The second section contains information about separately
3481: downloaded patches, if any.
3482: </p>
1.41 asau 3483: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3484: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3485: Name(s) of additional files that contain distribution patches.
3486: There is no default. pkgsrc will look for them at
3487: <code class="varname">PATCH_SITES</code>.
3488: They will automatically be uncompressed before patching if
3489: the names end with <code class="filename">.gz</code> or
3490: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3491: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3492: Primary location(s) for distribution patch files (see
1.80 wiz 3493: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3494: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.125 leot 3495: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.80 wiz 3496: help find the correct files to patch. It defaults to
3497: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3498: </ul></div>
3499: <p>The third section contains the following variables.
3500: </p>
1.41 asau 3501: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3502: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3503: address of the person who feels responsible for this package,
3504: and who is most likely to look at problems or questions regarding
1.125 leot 3505: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14 jmcneill 3506: Other developers may contact the <code class="varname">MAINTAINER</code>
3507: before making changes to the package, but are not required to
3508: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3509: to yourself. If you really can't maintain the package for future
3510: updates, set it to
1.10 hubertf 3511: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3512: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3513: of <code class="varname">MAINTAINER</code> when you do not want other
3514: developers to update or change the package without contacting
3515: you first. A package Makefile should contain one of
3516: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3517: not both. </p></li>
1.23 wiz 3518: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3519: find more information about the package.</p></li>
1.23 wiz 3520: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3521: description of the package (should not include the package
3522: name).</p></li>
1.122 leot 3523: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3524: applicable for the package. See <a class="xref" href="#handling-licenses" title="19.1.3. Handling licenses">Section 19.1.3, “Handling licenses”</a> for further details.</p></li>
1.1 dsieger 3525: </ul></div>
3526: <p>Other variables that affect the build:
3527: </p>
1.41 asau 3528: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3529: <p><code class="varname">WRKSRC</code>: The directory where the
3530: interesting distribution files of the package are found. The
3531: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3532: works for most packages.</p>
3533: <p>If a package doesn't create a subdirectory for itself
3534: (most GNU software does, for instance), but extracts itself in
3535: the current directory, you should set
3536: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3537: <p>If a package doesn't create a subdirectory with the
3538: name of <code class="varname">DISTNAME</code> but some different name,
3539: set <code class="varname">WRKSRC</code> to point to the proper name in
3540: <code class="filename">${WRKDIR}</code>, for example
3541: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.120 sevan 3542: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.1 dsieger 3543: <p>The name of the working directory created by pkgsrc is
3544: taken from the <code class="varname">WRKDIR_BASENAME</code>
3545: variable. By default, its value is
3546: <code class="filename">work</code>. If you want to use the same
3547: pkgsrc tree for building different kinds of binary packages,
3548: you can change the variable according to your needs. Two
3549: other variables handle common cases of setting
3550: <code class="varname">WRKDIR_BASENAME</code> individually. If
3551: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3552: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3553: the host's name is attached to the directory name. If
3554: <code class="varname">OBJMACHINE</code> is defined, the platform name
3555: is attached, which might look like
3556: <code class="filename">work.i386</code> or
3557: <code class="filename">work.sparc</code>.</p>
3558: </li></ul></div>
3559: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3561: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3562: installed in compressed form by the package. For packages using
3563: BSD-style makefiles which honor MANZ, there is
3564: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3565: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3566: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3567: below).</p></li>
1.23 wiz 3568: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.1 dsieger 3569: </ul></div>
3570: </div>
1.41 asau 3571: <div class="sect1">
1.1 dsieger 3572: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3573: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 3574: </h2></div></div></div>
3575: <p>The <code class="filename">distinfo</code> file contains the message
3576: digest, or checksum, of each distfile needed for the package. This
3577: ensures that the distfiles retrieved from the Internet have not been
3578: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3579: a security hole. To provide maximum security, all distfiles are
3580: protected using three different message digest algorithms (SHA1,
3581: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3582: <p>The <code class="filename">distinfo</code> file also contains the
3583: checksums for all the patches found in the
1.108 rillig 3584: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a>).</p>
1.1 dsieger 3585: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3586: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3587: <p>Some packages have different sets of distfiles depending on
1.120 sevan 3588: the platform, for example <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.1 dsieger 3589: <code class="filename">distinfo</code> file and care should be taken when
3590: upgrading such a package to ensure distfile information is not
3591: lost.</p>
3592: </div>
1.41 asau 3593: <div class="sect1">
1.1 dsieger 3594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 3595: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
3596: </h2></div></div></div>
3597: <p>Some packages don't work out-of-the box on the various
3598: platforms that are supported by pkgsrc. These packages need
3599: to be patched to make them work. The patch files can be
1.1 dsieger 3600: found in the <code class="filename">patches/</code> directory.</p>
3601: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3602: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3603: extracting them, in alphabetic order.</p>
1.41 asau 3604: <div class="sect2">
1.1 dsieger 3605: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3606: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3607: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3608: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3609: problems. (To force patches to apply with fuzz you can set
3610: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3611: should contain only changes for a single file, and no file should be
3612: patched by more than one patch file. This helps to keep future
3613: modifications simple.</p>
3614: <p>Each patch file is structured as follows: In the first line,
3615: there is the RCS Id of the patch itself. The second line should be
3616: empty for aesthetic reasons. After that, there should be a comment for
3617: each change that the patch does. There are a number of standard
3618: cases:</p>
1.41 asau 3619: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3620: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3621: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3622: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3623: platform and other environment (for example, the compiler) that the
3624: patch is needed for.</p></li>
3625: </ul></div>
1.108 rillig 3626: <p>The patch should be commented so that any
1.1 dsieger 3627: developer who knows the code of the application can make some use of
3628: the patch. Special care should be taken for the upstream developers,
3629: since we generally want that they accept our patches, so we have less
3630: work in the future.</p>
3631: </div>
1.41 asau 3632: <div class="sect2">
1.1 dsieger 3633: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3634: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3635: <p>One important thing to mention is to pay attention that no RCS
3636: IDs get stored in the patch files, as these will cause problems when
3637: later checked into the NetBSD CVS tree. Use the
1.120 sevan 3638: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.1 dsieger 3639: problems.</p>
3640: <p>For even more automation, we recommend using
1.10 hubertf 3641: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3642: whole set of patches. You just have to backup files before you
3643: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3644: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3645: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3646: you upgrade a package this way, you can easily compare the new
3647: set of patches with the previously existing one with
1.24 wiz 3648: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3649: are replaced by new files, so carefully check if you want to take all
3650: the changes.</p>
1.1 dsieger 3651: <p>When you have finished a package, remember to generate
1.10 hubertf 3652: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 3653: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.1 dsieger 3654: <p>When adding a patch that corrects a problem in the
3655: distfile (rather than e.g. enforcing pkgsrc's view of where
3656: man pages should go), send the patch as a bug report to the
3657: maintainer. This benefits non-pkgsrc users of the package,
3658: and usually makes it possible to remove the patch in future
3659: version.</p>
1.2 rillig 3660: <p>The file names of the patch files are usually of the form
1.24 wiz 3661: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3662: Many packages still use the previous convention
3663: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3664: but new patches should be of the form containing the filename.
1.120 sevan 3665: <span class="command"><strong>mkpatches</strong></span> included in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.24 wiz 3666: automatically.</p>
1.1 dsieger 3667: </div>
1.41 asau 3668: <div class="sect2">
1.1 dsieger 3669: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3670: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3671: <p>If you want to share patches between multiple packages
3672: in pkgsrc, e.g. because they use the same distfiles, set
3673: <code class="varname">PATCHDIR</code> to the path where the patch files
3674: can be found, e.g.:</p>
3675: <pre class="programlisting">
3676: PATCHDIR= ${.CURDIR}/../xemacs/patches
3677: </pre>
3678: <p>Patch files that are distributed by the author or other
3679: maintainers can be listed in
3680: <code class="varname">PATCHFILES</code>.</p>
3681: <p>If it is desired to store any patches that should not be
3682: committed into pkgsrc, they can be kept outside the pkgsrc
3683: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3684: directory tree there is expected to have the same
1.23 wiz 3685: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3686: patches are expected to be stored inside these dirs (also
3687: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3688: example, if you want to keep a private patch for
3689: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3690: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3691: files in the named directory are expected to be patch files,
3692: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3693: applied</em></span>.</p>
3694: </div>
1.41 asau 3695: <div class="sect2">
1.1 dsieger 3696: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3697: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3698: <p>When fixing a portability issue in the code do not use
3699: preprocessor magic to check for the current operating system nor
3700: platform. Doing so hurts portability to other platforms because
3701: the OS-specific details are not abstracted appropriately.</p>
3702: <p>The general rule to follow is: instead of checking for the
3703: operating system the application is being built on, check for the
3704: specific <span class="emphasis"><em>features</em></span> you need. For example,
3705: instead of assuming that kqueue is available under NetBSD and
3706: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3707: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3708: yes, this generally involves patching the
1.10 hubertf 3709: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3710: that prevents some OSes from adopting interfaces from other OSes
3711: (e.g. Linux implementing kqueue), something that the above checks
3712: cannot take into account.</p>
3713: <p>Of course, checking for features generally involves more
3714: work on the developer's side, but the resulting changes are
3715: cleaner and there are chances they will work on many other
3716: platforms. Not to mention that there are higher chances of being
3717: later integrated into the mainstream sources. Remember:
3718: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3719: <p>Some typical examples:</p>
3720: <div class="table">
1.6 rillig 3721: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.106 tnn 3722: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3723: <colgroup>
3724: <col>
3725: <col>
3726: <col>
3727: </colgroup>
3728: <thead><tr>
3729: <th>Where</th>
3730: <th>Incorrect</th>
3731: <th>Correct</th>
3732: </tr></thead>
3733: <tbody>
3734: <tr>
3735: <td>configure script</td>
3736: <td>
3737: <pre class="programlisting">
3738: case ${target_os} in
3739: netbsd*) have_kvm=yes ;;
3740: *) have_kvm=no ;;
3741: esac
3742: </pre>
3743: </td>
3744: <td>
3745: <pre class="programlisting">
3746: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3747: </pre>
3748: </td>
3749: </tr>
3750: <tr>
3751: <td>C source file</td>
3752: <td>
3753: <pre class="programlisting">
3754: #if defined(__NetBSD__)
3755: # include <sys/event.h>
3756: #endif
3757: </pre>
3758: </td>
3759: <td>
3760: <pre class="programlisting">
3761: #if defined(HAVE_SYS_EVENT_H)
3762: # include <sys/event.h>
3763: #endif
3764: </pre>
3765: </td>
3766: </tr>
3767: <tr>
3768: <td>C source file</td>
3769: <td>
3770: <pre class="programlisting">
3771: int
3772: monitor_file(...)
3773: {
3774: #if defined(__NetBSD__)
3775: int fd = kqueue();
3776: ...
3777: #else
3778: ...
3779: #endif
3780: }
3781: </pre>
3782: </td>
3783: <td>
3784: <pre class="programlisting">
3785: int
3786: monitor_file(...)
3787: {
3788: #if defined(HAVE_KQUEUE)
3789: int fd = kqueue();
3790: ...
3791: #else
1.112 rillig 3792: ...
1.1 dsieger 3793: #endif
3794: }
3795: </pre>
3796: </td>
3797: </tr>
3798: </tbody>
3799: </table></div>
3800: </div>
3801: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 3802: packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
3803: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 3804: 2</a>). It summarizes multiple details on how to make
3805: software easier to package; all the suggestions in it were
3806: collected from our experience in pkgsrc work, so they are possibly
3807: helpful when creating patches too.</p>
3808: </div>
1.41 asau 3809: <div class="sect2">
1.1 dsieger 3810: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3811: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3812: <p>Always, always, <span class="strong"><strong>always</strong></span>
3813: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3814: improvements you do to a package to the mainstream developers.
3815: This is the only way to get their attention on portability issues
3816: and to ensure that future versions can be built out-of-the box on
3817: NetBSD. Furthermore, any user that gets newer distfiles will get
3818: the fixes straight from the packaged code.</p>
3819: <p>This generally involves cleaning up the patches
3820: (because sometimes the patches that are
1.40 wiz 3821: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3822: appropriate trackers for the projects and working with the
3823: mainstream authors to accept your changes. It is
3824: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3825: the packages in pkgsrc are kept simple and thus further changes
3826: can be done without much hassle.</p>
1.24 wiz 3827: <p>When you have done this, please add a URL to the upstream
3828: bug report to the patch comment.</p>
1.1 dsieger 3829: <p>Support the idea of free software!</p>
3830: </div>
3831: </div>
1.41 asau 3832: <div class="sect1">
1.1 dsieger 3833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3834: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 3835: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3836: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3837: <dd><p>A multi-line description of the piece of software. This should include
3838: any credits where they are due. Please bear in mind that others do not
3839: share your sense of humour (or spelling idiosyncrasies), and that others
3840: will read everything that you write here.</p></dd>
3841: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3842: <dd><p>This file governs the files that are installed on your
3843: system: all the binaries, manual pages, etc. There are other
3844: directives which may be entered in this file, to control the
3845: creation and deletion of directories, and the location of
1.10 hubertf 3846: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 3847: information.</p></dd>
3848: </dl></div>
3849: </div>
1.41 asau 3850: <div class="sect1">
1.1 dsieger 3851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3852: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 3853: <div class="sect2">
1.1 dsieger 3854: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3855: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 3856: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3857: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 3858: <dd>
1.125 leot 3859: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 3860: First time after package extraction and before files are
3861: moved in place, the second time after the files to install
3862: are moved in place. This can be used to do any custom
3863: procedures not possible with @exec commands in
1.125 leot 3864: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3865: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.
1.28 wiz 3866: Please note that you can modify variables in it easily by using
3867: <code class="varname">FILES_SUBST</code> in the package's
3868: <code class="filename">Makefile</code>:</p>
3869: <pre class="programlisting">
3870: FILES_SUBST+= SOMEVAR="somevalue"
3871: </pre>
3872: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3873: <code class="filename">INSTALL</code>. By default, substitution is
3874: performed for <code class="varname">PREFIX</code>,
3875: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3876: <code class="varname">VARBASE</code>, and a few others, type
3877: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3878: complete list.</p>
3879: </dd>
1.1 dsieger 3880: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3881: <dd><p>This script is executed before and after any files are removed. It is
3882: this script's responsibility to clean up any additional messy details
3883: around the package's installation, since all pkg_delete knows is how to
3884: delete the files created in the original distribution.
1.125 leot 3885: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3886: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28 wiz 3887: The same methods to replace variables can be used as for
3888: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 3889: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3890: <dd>
3891: <p>This file is displayed after installation of the package.
3892: Useful for things like legal notices on almost-free
3893: software and hints for updating config files after
3894: installing modules for apache, PHP etc.
3895: Please note that you can modify variables in it easily by using
3896: <code class="varname">MESSAGE_SUBST</code> in the package's
3897: <code class="filename">Makefile</code>:</p>
3898: <pre class="programlisting">
3899: MESSAGE_SUBST+= SOMEVAR="somevalue"
3900: </pre>
1.23 wiz 3901: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 3902: <code class="filename">MESSAGE</code>. By default, substitution is
3903: performed for <code class="varname">PKGNAME</code>,
3904: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 3905: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 3906: <code class="varname">PKG_SYSCONFDIR</code>,
3907: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 3908: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 3909: <p>You can display a different or additional files by
3910: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3911: default is <code class="filename">MESSAGE</code>, if the file
3912: exists.</p>
3913: </dd>
3914: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 3915: <dd>
3916: <p>This file is used by the alternatives framework.
3917: It creates, configures, and destroys generic wrappers used to
3918: run programs with similar interfaces.
3919: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3920: for more information.</p>
3921: <p>Each line of the file contains two filenames, first
3922: the wrapper and then the alternative provided by the package.
3923: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3924: </dd>
1.1 dsieger 3925: </dl></div>
3926: </div>
1.41 asau 3927: <div class="sect2">
1.1 dsieger 3928: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3929: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 3930: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3931: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3932: <dd><p>This file contains arbitrary things that could
3933: also go into a <code class="filename">Makefile</code>, but its purpose is
3934: to be used by more than one package. This file should only be
3935: used when the packages that will use the file are known in
3936: advance. For other purposes it is often better to write a
3937: <code class="filename">*.mk</code> file and give it a good name that
3938: describes what it does.</p></dd>
3939: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3940: <dd><p>This file contains the dependency information
1.10 hubertf 3941: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1 dsieger 3942: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3943: <dd><p>This file contains workarounds for compiler bugs
3944: and similar things. It is included automatically by the pkgsrc
3945: infrastructure, so you don't need an extra
3946: <code class="literal">.include</code> line for
3947: it.</p></dd>
3948: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3949: <dd><p>This file contains the code for the
1.10 hubertf 3950: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1 dsieger 3951: selected by the user. If a package has only one or two options,
3952: it is equally acceptable to put the code directly into the
3953: <code class="filename">Makefile</code>.</p></dd>
3954: </dl></div>
3955: </div>
1.41 asau 3956: <div class="sect2">
1.1 dsieger 3957: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3958: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 3959: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3960: <dt><span class="term"><code class="filename">README*</code></span></dt>
3961: <dd><p>These files do not take place in the creation of
3962: a package and thus are purely informative to the package
3963: developer.</p></dd>
3964: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3965: <dd><p>This file contains things that need to be done
3966: to make the package even
3967: better.</p></dd>
3968: </dl></div>
3969: </div>
3970: </div>
1.41 asau 3971: <div class="sect1">
1.1 dsieger 3972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3973: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 3974: </h2></div></div></div>
1.10 hubertf 3975: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 3976: unpacked into the directory denoted by
3977: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 3978: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 3979: directory is also used to keep various timestamp files.
3980: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3981: The default is <code class="filename">${.CURDIR}/work</code>
3982: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3983: if <code class="varname">OBJMACHINE</code> is set.</p>
3984: </div>
1.41 asau 3985: <div class="sect1">
1.1 dsieger 3986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3987: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 3988: </h2></div></div></div>
3989: <p>If you have any files that you wish to be placed in the package prior
3990: to configuration or building, you could place these files here and use
1.10 hubertf 3991: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 3992: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 3993: this. Alternatively, you could simply diff the file against
3994: <code class="filename">/dev/null</code> and use the patch mechanism to manage
3995: the creation of this file.</p>
3996: <p>If you want to share files in this way with other
3997: packages, set the <code class="varname">FILESDIR</code> variable to point
3998: to the other package's <code class="filename">files</code> directory,
3999: e.g.:</p>
4000: <pre class="programlisting">
4001: FILESDIR=${.CURDIR}/../xemacs/files
4002: </pre>
4003: </div>
4004: </div>
1.41 asau 4005: <div class="chapter">
1.1 dsieger 4006: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4007: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4008: <div class="toc">
4009: <p><b>Table of Contents</b></p>
1.100 leot 4010: <dl class="toc">
1.6 rillig 4011: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4012: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4013: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4014: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4015: <dd><dl>
4016: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117 sevan 4017: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108 rillig 4018: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
4019: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4020: </dl></dd>
4021: </dl>
4022: </div>
4023: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4024: each of which forms a well-defined part of the pkgsrc system. Using
1.125 leot 4025: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1 dsieger 4026: like pkgsrc requires some discipline to keep the code correct and
4027: understandable.</p>
4028: <p>The basic ingredients for <code class="filename">Makefile</code>
4029: programming are variables (which are actually macros) and shell
4030: commands. Among these shell commands may even be more complex ones
1.125 leot 4031: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1 dsieger 4032: as intended it is necessary to quote all variables correctly when they
4033: are used.</p>
4034: <p>This chapter describes some patterns, that appear quite often in
4035: <code class="filename">Makefile</code>s, including the pitfalls that come along
4036: with them.</p>
1.41 asau 4037: <div class="sect1">
1.1 dsieger 4038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4039: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4041: <p>When you are creating a file as a
4042: target of a rule, always write the data to a temporary file first
4043: and finally rename that file. Otherwise there might occur an error
4044: in the middle of generating the file, and when the user runs
1.125 leot 4045: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1 dsieger 4046: regenerated properly. Example:</p>
4047: <pre class="programlisting">
4048: wrong:
4049: @echo "line 1" > ${.TARGET}
4050: @echo "line 2" >> ${.TARGET}
4051: @false
4052:
4053: correct:
4054: @echo "line 1" > ${.TARGET}.tmp
4055: @echo "line 2" >> ${.TARGET}.tmp
4056: @false
4057: @mv ${.TARGET}.tmp ${.TARGET}
4058: </pre>
1.10 hubertf 4059: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4060: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4061: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4062: correct</strong></span> gives an error message twice, as expected.</p>
1.125 leot 4063: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1 dsieger 4064: <code class="literal">${.TARGET}</code> in case of error, but this only
4065: happens when it is interrupted, for example by pressing
4066: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.125 leot 4067: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1 dsieger 4068: </li></ul></div>
4069: </div>
1.41 asau 4070: <div class="sect1">
1.1 dsieger 4071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4072: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4073: <p><code class="filename">Makefile</code> variables contain strings that
4074: can be processed using the five operators ``='', ``+='', ``?='',
1.125 leot 4075: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1 dsieger 4076: page.</p>
4077: <p>When a variable's value is parsed from a
4078: <code class="filename">Makefile</code>, the hash character ``#'' and the
4079: backslash character ``\'' are handled specially. If a backslash is
4080: followed by a newline, any whitespace immediately in front of the
4081: backslash, the backslash, the newline, and any whitespace
4082: immediately behind the newline are replaced with a single space. A
4083: backslash character and an immediately following hash character are
4084: replaced with a single hash character. Otherwise, the backslash is
4085: passed as is. In a variable assignment, any hash character that is
4086: not preceded by a backslash starts a comment that continues upto the
4087: end of the logical line.</p>
1.108 rillig 4088: <p>The evaluation of variables either happens immediately or lazy.
4089: It happens immediately when the variable occurs
4090: on the right-hand side of the ``:='' or the ``!='' operator, in a
4091: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4092: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4093: <p>Some of the modifiers split the string into words and then
4094: operate on the words, others operate on the string as a whole. When
1.125 leot 4095: a string is split into words, it is split like in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.1 dsieger 4096: <p>There are several types of variables that should be handled
4097: differently. Strings and two types of lists.</p>
1.41 asau 4098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4099: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4100: characters. Nevertheless, you should restrict yourself to only
4101: using printable characters. Examples are
4102: <code class="varname">PREFIX</code> and
4103: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4104: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4105: are never exported to any shell command. Their elements are
4106: separated by whitespace. Therefore, the elements themselves cannot
4107: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4108: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4109: Examples are <code class="varname">DEPENDS</code> and
4110: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4111: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4112: may be exported to a shell command. Their elements can contain any
4113: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4114: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4115: <code class="varname">DISTFILES</code> and
4116: <code class="varname">MASTER_SITES</code>.</p></li>
4117: </ul></div>
1.41 asau 4118: <div class="sect2">
1.1 dsieger 4119: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4120: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4121: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4122: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4123: are reserved for use by the pkgsrc infrastructure. They shall
4124: not be used by package
4125: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4126: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4127: lowercase variable names for the iteration
4128: variables.</p></li>
1.23 wiz 4129: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4130: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4131: <code class="varname">DISTFILES</code>.</p></li>
4132: </ul></div>
4133: </div>
4134: </div>
1.41 asau 4135: <div class="sect1">
1.1 dsieger 4136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4137: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.41 asau 4138: <div class="sect2">
1.1 dsieger 4139: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4140: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4141: <p>When adding a string that possibly contains whitespace or quotes to
4142: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4143: modifier.</p>
4144: <p>When adding another list to a list (example 2), it must not be
4145: quoted, since its elements are already quoted.</p>
1.1 dsieger 4146: <pre class="programlisting">
1.108 rillig 4147: STRING= foo * bar `date`
4148: LIST= # empty
4149: ANOTHER_LIST= a=b c=d
4150:
4151: LIST+= ${STRING:Q} # 1
4152: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4153: </pre>
4154: </div>
1.41 asau 4155: <div class="sect2">
1.1 dsieger 4156: <div class="titlepage"><div><div><h3 class="title">
1.117 sevan 4157: <a name="echo-literal"></a>12.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108 rillig 4158: <p>Echoing a string containing special characters needs special
4159: work.</p>
1.1 dsieger 4160: <pre class="programlisting">
4161: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4162: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4163:
4164: all:
4165: echo ${STRING} # 1
1.108 rillig 4166: echo ${STRING:Q} # 2
4167: printf '%s\n' ${STRING:Q}'' # 3
4168: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4169: </pre>
4170: <p>Example 1 leads to a syntax error in the shell, as the characters
4171: are just copied.</p>
4172: <p>Example 2 quotes the string so that the shell interprets it
4173: correctly. But the echo command may additionally interpret strings with a
4174: leading dash or those containing backslashes.</p>
1.125 leot 4175: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.108 rillig 4176: interprets the format string, but not the next argument.</p>
4177: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4178: need to be quoted because the quoting has already been done
4179: when adding elements to the list.</p>
1.1 dsieger 4180: </div>
1.41 asau 4181: <div class="sect2">
1.1 dsieger 4182: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 4183: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
4184: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4185: GNU-style configure script (especially those that call other configure
4186: scripts), it must not have leading or trailing whitespace, since
4187: otherwise the configure script gets confused. To trim leading and
4188: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4189: following example:</p>
1.1 dsieger 4190: <pre class="programlisting">
4191: CPPFLAGS= # empty
1.108 rillig 4192: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4193: CPPFLAGS+= ${MY_CPPFLAGS}
4194:
4195: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4196:
4197: all:
4198: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4199: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4200: </pre>
1.108 rillig 4201: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4202: trailing whitespace because the <code class="code">+=</code> operator always adds a
4203: space.</p>
4204: </div>
4205: <div class="sect2">
4206: <div class="titlepage"><div><div><h3 class="title">
4207: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
4208: <p>When a possibly empty variable is used in a shell program, it may
4209: lead to a syntax error.</p>
4210: <pre class="programlisting">
4211: EGFILES= # empty
4212:
4213: install-examples: # produces a syntax error in the shell
4214: for egfile in ${EGFILES}; do \
4215: echo "Installing $$egfile"; \
4216: done
4217: </pre>
4218: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.125 leot 4219: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.108 rillig 4220: To fix this syntax error, use one of the snippets below.</p>
4221: <pre class="programlisting">
4222: EMPTY= # empty
4223:
4224: install-examples:
4225: for egfile in ${EGFILES} ""; do \
4226: [ -n "$$egfile" ] || continue; \
4227: echo "Installing $$egfile"; \
1.1 dsieger 4228: done
1.108 rillig 4229: </pre>
4230: <p>In this case, an empty string is appended to the iteration list (to
4231: prevent the syntax error) and filtered out later.</p>
4232: <pre class="programlisting">
4233: EGFILES= # empty
1.1 dsieger 4234:
1.108 rillig 4235: install-examples:
4236: .for egfile in ${EGFILES}
4237: echo "Installing ${egfile}"
1.1 dsieger 4238: .endfor
4239: </pre>
1.108 rillig 4240: <p>This variant only works when <code class="varname">EGFILES</code> does not
4241: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
4242: simple whitespace.</p>
4243: <p>To have a shell command test whether a make variable is empty, use
4244: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4245: </div>
4246: </div>
4247: </div>
1.41 asau 4248: <div class="chapter">
1.1 dsieger 4249: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4250: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4251: <div class="toc">
4252: <p><b>Table of Contents</b></p>
1.100 leot 4253: <dl class="toc">
1.6 rillig 4254: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4255: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4256: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 4257: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4258: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4259: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 4260: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4261: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4262: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4263: </dl>
4264: </div>
4265: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4266: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4267: the package (relative to the <code class="filename">${PREFIX}</code>
4268: directory it's been installed in) plus some additional statements
1.125 leot 4269: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 4270: This chapter addresses some issues that need attention when
4271: dealing with the <code class="filename">PLIST</code> file (or files, see
4272: below!).</p>
1.41 asau 4273: <div class="sect1">
1.1 dsieger 4274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4275: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4276: <p>Be sure to add a RCS ID line as the first thing in any
4277: <code class="filename">PLIST</code> file you write:</p>
4278: <pre class="programlisting">
1.121 sevan 4279: @comment $NetBSD $
1.111 sevan 4280: </pre>
1.123 wiz 4281: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4282: workaround here to prevent CVS expanding to the filename of the guide. When
1.125 leot 4283: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 4284: </div>
1.41 asau 4285: <div class="sect1">
1.1 dsieger 4286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4287: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4288: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4289: to output a PLIST that matches any new files since the package
1.10 hubertf 4290: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.1 dsieger 4291: more information on this target.</p>
4292: </div>
1.41 asau 4293: <div class="sect1">
1.1 dsieger 4294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4295: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4296: </h2></div></div></div>
4297: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4298: of AWK patterns and actions that are used to filter the output of
4299: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4300: scripting you like to it, but be careful with quoting.</p>
4301: <p>For example, to get all files inside the
4302: <code class="filename">libdata/foo</code> directory removed from the
4303: resulting PLIST:</p>
4304: <pre class="programlisting">
4305: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4306: </pre>
1.1 dsieger 4307: </div>
1.41 asau 4308: <div class="sect1">
1.1 dsieger 4309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4310: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4311: <p>A number of variables are substituted automatically in
4312: PLISTs when a package is installed on a system. This includes the
4313: following variables:</p>
1.41 asau 4314: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4315: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4316: <dd>
4317: <p>Some packages like emacs and perl embed information
4318: about which architecture they were built on into the
4319: pathnames where they install their files. To handle this
4320: case, PLIST will be preprocessed before actually used, and
4321: the symbol
1.23 wiz 4322: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4323: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4324: same is done if the string
4325: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4326: PLIST somewhere - use this on packages that have GNU
4327: autoconf-created configure scripts.</p>
1.41 asau 4328: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4329: <h3 class="title">Legacy note</h3>
4330: <p>There used to be a symbol
1.23 wiz 4331: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4332: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4333: -m</strong></span>, but that's no longer supported and has
4334: been removed.</p>
4335: </div>
4336: </dd>
4337: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4338: <dd>
4339: <p>Some packages want to embed the OS name and version
4340: into some paths. To do this, use these variables in the
4341: <code class="filename">PLIST</code>:
4342: </p>
1.41 asau 4343: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4344: <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>
4345: <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>
4346: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.1 dsieger 4347: </ul></div>
4348: </dd>
4349: </dl></div>
1.88 tnn 4350: <p>For a list of values which are replaced by
4351: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4352: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4353: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4354: <p>If you want to change other variables not listed above, you
4355: can add variables and their expansions to this variable in the
1.10 hubertf 4356: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.1 dsieger 4357: <pre class="programlisting">
4358: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4359: </pre>
1.23 wiz 4360: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4361: in the <code class="filename">PLIST</code> with
1.23 wiz 4362: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4363: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4364: the common case of conditionally including some
4365: <code class="filename">PLIST</code> entries. It can be done by adding
4366: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4367: setting the corresponding <code class="varname">PLIST.foo</code> variable
4368: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4369: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4370: in the <code class="filename">PLIST</code> with either
1.23 wiz 4371: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4372: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4373: For example, in <code class="filename">Makefile</code>:</p>
4374: <pre class="programlisting">
1.112 rillig 4375: PLIST_VARS+= foo
1.18 snj 4376: .if <em class="replaceable"><code>condition</code></em>
1.112 rillig 4377: PLIST.foo= yes
1.18 snj 4378: .else
1.111 sevan 4379: </pre>
1.18 snj 4380: <p>And then in <code class="filename">PLIST</code>:</p>
4381: <pre class="programlisting">
1.121 sevan 4382: @comment $NetBSD $
1.18 snj 4383: bin/bar
4384: man/man1/bar.1
4385: ${PLIST.foo}bin/foo
4386: ${PLIST.foo}man/man1/foo.1
4387: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4388: </pre>
1.123 wiz 4389: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4390: workaround here to prevent CVS expanding to the filename of the guide. When
4391: adding the RCS ID the space should be ommited.</p>
1.1 dsieger 4392: </div>
1.41 asau 4393: <div class="sect1">
1.1 dsieger 4394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4395: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 4396: <p>Man pages should be installed in compressed form if
4397: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4398: and uncompressed otherwise. To handle this in the
1.23 wiz 4399: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4400: appended/removed automatically for man pages according to
4401: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4402: or not, see above for details. This modification of the
4403: <code class="filename">PLIST</code> file is done on a copy of it, not
4404: <code class="filename">PLIST</code> itself.</p>
4405: </div>
1.41 asau 4406: <div class="sect1">
1.1 dsieger 4407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4408: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4409: </h2></div></div></div>
4410: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4411: in generating the binary package, set the variable
4412: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.125 leot 4413: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1 dsieger 4414: important. The default for <code class="varname">PLIST_SRC</code> is
4415: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4416: </div>
1.41 asau 4417: <div class="sect1">
1.1 dsieger 4418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4419: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4420: <p>Some packages decide to install a different set of files based on
4421: the operating system being used. These differences can be
4422: automatically handled by using the following files:</p>
1.41 asau 4423: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4424: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4425: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4426: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4427: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4428: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4429: </ul></div>
4430: </div>
1.41 asau 4431: <div class="sect1">
1.1 dsieger 4432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 4433: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
4434: <p>Some packages decide to generate hard-to-guess file names
4435: during installation that are hard to wire down.</p>
4436: <p>In such cases, you can set the
4437: <code class="varname">GENERATE_PLIST</code> variable to shell code
4438: terminated (with a semicolon) that will output PLIST entries which
4439: will be appended to the PLIST</p>
4440: <p>You can find one example in editors/xemacs:</p>
4441: <pre class="programlisting">
1.111 sevan 4442: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4443: </pre>
1.86 wiz 4444: <p>which will append something like
4445: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4446: <code class="filename">PLIST</code>.
4447: </p>
4448: </div>
4449: <div class="sect1">
4450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4451: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4452: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4453: multiple (and unrelated) packages install files. These
1.22 jakllsch 4454: directories were problematic because you had to add special
4455: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4456: centralized package handle them.</p>
1.22 jakllsch 4457: <p>In pkgsrc, it is now easy: Each package should create
4458: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4459: will remove any directories left empty after uninstalling a
4460: package.</p>
4461: <p>If a package needs an empty directory to work, create
4462: the directory during installation as usual, and also add an
4463: entry to the PLIST:
1.111 sevan 4464:
4465: </p>
1.1 dsieger 4466: <pre class="programlisting">
1.22 jakllsch 4467: @pkgdir path/to/empty/directory
1.111 sevan 4468: </pre>
1.22 jakllsch 4469: <p>
1.111 sevan 4470:
1.86 wiz 4471: or take a look at <code class="varname">MAKE_DIRS</code> and
4472: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4473: </p>
1.1 dsieger 4474: </div>
4475: </div>
1.41 asau 4476: <div class="chapter">
1.1 dsieger 4477: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4478: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4479: <div class="toc">
4480: <p><b>Table of Contents</b></p>
1.100 leot 4481: <dl class="toc">
1.6 rillig 4482: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 4483: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4484: <dd><dl>
1.6 rillig 4485: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 4486: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
4487: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4488: and
4489: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4490: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4491: </dl></dd>
1.23 wiz 4492: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1 dsieger 4493: <dd><dl>
1.23 wiz 4494: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 4495: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1 dsieger 4496: </dl></dd>
4497: </dl>
4498: </div>
4499: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4500: are seen by a package's configure and build processes. This is implemented
4501: in a two step process:</p>
1.23 wiz 4502: <div class="orderedlist"><ol class="orderedlist" type="1">
4503: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4504: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4505: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4506: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4507: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4508: <code class="option">-L${LOCALBASE}/lib</code> into references to
4509: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4510: native compiler on some operating systems look like GCC, so that
4511: packages that expect GCC won't require modifications to build with
4512: those native compilers.</p></li>
4513: </ol></div>
4514: <p>This normalizes the environment in which a package is built so that the
4515: package may be built consistently despite what other software may be
4516: installed. Please note that the normal system header and library paths,
4517: e.g. <code class="filename">/usr/include</code>,
4518: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4519: designed to insulate the package build from non-system-supplied
4520: software.</p>
1.41 asau 4521: <div class="sect1">
1.1 dsieger 4522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4523: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4524: <p>The process of converting packages to use the buildlink3
1.23 wiz 4525: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4526: The things to keep in mind are:</p>
1.23 wiz 4527: <div class="orderedlist"><ol class="orderedlist" type="1">
4528: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4529: instead of the actual toolchain. Some packages are tricky,
4530: and the only way to know for sure is the check
4531: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4532: wrappers are being invoked.</p></li>
1.23 wiz 4533: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4534: the package Makefile, e.g. Java VMs, standalone shells,
4535: etc., because the code to symlink files into
4536: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4537: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4538: </p></li>
1.23 wiz 4539: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4540: <code class="filename">buildlink3.mk</code> files that you list in a
4541: package's Makefile are added as dependencies for that package.
4542: </p></li>
4543: </ol></div>
4544: <p>If a dependency on a particular package is required for its libraries and
4545: headers, then we replace:</p>
4546: <pre class="programlisting">
4547: DEPENDS+= foo>=1.1.0:../../category/foo
4548: </pre>
4549: <p>with</p>
4550: <pre class="programlisting">
4551: .include "../../category/foo/buildlink3.mk"
4552: </pre>
4553: <p>The buildlink3.mk files usually define the required dependencies.
4554: If you need a newer version of the dependency when using buildlink3.mk
4555: files, then you can define it in your Makefile; for example:</p>
4556: <pre class="programlisting">
4557: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4558: .include "../../category/foo/buildlink3.mk"
4559: </pre>
4560: <p>There are several <code class="filename">buildlink3.mk</code>
4561: files in <code class="filename">pkgsrc/mk</code>
4562: that handle special package issues:</p>
1.41 asau 4563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4564: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4565: the native or a pkgsrc Berkeley DB implementation based on
4566: the values of <code class="varname">BDB_ACCEPTED</code> and
4567: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4568: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4569: comes with neither Curses nor NCurses, this will take care
1.120 sevan 4570: to install the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.23 wiz 4571: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4572: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4573: adding a dependency on Heimdal or MIT-krb5 for packages that
4574: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4575: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4576: system-provided Motif installation or adds a dependency on
1.126 leot 4577: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.23 wiz 4578: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.126 leot 4579: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
4580: to choose which Motif version will be used.</p></li>
1.55 ryoon 4581: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4582: system-provided GNU readline or editline (libedit) installation,
1.120 sevan 4583: or adds a dependency on <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
4584: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.55 ryoon 4585: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4586: If your package really needs GNU readline library, its Makefile
4587: should include <code class="filename">devel/readline/buildlink3.mk</code>
4588: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4589: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4590: variables that may be used by packages that use the
4591: Open Sound System (OSS) API.</p></li>
1.23 wiz 4592: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4593: any of the Postgres versions in the variable
4594: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4595: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4596: the file for more information.</p></li>
1.23 wiz 4597: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4598: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.120 sevan 4599: a dependency on <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.23 wiz 4600: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4601: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4602: library.</p></li>
4603: </ul></div>
4604: <p>The comments in those <code class="filename">buildlink3.mk</code>
4605: files provide a more complete
4606: description of how to use them properly.</p>
4607: </div>
1.41 asau 4608: <div class="sect1">
1.1 dsieger 4609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4610: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4611: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4612: included by Makefiles to indicate the need to compile and link
4613: against header files and libraries provided by the package. A
4614: <code class="filename">buildlink3.mk</code> file should always provide
4615: enough information to add the correct type of dependency
4616: relationship and include any other
4617: <code class="filename">buildlink3.mk</code> files that it needs to find
4618: headers and libraries that it needs in turn.</p>
4619: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.120 sevan 4620: file for further editing, Rene Hexel's <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.1 dsieger 4621: package is highly recommended. For most packages, the following
4622: command will generate a good starting point for
4623: <code class="filename">buildlink3.mk</code> files:</p>
4624: <pre class="screen">
4625: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4626: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4627: </pre>
1.41 asau 4628: <div class="sect2">
1.1 dsieger 4629: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4630: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4631: <p>The following real-life example
4632: <code class="filename">buildlink3.mk</code> is taken
4633: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4634: <pre class="programlisting">
1.18 snj 4635: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4636:
1.112 rillig 4637: BUILDLINK_TREE+= tiff
1.1 dsieger 4638:
1.18 snj 4639: .if !defined(TIFF_BUILDLINK3_MK)
4640: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4641:
1.112 rillig 4642: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4643: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4644: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4645:
4646: .include "../../devel/zlib/buildlink3.mk"
4647: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4648: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4649:
1.112 rillig 4650: BUILDLINK_TREE+= -tiff
1.1 dsieger 4651: </pre>
4652: <p>The header and footer manipulate
1.18 snj 4653: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4654: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4655: the dependency tree.</p>
4656: <p>The main section is protected from multiple inclusion
1.1 dsieger 4657: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4658: added. Several important variables are set in the section:</p>
1.41 asau 4659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4660: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4661: is the actual dependency recorded in the installed
4662: package; this should always be set using
1.10 hubertf 4663: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4664: we're appending to any pre-existing list of values. This
4665: variable should be set to the first version of the
1.26 wiz 4666: package that had an backwards-incompatible API change.
1.1 dsieger 4667: </p></li>
1.23 wiz 4668: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4669: is the location of the <em class="replaceable"><code>pkg</code></em>
4670: pkgsrc directory.</p></li>
1.23 wiz 4671: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4672: (not shown above) controls whether we use
4673: <code class="varname">BUILD_DEPENDS</code> or
4674: <code class="varname">DEPENDS</code> to add the dependency on
4675: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4676: selected by setting
4677: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4678: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4679: used.</p></li>
1.23 wiz 4680: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4681: and
4682: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4683: (not shown above) are lists of subdirectories of
4684: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4685: to add to the header and library search paths. These
1.23 wiz 4686: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4687: respectively.</p></li>
1.23 wiz 4688: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4689: (not shown above) is the list of preprocessor flags to add
4690: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4691: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4692: should be avoided and instead be handled using
4693: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4694: above.</p></li>
4695: </ul></div>
4696: <p>The following variables are all optionally defined within
4697: this second section (protected against multiple inclusion) and
4698: control which package files are symlinked into
4699: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4700: transformed during the symlinking:</p>
1.41 asau 4701: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4702: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4703: (not shown above) is a shell glob pattern relative to
4704: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4705: to be symlinked into
4706: <code class="filename">${BUILDLINK_DIR}</code>,
4707: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4708: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4709: (not shown above) is a shell pipeline that
4710: outputs to stdout a list of files relative to
4711: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4712: The resulting files are to be symlinked
4713: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4714: this takes the <code class="filename">+CONTENTS</code> of a
4715: <em class="replaceable"><code>pkg</code></em> and filters it through
4716: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4717: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4718: (not shown above) is a filter command that filters
4719: <code class="filename">+CONTENTS</code> input into a list of files
4720: relative to
4721: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4722: on stdout. By default,
1.1 dsieger 4723: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4724: outputs the contents of the <code class="filename">include</code>
4725: and <code class="filename">lib</code> directories in the package
1.84 wiz 4726: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4727: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4728: (not shown above) is a list of sed arguments used to
4729: transform the name of the source filename into a
1.10 hubertf 4730: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4731: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4732: </ul></div>
1.18 snj 4733: <p>This section can additionally include any
1.1 dsieger 4734: <code class="filename">buildlink3.mk</code> needed for
4735: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4736: Including these <code class="filename">buildlink3.mk</code> files
4737: means that the headers and libraries for these
4738: dependencies are also symlinked into
4739: <code class="filename">${BUILDLINK_DIR}</code>
4740: whenever the <em class="replaceable"><code>pkg</code></em>
4741: <code class="filename">buildlink3.mk</code>
1.18 snj 4742: file is included. Dependencies are only added for directly
4743: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4744: <p>When providing a <code class="filename">buildlink3.mk</code> and
4745: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4746: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4747: header files are automatically exposed when the package is
4748: use.</p>
4749: <p>In particular, if only an executable
4750: (<code class="filename">bin/foo</code>) is linked against a library, that
4751: library does not need to be propagated in the
4752: <code class="filename">buildlink3.mk</code> file.</p>
4753: <p>The following steps should help you decide if a
4754: <code class="filename">buildlink3.mk</code> file needs to be included:
4755: </p>
4756: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4757: <li class="listitem"><p>Look at the installed header files: What
4758: headers do they include? The packages providing these files
4759: must be buildlinked.</p></li>
1.49 wiz 4760: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4761: libraries and look against what other libraries they link.
4762: Some of the packages providing these probably need to be
4763: buildlinked; however, it's not automatic, since e.g. GTK on
4764: some systems pulls in the X libraries, so they will show up in
4765: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4766: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4767: used as a hint.</p></li>
1.47 wiz 4768: </ul></div>
4769: <p>
4770: </p>
1.1 dsieger 4771: </div>
1.41 asau 4772: <div class="sect2">
1.1 dsieger 4773: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 4774: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 4775: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4776: and
4777: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4778: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4779: <p>These two variables differ in that one describes source
4780: compatibility (API) and the other binary compatibility (ABI).
4781: The difference is that a change in the API breaks compilation of
4782: programs while changes in the ABI stop compiled programs from
4783: running.</p>
4784: <p>Changes to the
1.27 wiz 4785: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4786: variable in a <code class="filename">buildlink3.mk</code> file happen
4787: very rarely. One possible reason is that all packages depending
4788: on this already need a newer version. In case it is bumped see
4789: the description below.</p>
4790: <p>The most common example of an ABI change is that the major
4791: version of a shared library is increased. In this case,
4792: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4793: should be adjusted to require at least the new package version.
4794: Then the packages that depend on this package need their
4795: <code class="varname">PKGREVISION</code>s increased and, if they have
4796: <code class="filename">buildlink3.mk</code> files, their
4797: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4798: adjusted, too. This is needed so pkgsrc will require the correct
4799: package dependency and not settle for an older one when building
4800: the source.</p>
1.108 rillig 4801: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, “Handling dependencies”</a> for
1.26 wiz 4802: more information about dependencies on other packages,
4803: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4804: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4805: <p>Please take careful consideration before adjusting
4806: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4807: or
4808: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4809: as we don't want to cause unneeded package deletions and
4810: rebuilds. In many cases, new versions of packages work just
4811: fine with older dependencies.</p>
4812: <p>Also it is not needed to set
1.26 wiz 4813: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4814: when it is identical to
1.1 dsieger 4815: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4816: </div>
4817: </div>
1.41 asau 4818: <div class="sect1">
1.1 dsieger 4819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4820: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4821: <p>Some packages in pkgsrc install headers and libraries that
4822: coincide with headers and libraries present in the base system.
4823: Aside from a <code class="filename">buildlink3.mk</code> file, these
4824: packages should also include a <code class="filename">builtin.mk</code>
4825: file that includes the necessary checks to decide whether using
4826: the built-in software or the pkgsrc software is
4827: appropriate.</p>
4828: <p>The only requirements of a builtin.mk file for
4829: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4830: <div class="orderedlist"><ol class="orderedlist" type="1">
4831: <li class="listitem"><p>It should set
1.1 dsieger 4832: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4833: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4834: after it is included.</p></li>
1.23 wiz 4835: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4836: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4837: which is already set before the
4838: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4839: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4840: is <span class="emphasis"><em>very</em></span> important and takes careful
4841: attention to <code class="filename">Makefile</code> coding.</p></li>
4842: </ol></div>
1.41 asau 4843: <div class="sect2">
1.1 dsieger 4844: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4845: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1 dsieger 4846: <p>The following is the recommended template for builtin.mk
4847: files:</p>
4848: <pre class="programlisting">
4849: .if !defined(IS_BUILTIN.foo)
4850: #
4851: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4852: # genuinely exists in the system or not.
4853: #
4854: IS_BUILTIN.foo?= no
4855:
4856: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4857: # version can be determined.
4858: #
4859: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4860: BUILTIN_PKG.foo?= foo-1.0
4861: . endif
4862: .endif # IS_BUILTIN.foo
4863:
4864: .if !defined(USE_BUILTIN.foo)
4865: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4866: . if defined(BUILTIN_PKG.foo)
4867: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4868: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4869: USE_BUILTIN.foo!= \
4870: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4871: && ${ECHO} "yes" || ${ECHO} "no"
4872: . endif
4873: . endfor
4874: . endif
4875: .endif # USE_BUILTIN.foo
4876:
4877: CHECK_BUILTIN.foo?= no
4878: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4879: #
4880: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4881: # "yes" or "no".
4882: #
4883: .endif # CHECK_BUILTIN.foo
4884: </pre>
4885: <p>The first section sets
4886: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4887: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4888: in the base system. This should not be a base system software
4889: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 4890: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 4891: included as part of the base system. This variable is only
4892: used internally within the <code class="filename">builtin.mk</code>
4893: file.</p>
4894: <p>The second section sets
4895: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4896: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4897: system if it exists (if
4898: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4899: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 4900: within the <code class="filename">builtin.mk</code> file.</p>
4901: <p>The third section sets
4902: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4903: and is <span class="emphasis"><em>required</em></span> in all
4904: <code class="filename">builtin.mk</code> files. The code in this
4905: section must make the determination whether the built-in
4906: software is adequate to satisfy the dependencies listed in
4907: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4908: This is typically done by comparing
4909: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4910: against each of the dependencies in
4911: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4912: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4913: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4914: end of the <code class="filename">builtin.mk</code> file. Note that
4915: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4916: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 4917: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4918: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 4919: that the built-in version of the software is similar enough to
4920: be used as a replacement.</p>
4921: <p>The last section is guarded by
4922: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4923: and includes code that uses the value of
4924: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4925: set in the previous section. This typically includes, e.g.,
4926: adding additional dependency restrictions and listing additional
4927: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4928: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
4929: </div>
1.41 asau 4930: <div class="sect2">
1.1 dsieger 4931: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4932: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 4933: <p>When building packages, it's possible to choose whether to set
4934: a global preference for using either the built-in (native)
4935: version or the pkgsrc version of software to satisfy a
4936: dependency. This is controlled by setting
4937: <code class="varname">PREFER_PKGSRC</code> and
4938: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 4939: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.1 dsieger 4940: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4941: use the pkgsrc versions of software, while
4942: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4943: built-in versions. Preferences are determined by the most
4944: specific instance of the package in either
4945: <code class="varname">PREFER_PKGSRC</code> or
4946: <code class="varname">PREFER_NATIVE</code>. If a package is specified
4947: in neither or in both variables, then
4948: <code class="varname">PREFER_PKGSRC</code> has precedence over
4949: <code class="varname">PREFER_NATIVE</code>. For example, to require
4950: using pkgsrc versions of software for all but the most basic
4951: bits on a NetBSD system, you can set:</p>
4952: <pre class="programlisting">
4953: PREFER_PKGSRC= yes
4954: PREFER_NATIVE= getopt skey tcp_wrappers
4955: </pre>
4956: <p>A package <span class="emphasis"><em>must</em></span> have a
4957: <code class="filename">builtin.mk</code>
4958: file to be listed in <code class="varname">PREFER_NATIVE</code>,
4959: otherwise it is simply ignored in that list.</p>
1.117 sevan 4960: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
4961: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
4962: bootstrap.
4963: Switching between settings globally at a later date can introduce
4964: complications with dependency resolution. This is caused by packages
4965: built with the opposite preference being installed alongside each other.</p>
4966: <pre class="screen">
4967: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
4968: </pre>
1.1 dsieger 4969: </div>
4970: </div>
4971: </div>
1.41 asau 4972: <div class="chapter">
1.1 dsieger 4973: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4974: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 4975: <div class="toc">
4976: <p><b>Table of Contents</b></p>
1.100 leot 4977: <dl class="toc">
1.6 rillig 4978: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1 dsieger 4979: <dd><dl>
1.6 rillig 4980: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
4981: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 4982: </dl></dd>
1.6 rillig 4983: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 4984: <dd><dl>
1.23 wiz 4985: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 4986: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
4987: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
4988: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
4989: </dl></dd>
4990: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
4991: <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>
4992: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
4993: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
4994: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
4995: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
4996: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1 dsieger 4997: </dl>
4998: </div>
4999: <p>This chapter describes the framework known as
5000: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5001: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5002: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5003: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5004: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5005: provided that packages are correctly designed.</p></li>
1.23 wiz 5006: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5007: <li class="listitem"><p>Registration of system users and groups.</p></li>
5008: <li class="listitem"><p>Registration of system shells.</p></li>
5009: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5010: </ul></div>
5011: <p>The following sections inspect each of the above points in detail.</p>
5012: <p>You may be thinking that many of the things described here could be
5013: easily done with simple code in the package's post-installation target
5014: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5015: as the code in them is only executed when building from source. Machines
5016: using binary packages could not benefit from it at all (as the code itself
5017: could be unavailable). Therefore, the only way to achieve any of the items
5018: described above is by means of the installation scripts, which are
5019: automatically generated by pkginstall.</p>
1.41 asau 5020: <div class="sect1">
1.1 dsieger 5021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5022: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5023: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5024: of files and directories that belong to a package. The names used in it
5025: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5026: which means that it cannot register files outside this directory (absolute
5027: path names are not allowed). Despite this restriction, some packages need
5028: to install files outside this location; e.g., under
5029: <code class="filename">${VARBASE}</code> or
5030: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5031: is to create such files during installation time by using
5032: installation scripts.</p>
5033: <p>The generic installation scripts are shell scripts that can
5034: contain arbitrary code. The list of scripts to execute is taken from
5035: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5036: <code class="filename">INSTALL</code>. A similar variable exists for package
5037: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5038: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5039: commands, so they have the potential to create and manage files
5040: anywhere in the file system.</p>
5041: <p>Using these general installation files is not recommended, but
5042: may be needed in some special cases. One reason for avoiding them is
5043: that the user has to trust the packager that there is no unwanted or
5044: simply erroneous code included in the installation script. Also,
5045: previously there were many similar scripts for the same functionality,
5046: and fixing a common error involved finding and changing all of
5047: them.</p>
5048: <p>The pkginstall framework offers another, standardized way. It
5049: provides generic scripts to abstract the manipulation of such files
5050: and directories based on variables set in the package's
5051: <code class="filename">Makefile</code>. The rest of this section describes
5052: these variables.</p>
1.41 asau 5053: <div class="sect2">
1.1 dsieger 5054: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5055: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5056: <p>The following variables can be set to request the creation of
5057: directories anywhere in the file system:</p>
1.41 asau 5058: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5059: <li class="listitem">
5060: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5061: contain a list of directories that should be created and should attempt
5062: to be destroyed by the installation scripts. The difference between
5063: the two is that the latter prompts the administrator to remove any
5064: directories that may be left after deinstallation (because they were
1.108 rillig 5065: not empty), while the former does not. Example:</p>
5066: <pre class="programlisting">
5067: MAKE_DIRS+= ${VARBASE}/foo/private
5068: </pre>
5069: </li>
1.23 wiz 5070: <li class="listitem">
1.1 dsieger 5071: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5072: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5073: which directories should be created and should attempt to be destroyed
5074: by the installation scripts. Each tuple holds the following values,
5075: separated by spaces: the directory name, its owner, its group and its
5076: numerical mode. For example:</p>
5077: <pre class="programlisting">
1.108 rillig 5078: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5079: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5080: </pre>
5081: <p>The difference between the two is exactly the same as their
5082: non-<code class="varname">PERMS</code> counterparts.</p>
5083: </li>
5084: </ul></div>
5085: </div>
1.41 asau 5086: <div class="sect2">
1.1 dsieger 5087: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5088: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5089: <p>Creating non-empty files outside the installation prefix is tricky
5090: because the <code class="filename">PLIST</code> forces all files to be inside it.
5091: To overcome this problem, the only solution is to extract the file in the
5092: known place (i.e., inside the installation prefix) and copy it to the
5093: appropriate location during installation (done by the installation scripts
5094: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5095: file</em></span> in the following paragraphs, which describe the variables
5096: that can be used to automatically and consistently handle files outside the
5097: installation prefix:</p>
1.41 asau 5098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5099: <li class="listitem">
1.1 dsieger 5100: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5101: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5102: During installation time, the master file is copied to the target one
5103: if and only if the latter does not exist. Upon deinstallation, the
5104: target file is removed provided that it was not modified by the
5105: installation.</p>
5106: <p>The difference between the two is that the latter prompts the
5107: administrator to remove any files that may be left after
5108: deinstallation (because they were not empty), while the former does
5109: not.</p>
5110: </li>
1.23 wiz 5111: <li class="listitem">
1.1 dsieger 5112: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5113: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5114: files as well as their target locations. For each of them, it also
5115: specifies their owner, their group and their numeric permissions, in
5116: this order. For example:</p>
5117: <pre class="programlisting">
1.108 rillig 5118: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5119: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5120: </pre>
5121: <p>The difference between the two is exactly the same as their
5122: non-<code class="varname">PERMS</code> counterparts.</p>
5123: </li>
5124: </ul></div>
5125: </div>
5126: </div>
1.41 asau 5127: <div class="sect1">
1.1 dsieger 5128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5129: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5130: <p>Configuration files are special in the sense that they are installed
5131: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5132: need special treatment during installation (most of which is automated by
5133: pkginstall). The main concept you must bear in mind is that files marked
5134: as configuration files are automatically copied to the right place (somewhere
5135: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5136: and only if</em></span> they didn't exist before. Similarly, they will not
5137: be removed if they have local modifications. This ensures that
5138: administrators never lose any custom changes they may have made.</p>
1.41 asau 5139: <div class="sect2">
1.1 dsieger 5140: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5141: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1 dsieger 5142: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5143: specifies where configuration files shall be installed. Its contents are
5144: set based upon the following variables:</p>
1.41 asau 5145: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5146: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5147: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5148: be overridden by the user to point to his preferred location (e.g.,
5149: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5150: Packages must not use it directly.</p></li>
1.23 wiz 5151: <li class="listitem">
1.1 dsieger 5152: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5153: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5154: for the package being built shall be installed. The definition of this
5155: variable only makes sense in the package's
5156: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5157: <p>As an example, consider the Apache package,
1.120 sevan 5158: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.1 dsieger 5159: configuration files under the
5160: <code class="filename">httpd/</code> subdirectory of
5161: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5162: Makefile.</p>
5163: </li>
1.23 wiz 5164: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5165: variable that holds this package's configuration directory (if
5166: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5167: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5168: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5169: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5170: directory where the configuration files for the package identified by
5171: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5172: </ul></div>
5173: <p>Based on the above variables, pkginstall determines the value of
5174: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5175: variable that can be used within a package to refer to its configuration
5176: directory. The algorithm used to set its value is basically the
5177: following:</p>
1.23 wiz 5178: <div class="orderedlist"><ol class="orderedlist" type="1">
5179: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5180: its value is used.</p></li>
1.23 wiz 5181: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5182: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5183: <code class="filename">Makefile</code>, the resulting value is
5184: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5185: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5186: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5187: </ol></div>
5188: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5189: 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
5190: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5191: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5192: </div>
1.41 asau 5193: <div class="sect2">
1.1 dsieger 5194: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5195: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5196: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5197: known place, you need to teach each package where it shall install its
5198: files. In some cases you will have to patch the package Makefiles to
5199: achieve it. If you are lucky, though, it may be as easy as passing an
5200: extra flag to the configuration script; this is the case of GNU Autoconf-
5201: generated files:</p>
5202: <pre class="programlisting">
5203: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5204: </pre>
5205: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5206: for</em></span> its configuration files, not where they will be originally
5207: installed (although the difference is never explicit,
5208: unfortunately).</p>
5209: </div>
1.41 asau 5210: <div class="sect2">
1.1 dsieger 5211: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5212: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5213: <p>As said before, pkginstall automatically handles configuration files.
5214: This means that <span class="strong"><strong>the packages themselves must not
5215: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5216: directly</strong></span>. Bad news is that many software installation scripts
5217: will, out of the box, mess with the contents of that directory. So what is
5218: the correct procedure to fix this issue?</p>
5219: <p>You must teach the package (usually by manually patching it) to
5220: install any configuration files under the examples hierarchy,
5221: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5222: <code class="filename">PLIST</code> registers them and the administrator always
5223: has the original copies available.</p>
5224: <p>Once the required configuration files are in place (i.e., under the
5225: examples hierarchy), the pkginstall framework can use them as master copies
5226: during the package installation to update what is in
5227: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5228: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5229: used. Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.1 dsieger 5230: about their syntax and their purpose. Here is an example, taken from the
1.120 sevan 5231: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.1 dsieger 5232: <pre class="programlisting">
5233: EGDIR= ${PREFIX}/share/doc/mutt/samples
5234: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5235: </pre>
5236: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5237: package and has no meaning outside it.</p>
5238: </div>
1.41 asau 5239: <div class="sect2">
1.1 dsieger 5240: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5241: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5242: <p>The automatic copying of config files can be toggled by setting the
5243: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5244: installation.</p>
5245: </div>
5246: </div>
1.41 asau 5247: <div class="sect1">
1.1 dsieger 5248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5249: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5250: <p>System startup scripts are special files because they must be
5251: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5252: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.1 dsieger 5253: can be used. However, pkginstall provides a special mechanism to handle
5254: these files.</p>
5255: <p>In order to provide system startup scripts, the package has
5256: to:</p>
1.23 wiz 5257: <div class="orderedlist"><ol class="orderedlist" type="1">
5258: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5259: the <code class="literal">.sh</code> suffix appended. Considering the
1.120 sevan 5260: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.1 dsieger 5261: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5262: <li class="listitem">
1.1 dsieger 5263: <p>Tell pkginstall to handle it, appending the name of the script,
5264: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5265: Continuing the previous example:</p>
5266: <pre class="programlisting">
5267: RCD_SCRIPTS+= cupsd
5268: </pre>
5269: </li>
5270: </ol></div>
5271: <p>Once this is done, pkginstall will do the following steps for each
5272: script in an automated fashion:</p>
1.23 wiz 5273: <div class="orderedlist"><ol class="orderedlist" type="1">
5274: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5275: substitutions described in the <code class="filename">FILES_SUBST</code>
5276: variable.</p></li>
1.23 wiz 5277: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5278: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5279: that this master file must be explicitly registered in the
5280: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5281: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5282: from the examples hierarchy into the system-wide startup scripts
5283: directory.</p></li>
5284: </ol></div>
1.41 asau 5285: <div class="sect2">
1.1 dsieger 5286: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5287: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5288: <p>The automatic copying of config files can be toggled by setting the
5289: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5290: installation. Note that the scripts will be always copied inside the
5291: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5292: matter what the value of this variable is.</p>
5293: </div>
5294: </div>
1.41 asau 5295: <div class="sect1">
1.1 dsieger 5296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5297: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5298: <p>If a package needs to create special users and/or groups during
5299: installation, it can do so by using the pkginstall framework.</p>
5300: <p>Users can be created by adding entries to the
5301: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5302: syntax:</p>
5303: <pre class="programlisting">
5304: user:group
5305: </pre>
5306: <p>Further specification of user details may be done by setting
5307: per-user variables.
5308: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5309: numeric UID for the user.
5310: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5311: user's description or comment.
5312: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5313: user's home directory, and defaults to
5314: <code class="filename">/nonexistent</code> if not specified.
5315: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5316: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5317: not specified.</p>
5318: <p>Similarly, groups can be created by adding entries to the
5319: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5320: <pre class="programlisting">
5321: group
5322: </pre>
5323: <p>The numeric GID of the group may be set by defining
5324: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5325: <p>If a package needs to create the users and groups at an earlier
1.116 wiz 5326: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5327: <code class="literal">configure</code>,<code class="literal">build</code>, or
5328: <code class="literal">pre-install</code> to indicate the phase before which the
5329: users and groups are created. In this case, the numeric UIDs and GIDs
5330: of the created users and groups are automatically hardcoded into the
5331: final installation scripts.</p>
1.1 dsieger 5332: </div>
1.41 asau 5333: <div class="sect1">
1.1 dsieger 5334: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5335: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5336: <p>Packages that install system shells should register them in the shell
5337: database, <code class="filename">/etc/shells</code>, to make things easier to the
5338: administrator. This must be done from the installation scripts to keep
5339: binary packages working on any system. pkginstall provides an easy way to
5340: accomplish this task.</p>
5341: <p>When a package provides a shell interpreter, it has to set the
5342: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5343: add some hooks to the installation scripts to handle it. Consider the
1.120 sevan 5344: following example, taken from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.1 dsieger 5345: <pre class="programlisting">
5346: PKG_SHELL= ${PREFIX}/bin/zsh
5347: </pre>
1.41 asau 5348: <div class="sect2">
1.1 dsieger 5349: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5350: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5351: <p>The automatic registration of shell interpreters can be disabled by
5352: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5353: environment variable to <code class="literal">NO</code>.</p>
5354: </div>
5355: </div>
1.41 asau 5356: <div class="sect1">
1.1 dsieger 5357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5358: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5359: <p>Packages that install X11 fonts should update the database files
5360: that index the fonts within each fonts directory. This can easily be
5361: accomplished within the pkginstall framework.</p>
5362: <p>When a package installs X11 fonts, it must list the directories in
5363: which fonts are installed in the
5364: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5365: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5366: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.1 dsieger 5367: installation scripts to run the appropriate commands to update the fonts
5368: database files within each of those directories. For convenience, if the
5369: directory path is relative, it is taken to be relative to the package's
1.120 sevan 5370: installation prefix. Consider the following example, taken from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1 dsieger 5371: <pre class="programlisting">
1.67 wiz 5372: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5373: </pre>
1.41 asau 5374: <div class="sect2">
1.1 dsieger 5375: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5376: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5377: <p>The automatic update of fonts databases can be disabled by
5378: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5379: environment variable to <code class="literal">NO</code>.</p>
5380: </div>
5381: </div>
5382: </div>
1.41 asau 5383: <div class="chapter">
1.1 dsieger 5384: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5385: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5386: <div class="toc">
5387: <p><b>Table of Contents</b></p>
1.100 leot 5388: <dl class="toc">
1.6 rillig 5389: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5390: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 5391: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5392: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5393: </dl>
5394: </div>
5395: <p>Many packages have the ability to be built to support different
5396: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5397: in pkgsrc that provides generic handling of those options that
5398: determine different ways in which the packages can be built. It's
5399: possible for the user to specify exactly which sets of options will be
5400: built into a package or to allow a set of global default options
5401: apply.</p>
1.7 rillig 5402: <p>There are two broad classes of behaviors that one might want to
5403: control via options. One is whether some particular feature is
5404: enabled in a program that will be built anyway, often by including or
5405: not including a dependency on some other package. The other is
5406: whether or not an additional program will be built as part of the
5407: package. Generally, it is better to make a split package for such
5408: additional programs instead of using options, because it enables
5409: binary packages to be built which can then be added separately. For
5410: example, the foo package might have minimal dependencies (those
5411: packages without which foo doesn't make sense), and then the foo-gfoo
5412: package might include the GTK frontend program gfoo. This is better
5413: than including a gtk option to foo that adds gfoo, because either that
5414: option is default, in which case binary users can't get foo without
5415: gfoo, or not default, in which case they can't get gfoo. With split
5416: packages, they can install foo without having GTK, and later decide to
5417: install gfoo (pulling in GTK at that time). This is an advantage to
5418: source users too, avoiding the need for rebuilds.</p>
5419: <p>Plugins with widely varying dependencies should usually be split
5420: instead of options.</p>
5421: <p>It is often more work to maintain split packages, especially if
5422: the upstream package does not support this. The decision of split
5423: vs. option should be made based on the likelihood that users will want
5424: or object to the various pieces, the size of the dependencies that are
5425: included, and the amount of work.</p>
5426: <p>A further consideration is licensing. Non-free parts, or parts
5427: that depend on non-free dependencies (especially plugins) should
5428: almost always be split if feasible.</p>
1.41 asau 5429: <div class="sect1">
1.1 dsieger 5430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5431: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 5432: <p>Global default options are listed in
5433: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5434: that should be built into every package if that option is supported.
1.10 hubertf 5435: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5436: </div>
1.41 asau 5437: <div class="sect1">
1.1 dsieger 5438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5439: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5440: </h2></div></div></div>
5441: <p>The following example shows how
5442: <code class="filename">bsd.options.mk</code> should be used
5443: by the hypothetical ``wibble'' package, either in the package
5444: <code class="filename">Makefile</code>, or in a file,
5445: e.g. <code class="filename">options.mk</code>, that is included by the
5446: main package <code class="filename">Makefile</code>.</p>
5447: <pre class="programlisting">
5448: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5449: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5450: PKG_OPTIONS_OPTIONAL_GROUPS= database
5451: PKG_OPTIONS_GROUP.database= mysql pgsql
5452: PKG_SUGGESTED_OPTIONS= wibble-foo
5453: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5454: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5455:
5456: .include "../../mk/bsd.prefs.mk"
5457:
5458: # this package was previously named wibble2
5459: .if defined(PKG_OPTIONS.wibble2)
5460: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5461: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5462: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5463: .endif
5464:
5465: .include "../../mk/bsd.options.mk"
5466:
5467: # Package-specific option-handling
5468:
5469: ###
5470: ### FOO support
5471: ###
5472: .if !empty(PKG_OPTIONS:Mwibble-foo)
5473: CONFIGURE_ARGS+= --enable-foo
5474: .endif
5475:
5476: ###
5477: ### LDAP support
5478: ###
5479: .if !empty(PKG_OPTIONS:Mldap)
5480: . include "../../databases/openldap-client/buildlink3.mk"
5481: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5482: .endif
5483:
5484: ###
5485: ### database support
5486: ###
5487: .if !empty(PKG_OPTIONS:Mmysql)
5488: . include "../../mk/mysql.buildlink3.mk"
5489: .endif
5490: .if !empty(PKG_OPTIONS:Mpgsql)
5491: . include "../../mk/pgsql.buildlink3.mk"
5492: .endif
5493: </pre>
5494: <p>The first section contains the information about which build
5495: options are supported by the package, and any default options settings
5496: if needed.</p>
1.23 wiz 5497: <div class="orderedlist"><ol class="orderedlist" type="1">
5498: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.125 leot 5499: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1 dsieger 5500: options. It should be set to
5501: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5502: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5503: at the point where the options are processed.</p></li>
1.23 wiz 5504: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5505: build options supported by the package.</p></li>
1.23 wiz 5506: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5507: list of names of groups of mutually exclusive options. The options in
5508: each group are listed in
5509: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5510: The most specific setting of any option from the group takes
5511: precedence over all other options in the group. Options from the
5512: groups will be automatically added to
5513: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5514: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5515: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5516: packages will fail if no option from the group is
5517: selected.</p></li>
1.23 wiz 5518: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5519: of names of sets of options. At least one option from each set must
5520: be selected. The options in each set are listed in
5521: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5522: Options from the sets will be automatically added to
5523: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5524: fail if no option from the set is selected.</p></li>
1.23 wiz 5525: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5526: build options which are enabled by default.</p></li>
1.23 wiz 5527: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5528: of
1.23 wiz 5529: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.10 hubertf 5530: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5531: their option counterparts. Pairs should be added with
1.23 wiz 5532: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5533: warning will be issued if the user uses a legacy
5534: variable.</p></li>
1.23 wiz 5535: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5536: of
1.23 wiz 5537: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.1 dsieger 5538: pairs that map options that have been renamed to their new
1.23 wiz 5539: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5540: the listing of global legacy options. A warning will be issued if
5541: the user uses a legacy option.</p></li>
1.23 wiz 5542: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5543: options implied by deprecated variables used. This can be used for
5544: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5545: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5546: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5547: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5548: a list of warnings about deprecated variables or options used, and
5549: what to use instead.</p></li>
5550: </ol></div>
5551: <p>A package should never modify
5552: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5553: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5554: To suggest a default set of options, use
5555: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5556: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5557: including <code class="filename">bsd.options.mk</code>. If none of
5558: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5559: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5560: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5561: happen with platform-specific options if none of them is supported on
5562: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5563: empty list and the package is otherwise treated as not using the
5564: options framework.</p>
5565: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5566: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5567: build options, properly filtered to remove unsupported and duplicate
5568: options.</p>
5569: <p>The remaining sections contain the logic that is specific to
5570: each option. The correct way to check for an option is to check
5571: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5572: <pre class="programlisting">
5573: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5574: </pre>
5575: </div>
1.41 asau 5576: <div class="sect1">
1.1 dsieger 5577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5578: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 5579: <p>Options that enable similar features in different packages (like
5580: optional support for a library) should use a common name in all
5581: packages that support it (like the name of the library). If another
5582: package already has an option with the same meaning, use the same
5583: name.</p>
5584: <p>Options that enable features specific to one package, where it's
5585: unlikely that another (unrelated) package has the same (or a similar)
5586: optional feature, should use a name prefixed with
5587: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5588: <p>If a group of related packages share an optional feature
5589: specific to that group, prefix it with the name of the
1.23 wiz 5590: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5591: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5592: <p>For new options, add a line to
5593: <code class="filename">mk/defaults/options.description</code>. Lines have two
5594: fields, separated by tab. The first field is the option name, the
5595: second its description. The description should be a whole sentence
5596: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5597: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5598: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5599: </div>
1.41 asau 5600: <div class="sect1">
1.7 rillig 5601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5602: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5603: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7 rillig 5604: different dependencies based on the options with which the package was
5605: built. For querying these options, the file
5606: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5607: typical example looks like this:</p>
5608: <pre class="programlisting">
5609: pkgbase := libpurple
5610: .include "../../mk/pkg-build-options.mk"
5611:
5612: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5613: ...
5614: .endif
5615: </pre>
5616: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5617: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5618: options of the libpurple package, which can then be queried like
5619: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5620: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5621: details.</p>
5622: </div>
1.1 dsieger 5623: </div>
1.41 asau 5624: <div class="chapter">
1.1 dsieger 5625: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5626: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 5627: <div class="toc">
5628: <p><b>Table of Contents</b></p>
1.100 leot 5629: <dl class="toc">
1.6 rillig 5630: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
5631: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
5632: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
5633: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 5634: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 5635: <dd><dl>
5636: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
5637: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
5638: </dl></dd>
1.23 wiz 5639: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5640: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5641: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5642: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5643: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5644: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5645: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5646: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5647: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5648: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 5649: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
5650: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 5651: </dl>
5652: </div>
1.41 asau 5653: <div class="sect1">
1.1 dsieger 5654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5655: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 5656: <p>This chapter gives a detailed description on how a package is
5657: built. Building a package is separated into different
5658: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5659: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5660: described in the following sections. Each phase is split into
1.1 dsieger 5661: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5662: containing phase, prefixed by one of <code class="varname">pre-</code>,
5663: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5664: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5665: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5666: <p>Never override the regular targets (like
5667: <code class="varname">fetch</code>), if you have to, override the
5668: <code class="varname">do-*</code> ones instead.</p>
5669: <p>The basic steps for building a program are always the same. First
5670: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5671: the local system and then extracted. After any pkgsrc-specific patches
5672: to compile properly are applied, the software can be configured, then
5673: built (usually by compiling), and finally the generated binaries, etc.
5674: can be put into place on the system.</p>
5675: <p>To get more details about what is happening at each step,
5676: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5677: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5678: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5679: </div>
1.41 asau 5680: <div class="sect1">
1.1 dsieger 5681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5682: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 5683: <p>Before outlining the process performed by the NetBSD package system in
5684: the next section, here's a brief discussion on where programs are
5685: installed, and which variables influence this.</p>
5686: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5687: where all files of the final program shall be installed. It is
5688: usually set to <code class="varname">LOCALBASE</code>
5689: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5690: for pkgs in the <code class="filename">cross</code> category. The value of
5691: <code class="varname">PREFIX</code> needs to be put
5692: into the various places in the program's source where paths to
1.108 rillig 5693: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.1 dsieger 5694: <p>When choosing which of these variables to use,
5695: follow the following rules:</p>
1.41 asau 5696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5697: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5698: where the current pkg will be installed. When referring to a
5699: pkg's own installation path, use
1.23 wiz 5700: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5701: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5702: are installed. If you need to construct a -I or -L argument
5703: to the compiler to find includes and libraries installed by
1.23 wiz 5704: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5705: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5706: installed all packages in <code class="filename">/usr/local</code>. As
5707: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5708: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5709: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5710: distribution (from xsrc, etc.) is installed. When looking for
5711: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5712: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5713: <li class="listitem"><p>X11-based packages using imake must set
5714: <code class="varname">USE_IMAKE</code> to be installed correctly under
5715: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5716: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.125 leot 5717: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1 dsieger 5718: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5719: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5720: </ul></div>
5721: </div>
1.41 asau 5722: <div class="sect1">
1.1 dsieger 5723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5724: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5725: <p>When building a package, various directories are used to store
1.1 dsieger 5726: source files, temporary files, pkgsrc-internal files, and so on. These
5727: directories are explained here.</p>
5728: <p>Some of the directory variables contain relative pathnames. There
5729: are two common base directories for these relative directories:
5730: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5731: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5732: inside the package itself.</p>
1.41 asau 5733: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5734: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5735: <dd><p>This is an absolute pathname that points to the pkgsrc
5736: root directory. Generally, you don't need
5737: it.</p></dd>
5738: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5739: <dd><p>This is an absolute pathname that points to the
5740: current package.</p></dd>
5741: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5742: <dd><p>This is a pathname relative to
5743: <code class="varname">PKGSRCDIR</code> that points to the current
5744: package.</p></dd>
5745: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5746: <dd><p>This is an absolute pathname pointing to the directory
5747: where all work takes place. The distfiles are extracted to this
5748: directory. It also contains temporary directories and log files used by
5749: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5750: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5751: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5752: <dd><p>This is an absolute pathname pointing to the directory
5753: where the distfiles are extracted. It is usually a direct subdirectory
5754: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5755: that isn't hidden. This variable may be changed by a package
5756: <code class="filename">Makefile</code>.</p></dd>
5757: </dl></div>
1.14 jmcneill 5758: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5759: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5760: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5761: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5762: If users would like to have their pkgsrc trees behave in a
5763: read-only manner, then the value of
5764: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5765: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5766: </div>
1.41 asau 5767: <div class="sect1">
1.1 dsieger 5768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5769: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 5770: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5771: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5772: phase. This will automatically run all phases that are required for this
5773: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5774: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5775: the package will be built, but not installed.</p>
5776: </div>
1.41 asau 5777: <div class="sect1">
1.1 dsieger 5778: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5779: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5780: <p>The first step in building a package is to fetch the
5781: distribution files (distfiles) from the sites that are providing
5782: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5783: phase.</p>
1.41 asau 5784: <div class="sect2">
1.1 dsieger 5785: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5786: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 5787: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5788: defines all URLs from where the distfile, whose name is
5789: derived from the <code class="varname">DISTNAME</code> variable, is
5790: fetched. The more complicated cases are described
5791: below.</p>
5792: <p>The variable <code class="varname">DISTFILES</code> specifies
5793: the list of distfiles that have to be fetched. Its value
1.66 asau 5794: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5795: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5796: so that most packages don't need to define it at all.
5797: <code class="varname">EXTRACT_SUFX</code> is
5798: <code class="literal">.tar.gz</code> by default, but can be changed
5799: freely. Note that if your package requires additional
5800: distfiles to the default one, you cannot just append the
5801: additional filenames using the <code class="literal">+=</code>
5802: operator, but you have write for example:</p>
5803: <pre class="programlisting">
1.66 asau 5804: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5805: </pre>
5806: <p>Each distfile is fetched from a list of sites, usually
5807: <code class="varname">MASTER_SITES</code>. If the package has multiple
5808: <code class="varname">DISTFILES</code> or multiple
5809: <code class="varname">PATCHFILES</code> from different sites, you can
5810: set
5811: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5812: to the list of URLs where the file
5813: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5814: (including the suffix) can be found.</p>
5815: <pre class="programlisting">
5816: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5817: DISTFILES+= foo-file.tar.gz
5818: SITES.foo-file.tar.gz= \
5819: http://www.somewhere.com/somehow/ \
5820: http://www.somewhereelse.com/mirror/somehow/
5821: </pre>
5822: <p>When actually fetching the distfiles, each item from
5823: <code class="varname">MASTER_SITES</code> or
5824: <code class="varname">SITES.*</code> gets the name of each distfile
5825: appended to it, without an intermediate slash. Therefore,
5826: all site values have to end with a slash or other separator
5827: character. This allows for example to set
5828: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5829: that gets the name of the distfile as a parameter. In this
5830: case, the definition would look like:</p>
5831: <pre class="programlisting">
5832: MASTER_SITES= http://www.example.com/download.cgi?file=
5833: </pre>
1.22 jakllsch 5834: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5835: In that case the URL is taken as is, fetched and the result
5836: stored under the name of the distfile. You can use this style
5837: for the case when the download URL style does not match the
5838: above common case. For example, if permanent download URL is a
5839: redirector to the real download URL, or the download file name
5840: is offered by an HTTP Content-Disposition header. In the
5841: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5842: created instead of the default
5843: <code class="filename">v1.0.0.tar.gz</code>.</p>
5844: <pre class="programlisting">
5845: DISTNAME= foo-1.0.0
5846: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5847: </pre>
1.1 dsieger 5848: <p>There are some predefined values for
5849: <code class="varname">MASTER_SITES</code>, which can be used in
5850: packages. The names of the variables should speak for
5851: themselves.</p>
5852: <pre class="programlisting">
5853: ${MASTER_SITE_APACHE}
5854: ${MASTER_SITE_BACKUP}
5855: ${MASTER_SITE_CYGWIN}
5856: ${MASTER_SITE_DEBIAN}
5857: ${MASTER_SITE_FREEBSD}
5858: ${MASTER_SITE_FREEBSD_LOCAL}
5859: ${MASTER_SITE_GENTOO}
5860: ${MASTER_SITE_GNOME}
5861: ${MASTER_SITE_GNU}
5862: ${MASTER_SITE_GNUSTEP}
1.66 asau 5863: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 5864: ${MASTER_SITE_IFARCHIVE}
5865: ${MASTER_SITE_KDE}
5866: ${MASTER_SITE_MOZILLA}
1.66 asau 5867: ${MASTER_SITE_MOZILLA_ALL}
5868: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 5869: ${MASTER_SITE_MYSQL}
1.66 asau 5870: ${MASTER_SITE_NETLIB}
1.1 dsieger 5871: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 5872: ${MASTER_SITE_OSDN}
1.1 dsieger 5873: ${MASTER_SITE_PERL_CPAN}
5874: ${MASTER_SITE_PGSQL}
1.66 asau 5875: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 5876: ${MASTER_SITE_R_CRAN}
5877: ${MASTER_SITE_SOURCEFORGE}
5878: ${MASTER_SITE_SUNSITE}
5879: ${MASTER_SITE_SUSE}
5880: ${MASTER_SITE_TEX_CTAN}
5881: ${MASTER_SITE_XCONTRIB}
5882: ${MASTER_SITE_XEMACS}
1.66 asau 5883: ${MASTER_SITE_XORG}
1.1 dsieger 5884: </pre>
5885: <p>Some explanations for the less self-explaining ones:
5886: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 5887: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.25 spz 5888: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.1 dsieger 5889: <p>If you choose one of these predefined sites, you may
5890: want to specify a subdirectory of that site. Since these
5891: macros may expand to more than one actual site, you
5892: <span class="emphasis"><em>must</em></span> use the following construct to
5893: specify a subdirectory:</p>
5894: <pre class="programlisting">
5895: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5896: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5897: </pre>
5898: <p>Note the trailing slash after the subdirectory
5899: name.</p>
5900: </div>
1.41 asau 5901: <div class="sect2">
1.1 dsieger 5902: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5903: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 5904: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5905: all the distfiles exist in a local directory
5906: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
5907: user). If the files do not exist, they are fetched using
5908: commands of the form</p>
5909: <pre class="programlisting">
5910: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5911: </pre>
5912: <p>where <code class="literal">${site}</code> varies through
5913: several possibilities in turn: first,
5914: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
5915: sites specified in either <code class="varname">SITES.file</code> if
5916: defined, else <code class="varname">MASTER_SITES</code> or
5917: <code class="varname">PATCH_SITES</code>, as applies, then finally the
5918: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
5919: all except the first and the last can be optionally sorted
5920: by the user, via setting either
5921: <code class="varname">MASTER_SORT_RANDOM</code>, and
5922: <code class="varname">MASTER_SORT_AWK</code> or
5923: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 5924: <p> The specific command and arguments used depend on the
5925: <code class="varname">FETCH_USING</code> parameter. The example above is
5926: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 5927: <p>The distfiles mirror run by the NetBSD Foundation uses the
5928: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
5929: distfiles, if they are freely distributable. Packages setting
5930: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 5931: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 5932: mirrored.</p>
5933: </div>
5934: </div>
1.41 asau 5935: <div class="sect1">
1.1 dsieger 5936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5937: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 5938: <p>After the distfile(s) are fetched, their checksum is
5939: generated and compared with the checksums stored in the
5940: distinfo file. If the checksums don't match, the build is
5941: aborted. This is to ensure the same distfile is used for
5942: building, and that the distfile wasn't changed, e.g. by some
5943: malign force, deliberately changed distfiles on the master
5944: distribution site or network lossage.</p>
5945: </div>
1.41 asau 5946: <div class="sect1">
1.1 dsieger 5947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5948: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 5949: <p>When the distfiles are present on the local system, they
5950: need to be extracted, as they usually come in the form of some
5951: compressed archive format.</p>
5952: <p>By default, all <code class="varname">DISTFILES</code> are
5953: extracted. If you only need some of them, you can set the
5954: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
5955: files.</p>
5956: <p>Extracting the files is usually done by a little
5957: program, <code class="filename">mk/extract/extract</code>, which
5958: already knows how to extract various archive formats, so most
5959: likely you will not need to change anything here. But if you
5960: need, the following variables may help you:</p>
1.41 asau 5961: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5962: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
5963: <dd><p>Use these variables to override the default
5964: options for an extract command, which are defined in
5965: <code class="filename">mk/extract/extract</code>.</p></dd>
5966: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
5967: <dd><p>This variable can be set to
1.14 jmcneill 5968: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
5969: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 5970: absolute pathname pointing to the command with which tar
1.14 jmcneill 5971: archives should be extracted. It is preferred to choose bsdtar over gtar
5972: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 5973: </dl></div>
5974: <p>If the <code class="filename">extract</code> program doesn't
5975: serve your needs, you can also override the
5976: <code class="varname">EXTRACT_CMD</code> variable, which holds the
5977: command used for extracting the files. This command is
5978: executed in the <code class="filename">${WRKSRC}</code>
5979: directory. During execution of this command, the shell
5980: variable <code class="varname">extract_file</code> holds the absolute
5981: pathname of the file that is going to be extracted.</p>
5982: <p>And if that still does not suffice, you can override the
5983: <code class="varname">do-extract</code> target in the package
5984: Makefile.</p>
5985: </div>
1.41 asau 5986: <div class="sect1">
1.1 dsieger 5987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5988: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 5989: <p>After extraction, all the patches named by the
5990: <code class="varname">PATCHFILES</code>, those present in the patches
5991: subdirectory of the package as well as in
5992: $LOCALPATCHES/$PKGPATH (e.g.
5993: <code class="filename">/usr/local/patches/graphics/png</code>) are
5994: applied. Patchfiles ending in <code class="filename">.Z</code> or
5995: <code class="filename">.gz</code> are uncompressed before they are
5996: applied, files ending in <code class="filename">.orig</code> or
5997: <code class="filename">.rej</code> are ignored. Any special options to
1.125 leot 5998: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.108 rillig 5999: <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.125 leot 6000: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1 dsieger 6001: it fail if the patches apply with some lines of fuzz. Please
6002: fix (regen) the patches so that they apply cleanly. The
6003: rationale behind this is that patches that don't apply cleanly
6004: may end up being applied in the wrong place, and cause severe
6005: harm there.</p>
6006: </div>
1.41 asau 6007: <div class="sect1">
1.1 dsieger 6008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6009: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6010: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.1 dsieger 6011: </p>
6012: </div>
1.41 asau 6013: <div class="sect1">
1.1 dsieger 6014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6015: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6016: <p>This phase creates wrapper programs for the compilers and
6017: linkers. The following variables can be used to tweak the
6018: wrappers.</p>
1.41 asau 6019: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6020: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6021: <dd><p>The command used to print progress
6022: messages. Does nothing by default. Set to
6023: <code class="literal">${ECHO}</code> to see the progress
6024: messages.</p></dd>
6025: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6026: <dd><p>This variable can be set to
6027: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6028: depending on whether you want additional information in the
6029: wrapper log file.</p></dd>
6030: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6031: <dd><p>This variable can be set to
6032: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6033: on whether the wrapper should use its cache, which will
6034: improve the speed. The default value is
6035: <code class="literal">yes</code>, but is forced to
6036: <code class="literal">no</code> if the platform does not support
6037: it.</p></dd>
6038: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6039: <dd><p>A list of reordering commands. A reordering
6040: command has the form
6041: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6042: It ensures that that
6043: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6044: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6045: </p></dd>
6046: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6047: <dd><p>A list of transformation commands. [TODO:
6048: investigate further]</p></dd>
6049: </dl></div>
6050: </div>
1.41 asau 6051: <div class="sect1">
1.1 dsieger 6052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6053: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6054: <p>Most pieces of software need information on the header
6055: files, system calls, and library routines which are available
6056: on the platform they run on. The process of determining this
6057: information is known as configuration, and is usually
6058: automated. In most cases, a script is supplied with the
6059: distfiles, and its invocation results in generation of header
6060: files, Makefiles, etc.</p>
6061: <p>If the package contains a configure script, this can be
6062: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6063: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6064: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6065: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6066: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6067: <pre class="programlisting">
6068: .for d in ${CONFIGURE_DIRS}
6069: cd ${WRKSRC} \
6070: && cd ${d} \
6071: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6072: .endfor
6073: </pre>
6074: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6075: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6076: <code class="varname">WRKSRC</code>. In each of these directories, the
6077: configure script is run with the environment
6078: <code class="varname">CONFIGURE_ENV</code> and arguments
6079: <code class="varname">CONFIGURE_ARGS</code>. The variables
6080: <code class="varname">CONFIGURE_ENV</code>,
6081: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6082: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6083: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6084: package.</p>
1.37 wiz 6085: <p>If the program uses the Perl way of configuration (mainly Perl
6086: modules, but not only), i.e. a file called
6087: <code class="filename">Makefile.PL</code>, it should include
6088: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6089: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6090: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6091: <p>If the program uses an <code class="filename">Imakefile</code>
6092: for configuration, the appropriate steps can be invoked by
6093: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6094: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6095: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6096: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6097: <p>If the program uses <code class="filename">cmake</code>
6098: for configuration, the appropriate steps can be invoked by
1.23 wiz 6099: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6100: You can add variables to cmake's environment by adding them to the
6101: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6102: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6103: The top directory argument is given by the
6104: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6105: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6106: <p>If there is no configure step at all, set
1.23 wiz 6107: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6108: </div>
1.41 asau 6109: <div class="sect1">
1.1 dsieger 6110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6111: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6112: <p>For building a package, a rough equivalent of the
6113: following code is executed.</p>
6114: <pre class="programlisting">
6115: .for d in ${BUILD_DIRS}
6116: cd ${WRKSRC} \
6117: && cd ${d} \
6118: && env ${MAKE_ENV} \
6119: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6120: -f ${MAKE_FILE} \
6121: ${BUILD_TARGET}
6122: .endfor
6123: </pre>
6124: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6125: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6126: <code class="varname">WRKSRC</code>. In each of these directories,
6127: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6128: <code class="varname">MAKE_ENV</code> and arguments
6129: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6130: <code class="varname">MAKE_ENV</code>,
6131: <code class="varname">BUILD_MAKE_FLAGS</code>,
6132: <code class="varname">MAKE_FILE</code> and
6133: <code class="varname">BUILD_TARGET</code> may all be changed by the
6134: package.</p>
6135: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6136: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6137: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6138: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6139: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6140: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6141: <p>If there is no build step at all, set
1.23 wiz 6142: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6143: </div>
1.41 asau 6144: <div class="sect1">
1.1 dsieger 6145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6146: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6147: <p>[TODO]</p>
6148: </div>
1.41 asau 6149: <div class="sect1">
1.1 dsieger 6150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6151: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6152: <p>Once the build stage has completed, the final step is to
6153: install the software in public directories, so users can
6154: access the programs and files.</p>
6155: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6156: equivalent of the following code is executed. Additionally,
6157: before and after this code, much magic is performed to do
6158: consistency checks, registering the package, and so on.</p>
6159: <pre class="programlisting">
6160: .for d in ${INSTALL_DIRS}
6161: cd ${WRKSRC} \
6162: && cd ${d} \
6163: && env ${MAKE_ENV} \
6164: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6165: -f ${MAKE_FILE} \
6166: ${INSTALL_TARGET}
6167: .endfor
6168: </pre>
6169: <p>The variable's meanings are analogous to the ones in the
6170: <span class="emphasis"><em>build</em></span> phase.
6171: <code class="varname">INSTALL_DIRS</code> defaults to
6172: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6173: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6174: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6175: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6176: defined.</p>
6177: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6178: variables are useful. They are all variations of the
1.125 leot 6179: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1 dsieger 6180: permissions preset. <code class="varname">INSTALL</code> is the plain
6181: install command. The specialized variants, together with their
6182: intended use, are:</p>
1.41 asau 6183: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6184: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6185: <dd><p>directories that contain
6186: binaries</p></dd>
6187: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6188: <dd><p>directories that contain
6189: scripts</p></dd>
6190: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6191: <dd><p>directories that contain shared and static
6192: libraries</p></dd>
6193: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6194: <dd><p>directories that contain data
6195: files</p></dd>
6196: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6197: <dd><p>directories that contain man
6198: pages</p></dd>
1.100 leot 6199: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6200: <dd><p>directories that contain data files for games
6201: </p></dd>
1.1 dsieger 6202: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6203: <dd><p>binaries that can be stripped from debugging
6204: symbols</p></dd>
6205: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6206: <dd><p>binaries that cannot be
6207: stripped</p></dd>
6208: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6209: <dd><p>game
6210: binaries</p></dd>
6211: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6212: <dd><p>shared and static
6213: libraries</p></dd>
6214: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6215: <dd><p>data files</p></dd>
6216: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6217: <dd><p>data files for
6218: games</p></dd>
6219: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6220: <dd><p>man pages</p></dd>
6221: </dl></div>
6222: <p>Some other variables are:</p>
1.41 asau 6223: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6224: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.125 leot 6225: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?strip+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.106 tnn 6226: when installing binaries. Any debugging sections and symbols present in
6227: binaries will be preserved.
6228: </p></dd>
1.1 dsieger 6229: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6230: <dd><p>A list of directories relative to
6231: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6232: beginning of the <span class="emphasis"><em>install</em></span> phase.
6233: The package is supposed to create all needed directories itself
6234: before installing files to it and list all other directories here.
6235: </p></dd>
6236: </dl></div>
6237: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6238: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6239: mostly relevant for packages in the <code class="filename">regress</code>
6240: category.</p>
6241: </div>
1.41 asau 6242: <div class="sect1">
1.1 dsieger 6243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6244: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6245: <p>Once the install stage has completed, a binary package of
6246: the installed files can be built. These binary packages can be
6247: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6248: the <span class="command"><strong>make bin-install</strong></span> or by using
6249: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6250: <p>By default, the binary packages are created in
6251: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6252: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6253: one for each category in the <code class="varname">CATEGORIES</code>
6254: variable. <code class="varname">PACKAGES</code> defaults to
6255: <code class="filename">pkgsrc/packages</code>.</p>
6256: </div>
1.41 asau 6257: <div class="sect1">
1.1 dsieger 6258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6259: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6260: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6261: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6262: to clean the work directories of all dependencies too, use
1.10 hubertf 6263: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6264: </div>
1.41 asau 6265: <div class="sect1">
1.1 dsieger 6266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6267: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6268: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6269: <dt><span class="term">pre/post-*</span></dt>
6270: <dd><p>For any of the main targets described in the
6271: previous section, two auxiliary targets exist with
1.23 wiz 6272: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.1 dsieger 6273: prefix for the main target's name. These targets are
6274: invoked before and after the main target is called,
6275: allowing extra configuration or installation steps be
6276: performed from a package's Makefile, for example, which
6277: a program's configure script or install target
6278: omitted.</p></dd>
6279: <dt><span class="term">do-*</span></dt>
6280: <dd><p>Should one of the main targets do the wrong thing,
6281: and should there be no variable to fix this, you can
6282: redefine it with the do-* target. (Note that redefining
6283: the target itself instead of the do-* target is a bad
6284: idea, as the pre-* and post-* targets won't be called
6285: anymore, etc.) You will not usually need to do
6286: this.</p></dd>
6287: <dt><span class="term">reinstall</span></dt>
6288: <dd>
1.10 hubertf 6289: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6290: you noticed some file was not installed properly, you
6291: can repeat the installation with this target, which will
1.23 wiz 6292: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6293: <p>This is the default value of
6294: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6295: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6296: package</strong></span>, where the defaults are
1.23 wiz 6297: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6298: respectively.</p>
6299: </dd>
6300: <dt><span class="term">deinstall</span></dt>
6301: <dd>
1.125 leot 6302: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1 dsieger 6303: current directory, effectively de-installing the
6304: package. The following variables can be used to tune the
6305: behaviour:</p>
1.41 asau 6306: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6307: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.125 leot 6308: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1 dsieger 6309: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6310: <dd><p>Remove all packages that require (depend on)
6311: the given package. This can be used to remove any
6312: packages that may have been pulled in by a given
1.10 hubertf 6313: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6314: DEINSTALLDEPENDS=1</strong></span> is done in
6315: <code class="filename">pkgsrc/x11/kde</code>, this is
6316: likely to remove whole KDE. Works by adding
1.125 leot 6317: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1 dsieger 6318: command line.</p></dd>
6319: </dl></div>
6320: </dd>
6321: <dt><span class="term">bin-install</span></dt>
6322: <dd><p>Install a binary package from local disk and via FTP
6323: from a list of sites (see the
6324: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6325: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6326: available anywhere. The arguments given to
1.10 hubertf 6327: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6328: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6329: operation, etc.</p></dd>
1.95 wiz 6330: <dt><span class="term">install-clean</span></dt>
6331: <dd><p>This target removes the state files for the "install" and later
6332: phases so that the "install" target may be re-invoked. This can be
6333: used after editing the PLIST to install the package without
6334: rebuilding it.</p></dd>
6335: <dt><span class="term">build-clean</span></dt>
6336: <dd><p>This target removes the state files for the "build" and later
6337: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6338: <dt><span class="term">update</span></dt>
6339: <dd>
6340: <p>This target causes the current package to be
6341: updated to the latest version. The package and all
6342: depending packages first get de-installed, then current
6343: versions of the corresponding packages get compiled and
6344: installed. This is similar to manually noting which
6345: packages are currently installed, then performing a
1.10 hubertf 6346: series of <span class="command"><strong>make deinstall</strong></span> and
6347: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6348: <code class="varname">UPDATE_TARGET</code> is set to) for these
6349: packages.</p>
1.23 wiz 6350: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6351: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6352: update</strong></span> was interrupted for some reason.
6353: However, in this case, make sure you don't call
1.10 hubertf 6354: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6355: list of dependent packages in <code class="varname">WRKDIR</code>.
6356: Otherwise, you lose the ability to automatically update
6357: the current package along with the dependent packages
6358: you have installed.</p>
1.10 hubertf 6359: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6360: update</strong></span> will only work as long as the package
6361: tree remains unchanged. If the source code for one of
6362: the packages to be updated has been changed, resuming
1.10 hubertf 6363: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6364: fail!</p>
6365: <p>The following variables can be used either on the
1.10 hubertf 6366: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6367: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6368: update</strong></span>:</p>
1.41 asau 6369: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6370: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6371: <dd><p>Install target to recursively use for the
6372: updated package and the dependent packages.
6373: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6374: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6375: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6376: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6377: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6378: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6379: endless loop!</p></dd>
6380: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6381: <dd><p>Don't clean up after updating. Useful if
6382: you want to leave the work sources of the updated
6383: packages around for inspection or other purposes.
6384: Be sure you eventually clean up the source tree
1.23 wiz 6385: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6386: or you may run into troubles with old source code
6387: still lying around on your next
1.10 hubertf 6388: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6389: update</strong></span>.</p></dd>
6390: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6391: <dd><p>Deinstall each package before installing
6392: (making <code class="varname">DEPENDS_TARGET</code>). This
6393: may be necessary if the
1.23 wiz 6394: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6395: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6396: update</strong></span>.</p></dd>
6397: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6398: <dd><p>Allows you to disable recursion and hardcode
6399: the target for packages. The default is
1.23 wiz 6400: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6401: facilitating a recursive update of prerequisite
6402: packages. Only set
6403: <code class="varname">DEPENDS_TARGET</code> if you want to
6404: disable recursive updates. Use
6405: <code class="varname">UPDATE_TARGET</code> instead to just
6406: set a specific target for each package to be
1.10 hubertf 6407: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6408: (see above).</p></dd>
6409: </dl></div>
6410: </dd>
6411: <dt><span class="term">clean-update</span></dt>
6412: <dd>
6413: <p>Clean the source tree for all packages that would
1.10 hubertf 6414: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6415: from the current directory. This target should not be
6416: used if the current package (or any of its depending
6417: packages) have already been de-installed (e.g., after
1.10 hubertf 6418: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6419: some packages you intended to update. As a rule of
6420: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6421: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6422: and only if you have a dirty package tree (e.g., if you
6423: used <code class="varname">NOCLEAN</code>).</p>
6424: <p>If you are unsure about whether your tree is
1.10 hubertf 6425: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6426: clean</strong></span> at the top of the tree, or use the
6427: following sequence of commands from the directory of the
6428: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6429: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6430: time, otherwise you lose all the packages you wanted to
6431: update!):</p>
6432: <pre class="screen">
6433: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6434: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6435: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6436: </pre>
6437: <p>The following variables can be used either on the
1.10 hubertf 6438: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6439: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6440: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6441: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6442: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6443: reconstruct the list of directories to update for
1.10 hubertf 6444: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6445: update</strong></span> successfully installed all
6446: packages you wanted to update. Normally, this is
1.10 hubertf 6447: done automatically on <span class="command"><strong>make
1.1 dsieger 6448: update</strong></span>, but may have been suppressed by
6449: the <code class="varname">NOCLEAN</code> variable (see
6450: above).</p></dd>
6451: </dl></div>
6452: </dd>
6453: <dt><span class="term">replace</span></dt>
6454: <dd>
6455: <p>Update the installation of the current package. This
6456: differs from update in that it does not replace dependent
1.120 sevan 6457: packages. You will need to install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.1 dsieger 6458: target to work.</p>
6459: <p><span class="emphasis"><em>Be careful when using this
6460: target!</em></span> There are no guarantees that dependent
6461: packages will still work, in particular they will most
1.10 hubertf 6462: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6463: library package whose shared library major version changed
6464: between your installed version and the new one. For this
6465: reason, this target is not officially supported and only
6466: recommended for advanced users.</p>
6467: </dd>
6468: <dt><span class="term">info</span></dt>
1.125 leot 6469: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1 dsieger 6470: package. You can use this to check which version of a
6471: package is installed.</p></dd>
6472: <dt><span class="term">index</span></dt>
6473: <dd>
6474: <p>This is a top-level command, i.e. it should be used in
6475: the <code class="filename">pkgsrc</code> directory. It creates a
6476: database of all packages in the local pkgsrc tree, including
6477: dependencies, comment, maintainer, and some other useful
6478: information. Individual entries are created by running
1.10 hubertf 6479: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6480: directories. This index file is saved as
6481: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6482: verbose format by running <span class="command"><strong>make
1.1 dsieger 6483: print-index</strong></span>. You can search in it with
1.10 hubertf 6484: <span class="command"><strong>make search
1.1 dsieger 6485: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6486: extract a list of all packages that depend on a particular
1.10 hubertf 6487: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6488: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6489: <p>Running this command takes a very long time, some
6490: hours even on fast machines!</p>
6491: </dd>
6492: <dt><span class="term">readme</span></dt>
6493: <dd>
6494: <p>This target generates a
6495: <code class="filename">README.html</code> file, which can be
1.120 sevan 6496: viewed using a browser such as <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.1 dsieger 6497: contain references to any packages which are in the
6498: <code class="varname">PACKAGES</code> directory on the local
6499: host. The generated files can be made to refer to URLs
6500: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6501: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6502: wanted to generate <code class="filename">README.html</code>
6503: files which pointed to binary packages on the local
6504: machine, in the directory
6505: <code class="filename">/usr/packages</code>, set
6506: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6507: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6508: <code class="varname">${PACKAGES}</code> directory and its
6509: subdirectories will be searched for all the binary
6510: packages.</p>
6511: <p>The target can be run at the toplevel or in category
6512: directories, in which case it descends recursively.</p>
6513: </dd>
6514: <dt><span class="term">readme-all</span></dt>
6515: <dd><p>This is a top-level command, run it in
6516: <code class="filename">pkgsrc</code>. Use this target to create a
6517: file <code class="filename">README-all.html</code> which contains a
6518: list of all packages currently available in the NetBSD
6519: Packages Collection, together with the category they belong
6520: to and a short description. This file is compiled from the
6521: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6522: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6523: readme</strong></span>.</p></dd>
6524: <dt><span class="term">cdrom-readme</span></dt>
6525: <dd><p>This is very much the same as the
1.23 wiz 6526: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6527: used when generating a pkgsrc tree to be written to a
6528: CD-ROM. This target also produces
6529: <code class="filename">README.html</code> files, and can be made
6530: to refer to URLs based on
6531: <code class="varname">CDROM_PKG_URL_HOST</code> and
6532: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6533: <dt><span class="term">show-distfiles</span></dt>
6534: <dd><p>This target shows which distfiles and patchfiles
6535: are needed to build the package
6536: (<code class="varname">ALLFILES</code>, which contains all
6537: <code class="varname">DISTFILES</code> and
6538: <code class="varname">PATCHFILES</code>, but not
6539: <code class="filename">patches/*</code>).</p></dd>
6540: <dt><span class="term">show-downlevel</span></dt>
6541: <dd><p>This target shows nothing if the package is not
6542: installed. If a version of this package is installed,
6543: but is not the version provided in this version of
6544: pkgsrc, then a warning message is displayed. This target
6545: can be used to show which of your installed packages are
6546: downlevel, and so the old versions can be deleted, and
6547: the current ones added.</p></dd>
6548: <dt><span class="term">show-pkgsrc-dir</span></dt>
6549: <dd><p>This target shows the directory in the pkgsrc
6550: hierarchy from which the package can be built and
6551: installed. This may not be the same directory as the one
6552: from which the package was installed. This target is
6553: intended to be used by people who may wish to upgrade
6554: many packages on a single host, and can be invoked from
6555: the top-level pkgsrc Makefile by using the
1.23 wiz 6556: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6557: <dt><span class="term">show-installed-depends</span></dt>
6558: <dd><p>This target shows which installed packages match
6559: the current package's <code class="varname">DEPENDS</code>. Useful
6560: if out of date dependencies are causing build
6561: problems.</p></dd>
1.95 wiz 6562: <dt><span class="term">print-build-depends-list</span></dt>
6563: <dd><p>This target shows the list of packages that the current package
6564: depends on for building.</p></dd>
6565: <dt><span class="term">print-run-depends-list</span></dt>
6566: <dd><p>This target shows the list of packages that the current package
6567: depends on for running.</p></dd>
1.1 dsieger 6568: <dt><span class="term">check-shlibs</span></dt>
6569: <dd><p>After a package is installed, check all its
6570: binaries and (on ELF platforms) shared libraries to see
6571: if they find the shared libs they need. Run by default
1.10 hubertf 6572: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1 dsieger 6573: <dt><span class="term">print-PLIST</span></dt>
6574: <dd>
1.23 wiz 6575: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6576: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6577: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6578: -newer work/.extract_done</strong></span>. An attempt is made
6579: to care for shared libs etc., but it is
6580: <span class="emphasis"><em>strongly</em></span> recommended to review the
6581: result before putting it into
6582: <code class="filename">PLIST</code>. On upgrades, it's useful to
6583: diff the output of this command against an already
6584: existing <code class="filename">PLIST</code> file.</p>
1.125 leot 6585: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 6586: other methods that don't update file access times, be
6587: sure to add these files manually to your
1.23 wiz 6588: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6589: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6590: them!</p>
1.23 wiz 6591: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.1 dsieger 6592: information on this target.</p>
6593: </dd>
6594: <dt><span class="term">bulk-package</span></dt>
6595: <dd>
6596: <p>Used to do bulk builds. If an appropriate binary
6597: package already exists, no action is taken. If not, this
6598: target will compile, install and package it (and its
6599: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 6600: 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
6601: builds)</i></a>).
1.1 dsieger 6602: After creating the binary package, the sources, the
6603: just-installed package and its required packages are
6604: removed, preserving free disk space.</p>
6605: <p><span class="emphasis"><em>Beware that this target may deinstall
6606: all packages installed on a system!</em></span></p>
6607: </dd>
6608: <dt><span class="term">bulk-install</span></dt>
6609: <dd>
6610: <p>Used during bulk-installs to install required
6611: packages. If an up-to-date binary package is available,
1.125 leot 6612: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10 hubertf 6613: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6614: but the installed binary won't be removed.</p>
6615: <p>A binary package is considered
1.23 wiz 6616: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.125 leot 6617: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41 asau 6618: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6619: <li class="listitem"><p>None of the package's files
1.1 dsieger 6620: (<code class="filename">Makefile</code>, ...) were modified
6621: since it was built.</p></li>
1.23 wiz 6622: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6623: packages were modified since it was built.</p></li>
6624: </ul></div>
6625: <p><span class="emphasis"><em>Beware that this target may deinstall
6626: all packages installed on a system!</em></span></p>
6627: </dd>
6628: </dl></div>
6629: </div>
6630: </div>
1.41 asau 6631: <div class="chapter">
1.1 dsieger 6632: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6633: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6634: <div class="toc">
6635: <p><b>Table of Contents</b></p>
1.100 leot 6636: <dl class="toc">
1.6 rillig 6637: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
6638: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
6639: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6640: </dl>
6641: </div>
6642: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6643: by pkgsrc and also for individual packages to define what commands
6644: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
6645: or for later run-time of an installed packaged (such as
6646: <code class="varname">DEPENDS</code>).
6647: If the native system provides an adequate tool, then in many cases, a pkgsrc
6648: package will not be used.</p>
6649: <p>When building a package, the replacement tools are
6650: made available in a directory (as symlinks or wrapper scripts)
6651: that is early in the executable search path. Just like the buildlink
6652: system, this helps with consistent builds.</p>
6653: <p>A tool may be needed to help build a specific package. For example,
6654: perl, GNU make (gmake) or yacc may be needed.</p>
6655: <p>Also a tool may be needed, for example, because the native system's supplied
6656: tool may be inefficient for building a package with pkgsrc.
6657: For example, a package may need GNU awk, bison (instead of
6658: yacc) or a better sed.</p>
6659: <p>The tools used by a package can be listed by running
1.10 hubertf 6660: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6661: <div class="sect1">
1.1 dsieger 6662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6663: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6664: <p>The default set of tools used by pkgsrc is defined in
6665: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6666: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6667: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6668: These can be seen by running:
1.10 hubertf 6669: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6670: <p>If a package needs a specific program to build
6671: then the <code class="varname">USE_TOOLS</code> variable can be used
6672: to define the tools needed.</p>
6673: </div>
1.41 asau 6674: <div class="sect1">
1.1 dsieger 6675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6676: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6677: <p>In the following examples, the :run means that it is needed at
6678: run-time (and becomes a DEPENDS).
1.1 dsieger 6679: The default is a build dependency which can be set with
6680: :build. (So in this example, it is the same as gmake:build
6681: and pkg-config:build.)</p>
6682: <pre class="programlisting">
6683: USE_TOOLS+= gmake perl:run pkg-config
6684: </pre>
6685: <p>When using the tools framework, a
6686: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6687: which contains the full path to the appropriate tool. For example,
1.23 wiz 6688: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6689: on Linux systems.</p>
6690: <p>If you always need a pkgsrc version of the
6691: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6692: </p>
6693: </div>
1.41 asau 6694: <div class="sect1">
1.1 dsieger 6695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6696: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6697: <p>When improving or porting pkgsrc to a new platform, have a look
6698: at (or create) the corresponding platform specific make file fragment under
6699: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6700: the name of the common tools. For example:</p>
6701: <pre class="programlisting">
6702: .if exists(/usr/bin/bzcat)
6703: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6704: .elif exists(/usr/bin/bzip2)
6705: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6706: .endif
6707:
6708: TOOLS_PLATFORM.true?= true # shell builtin
6709: </pre>
6710: </div>
6711: </div>
1.41 asau 6712: <div class="chapter">
1.1 dsieger 6713: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6714: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 6715: <div class="toc">
6716: <p><b>Table of Contents</b></p>
1.100 leot 6717: <dl class="toc">
1.6 rillig 6718: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 6719: <dd><dl>
1.108 rillig 6720: <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>
6721: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
6722: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
6723: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
6724: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
6725: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
6726: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
6727: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
6728: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
6729: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6730: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.6 rillig 6731: </dl></dd>
1.108 rillig 6732: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 6733: <dd><dl>
6734: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6735: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.88 tnn 6736: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 6737: </dl></dd>
1.108 rillig 6738: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 6739: <dd><dl>
6740: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
6741: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6742: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
6743: </dl></dd>
6744: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
6745: <dd><dl>
6746: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
6747: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
6748: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 6749: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
6750: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 6751: </dl></dd>
1.108 rillig 6752: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 6753: <dd><dl>
6754: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
6755: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 6756: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 6757: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
6758: </dl></dd>
1.108 rillig 6759: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 6760: <dd><dl>
6761: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
6762: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
6763: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
6764: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
6765: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6766: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
6767: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
6768: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 6769: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 6770: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 6771: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
6772: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
6773: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
6774: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
6775: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
6776: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
6777: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
6778: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 6779: emulation</a></span></dt>
1.6 rillig 6780: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
6781: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6782: </dl></dd>
1.6 rillig 6783: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6784: </dl>
6785: </div>
1.41 asau 6786: <div class="sect1">
1.1 dsieger 6787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6788: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 6789: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6790: different platforms. As a result, it is important to ensure,
6791: where possible, that packages in pkgsrc are portable. This
6792: chapter mentions some particular details you should pay
6793: attention to while working on pkgsrc.</p>
1.41 asau 6794: <div class="sect2">
1.1 dsieger 6795: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6796: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 6797: </h3></div></div></div>
6798: <p>The pkgsrc user can configure pkgsrc by overriding several
6799: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6800: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6801: want to use those variables in the preprocessor directives of
1.125 leot 6802: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 6803: <code class="literal">.for</code>), you need to include the file
6804: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6805: loads the user preferences.</p>
6806: <p>But note that some variables may not be completely defined
6807: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6808: included, as they may contain references to variables that are
1.108 rillig 6809: not yet defined. In shell commands (the lines in
6810: <code class="filename">Makefile</code> that are indented with a tab) this
6811: is no problem, since variables are only expanded when they are
6812: used. But in the preprocessor directives mentioned above and in
6813: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6814: dependencies</code>) the variables are expanded at load
6815: time.</p>
1.41 asau 6816: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6817: <h3 class="title">Note</h3>
1.108 rillig 6818: <p>To check whether a variable can be used at load time,
6819: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6820: </div>
6821: </div>
1.41 asau 6822: <div class="sect2">
1.1 dsieger 6823: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6824: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6825: <p>Occasionally, packages require interaction from the user,
6826: and this can be in a number of ways:</p>
1.41 asau 6827: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6828: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 6829: interaction such as entering username/password or accepting a
6830: license on a web page.</p></li>
1.23 wiz 6831: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 6832: passwords.</p></li>
1.23 wiz 6833: <li class="listitem"><p>help to configure the package before it is built</p></li>
6834: <li class="listitem"><p>help during the build process</p></li>
6835: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 6836: </ul></div>
1.108 rillig 6837: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6838: variable to define which stages need interaction. This should be
6839: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 6840: <pre class="programlisting">
6841: INTERACTIVE_STAGE= configure install
1.111 sevan 6842: </pre>
1.1 dsieger 6843: <p>The user can then decide to skip this package by setting the
1.108 rillig 6844: <code class="varname">BATCH</code> variable. Packages that require interaction
6845: are also excluded from bulk builds.</p>
1.1 dsieger 6846: </div>
1.41 asau 6847: <div class="sect2">
1.1 dsieger 6848: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6849: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 6850: <p>Authors of software can choose the licence under which software
6851: can be copied. The Free Software Foundation has declared some
6852: licenses "Free", and the Open Source Initiative has a definition of
6853: "Open Source".</p>
6854: <p>By default, pkgsrc allows packages with Free or Open Source
6855: licenses to be built. To allow packages with other licenses to be
6856: built as well, the pkgsrc user needs to add these licenses to the
6857: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6858: that this variable only affects which packages may be
6859: <span class="emphasis"><em>built</em></span>, while the license terms often also
6860: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 6861: <p>One might want to only install packages with a BSD license,
1.108 rillig 6862: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 6863: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 6864: user can override the default by setting the
6865: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 6866: of "+=". The licenses accepted by default are defined in the
6867: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6868: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 6869: <p>The license tag mechanism is intended to address
6870: copyright-related issues surrounding building, installing and
6871: using a package, and not to address redistribution issues (see
6872: <code class="varname">RESTRICTED</code> and
1.111 sevan 6873: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 6874: Packages with redistribution restrictions should set these
6875: tags.</p>
1.1 dsieger 6876: <p>Denoting that a package may be copied according to a
6877: particular license is done by placing the license in
6878: <code class="filename">pkgsrc/licenses</code> and setting the
6879: <code class="varname">LICENSE</code> variable to a string identifying the
1.120 sevan 6880: license, e.g. in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1 dsieger 6881: <pre class="programlisting">
6882: LICENSE= xv-license
1.111 sevan 6883: </pre>
1.1 dsieger 6884: <p>When trying to build, the user will get a notice that the
6885: package is covered by a license which has not been placed in the
6886: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
6887: <pre class="programlisting">
6888: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6889: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6890: ===> To view the license, enter "/usr/bin/make show-license".
6891: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6892: ===> ACCEPTABLE_LICENSES+=xv-license
6893: *** Error code 1
1.111 sevan 6894: </pre>
1.10 hubertf 6895: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 6896: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 6897: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 6898: convey to pkgsrc that it should not in the future fail because of
6899: that license:</p>
6900: <pre class="programlisting">
6901: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 6902: </pre>
6903: <p>The use of <code class="varname">LICENSE=shareware</code>,
6904: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
6905: is deprecated because it does not crisply refer to a particular
6906: license text. Another problem with such usage is that it does not
6907: enable a user to tell pkgsrc to proceed for a single package
6908: without also telling pkgsrc to proceed for all packages with that
6909: tag.</p>
6910: <div class="sect3">
6911: <div class="titlepage"><div><div><h4 class="title">
6912: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 6913: <p>When adding a package with a new license, the following steps
6914: are required:</p>
6915: <div class="orderedlist"><ol class="orderedlist" type="1">
6916: <li class="listitem">
1.111 sevan 6917: <p>Check whether the license qualifies as Free or Open
6918: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
6919: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
6920: Open Source Initiative</a>. If this is the case, the filename in
6921: <code class="filename">pkgsrc/licenses/</code> does not need the
6922: <code class="filename">-license</code> suffix, and the license name should be
6923: added to:</p>
1.48 rodent 6924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6925: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
6926: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
6927: </ul></div>
6928: </li>
6929: <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>
6930: </ol></div>
1.111 sevan 6931: </div>
6932: <div class="sect3">
6933: <div class="titlepage"><div><div><h4 class="title">
6934: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 6935: <p>When the license changes (in a way other than formatting),
1.111 sevan 6936: make sure that the new license has a different name (e.g.,
1.1 dsieger 6937: append the version number if it exists, or the date). Just
6938: because a user told pkgsrc to build programs under a previous
6939: version of a license does not mean that pkgsrc should build
6940: programs under the new licenses. The higher-level point is that
6941: pkgsrc does not evaluate licenses for reasonableness; the only
6942: test is a mechanistic test of whether a particular text has been
1.111 sevan 6943: approved by either of two bodies (FSF or OSI).</p>
6944: </div>
1.1 dsieger 6945: </div>
1.41 asau 6946: <div class="sect2">
1.1 dsieger 6947: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 6948: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 6949: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 6950: By declaring the restrictions, package tools can
1.1 dsieger 6951: automatically refrain from e.g. placing binary packages on FTP
6952: sites.</p>
1.111 sevan 6953: <p>There are four possible restrictions, which are
1.1 dsieger 6954: the cross product of sources (distfiles) and binaries not being
6955: placed on FTP sites and CD-ROMs. Because this is rarely the exact
6956: language in any license, and because non-Free licenses tend to be
6957: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 6958: CD-ROM.
6959:
6960: "FTP" means making the source or binary file available over the
6961: Internet at no charge.
6962:
6963: "CD-ROM" means making the source or binary available on some kind of
6964: media, together with other source and binary packages, which is sold
6965: for a distribution charge.
1.1 dsieger 6966: </p>
6967: <p>In order to encode these restrictions, the package system
6968: defines five make variables that can be set to note these
6969: restrictions:</p>
1.41 asau 6970: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6971: <li class="listitem">
1.1 dsieger 6972: <p><code class="varname">RESTRICTED</code></p>
6973: <p>This variable should be set whenever a restriction
6974: exists (regardless of its kind). Set this variable to a
6975: string containing the reason for the restriction. It should
6976: be understood that those wanting to understand the restriction
6977: will have to read the license, and perhaps seek advice of
6978: counsel.</p>
6979: </li>
1.23 wiz 6980: <li class="listitem">
1.1 dsieger 6981: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
6982: <p>Binaries may not be placed on CD-ROM containing other
6983: binary packages, for which a distribution charge may be made.
6984: In this case, set this variable to
6985: <code class="varname">${RESTRICTED}</code>.</p>
6986: </li>
1.23 wiz 6987: <li class="listitem">
1.1 dsieger 6988: <p><code class="varname">NO_BIN_ON_FTP</code></p>
6989: <p>Binaries may not made available on the Internet without
6990: charge. In this case, set this variable to
6991: <code class="varname">${RESTRICTED}</code>. If this variable is set,
6992: binary packages will not be included on ftp.NetBSD.org.</p>
6993: </li>
1.23 wiz 6994: <li class="listitem">
1.1 dsieger 6995: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
6996: <p>Distfiles may not be placed on CD-ROM, together with
6997: other distfiles, for which a fee may be charged. In this
6998: case, set this variable to <code class="varname">${RESTRICTED}</code>.
6999: </p>
7000: </li>
1.23 wiz 7001: <li class="listitem">
1.1 dsieger 7002: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7003: <p>Distfiles may not made available via FTP at no charge.
7004: In this case, set this variable to
7005: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7006: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7007: </li>
7008: </ul></div>
1.111 sevan 7009: <p>Please note that packages will be removed from pkgsrc when the
7010: distfiles are not distributable and cannot be obtained for a period
7011: of one full quarter branch. Packages with manual/interactive fetch
7012: must have a maintainer and it is his/her responsibility to ensure
7013: this.</p>
1.1 dsieger 7014: </div>
1.41 asau 7015: <div class="sect2">
1.1 dsieger 7016: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7017: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7018: <p>Your package may depend on some other package being present
7019: - and there are various ways of expressing this dependency.
7020: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7021: <code class="varname">DEPENDS</code> definitions, the
7022: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7023: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7024: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7025: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 7026: <p>The basic difference between the two variables is as
7027: follows: The <code class="varname">DEPENDS</code> definition registers
7028: that pre-requisite in the binary package so it will be pulled in
7029: when the binary package is later installed, whilst the
7030: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7031: dependency that is only needed for building the package.</p>
7032: <p>This means that if you only need a package present whilst
7033: you are building, it should be noted as a
7034: <code class="varname">BUILD_DEPENDS</code>.</p>
7035: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7036: <code class="varname">DEPENDS</code> definition is:</p>
7037: <pre class="programlisting">
7038: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7039: </pre>
1.23 wiz 7040: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7041: may include any of the wildcard version numbers recognized by
1.125 leot 7042: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7043: <div class="orderedlist"><ol class="orderedlist" type="1">
7044: <li class="listitem">
1.1 dsieger 7045: <p>If your package needs another package's binaries or
1.54 wiz 7046: libraries to build and run, and if that package has a
1.1 dsieger 7047: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7048: <pre class="programlisting">
7049: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7050: </pre>
1.1 dsieger 7051: </li>
1.23 wiz 7052: <li class="listitem">
1.54 wiz 7053: <p>If your package needs another package's binaries or
7054: libraries only for building, and if that package has a
7055: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7056: <pre class="programlisting">
7057: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7058: </pre>
1.54 wiz 7059: <p>but set
7060: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7061: to make it a build dependency only. This case is rather
7062: rare.</p>
7063: </li>
7064: <li class="listitem">
1.25 spz 7065: <p>If your package needs binaries from another package to build,
7066: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7067: <pre class="programlisting">
1.25 spz 7068: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.111 sevan 7069: </pre>
1.1 dsieger 7070: </li>
1.25 spz 7071: <li class="listitem"><p>If your package needs a library with which to link and
7072: there is no <code class="filename">buildlink3.mk</code> file
7073: available, create one. Using
7074: <code class="varname">DEPENDS</code> won't be sufficient because the
7075: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7076: <li class="listitem">
1.25 spz 7077: <p>If your package needs some executable to be able to run
7078: correctly and if there's no
7079: <code class="filename">buildlink3.mk</code> file, this is specified
7080: using the <code class="varname">DEPENDS</code> variable. The
1.120 sevan 7081: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.25 spz 7082: be able to execute the latex binary from the teTeX package
7083: when it runs, and that is specified:</p>
1.1 dsieger 7084: <pre class="programlisting">
1.25 spz 7085: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.111 sevan 7086: </pre>
1.25 spz 7087: </li>
7088: <li class="listitem">
7089: <p>You can use wildcards in package dependencies. Note that
7090: such wildcard dependencies are retained when creating binary
7091: packages. The dependency is checked when installing the binary
7092: package and any package which matches the pattern will be
7093: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7094: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7095: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7096: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7097: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7098: <p>Wildcards can also be used to specify that a package
7099: will only build against a certain minimum version of a
7100: pre-requisite:</p>
7101: <pre class="programlisting">
1.25 spz 7102: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7103: </pre>
1.25 spz 7104: <p>This means that the package will build using version 6.0
7105: of ImageMagick or newer. Such a dependency may be warranted
7106: if, for example, the command line options of an executable
7107: have changed.</p>
7108: <p>If you need to depend on minimum versions of libraries,
7109: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7110: <p>For security fixes, please update the package
1.108 rillig 7111: vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.9. Handling packages with security problems">Section 19.1.9, “Handling packages with security problems”</a> for more
1.1 dsieger 7112: information.</p>
7113: </li>
7114: </ol></div>
7115: <p>If your package needs files from another package to build,
7116: add the relevant distribution files to
7117: <code class="varname">DISTFILES</code>, so they will be extracted
1.120 sevan 7118: automatically. See the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1 dsieger 7119: (It relies on the jpeg sources being present in source form
7120: during the build.)</p>
7121: </div>
1.41 asau 7122: <div class="sect2">
1.1 dsieger 7123: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7124: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7125: <p>Your package may conflict with other packages a user might
7126: already have installed on his system, e.g. if your package
7127: installs the same set of files as another package in the pkgsrc
1.80 wiz 7128: tree or has the same <code class="varname">PKGNAME</code>.</p>
7129: <p>These cases are handled automatically by the packaging tools
7130: at package installation time and do not need to be handled
7131: manually.</p>
7132: <p>In case the conflicts can not be recognized automatically
7133: (e.g., packages using the same config file location but no other
7134: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7135: space-separated list of packages (including version string) your
7136: package conflicts with.</p>
1.120 sevan 7137: <p>For example, if both <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
7138: and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
1.80 wiz 7139: use the same config file, you would set in
7140: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7141: <pre class="programlisting">
1.80 wiz 7142: CONFLICTS= baz-[0-9]*
1.111 sevan 7143: </pre>
1.80 wiz 7144: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7145: <pre class="programlisting">
1.80 wiz 7146: CONFLICTS= bar-[0-9]*
1.111 sevan 7147: </pre>
1.1 dsieger 7148: </div>
1.41 asau 7149: <div class="sect2">
1.1 dsieger 7150: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7151: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7152: <p>There are several reasons why a package might be
7153: instructed to not build under certain circumstances. If the
7154: package builds and runs on most platforms, the exceptions
1.83 dholland 7155: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7156: the package builds and runs on a small handful of platforms,
7157: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7158: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7159: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7160: (OS-version-platform) that can use glob-style
7161: wildcards.</p>
7162: <p>If a package is not appropriate for some platforms (as
1.114 maya 7163: opposed to merely broken), a different set of variables should be
1.83 dholland 7164: used as this affects failure reporting and statistics.
7165: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7166: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7167: the package is appropriate for only a small handful of platforms
7168: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7169: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7170: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7171: (OS-version-platform) that can use glob-style
7172: wildcards.</p>
7173: <p>Some packages are tightly bound to a specific version of an
1.120 sevan 7174: operating system, e.g. LKMs or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.1 dsieger 7175: backwards compatible with other versions of the OS, and should be
7176: uploaded to a version specific directory on the FTP server. Mark
7177: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7178: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7179: the package system internals, but may be used in the
7180: future.</p>
7181: <p>If the package should be skipped (for example, because it
7182: provides functionality already provided by the system), set
7183: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7184: the package should fail because some preconditions are not met,
7185: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7186: message.</p>
7187: </div>
1.41 asau 7188: <div class="sect2">
1.1 dsieger 7189: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7190: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7191: <p>To ensure that a package may not be deleted, once it has been
7192: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7193: be set in the package Makefile. This will be carried into any
7194: binary package that is made from this pkgsrc entry. A
1.23 wiz 7195: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.125 leot 7196: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7197: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7198: </div>
1.41 asau 7199: <div class="sect2">
1.1 dsieger 7200: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7201: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7202: <p>When a vulnerability is found, this should be noted in
7203: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7204: and after committing that file, ask pkgsrc-security@NetBSD.org to
7205: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7206: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7207: <code class="varname">PKGREVISION</code> should be increased (this is of
7208: course not necessary if the problem is fixed by using a newer
7209: release of the software), and the pattern in the
7210: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7211: <p>Also, if the fix should be applied to the stable pkgsrc
7212: branch, be sure to submit a pullup request!</p>
7213: <p>Binary packages already on ftp.NetBSD.org will be handled
7214: semi-automatically by a weekly cron job.</p>
7215: </div>
1.41 asau 7216: <div class="sect2">
1.1 dsieger 7217: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7218: <a name="bumping-pkgrevision"></a>19.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 7219: <p>When making fixes to an existing package it can be useful
7220: to change the version number in <code class="varname">PKGNAME</code>. To
7221: avoid conflicting with future versions by the original author, a
1.23 wiz 7222: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 7223: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7224: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7225: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7226: <pre class="programlisting">
7227: DISTNAME= foo-17.42
7228: PKGREVISION= 9
1.111 sevan 7229: </pre>
1.1 dsieger 7230: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7231: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7232: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7233: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7234: <code class="varname">PKGNAME_NOREV</code>.</p>
7235: <p>When a new release of the package is released, the
7236: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7237: minor release of the above package, things should be like:</p>
7238: <pre class="programlisting">
7239: DISTNAME= foo-17.43
1.111 sevan 7240: </pre>
1.1 dsieger 7241: <p><code class="varname">PKGREVISION</code> should be incremented for any
7242: non-trivial change in the resulting binary package. Without a
7243: <code class="varname">PKGREVISION</code> bump, someone with the previous
7244: version installed has no way of knowing that their package is out
7245: of date. Thus, changes without increasing
7246: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7247: trivial that no reasonable person would want to upgrade", and this
7248: is the rough test for when increasing
7249: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7250: changes that do not merit increasing
7251: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7252: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7253: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7254: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7255: or comments in Makefile.</p></li>
1.23 wiz 7256: <li class="listitem"><p>
1.1 dsieger 7257: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7258: <li class="listitem"><p>
1.1 dsieger 7259: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7260: <li class="listitem"><p>
1.1 dsieger 7261: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7262: </ul></div>
7263: <p>Examples of changes that do merit an increase to
7264: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7265: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7266: <li class="listitem"><p>
1.1 dsieger 7267: Security fixes</p></li>
1.23 wiz 7268: <li class="listitem"><p>
1.1 dsieger 7269: Changes or additions to a patch file</p></li>
1.23 wiz 7270: <li class="listitem"><p>
1.1 dsieger 7271: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 7272: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 7273: </ul></div>
7274: <p>PKGREVISION must also be incremented when dependencies have ABI
7275: changes.</p>
7276: </div>
1.41 asau 7277: <div class="sect2">
1.1 dsieger 7278: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 7279: <a name="fixes.subst"></a>19.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1 dsieger 7280: <p>When you want to replace the same text in multiple files
7281: or when the replacement text varies, patches alone cannot help.
7282: This is where the SUBST framework comes in. It provides an
7283: easy-to-use interface for replacing text in files.
7284: Example:</p>
7285: <pre class="programlisting">
7286: SUBST_CLASSES+= fix-paths
7287: SUBST_STAGE.fix-paths= pre-configure
7288: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7289: SUBST_FILES.fix-paths= src/*.c
7290: SUBST_FILES.fix-paths+= scripts/*.sh
7291: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7292: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 sevan 7293: </pre>
1.1 dsieger 7294: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7295: that are used to identify the different SUBST blocks that are
7296: defined. The SUBST framework is heavily used by pkgsrc, so it is
7297: important to always use the <code class="literal">+=</code> operator with
7298: this variable. Otherwise some substitutions may be
7299: skipped.</p>
7300: <p>The remaining variables of each SUBST block are
7301: parameterized with the identifier from the first line
7302: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7303: parameters to a function call.</p>
7304: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7305: which the replacement will take place. All combinations of
7306: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7307: <code class="literal">post-</code> together with a phase name are
7308: possible, though only few are actually used. Most commonly used
7309: are <code class="literal">post-patch</code> and
7310: <code class="literal">pre-configure</code>. Of these two,
7311: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7312: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7313: have the state after applying the patches but before making any
7314: other changes. This is especially useful when you are debugging
7315: a package in order to create new patches for it. Similarly,
7316: <code class="literal">post-build</code> is preferred over
7317: <code class="literal">pre-install</code>, because the install phase should
7318: generally be kept as simple as possible. When you use
7319: <code class="literal">post-build</code>, you have the same files in the
7320: working directory that will be installed later, so you can check
7321: if the substitution has succeeded.</p>
7322: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7323: that is printed just before the substitution is done.</p>
7324: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7325: globbing patterns that specifies the files in which the
7326: substitution will take place. The patterns are interpreted
7327: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7328: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.125 leot 7329: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1 dsieger 7330: command should be prefixed with <code class="literal">-e</code>, so that
7331: all SUBST blocks look uniform.</p>
7332: <p>There are some more variables, but they are so seldomly
7333: used that they are only documented in the
7334: <code class="filename">mk/subst.mk</code> file.</p>
7335: </div>
7336: </div>
1.41 asau 7337: <div class="sect1">
1.1 dsieger 7338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7339: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7340: <div class="sect2">
1.1 dsieger 7341: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7342: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 7343: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7344: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7345: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7346: with the name of each file to download as an argument, expecting
7347: it to output the URL of the directory from which to download
1.120 sevan 7348: it. <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1 dsieger 7349: example of this usage.</p>
7350: <p>If the download can't be automated, because the user must
7351: submit personal information to apply for a password, or must pay
7352: for the source, or whatever, you can set
7353: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7354: displayed to the user before aborting the build. Example:</p>
7355: <pre class="programlisting">
7356: FETCH_MESSAGE= "Please download the files"
7357: FETCH_MESSAGE+= " "${DISTFILES:Q}
7358: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7359: </pre>
1.1 dsieger 7360: </div>
1.41 asau 7361: <div class="sect2">
1.1 dsieger 7362: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7363: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 7364: <p>Sometimes authors of a software package make some
7365: modifications after the software was released, and they put up a
7366: new distfile without changing the package's version number. If a
7367: package is already in pkgsrc at that time, the checksum will
7368: no longer match. The contents of the new distfile should be
7369: compared against the old one before changing anything, to make
7370: sure the distfile was really updated on purpose, and that
7371: no trojan horse or so crept in.
7372: Please mention that the distfiles were compared and what was found
1.53 rodent 7373: in your commit message.</p>
1.109 wiz 7374: <p>Then, the correct way to work around this is to set
7375: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7376: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7377: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7378: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7379: <code class="varname">PATCHFILES</code> for this package will be put in that
1.109 wiz 7380: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="19.1.10. How to handle incrementing versions when fixing an existing package">Section 19.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.1 dsieger 7381: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7382: including the <code class="filename">nbX</code> suffix) or a date stamp can
7383: be appended, like
7384: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53 rodent 7385: <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>
7386: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7387: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7388: path in the filenames.
1.53 rodent 7389: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7390: Furthermore, a mail to the package's authors seems appropriate
7391: telling them that changing distfiles after releases without
7392: changing the file names is not good practice.</p>
7393: </div>
1.88 tnn 7394: <div class="sect2">
7395: <div class="titlepage"><div><div><h3 class="title">
7396: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 7397: <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:
7398: </p>
1.88 tnn 7399: <div class="sect3">
7400: <div class="titlepage"><div><div><h4 class="title">
7401: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
7402: <p>
7403: 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.
7404: </p>
7405: <pre class="programlisting">
7406: DISTNAME= exampleproject-1.0
1.90 tnn 7407: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7408: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7409: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7410: EXTRACT_SUFX= .zip
7411: </pre>
7412: </div>
7413: <div class="sect3">
7414: <div class="titlepage"><div><div><h4 class="title">
7415: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
7416: <p>
7417: 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.
7418: </p>
7419: <pre class="programlisting">
7420: DISTNAME= example-1.0
1.107 jnemeth 7421: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7422: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7423: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7424: </pre>
1.88 tnn 7425: </div>
7426: <div class="sect3">
7427: <div class="titlepage"><div><div><h4 class="title">
7428: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
7429: <p>
7430: 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.
7431: </p>
7432: <pre class="programlisting">
7433: DISTNAME= offensive-1.6
1.90 tnn 7434: PKGNAME= ${DISTNAME:S/offensive/proper/}
7435: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7436: GITHUB_PROJECT= exampleproject
7437: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7438: EXTRACT_SUFX= .zip
1.111 sevan 7439: </pre>
1.88 tnn 7440: </div>
7441: </div>
1.1 dsieger 7442: </div>
1.41 asau 7443: <div class="sect1">
1.1 dsieger 7444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7445: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7446: <div class="sect2">
1.1 dsieger 7447: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7448: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7449: <p>pkgsrc supports many different machines, with different
7450: object formats like a.out and ELF, and varying abilities to do
7451: shared library and dynamic loading at all. To accompany this,
7452: varying commands and options have to be passed to the
7453: compiler, linker, etc. to get the Right Thing, which can be
7454: pretty annoying especially if you don't have all the machines
7455: at your hand to test things. The
1.120 sevan 7456: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 7457: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7458: both static and dynamic libraries from a set of source files,
7459: thus being platform-independent.</p>
7460: <p>Here's how to use libtool in a package in seven simple
7461: steps:</p>
1.23 wiz 7462: <div class="orderedlist"><ol class="orderedlist" type="1">
7463: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7464: Makefile.</p></li>
1.23 wiz 7465: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7466: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7467: add it to the definition of <code class="varname">CC</code>, if only
7468: libraries are being built in a given Makefile. This one command
7469: will build both PIC and non-PIC library objects, so you need not
7470: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7471: <li class="listitem">
1.1 dsieger 7472: <p>For the linking of the library, remove any
1.23 wiz 7473: <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
7474: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7475: <pre class="programlisting">
7476: ${LIBTOOL} --mode=link \
7477: ${CC} -o ${.TARGET:.a=.la} \
7478: ${OBJS:.o=.lo} \
7479: -rpath ${PREFIX}/lib \
7480: -version-info major:minor
1.111 sevan 7481: </pre>
1.1 dsieger 7482: <p>Note that the library is changed to have a
7483: <code class="filename">.la</code> extension, and the objects are
7484: changed to have a <code class="filename">.lo</code>
7485: extension. Change <code class="varname">OBJS</code> as
7486: necessary. This automatically creates all of the
7487: <code class="filename">.a</code>,
7488: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7489: necessary) in the build directory. Be sure to include
1.23 wiz 7490: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7491: minor are zero, as libtool will otherwise strip off the
7492: shared library version.</p>
7493: <p>From the libtool manual:</p>
7494: <pre class="programlisting">
7495: So, libtool library versions are described by three integers:
7496:
7497: CURRENT
7498: The most recent interface number that this library implements.
7499:
7500: REVISION
7501: The implementation number of the CURRENT interface.
7502:
7503: AGE
7504: The difference between the newest and oldest interfaces that
7505: this library implements. In other words, the library implements
7506: all the interface numbers in the range from number `CURRENT -
7507: AGE' to `CURRENT'.
7508:
7509: If two libraries have identical CURRENT and AGE numbers, then the
7510: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 7511: </pre>
1.23 wiz 7512: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7513: different results for a.out and ELF (excluding symlinks)
7514: in only one case. An ELF library of the form
1.23 wiz 7515: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 7516: will have a symlink of
1.23 wiz 7517: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 7518: on an a.out platform. This is handled
7519: automatically.</p>
1.23 wiz 7520: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7521: directory of the library being built.</p>
7522: <p>In the <code class="filename">PLIST</code>, include only the
7523: <code class="filename">.la</code> file, the other files will be
7524: added automatically.</p>
7525: </li>
1.23 wiz 7526: <li class="listitem">
1.1 dsieger 7527: <p>When linking shared object (<code class="filename">.so</code>)
1.125 leot 7528: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 7529: shared libraries, use <span class="quote">“<span class="quote">-module
7530: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7531: tacked on.</p>
7532: <p>The <code class="filename">PLIST</code> file gets the
7533: <code class="filename">foo.so</code> entry.</p>
7534: </li>
1.23 wiz 7535: <li class="listitem">
1.1 dsieger 7536: <p>When linking programs that depend on these libraries
7537: <span class="emphasis"><em>before</em></span> they are installed, preface
1.125 leot 7538: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 7539: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7540: libraries (static or shared), but please be aware that
7541: libtool will not allow you to specify a relative path in
1.23 wiz 7542: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7543: expects you to change that argument to be the
7544: <code class="filename">.la</code> file. e.g.</p>
7545: <pre class="programlisting">
7546: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 7547: </pre>
1.1 dsieger 7548: <p>should be changed to:</p>
7549: <pre class="programlisting">
7550: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 7551: </pre>
1.1 dsieger 7552: <p>and it will do the right thing with the libraries.</p>
7553: </li>
1.23 wiz 7554: <li class="listitem">
1.125 leot 7555: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
7556: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 7557: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7558: <code class="filename">.la</code>. e.g.</p>
7559: <pre class="programlisting">
1.22 jakllsch 7560: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 7561: </pre>
1.1 dsieger 7562: <p>This will install the static <code class="filename">.a</code>,
7563: shared library, any needed symlinks, and run
1.125 leot 7564: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 7565: </li>
1.23 wiz 7566: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7567: the <code class="filename">.la</code>
7568: file (this is a change from previous behaviour).</p></li>
7569: </ol></div>
7570: </div>
1.41 asau 7571: <div class="sect2">
1.1 dsieger 7572: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7573: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7574: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7575: package Makefile. This will override the package's own libtool
7576: in most cases. For older libtool using packages, libtool is
7577: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7578: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7579: configure; find work*/ -name libtool</strong></span>.</p>
7580: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7581: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7582: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7583: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7584: package's libtool script(s), set it as appropriate.</p>
7585: <p>If you do not need <code class="filename">*.a</code> static
7586: libraries built and installed, then use
7587: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7588: <p>If your package makes use of the platform-independent library
7589: for loading dynamic shared objects, that comes with libtool
7590: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7591: <p>Some packages use libtool incorrectly so that the package
7592: may not work or build in some circumstances. Some of the more
7593: common errors are:</p>
1.41 asau 7594: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7595: <li class="listitem">
1.1 dsieger 7596: <p>The inclusion of a shared object (-module) as a dependent library in an
7597: executable or library. This in itself isn't a problem if one of two things
7598: has been done:</p>
1.23 wiz 7599: <div class="orderedlist"><ol class="orderedlist" type="1">
7600: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7601: <code class="filename">libfoo.la</code>, not
7602: <code class="filename">foo.la</code></p></li>
1.23 wiz 7603: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7604: </ol></div>
7605: </li>
1.23 wiz 7606: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7607: The function lt_dlinit() should be called and the macro
7608: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7609: executables.</p></li>
7610: </ul></div>
7611: </div>
1.41 asau 7612: <div class="sect2">
1.1 dsieger 7613: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7614: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7615: <p>If a package needs GNU autoconf or automake to be executed
7616: to regenerate the configure script and Makefile.in makefile
7617: templates, then they should be executed in a pre-configure
7618: target.</p>
7619: <p>For packages that need only autoconf:</p>
7620: <pre class="programlisting">
7621: AUTOCONF_REQD= 2.50 # if default version is not good enough
7622: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7623: ...
7624:
7625: pre-configure:
7626: cd ${WRKSRC} && autoconf
7627:
7628: ...
1.111 sevan 7629: </pre>
1.1 dsieger 7630: <p>and for packages that need automake and autoconf:</p>
7631: <pre class="programlisting">
7632: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7633: USE_TOOLS+= automake # use "automake14" for automake-1.4
7634: ...
7635:
7636: pre-configure:
7637: set -e; cd ${WRKSRC}; \
7638: aclocal; autoheader; automake -a --foreign -i; autoconf
7639:
7640: ...
1.111 sevan 7641: </pre>
1.1 dsieger 7642: <p>Packages which use GNU Automake will almost certainly
7643: require GNU Make.</p>
7644: <p>There are times when the configure process makes
7645: additional changes to the generated files, which then causes
7646: the build process to try to re-execute the automake sequence.
7647: This is prevented by touching various files in the configure
7648: stage. If this causes problems with your package you can set
7649: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7650: Makefile.</p>
7651: </div>
7652: </div>
1.41 asau 7653: <div class="sect1">
1.1 dsieger 7654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7655: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 7656: <div class="sect2">
1.1 dsieger 7657: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7658: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7659: <p>Compilers for the C, C++, and Fortran languages comes with
7660: the NetBSD base system. By default, pkgsrc assumes that a package
7661: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 7662: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7663: <p>To declare which language's compiler a package needs, set
7664: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7665: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7666: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7667: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7668: written in C++, usually need a C compiler for the configure
7669: phase.</p>
7670: </div>
1.41 asau 7671: <div class="sect2">
1.1 dsieger 7672: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7673: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 7674: <p>If a program is written in Java, use the Java framework in
7675: pkgsrc. The package must include
7676: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7677: provides the following variables:</p>
1.41 asau 7678: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7679: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7680: dependency on the JDK is added. If
1.23 wiz 7681: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7682: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7683: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7684: JDK.</p></li>
1.23 wiz 7685: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7686: a package needs a Java2 implementation. The supported values
1.23 wiz 7687: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7688: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7689: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7690: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7691: above. This variable is not set by default.</p></li>
1.24 wiz 7692: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7693: automatically set to the runtime location of the used Java
7694: implementation dependency. It may be used to set
7695: <code class="varname">JAVA_HOME</code> to a good value if the program
7696: needs this variable to be defined.
7697: </p></li>
1.1 dsieger 7698: </ul></div>
7699: </div>
1.41 asau 7700: <div class="sect2">
1.1 dsieger 7701: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7702: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7703: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7704: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7705: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7706: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7707: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7708: that you want adjusted. Every occurrence of
7709: <code class="filename">*/bin/perl</code> in a she-bang line will be
7710: replaced with the full path to the perl executable.</p>
1.1 dsieger 7711: <p>If a particular version of perl is needed, set the
7712: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7713: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 7714: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.1 dsieger 7715: about handling perl modules.</p>
7716: </div>
1.41 asau 7717: <div class="sect2">
1.1 dsieger 7718: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 7719: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
7720: <p><code class="varname">REPLACE_SH</code>,
7721: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7722: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7723: hash bangs in files. Please use the appropriate one, prefering
7724: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7725: Each should contain a list of scripts, relative to
7726: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7727: occurrence of the matching shell in a she-bang line will be
7728: replaced with the full path to the shell executable.
1.40 wiz 7729: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7730: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7731: </div>
1.41 asau 7732: <div class="sect2">
1.40 wiz 7733: <div class="titlepage"><div><div><h3 class="title">
7734: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7735: <p>Currently, there is no special handling for other languages
7736: in pkgsrc. If a compiler package provides a
7737: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7738: just add a (build) dependency on the appropriate compiler
7739: package.</p>
7740: </div>
7741: </div>
1.41 asau 7742: <div class="sect1">
1.1 dsieger 7743: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7744: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7745: <p>The most common failures when building a package are that
7746: some platforms do not provide certain header files, functions or
7747: libraries, or they provide the functions in a library that the
7748: original package author didn't know. To work around this, you
7749: can rewrite the source code in most cases so that it does not
7750: use the missing functions or provides a replacement function.</p>
1.41 asau 7751: <div class="sect2">
1.1 dsieger 7752: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7753: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7754: <p>If a package already comes with a GNU configure script, the
7755: preferred way to fix the build failure is to change the
7756: configure script, not the code. In the other cases, you can
7757: utilize the C preprocessor, which defines certain macros
7758: depending on the operating system and hardware architecture it
7759: compiles for. These macros can be queried using for example
7760: <code class="varname">#if defined(__i386)</code>. Almost every operating
7761: system, hardware architecture and compiler has its own macro.
7762: For example, if the macros <code class="varname">__GNUC__</code>,
7763: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7764: are all defined, you know that you are using NetBSD on an i386
7765: compatible CPU, and your compiler is GCC.</p>
7766: <p>The list of the following macros for hardware and
7767: operating system depends on the compiler that is used. For
7768: example, if you want to conditionally compile code on Solaris,
7769: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7770: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7771: <div class="sect3">
1.1 dsieger 7772: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7773: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 7774: <p>To distinguish between 4.4 BSD-derived systems and the
7775: rest of the world, you should use the following code.</p>
7776: <pre class="programlisting">
7777: #include <sys/param.h>
7778: #if (defined(BSD) && BSD >= 199306)
7779: /* BSD-specific code goes here */
7780: #else
7781: /* non-BSD-specific code goes here */
7782: #endif
7783: </pre>
7784: <p>If this distinction is not fine enough, you can also test
7785: for the following macros.</p>
7786: <pre class="programlisting">
1.45 obache 7787: Cygwin __CYGWIN__
7788: DragonFly __DragonFly__
1.1 dsieger 7789: FreeBSD __FreeBSD__
1.45 obache 7790: Haiku __HAIKU__
1.1 dsieger 7791: Interix __INTERIX
7792: IRIX __sgi (TODO: get a definite source for this)
7793: Linux linux, __linux, __linux__
1.83 dholland 7794: Mac OS X __APPLE__
1.45 obache 7795: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7796: Minix3 __minix
1.1 dsieger 7797: NetBSD __NetBSD__
7798: OpenBSD __OpenBSD__
7799: Solaris sun, __sun
7800: </pre>
7801: </div>
1.41 asau 7802: <div class="sect3">
1.1 dsieger 7803: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7804: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 7805: <pre class="programlisting">
7806: i386 i386, __i386, __i386__
7807: MIPS __mips
7808: SPARC sparc, __sparc
7809: </pre>
7810: </div>
1.41 asau 7811: <div class="sect3">
1.1 dsieger 7812: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7813: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 7814: <pre class="programlisting">
7815: GCC __GNUC__ (major version), __GNUC_MINOR__
7816: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7817: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7818: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7819: </pre>
7820: </div>
7821: </div>
1.41 asau 7822: <div class="sect2">
1.1 dsieger 7823: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7824: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 7825: <p>Some source files trigger bugs in the compiler, based on
7826: combinations of compiler version and architecture and almost
7827: always relation to optimisation being enabled. Common symptoms
7828: are gcc internal errors or never finishing compiling a
7829: file.</p>
7830: <p>Typically, a workaround involves testing the
7831: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7832: optimisation for that combination of file,
1.87 tnn 7833: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7834: <p>This used to be a big problem in the past, but is rarely
7835: needed now as compiler technology has matured. If you still need
7836: to add a compiler specific workaround, please do so in the file
7837: <code class="filename">hacks.mk</code> and describe the symptom and
7838: compiler version as detailed as possible.</p>
1.1 dsieger 7839: </div>
1.41 asau 7840: <div class="sect2">
1.1 dsieger 7841: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 7842: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
7843: </h3></div></div></div>
1.1 dsieger 7844: <p>This error message often means that a package did not
7845: link to a shared library it needs. The following functions are
7846: known to cause this error message over and over.</p>
7847: <div class="informaltable">
1.106 tnn 7848: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 7849: <colgroup>
7850: <col>
7851: <col>
7852: <col>
7853: </colgroup>
7854: <thead><tr>
7855: <th>Function</th>
7856: <th>Library</th>
7857: <th>Affected platforms</th>
7858: </tr></thead>
7859: <tbody>
7860: <tr>
7861: <td>accept, bind, connect</td>
7862: <td>-lsocket</td>
7863: <td>Solaris</td>
7864: </tr>
7865: <tr>
7866: <td>crypt</td>
7867: <td>-lcrypt</td>
7868: <td>DragonFly, NetBSD</td>
7869: </tr>
7870: <tr>
7871: <td>dlopen, dlsym</td>
7872: <td>-ldl</td>
7873: <td>Linux</td>
7874: </tr>
7875: <tr>
7876: <td>gethost*</td>
7877: <td>-lnsl</td>
7878: <td>Solaris</td>
7879: </tr>
7880: <tr>
7881: <td>inet_aton</td>
7882: <td>-lresolv</td>
7883: <td>Solaris</td>
7884: </tr>
7885: <tr>
7886: <td>nanosleep, sem_*, timer_*</td>
7887: <td>-lrt</td>
7888: <td>Solaris</td>
7889: </tr>
7890: <tr>
7891: <td>openpty</td>
7892: <td>-lutil</td>
7893: <td>Linux</td>
7894: </tr>
7895: </tbody>
7896: </table>
7897: </div>
7898: <p>To fix these linker errors, it is often sufficient to say
7899: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
7900: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 7901: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 7902: bmake</strong></span>.</p>
1.41 asau 7903: <div class="sect3">
1.1 dsieger 7904: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 7905: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 7906: <p>When you are using the SunPro compiler, there is another
7907: possibility. That compiler cannot handle the following code:</p>
7908: <pre class="programlisting">
7909: extern int extern_func(int);
7910:
7911: static inline int
7912: inline_func(int x)
7913: {
7914: return extern_func(x);
7915: }
7916:
7917: int main(void)
7918: {
7919: return 0;
7920: }
7921: </pre>
7922: <p>It generates the code for <code class="function">inline_func</code> even if
7923: that function is never used. This code then refers to
7924: <code class="function">extern_func</code>, which can usually not be resolved. To
7925: solve this problem you can try to tell the package to disable inlining
7926: of functions.</p>
7927: </div>
7928: </div>
1.41 asau 7929: <div class="sect2">
1.1 dsieger 7930: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7931: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 7932: <p>Sometimes packages fail to build because the compiler runs
7933: into an operating system specific soft limit. With the
7934: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 7935: to unlimit the resources. Currently, the allowed values are any combination of
7936: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
7937: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 7938: Setting this variable is similar to running the shell builtin
1.10 hubertf 7939: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 7940: segment size or maximum stack size of a process, respectively, to
7941: their hard limits.</p>
7942: </div>
7943: </div>
1.41 asau 7944: <div class="sect1">
1.1 dsieger 7945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 7946: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 7947: <div class="sect2">
1.1 dsieger 7948: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7949: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 7950: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 7951: with some operating systems cannot create more than one
7952: directory at a time. As such, you should call
7953: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
7954: <pre class="programlisting">
7955: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7956: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 7957: </pre>
1.23 wiz 7958: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
7959: dir2</code></span>”</span> to the
1.1 dsieger 7960: <code class="varname">INSTALLATION_DIRS</code> variable, which will
7961: automatically do the right thing.</p>
7962: </div>
1.41 asau 7963: <div class="sect2">
1.1 dsieger 7964: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7965: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 7966: <p>In general, documentation should be installed into
7967: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7968: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
7969: includes the version number of the package).</p>
7970: <p>Many modern packages using GNU autoconf allow to set the
7971: directory where HTML documentation is installed with the
1.23 wiz 7972: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 7973: is needed because otherwise the documentation ends up in
7974: <code class="filename">${PREFIX}/share/doc/html</code> or other
7975: places.</p>
7976: <p>An exception to the above is that library API documentation
1.120 sevan 7977: generated with the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.1 dsieger 7978: browsers (devhelp) should be left at their default location, which
7979: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
7980: documentation can be recognized from files ending in
7981: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
7982: (It is also acceptable to install such files in
7983: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
7984: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
7985: <code class="filename">.devhelp*</code> file must be directly in that
7986: directory then, no additional subdirectory level is allowed in
7987: this case. This is usually achieved by using
1.23 wiz 7988: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 7989: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
7990: though.)</p>
7991: </div>
1.41 asau 7992: <div class="sect2">
1.1 dsieger 7993: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7994: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 7995: <p>Certain packages, most of them in the games category, install
7996: a score file that allows all users on the system to record their
7997: highscores. In order for this to work, the binaries need to be
7998: installed setgid and the score files owned by the appropriate
1.35 wiz 7999: group and/or owner (traditionally the "games" user/group). Set
8000: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8001: following variables, documented in more detail in
8002: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8003: behaviour: <code class="varname">GAMEDATAMODE</code>,
8004: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8005: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8006: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8007: <code class="varname">GAMEDATA_PERMS</code> and
8008: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8009: <p>An example that illustrates some of the variables described above is
8010: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8011: used to properly set directory permissions of the directory where the
8012: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8013: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8014: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8015: binary:</p>
8016: <pre class="programlisting">
1.112 rillig 8017: USE_GAMESGROUP= yes
1.100 leot 8018:
1.112 rillig 8019: BUILD_DEFS+= VARBASE
1.100 leot 8020:
1.112 rillig 8021: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8022: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8023: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8024: </pre>
1.100 leot 8025: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8026: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8027: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8028: needed to be accessed by setgid games and
8029: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8030: <p>A package should therefore never hard code file ownership or
1.100 leot 8031: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8032: or alternatively on <code class="varname">INSTALL_GAME</code>,
8033: <code class="varname">INSTALL_GAME_DATA</code> and
8034: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8035: </div>
1.41 asau 8036: <div class="sect2">
1.1 dsieger 8037: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8038: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8039: <p><code class="varname">DESTDIR</code> support means that a package
8040: installs into a staging directory, not the final location of the
8041: files. Then a binary package is created which can be used for
8042: installation as usual. There are two ways: Either the package must
1.23 wiz 8043: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8044: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8045: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8046: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8047: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8048: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8049: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8050: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8051: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8052: the inclusion.</p></li>
1.23 wiz 8053: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8054: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8055: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8056: automatically. Many manual rules and pre/post-install often are
8057: incorrect; fix them.</p></li>
1.23 wiz 8058: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8059: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8060: <li class="listitem"><p>In general, packages should support
1.4 rillig 8061: <code class="varname">UNPRIVILEGED</code> to be able to use
8062: DESTDIR.</p></li>
8063: </ul></div>
8064: </div>
1.41 asau 8065: <div class="sect2">
1.4 rillig 8066: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8067: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8068: <p>Your package may also contain scripts with hardcoded paths to
8069: other interpreters besides (or as well as) perl. To correct the
8070: full pathname to the script interpreter, you need to set the
8071: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8072: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8073: <pre class="programlisting">
8074: REPLACE_INTERPRETER+= tcl
8075: REPLACE.tcl.old= .*/bin/tclsh
8076: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8077: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8078: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8079: </pre>
1.41 asau 8080: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8081: <h3 class="title">Note</h3>
8082: <p>Before March 2006, these variables were called
8083: <code class="varname">_REPLACE.*</code> and
8084: <code class="varname">_REPLACE_FILES.*</code>.</p>
8085: </div>
8086: </div>
1.41 asau 8087: <div class="sect2">
1.1 dsieger 8088: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8089: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8090: <p>Makefiles of packages providing perl5 modules should include
8091: the Makefile fragment
8092: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8093: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8094: configuration for such modules as well as various hooks to tune
8095: this configuration. See comments in this file for
8096: details.</p>
8097: <p>Perl5 modules will install into different places depending
8098: on the version of perl used during the build process. To
8099: address this, pkgsrc will append lines to the
8100: <code class="filename">PLIST</code> corresponding to the files listed in
8101: the installed <code class="filename">.packlist</code> file generated by
8102: most perl5 modules. This is invoked by defining
8103: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8104: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8105: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8106: e.g.:</p>
1.1 dsieger 8107: <pre class="programlisting">
1.47 wiz 8108: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8109: </pre>
1.47 wiz 8110: <p>The perl5 config variables
8111: <code class="varname">installarchlib</code>,
8112: <code class="varname">installscript</code>,
8113: <code class="varname">installvendorbin</code>,
8114: <code class="varname">installvendorscript</code>,
8115: <code class="varname">installvendorarch</code>,
8116: <code class="varname">installvendorlib</code>,
8117: <code class="varname">installvendorman1dir</code>, and
8118: <code class="varname">installvendorman3dir</code> represent those
8119: locations in which components of perl5 modules may be installed,
8120: provided as variable with uppercase and prefixed with
8121: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8122: and may be used by perl5 packages that don't have a packlist.
8123: These variables are also substituted for in the
8124: <code class="filename">PLIST</code> as uppercase prefixed with
8125: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8126: </div>
1.41 asau 8127: <div class="sect2">
1.1 dsieger 8128: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8129: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8130: <p>Some packages install info files or use the
1.23 wiz 8131: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8132: commands. <code class="varname">INFO_FILES</code> should be defined in
8133: the package Makefile so that <code class="filename">INSTALL</code> and
8134: <code class="filename">DEINSTALL</code> scripts will be generated to
8135: handle registration of the info files in the Info directory
1.23 wiz 8136: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8137: files registration is either provided by the system, or by a
8138: special purpose package automatically added as dependency if
8139: needed.</p>
8140: <p><code class="varname">PKGINFODIR</code> is the directory under
8141: <code class="filename">${PREFIX}</code> where info files are primarily
8142: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8143: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8144: <p>The info files for the package should be listed in the
8145: package <code class="filename">PLIST</code>; however any split info files
8146: need not be listed.</p>
1.23 wiz 8147: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8148: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8149: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8150: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8151: should be noted with the <code class="varname">TEXINFO_REQD</code>
8152: variable in the package <code class="filename">Makefile</code>. By
8153: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8154: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8155: does not match the required minimum, a build dependency on the
1.120 sevan 8156: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1 dsieger 8157: be added automatically.</p>
8158: <p>The build and installation process of the software provided
8159: by the package should not use the
1.10 hubertf 8160: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8161: info files is the task of the package
8162: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8163: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8164: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8165: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8166: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8167: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8168: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8169: no effect except the logging of a message. The script overriding
1.10 hubertf 8170: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8171: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8172: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8173: </div>
1.41 asau 8174: <div class="sect2">
1.1 dsieger 8175: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8176: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8177: <p>All packages that install manual pages should install them
8178: into the same directory, so that there is one common place to look
8179: for them. In pkgsrc, this place is
8180: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8181: should be used in packages. The default for
8182: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8183: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8184: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8185: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8186: <h3 class="title">Note</h3>
8187: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8188: is far from complete.</p>
8189: </div>
8190: <p>The <code class="filename">PLIST</code> files can just use
8191: <code class="filename">man/</code> as the top level directory for the man
8192: page file entries, and the pkgsrc framework will convert as
8193: needed. In all other places, the correct
8194: <code class="varname">PKGMANDIR</code> must be used.</p>
8195: <p>Packages that are
8196: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8197: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8198: <code class="filename">./configure</code>
8199: --mandir switch to set where the man pages should be installed.
8200: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8201: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8202: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8203: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8204: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8205: Or if the <code class="filename">./configure</code> script uses
8206: a non-standard use of --mandir, you can set
8207: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8208: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.1 dsieger 8209: information on installation of compressed manual pages.</p>
8210: </div>
1.41 asau 8211: <div class="sect2">
1.1 dsieger 8212: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8213: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8214: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8215: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8216: you need to take some extra steps to make sure they get registered
8217: in the database:</p>
1.23 wiz 8218: <div class="orderedlist"><ol class="orderedlist" type="1">
8219: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8220: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8221: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8222: deinstallation time, and tells the package where to install
1.7 rillig 8223: GConf data files using some standard configure arguments. It
1.1 dsieger 8224: also disallows any access to the database directly from the
8225: package.</p></li>
1.23 wiz 8226: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8227: <code class="filename">.schemas</code> files under
8228: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8229: installed under <code class="filename">${PREFIX}/etc</code>, you will
8230: need to manually patch the package.</p></li>
1.23 wiz 8231: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8232: directory, as they will be handled automatically. See
1.84 wiz 8233: <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.23 wiz 8234: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8235: your <code class="filename">Makefile</code> with a list of all
8236: <code class="filename">.schemas</code> files installed by the package, if
8237: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8238: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8239: your <code class="filename">Makefile</code> with a
8240: list of all <code class="filename">.entries</code> files installed by the
8241: package, if any. Names must not contain any directories in
8242: them.</p></li>
8243: </ol></div>
8244: </div>
1.41 asau 8245: <div class="sect2">
1.1 dsieger 8246: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8247: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8248: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8249: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8250: get registered in the database:</p>
1.23 wiz 8251: <div class="orderedlist"><ol class="orderedlist" type="1">
8252: <li class="listitem"><p>Include
1.18 snj 8253: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8254: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8255: takes care of rebuilding the scrollkeeper database at
8256: installation and deinstallation time, and disallows any access
8257: to it directly from the package.</p></li>
1.23 wiz 8258: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8259: <code class="filename">libdata/scrollkeeper</code> directory, as they
8260: will be handled automatically.</p></li>
1.23 wiz 8261: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8262: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8263: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8264: </ol></div>
8265: </div>
1.41 asau 8266: <div class="sect2">
1.1 dsieger 8267: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8268: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8269: <p>If a package installs font files, you will need to rebuild
8270: the fonts database in the directory where they get installed at
8271: installation and deinstallation time. This can be automatically
8272: done by using the pkginstall framework.</p>
8273: <p>You can list the directories where fonts are installed in the
8274: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8275: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8276: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.1 dsieger 8277: Also make sure that the database file
8278: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8279: <p>Note that you should not create new directories for fonts;
8280: instead use the standard ones to avoid that the user needs to
8281: manually configure his X server to find them.</p>
8282: </div>
1.41 asau 8283: <div class="sect2">
1.1 dsieger 8284: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8285: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8286: <p>If a package installs GTK2 immodules or loaders, you need to
8287: take some extra steps to get them registered in the GTK2 database
8288: properly:</p>
1.23 wiz 8289: <div class="orderedlist"><ol class="orderedlist" type="1">
8290: <li class="listitem"><p>Include
1.1 dsieger 8291: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8292: <code class="filename">buildlink3.mk</code> file. This takes care of
8293: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8294: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8295: your package installs GTK2 immodules.</p></li>
1.23 wiz 8296: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8297: GTK2 loaders.</p></li>
1.23 wiz 8298: <li class="listitem">
1.1 dsieger 8299: <p>Patch the package to not touch any of the GTK2
8300: databases directly. These are:</p>
1.41 asau 8301: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8302: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8303: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8304: </ul></div>
8305: </li>
1.23 wiz 8306: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8307: any entries under the <code class="filename">libdata/gtk-2.0</code>
8308: directory, as they will be handled automatically.</p></li>
8309: </ol></div>
8310: </div>
1.41 asau 8311: <div class="sect2">
1.1 dsieger 8312: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8313: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8314: <p>If a package installs SGML or XML data files that need to be
8315: registered in system-wide catalogs (like DTDs, sub-catalogs,
8316: etc.), you need to take some extra steps:</p>
1.23 wiz 8317: <div class="orderedlist"><ol class="orderedlist" type="1">
8318: <li class="listitem"><p>Include
1.1 dsieger 8319: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8320: your <code class="filename">Makefile</code>, which takes care of
8321: registering those files in system-wide catalogs at
8322: installation and deinstallation time.</p></li>
1.23 wiz 8323: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8324: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8325: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8326: any XML catalogs installed by the package.</p></li>
1.23 wiz 8327: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8328: to be added to the SGML catalog. These come in groups of
8329: three strings; see xmlcatmgr(1) for more information
8330: (specifically, arguments recognized by the 'add' action).
8331: Note that you will normally not use this variable.</p></li>
1.23 wiz 8332: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8333: to be added to the XML catalog. These come in groups of three
8334: strings; see xmlcatmgr(1) for more information (specifically,
8335: arguments recognized by the 'add' action). Note that you will
8336: normally not use this variable.</p></li>
8337: </ol></div>
8338: </div>
1.41 asau 8339: <div class="sect2">
1.1 dsieger 8340: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8341: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8342: <p>If a package provides extensions to the MIME database by
8343: installing <code class="filename">.xml</code> files inside
8344: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8345: need to take some extra steps to ensure that the database is kept
8346: consistent with respect to these new files:</p>
1.23 wiz 8347: <div class="orderedlist"><ol class="orderedlist" type="1">
8348: <li class="listitem"><p>Include
1.1 dsieger 8349: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8350: (avoid using the <code class="filename">buildlink3.mk</code> file from
8351: this same directory, which is reserved for inclusion from
8352: other <code class="filename">buildlink3.mk</code> files). It takes
8353: care of rebuilding the MIME database at installation and
8354: deinstallation time, and disallows any access to it directly
8355: from the package.</p></li>
1.23 wiz 8356: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8357: <code class="filename">share/mime</code> directory,
8358: <span class="emphasis"><em>except</em></span> for files saved under
8359: <code class="filename">share/mime/packages</code>. The former are
8360: handled automatically by
8361: the update-mime-database program, but the latter are
8362: package-dependent and must be removed by the package that
8363: installed them in the first place.</p></li>
1.23 wiz 8364: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8365: from the PLIST. They will be handled by the shared-mime-info
8366: package.</p></li>
8367: </ol></div>
8368: </div>
1.41 asau 8369: <div class="sect2">
1.1 dsieger 8370: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8371: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8372: <p>If a package uses intltool during its build, add
8373: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8374: which forces it to use the intltool package provided by pkgsrc,
8375: instead of the one bundled with the distribution file.</p>
8376: <p>This tracks intltool's build-time dependencies and uses the
8377: latest available version; this way, the package benefits of any
8378: bug fixes that may have appeared since it was released.</p>
8379: </div>
1.41 asau 8380: <div class="sect2">
1.1 dsieger 8381: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8382: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8383: <p>If a package contains a rc.d script, it won't be copied into
8384: the startup directory by default, but you can enable it, by adding
8385: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8386: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8387: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8388: it will automatically remove the scripts when the package is
8389: deinstalled.</p>
8390: </div>
1.41 asau 8391: <div class="sect2">
1.1 dsieger 8392: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8393: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8394: <p>If a package installs TeX packages into the texmf tree,
8395: the <code class="filename">ls-R</code> database of the tree needs to be
8396: updated.</p>
1.41 asau 8397: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8398: <h3 class="title">Note</h3>
1.22 jakllsch 8399: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8400: packages should install files
1.22 jakllsch 8401: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8402: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8403: </div>
1.23 wiz 8404: <div class="orderedlist"><ol class="orderedlist" type="1">
8405: <li class="listitem"><p>Include
1.22 jakllsch 8406: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8407: takes care of rebuilding the <code class="filename">ls-R</code>
8408: database at installation and deinstallation time.</p></li>
1.23 wiz 8409: <li class="listitem">
1.1 dsieger 8410: <p>If your package installs files into a texmf
8411: tree other than the one
1.22 jakllsch 8412: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8413: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8414: trees that need database update.</p>
8415: <p>If your package also installs font map files that need
1.10 hubertf 8416: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8417: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8418: set <code class="varname">TEX_MAP_FILES</code> and/or
8419: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8420: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8421: be run automatically at installation/deinstallation to
8422: enable/disable font map files for TeX output
8423: drivers.</p>
8424: </li>
1.23 wiz 8425: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8426: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8427: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8428: </ol></div>
8429: </div>
1.41 asau 8430: <div class="sect2">
1.1 dsieger 8431: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8432: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 8433: emulation</h3></div></div></div>
8434: <p>There are some packages that provide libraries and
8435: executables for running binaries from a one operating system
8436: on a different one (if the latter supports it). One example
8437: is running Linux binaries on NetBSD.</p>
1.120 sevan 8438: <p>The <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1 dsieger 8439: helps in extracting and packaging Linux rpm packages.</p>
8440: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8441: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8442: if all libraries for each installed executable can be found by
8443: the dynamic linker. Since the standard dynamic linker is run,
8444: this fails for emulation packages, because the libraries used
8445: by the emulation are not in the standard directories.</p>
8446: </div>
1.41 asau 8447: <div class="sect2">
1.1 dsieger 8448: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8449: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8450: <p>If a package installs images under the
8451: <code class="filename">share/icons/hicolor</code> and/or updates the
8452: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8453: database, you need to take some extra steps to make sure that the
8454: shared theme directory is handled appropriately and that the cache
8455: database is rebuilt:</p>
1.23 wiz 8456: <div class="orderedlist"><ol class="orderedlist" type="1">
8457: <li class="listitem"><p>Include
1.1 dsieger 8458: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8459: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8460: entry that refers to the theme cache.</p></li>
1.23 wiz 8461: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8462: directories from the <code class="filename">share/icons/hicolor</code>
8463: hierarchy because they will be handled automatically.</p></li>
8464: </ol></div>
8465: <p>The best way to verify that the PLIST is correct with
8466: respect to the last two points is to regenerate it using
1.10 hubertf 8467: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8468: </div>
1.41 asau 8469: <div class="sect2">
1.1 dsieger 8470: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8471: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8472: <p>If a package installs <code class="filename">.desktop</code> files
8473: under <code class="filename">share/applications</code> and these include
1.53 rodent 8474: MIME information (MimeType key), you need to take extra steps to
8475: ensure that they are registered into the MIME database:</p>
1.23 wiz 8476: <div class="orderedlist"><ol class="orderedlist" type="1">
8477: <li class="listitem"><p>Include
1.1 dsieger 8478: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8479: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8480: <code class="filename">share/applications/mimeinfo.cache</code> file.
8481: It will be handled automatically.</p></li>
8482: </ol></div>
8483: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8484: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8485: print-PLIST</strong></span>.</p>
8486: </div>
8487: </div>
1.41 asau 8488: <div class="sect1">
1.1 dsieger 8489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8490: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8491: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8492: immediately. In this case, one can plainly mark a package as broken. For
8493: this, one just sets the variable <code class="varname">BROKEN</code> to the
8494: reason why the package is broken (similar to the
8495: <code class="varname">RESTRICTED</code> variable). A user trying to build
8496: the package will immediately be shown this message, and the build
8497: will not be even tried.</p>
8498: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8499: intervals.</p>
8500: </div>
8501: </div>
1.41 asau 8502: <div class="chapter">
1.1 dsieger 8503: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8504: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 8505: <p>To check out all the gotchas when building a package, here are
8506: the steps that I do in order to get a package working. Please note
8507: this is basically the same as what was explained in the previous
8508: sections, only with some debugging aids.</p>
1.41 asau 8509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8510: <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>
8511: <li class="listitem">
1.120 sevan 8512: <p>Install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.1 dsieger 8513: create a directory for a new package, change into it, then run
1.10 hubertf 8514: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8515: <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>
8516: <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>
8517: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8518: </li>
1.23 wiz 8519: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8520: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8521: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8522: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8523: configure step to the package's
8524: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8525: <li class="listitem">
1.1 dsieger 8526: <p>Make the package compile, doing multiple rounds of</p>
8527: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8528: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8529: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8530: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8531: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8532: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8533: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8534: <p>Doing this step as non-root user will ensure that no files
8535: are modified that shouldn't be, especially during the build
1.10 hubertf 8536: phase. <span class="command"><strong>mkpatches</strong></span>,
8537: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.120 sevan 8538: from the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.1 dsieger 8539: package.</p>
8540: </li>
1.23 wiz 8541: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
8542: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
8543: <li class="listitem">
1.1 dsieger 8544: <p>Generate a <code class="filename">PLIST</code>:</p>
8545: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8546: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8547: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8548: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8549: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8550: <p>You usually need to be <code class="username">root</code> to do
8551: this. Look if there are any files left:</p>
8552: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8553: <p>If this reveals any files that are missing in
8554: <code class="filename">PLIST</code>, add them.</p>
8555: </li>
1.23 wiz 8556: <li class="listitem">
1.1 dsieger 8557: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8558: package again and make a binary package:</p>
8559: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8560: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8561: </li>
1.23 wiz 8562: <li class="listitem">
1.1 dsieger 8563: <p>Delete the installed package:</p>
8564: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8565: </li>
1.23 wiz 8566: <li class="listitem">
1.10 hubertf 8567: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8568: command, which shouldn't find anything now:</p>
8569: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8570: </li>
1.23 wiz 8571: <li class="listitem">
1.1 dsieger 8572: <p>Reinstall the binary package:</p>
8573: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8574: </li>
1.23 wiz 8575: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8576: <li class="listitem">
1.120 sevan 8577: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.1 dsieger 8578: reports:</p>
8579: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8580: </li>
1.23 wiz 8581: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.1 dsieger 8582: </ul></div>
8583: </div>
1.41 asau 8584: <div class="chapter">
1.1 dsieger 8585: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8586: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8587: <div class="toc">
8588: <p><b>Table of Contents</b></p>
1.100 leot 8589: <dl class="toc">
1.6 rillig 8590: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
8591: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8592: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 8593: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 8594: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 8595: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
8596: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8597: </dl>
8598: </div>
1.41 asau 8599: <div class="sect1">
1.1 dsieger 8600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8601: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8602: <p>Our policy is that we accept binaries only from pkgsrc
8603: developers to guarantee that the packages don't contain any
8604: trojan horses etc. This is not to annoy anyone but rather to
8605: protect our users! You're still free to put up your home-made
8606: binary packages and tell the world where to get them. NetBSD
8607: developers doing bulk builds and wanting to upload them please
1.66 asau 8608: 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
8609: builds)</i></a>.</p>
1.1 dsieger 8610: </div>
1.41 asau 8611: <div class="sect1">
1.1 dsieger 8612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8613: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8614: <p>First, check that your package is complete, compiles and
1.10 hubertf 8615: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.125 leot 8616: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 8617: archive that contains all files that make up the package.
8618: Finally, send this package to the pkgsrc bug tracking system,
1.125 leot 8619: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 8620: that, go to the web page
1.10 hubertf 8621: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 8622: which contains some instructions and a link to a form where you
8623: can submit packages. The
1.120 sevan 8624: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.21 snj 8625: also available as a substitute for either of the above two tools.
8626: </p>
1.1 dsieger 8627: <p>In the form of the problem report, the category should be
1.23 wiz 8628: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8629: and version number, and the description field should contain a
8630: short description of your package (contents of the COMMENT
8631: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8632: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8633: <p>If you want to submit several packages, please send a
8634: separate PR for each one, it's easier for us to track things
8635: that way.</p>
8636: <p>Alternatively, you can also import new packages into
1.23 wiz 8637: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8638: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8639: for details.</p>
8640: </div>
1.41 asau 8641: <div class="sect1">
1.1 dsieger 8642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8643: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8644: <p>Please note all package additions, updates, moves, and
8645: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8646: important to keep this file up to date and conforming to the
8647: existing format, because it will be used by scripts to
1.10 hubertf 8648: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8649: sites. Additionally, check the
8650: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
8651: for the package you updated or removed, in case it was mentioned
8652: there.</p>
8653: <p>When the <code class="varname">PKGREVISION</code> of a package is
8654: bumped, the change should appear in
8655: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
8656: related or otherwise relevant. Mass bumps that result from a
8657: dependency being updated should not be mentioned. In all other
8658: cases it's the developer's decision.</p>
8659: <p>There is a make target that helps in creating proper
1.10 hubertf 8660: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 8661: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8662: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
8663: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
8664: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 8665: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8666: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 8667: For new packages, or package moves or removals, set the
8668: <code class="varname">CTYPE</code> variable on the command line to "Added",
8669: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 8670: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 8671: not the same as your NetBSD login name. The target also automatically
8672: removes possibly existing entries for the package in the
8673: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 8674: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 8675: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
8676: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8677: makes the cvs commands use the main repository.
8678: </p>
1.1 dsieger 8679: </div>
1.41 asau 8680: <div class="sect1">
1.1 dsieger 8681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 8682: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 8683: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 8684: access to the pkgsrc repository.</p>
8685: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8686: Start by adding the directory and then files in the directory. Don't
8687: forget to add the new package to the category's
8688: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8689: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8690: <pre class="programlisting">
8691: <code class="prompt">$</code> cd .../pkgsrc/category
8692: <code class="prompt">$</code> cvs add pkgname
8693: <code class="prompt">$</code> cd pkgname
8694: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8695: <code class="prompt">$</code> cvs add patches/p*
8696: <code class="prompt">$</code> cvs status | less
1.34 wiz 8697: <code class="prompt">$</code> cvs commit
1.33 wiz 8698: <code class="prompt">$</code> cd ..
8699: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 8700: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 8701: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 8702: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 8703: </pre>
1.1 dsieger 8704: <p>The commit message of the initial import should include part of the
8705: <code class="filename">DESCR</code> file, so people reading the mailing lists know
8706: what the package is/does.</p>
1.33 wiz 8707: <p>Also mention the new package in
8708: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8709: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8710: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 8711: </div>
1.41 asau 8712: <div class="sect1">
1.1 dsieger 8713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8714: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 8715: <p>Please always put a concise, appropriate and relevant summary of the
8716: changes between old and new versions into the commit log when updating
8717: a package. There are various reasons for this:</p>
1.41 asau 8718: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8719: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 8720: or its information may be overwritten by newer information.</p></li>
1.23 wiz 8721: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8722: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 8723: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8724: repository is very useful for people who read the pkgsrc-changes mailing
8725: list, so that they can make tactical decisions about when to upgrade
8726: the package.</p></li>
8727: </ul></div>
8728: <p>Please also recognize that, just because a new version of a package
8729: has been released, it should not automatically be upgraded in the CVS
8730: repository. We prefer to be conservative in the packages that are
8731: included in pkgsrc - development or beta packages are not really the
8732: best thing for most places in which pkgsrc is used. Please use your
8733: judgement about what should go into pkgsrc, and bear in mind that
8734: stability is to be preferred above new and possibly untested features.</p>
8735: </div>
1.41 asau 8736: <div class="sect1">
1.1 dsieger 8737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 8738: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
8739: <p>Renaming packages is not recommended.</p>
8740: <p>When renaming packages, be sure to fix any references to old name
8741: in other Makefiles, options, buildlink files, etc.</p>
8742: <p>Also When renaming a package, please define
8743: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8744: pattern(s) of the previous package name.
8745: This may be repeated for multiple renames.
8746: The new package would be an exact replacement.
8747: </p>
1.23 wiz 8748: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 8749: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8750: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8751: not be an exact replacement but is a suggestion for the replaced
8752: functionality.</p>
8753: </div>
1.41 asau 8754: <div class="sect1">
1.20 snj 8755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8756: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
8757: <p>It is preferred that packages are not renamed or moved, but if needed
8758: please follow these steps.
8759: </p>
1.23 wiz 8760: <div class="orderedlist"><ol class="orderedlist" type="1">
8761: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8762: <li class="listitem">
1.1 dsieger 8763: <p>Remove all CVS dirs.</p>
8764: <p>Alternatively to the first two steps you can also do:</p>
8765: <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>
8766: <p>and use that for further work.</p>
8767: </li>
1.23 wiz 8768: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8769: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8770: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8771: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 8772: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8773: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8774: for doing an update using pkgsrc building; for example, it can
1.125 leot 8775: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 8776: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8777: new <code class="varname">PKGPATH</code> for that moved package. Note that
8778: it may have multiple matches, so the tool should also check on the
8779: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8780: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8781: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 8782: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 8783: place.</p></li>
1.23 wiz 8784: <li class="listitem">
1.1 dsieger 8785: <p>Check if any package depends on it:
8786: </p>
8787: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8788: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8789: </li>
1.23 wiz 8790: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8791: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8792: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8793: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8794: <li class="listitem">
1.1 dsieger 8795: <p>Commit the changed and removed files:</p>
8796: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
8797: <p>(and any packages from step 5, of course).</p>
8798: </li>
8799: </ol></div>
8800: </div>
8801: </div>
1.41 asau 8802: <div class="chapter">
1.1 dsieger 8803: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 8804: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 8805: <p>This section contains the answers to questions that may
8806: arise when you are writing a package. If you don't find your
8807: question answered here, first have a look in the other chapters,
8808: and if you still don't have the answer, ask on the
8809: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 8810: <div class="qandaset">
1.128 ! jnemeth 8811: <a name="idm79317168"></a><dl>
1.6 rillig 8812: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 8813: MAKEFLAGS, .MAKEFLAGS and
8814: MAKE_FLAGS?</a>
8815: </dt>
1.6 rillig 8816: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 8817: MAKE, GMAKE and
8818: MAKE_PROGRAM?</a>
8819: </dt>
1.6 rillig 8820: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 8821: CC, PKG_CC and
8822: PKGSRC_COMPILER?</a>
8823: </dt>
1.6 rillig 8824: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 8825: BUILDLINK_LDFLAGS,
8826: BUILDLINK_LDADD and
8827: BUILDLINK_LIBS?</a>
8828: </dt>
1.6 rillig 8829: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 8830: VARNAME=BUILDLINK_PREFIX.foo
8831: say it's empty?</a>
8832: </dt>
1.6 rillig 8833: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 8834: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
8835: don't understand the := inside
8836: it.</a>
8837: </dt>
1.6 rillig 8838: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 8839: developers?</a>
8840: </dt>
1.6 rillig 8841: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 8842: documentation?</a>
8843: </dt>
1.6 rillig 8844: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 8845: do?</a>
8846: </dt>
8847: </dl>
1.41 asau 8848: <table border="0" style="width: 100%;">
8849: <colgroup>
1.1 dsieger 8850: <col align="left" width="1%">
1.23 wiz 8851: <col>
1.41 asau 8852: </colgroup>
1.1 dsieger 8853: <tbody>
1.41 asau 8854: <tr class="question">
1.1 dsieger 8855: <td align="left" valign="top">
1.128 ! jnemeth 8856: <a name="devfaq.makeflags"></a><a name="idm79316784"></a><p><b>22.1.</b></p>
1.1 dsieger 8857: </td>
8858: <td align="left" valign="top"><p>What is the difference between
8859: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
8860: <code class="varname">MAKE_FLAGS</code>?</p></td>
8861: </tr>
8862: <tr class="answer">
8863: <td align="left" valign="top"></td>
8864: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.125 leot 8865: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 8866: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
8867: the <code class="varname">MAKE_PROGRAM</code> when building the
8868: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
8869: </tr>
1.41 asau 8870: <tr class="question">
1.1 dsieger 8871: <td align="left" valign="top">
1.128 ! jnemeth 8872: <a name="devfaq.make"></a><a name="idm79312688"></a><p><b>22.2.</b></p>
1.1 dsieger 8873: </td>
8874: <td align="left" valign="top"><p>What is the difference between
8875: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
8876: <code class="varname">MAKE_PROGRAM</code>?</p></td>
8877: </tr>
8878: <tr class="answer">
8879: <td align="left" valign="top"></td>
8880: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.125 leot 8881: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 8882: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
8883: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
8884: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
8885: Make program that is used for building the
8886: package.</p></td>
8887: </tr>
1.41 asau 8888: <tr class="question">
1.1 dsieger 8889: <td align="left" valign="top">
1.128 ! jnemeth 8890: <a name="devfaq.cc"></a><a name="idm79308336"></a><p><b>22.3.</b></p>
1.1 dsieger 8891: </td>
8892: <td align="left" valign="top"><p>What is the difference between
8893: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
8894: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
8895: </tr>
8896: <tr class="answer">
8897: <td align="left" valign="top"></td>
8898: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
8899: compiler, which can be configured by the pkgsrc user.
8900: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
8901: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
8902: path to a compiler, but the type of compiler that should be
8903: used. See <code class="filename">mk/compiler.mk</code> for more
8904: information about the latter variable.</p></td>
8905: </tr>
1.41 asau 8906: <tr class="question">
1.1 dsieger 8907: <td align="left" valign="top">
1.128 ! jnemeth 8908: <a name="devfaq.bl3flags"></a><a name="idm79304112"></a><p><b>22.4.</b></p>
1.1 dsieger 8909: </td>
8910: <td align="left" valign="top"><p>What is the difference between
8911: <code class="varname">BUILDLINK_LDFLAGS</code>,
8912: <code class="varname">BUILDLINK_LDADD</code> and
8913: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
8914: </tr>
8915: <tr class="answer">
8916: <td align="left" valign="top"></td>
8917: <td align="left" valign="top"><p>[FIXME]</p></td>
8918: </tr>
1.41 asau 8919: <tr class="question">
1.1 dsieger 8920: <td align="left" valign="top">
1.128 ! jnemeth 8921: <a name="devfaq.bl3prefix"></a><a name="idm79301936"></a><p><b>22.5.</b></p>
1.1 dsieger 8922: </td>
1.10 hubertf 8923: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 8924: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
8925: say it's empty?</p></td>
8926: </tr>
8927: <tr class="answer">
8928: <td align="left" valign="top"></td>
8929: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 8930: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
8931: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 8932: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 8933: command.</p></td>
8934: </tr>
1.41 asau 8935: <tr class="question">
1.1 dsieger 8936: <td align="left" valign="top">
1.128 ! jnemeth 8937: <a name="devfaq.master_sites"></a><a name="idm79290544"></a><p><b>22.6.</b></p>
1.1 dsieger 8938: </td>
8939: <td align="left" valign="top"><p>What does
1.108 rillig 8940: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
8941: don't understand the <code class="code">:=</code> inside
1.1 dsieger 8942: it.</p></td>
8943: </tr>
8944: <tr class="answer">
8945: <td align="left" valign="top"></td>
1.108 rillig 8946: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
8947: assignment operator, although it looks like it.
1.1 dsieger 8948: Instead, it is a degenerate form of
1.108 rillig 8949: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.125 leot 8950: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 8951: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 8952: case of <code class="varname">MASTER_SITE_*</code>,
8953: <em class="replaceable"><code>old_string</code></em> is the empty string and
8954: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 8955: <code class="code">package/</code>. That's where the
8956: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 8957: together.</p></td>
8958: </tr>
1.41 asau 8959: <tr class="question">
1.1 dsieger 8960: <td align="left" valign="top">
1.128 ! jnemeth 8961: <a name="devfaq.mailinglists"></a><a name="idm79283760"></a><p><b>22.7.</b></p>
1.1 dsieger 8962: </td>
8963: <td align="left" valign="top"><p>Which mailing lists are there for package
8964: developers?</p></td>
8965: </tr>
8966: <tr class="answer">
8967: <td align="left" valign="top"></td>
1.41 asau 8968: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 8969: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 8970: <dd><p>This is a list for technical discussions related
8971: to pkgsrc development, e.g. soliciting feedback for changes to
8972: pkgsrc infrastructure, proposed new features, questions related
8973: to porting pkgsrc to a new platform, advice for maintaining a
8974: package, patches that affect many packages, help requests moved
8975: from pkgsrc-users when an infrastructure bug is found,
8976: etc.</p></dd>
1.10 hubertf 8977: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 8978: <dd><p>All bug reports in category "pkg" sent with
1.125 leot 8979: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 8980: directly; use one of the other mailing
8981: lists.</p></dd>
8982: </dl></div></td>
8983: </tr>
1.41 asau 8984: <tr class="question">
1.1 dsieger 8985: <td align="left" valign="top">
1.128 ! jnemeth 8986: <a name="devfaq.documentation"></a><a name="idm79279920"></a><p><b>22.8.</b></p>
1.1 dsieger 8987: </td>
8988: <td align="left" valign="top"><p>Where is the pkgsrc
8989: documentation?</p></td>
8990: </tr>
8991: <tr class="answer">
8992: <td align="left" valign="top"></td>
8993: <td align="left" valign="top">
8994: <p>There are many places where you can find
8995: documentation about pkgsrc:</p>
1.41 asau 8996: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8997: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 8998: of chapters that explain large parts of pkgsrc, but some
8999: chapters tend to be outdated. Which ones they are is hard to
9000: say.</p></li>
1.23 wiz 9001: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 9002: about certain features, announcements of new parts of the pkgsrc
9003: infrastructure and sometimes even announcements that a certain
9004: feature has been marked as obsolete. The benefit here is that
9005: each message has a date appended to it.</p></li>
1.23 wiz 9006: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9007: <code class="filename">mk/</code> directory start with a comment that
9008: describes the purpose of the file and how it can be used by the
9009: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9010: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9011: help</strong></span>.</p></li>
1.23 wiz 9012: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9013: information, but they tend to be highly abbreviated, especially
9014: for actions that occur often. Some contain a detailed
9015: description of what has changed, but they are geared towards the
9016: other pkgsrc developers, not towards an average pkgsrc user.
9017: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9018: don't know what has been before, these messages may not be worth
9019: too much to you.</p></li>
1.23 wiz 9020: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9021: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9022: mind of the developer who wrote the code. To get this
1.10 hubertf 9023: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9024: to see who has written it and ask on the
9025: <code class="literal">tech-pkg</code> mailing list, so that others can
9026: find your questions later (see above). To be sure that the
9027: developer in charge reads the mail, you may CC him or
9028: her.</p></li>
9029: </ul></div>
9030: </td>
9031: </tr>
1.41 asau 9032: <tr class="question">
1.1 dsieger 9033: <td align="left" valign="top">
1.128 ! jnemeth 9034: <a name="devfaq.too-much-time"></a><a name="idm79273392"></a><p><b>22.9.</b></p>
1.1 dsieger 9035: </td>
9036: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9037: do?</p></td>
9038: </tr>
9039: <tr class="answer">
9040: <td align="left" valign="top"></td>
9041: <td align="left" valign="top">
9042: <p>This is not really an FAQ yet, but here's the answer
9043: anyway.</p>
1.41 asau 9044: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9045: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.120 sevan 9046: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.1 dsieger 9047: will tell you about newer versions of installed packages that are
9048: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9049: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9050: — it contains a list of suggested new packages and a list of
1.1 dsieger 9051: cleanups and enhancements for pkgsrc that would be nice to
9052: have.</p></li>
1.23 wiz 9053: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9054: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9055: mailing list.</p></li>
9056: </ul></div>
9057: </td>
9058: </tr>
9059: </tbody>
9060: </table>
9061: </div>
9062: </div>
1.41 asau 9063: <div class="chapter">
1.1 dsieger 9064: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9065: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9066: <div class="toc">
9067: <p><b>Table of Contents</b></p>
1.100 leot 9068: <dl class="toc">
1.6 rillig 9069: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9070: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9071: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9072: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9073: </dl>
9074: </div>
1.10 hubertf 9075: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9076: site</a>:</p>
9077: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9078: environment, an intuitive and attractive desktop for users, and the
9079: GNOME development platform, an extensive framework for building
9080: applications that integrate into the rest of the desktop.</p></blockquote></div>
9081: <p>pkgsrc provides a seamless way to automatically build and install
9082: a complete GNOME environment <span class="emphasis"><em>under many different
9083: platforms</em></span>. We can say with confidence that pkgsrc is one of
9084: the most advanced build and packaging systems for GNOME due to its
9085: included technologies buildlink3, the wrappers and tools framework and
9086: automatic configuration file management. Lots of efforts are put into
9087: achieving a completely clean deinstallation of installed software
9088: components.</p>
1.10 hubertf 9089: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9090: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9091: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9092: pkgsrc as its preferred packaging system, contributing lots of
9093: portability fixes to make GNOME build and install under it.</p>
9094: <p>This chapter is aimed at pkgsrc developers and other people
9095: interested in helping our GNOME porting and packaging efforts. It
9096: provides instructions on how to manage the existing packages and some
9097: important information regarding their internals.</p>
1.41 asau 9098: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9099: <h3 class="title">We need your help!</h3>
9100: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9101: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9102: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9103: work</a> list! There is still a long way to go to get a
9104: fully-functional GNOME desktop under NetBSD and we need your help to
9105: achieve it!</p>
9106: </div>
1.41 asau 9107: <div class="sect1">
1.1 dsieger 9108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9109: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9110: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9111: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120 sevan 9112: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.1 dsieger 9113: the core GNOME desktop environment. It only includes the necessary
9114: bits to get it to boot correctly, although it may lack important
9115: functionality for daily operation. The idea behind this package is
9116: to let end users build their own configurations on top of this one,
9117: first installing this meta package to achieve a functional setup and
9118: then adding individual applications.</p></li>
1.120 sevan 9119: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.1 dsieger 9120: complete installation of the GNOME platform and desktop as defined
9121: by the GNOME project; this is based on the components distributed in
9122: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9123: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9124: official FTP server. Developer-only tools found in those
9125: directories are not installed unless required by some other
9126: component to work properly. Similarly, packages from the bindings
9127: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9128: in unless required as a dependency for an end-user component. This
1.120 sevan 9129: package "extends" <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
9130: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.1 dsieger 9131: Installs all the tools required to build a GNOME component when
9132: fetched from the CVS repository. These are required to let the
1.10 hubertf 9133: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9134: </ul></div>
9135: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9136: sorted in a way that eases updates: a package may depend on other
9137: packages listed before it but not on any listed after it. It is very
9138: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9139: change it to alphabetical sorting!</em></span></p>
9140: </div>
1.41 asau 9141: <div class="sect1">
1.1 dsieger 9142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9143: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9144: <p>Almost all GNOME applications are written in C and use a common
9145: set of tools as their build system. Things get different with the new
9146: bindings to other languages (such as Python), but the following will
9147: give you a general idea on the minimum required tools:</p>
1.41 asau 9148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9149: <li class="listitem">
1.1 dsieger 9150: <p>Almost all GNOME applications use the GNU Autotools as their
9151: build system. As a general rule you will need to tell this to your
9152: package:</p>
9153: <pre class="programlisting">
9154: GNU_CONFIGURE=yes
9155: USE_LIBTOOL=yes
9156: USE_TOOLS+=gmake
9157: </pre>
9158: </li>
1.23 wiz 9159: <li class="listitem">
1.1 dsieger 9160: <p>If the package uses pkg-config to detect dependencies, add this
9161: tool to the list of required utilities:</p>
1.111 sevan 9162: <pre class="programlisting">
9163: USE_TOOLS+=pkg-config
9164: </pre>
1.120 sevan 9165: <p>Also use <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.1 dsieger 9166: the end of the build process to ensure that you did not miss to
9167: specify any dependency in your package and that the version
9168: requirements are all correct.</p>
9169: </li>
1.23 wiz 9170: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9171: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9172: to handle dependencies and to force the package to use the latest
9173: available version.</p></li>
1.23 wiz 9174: <li class="listitem">
1.1 dsieger 9175: <p>If the package uses gtk-doc (a documentation generation
9176: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9177: tool is rather big and the distfile should come with pregenerated
9178: documentation anyway; if it does not, it is a bug that you ought to
9179: report. For such packages you should disable gtk-doc (unless it is
9180: the default):</p>
1.111 sevan 9181: <pre class="programlisting">
9182: CONFIGURE_ARGS+=--disable-gtk-doc
9183: </pre>
1.1 dsieger 9184: <p>The default location of installed HTML files
9185: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9186: and should not be changed unless the package insists on installing
9187: them somewhere else. Otherwise programs as
1.10 hubertf 9188: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9189: do that with an entry similar to:</p>
1.111 sevan 9190: <pre class="programlisting">
9191: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9192: </pre>
1.1 dsieger 9193: </li>
9194: </ul></div>
9195: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9196: files under the installation prefix to maintain databases. In this
9197: context, shared means that those exact same directories and files are
9198: used among several different packages, leading to conflicts in the
9199: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9200: handle the most common cases, so you have to forget about using
9201: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9202: omitting shared files from them. If you find yourself doing those,
9203: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9204: <p>The following table lists the common situations that result in
9205: using shared directories or files. For each of them, the appropriate
9206: solution is given. After applying the solution be sure to
9207: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9208: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9209: <div class="table">
1.6 rillig 9210: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9211: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9212: <colgroup>
9213: <col>
9214: <col>
9215: </colgroup>
9216: <thead><tr>
9217: <th>If the package...</th>
9218: <th>Then...</th>
9219: </tr></thead>
9220: <tbody>
9221: <tr>
9222: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9223: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.1 dsieger 9224: </tr>
9225: <tr>
9226: <td>Installs icons under the
9227: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9228: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9229: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.1 dsieger 9230: </tr>
9231: <tr>
9232: <td>Installs files under
9233: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9234: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.1 dsieger 9235: </tr>
9236: <tr>
9237: <td>Installs <code class="filename">.desktop</code> files under
9238: <code class="filename">share/applications</code> and these include MIME
9239: information.</td>
1.10 hubertf 9240: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.1 dsieger 9241: </tr>
9242: </tbody>
9243: </table></div>
9244: </div>
9245: <br class="table-break">
9246: </div>
1.41 asau 9247: <div class="sect1">
1.1 dsieger 9248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9249: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9250: <p>When seeing GNOME as a whole, there are two kinds of
9251: updates:</p>
1.41 asau 9252: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9253: <dt><span class="term">Major update</span></dt>
9254: <dd>
9255: <p>Given that there is still a very long way for GNOME 3 (if it
9256: ever appears), we consider a major update one that goes from a
9257: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9258: where <code class="literal">Y</code> is even and greater than
9259: <code class="literal">X</code>. These are hard to achieve because they
9260: introduce lots of changes in the components' code and almost all
9261: GNOME distfiles are updated to newer versions. Some of them can
9262: even break API and ABI compatibility with the previous major
9263: version series. As a result, the update needs to be done all at
9264: once to minimize breakage.</p>
9265: <p>A major update typically consists of around 80 package
9266: updates and the addition of some new ones.</p>
9267: </dd>
9268: <dt><span class="term">Minor update</span></dt>
9269: <dd>
9270: <p>We consider a minor update one that goes from a
9271: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9272: one where <code class="literal">Y</code> is greater than
9273: <code class="literal">X</code>. These are easy to achieve because they do
9274: not update all GNOME components, can be done in an incremental way
9275: and do not break API nor ABI compatibility.</p>
9276: <p>A minor update typically consists of around 50 package
9277: updates, although the numbers here may vary a lot.</p>
9278: </dd>
9279: </dl></div>
9280: <p>In order to update the GNOME components in pkgsrc to a new stable
9281: release (either major or minor), the following steps should be
9282: followed:</p>
1.23 wiz 9283: <div class="orderedlist"><ol class="orderedlist" type="1">
9284: <li class="listitem">
1.1 dsieger 9285: <p>Get a list of all the tarballs that form the new release by
9286: using the following commands. These will leave the full list of the
1.18 snj 9287: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9288: file:</p>
9289: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9290: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9291: awk '{ print $9 }' >list.txt</code></strong>
9292: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9293: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9294: awk '{ print $9 }' >>list.txt</code></strong></pre>
9295: </li>
1.23 wiz 9296: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9297: bump their version to the release you are updating them to. The
9298: three meta packages should be always consistent with versioning.
9299: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9300: in them.</p></li>
1.23 wiz 9301: <li class="listitem">
1.1 dsieger 9302: <p>For each meta package, update all its
9303: <code class="varname">DEPENDS</code> lines to match the latest versions as
9304: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9305: newer version (even if found in the FTP) because the meta packages
9306: are supposed to list the exact versions that form a specific GNOME
9307: release. Exceptions are permitted here if a newer version solves a
9308: serious issue in the overall desktop experience; these typically
9309: come in the form of a revision bump in pkgsrc, not in newer versions
9310: from the developers.</p>
9311: <p>Packages not listed in the <code class="filename">list.txt</code> file
9312: should be updated to the latest version available (if found in
9313: pkgsrc). This is the case, for example, of the dependencies on the
1.120 sevan 9314: GNU Autotools in the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.1 dsieger 9315: </li>
1.23 wiz 9316: <li class="listitem">
1.1 dsieger 9317: <p>Generate a patch from the modified meta packages and extract the
9318: list of "new" lines. This will provide you an outline on what
9319: packages need to be updated in pkgsrc and in what order:</p>
9320: <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>
9321: </li>
1.23 wiz 9322: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9323: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9324: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9325: of <code class="filename">todo.txt</code> and update the packages listed in
9326: it in order. For major desktop updates none of these should be
9327: committed until the entire set is completed because there are chances
9328: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9329: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9330: the tree one by one with appropriate log messages. At the end,
9331: commit the three meta package updates and all the corresponding
9332: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9333: <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>
9334: </ol></div>
9335: </div>
1.41 asau 9336: <div class="sect1">
1.1 dsieger 9337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9338: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9339: <p>GNOME is a very big component in pkgsrc which approaches 100
9340: packages. Please, it is very important that you always, always,
9341: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9342: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.1 dsieger 9343: their attention on portability issues and to ensure that future versions
9344: can be built out-of-the box on NetBSD. The less custom patches in
9345: pkgsrc, the easier further updates are. Those developers in charge of
9346: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9347: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1 dsieger 9348: Bugzilla</a>. Not all components use these to track bugs, but most
9349: of them do. Do not be short on your reports: always provide detailed
9350: explanations of the current failure, how it can be improved to achieve
9351: maximum portability and, if at all possible, provide a patch against CVS
9352: head. The more verbose you are, the higher chances of your patch being
9353: accepted.</p>
9354: <p>Also, please avoid using preprocessor magic to fix portability
9355: issues. While the FreeBSD GNOME people are doing a great job in porting
9356: GNOME to their operating system, the official GNOME sources are now
9357: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9358: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 9359: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 9360: details.</p>
9361: </div>
9362: </div>
9363: </div>
1.41 asau 9364: <div class="part">
1.1 dsieger 9365: <div class="titlepage"><div><div><h1 class="title">
9366: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9367: <div class="partintro">
1.1 dsieger 9368: <div></div>
9369: <p>This part of the guide deals with everything
9370: from the infrastructure that is behind the interfaces described
9371: in the developer's guide. A casual package maintainer should not
9372: need anything from this part.</p>
9373: <div class="toc">
9374: <p><b>Table of Contents</b></p>
1.100 leot 9375: <dl class="toc">
1.6 rillig 9376: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9377: <dd><dl>
1.6 rillig 9378: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9379: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9380: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9381: <dd><dl>
1.6 rillig 9382: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9383: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9384: </dl></dd>
1.6 rillig 9385: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9386: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9387: <dd><dl>
1.6 rillig 9388: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9389: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 9390: </dl></dd>
1.6 rillig 9391: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9392: <dd><dl>
1.23 wiz 9393: <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>
9394: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 9395: </dl></dd>
9396: </dl></dd>
1.6 rillig 9397: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 9398: <dd><dl>
1.108 rillig 9399: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9400: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9401: <dd><dl>
1.108 rillig 9402: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9403: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9404: </dl></dd>
9405: </dl></dd>
1.6 rillig 9406: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108 rillig 9407: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 9408: </dl>
9409: </div>
9410: </div>
1.41 asau 9411: <div class="chapter">
1.1 dsieger 9412: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9413: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9414: <div class="toc">
9415: <p><b>Table of Contents</b></p>
1.100 leot 9416: <dl class="toc">
1.6 rillig 9417: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
9418: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
9419: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 9420: <dd><dl>
1.6 rillig 9421: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
9422: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 9423: </dl></dd>
1.6 rillig 9424: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
9425: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9426: <dd><dl>
1.6 rillig 9427: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
9428: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 9429: </dl></dd>
1.6 rillig 9430: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9431: <dd><dl>
1.23 wiz 9432: <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>
9433: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 9434: </dl></dd>
9435: </dl>
9436: </div>
9437: <p>The pkgsrc infrastructure consists of many small Makefile
9438: fragments. Each such fragment needs a properly specified
9439: interface. This chapter explains how such an interface looks
9440: like.</p>
1.41 asau 9441: <div class="sect1">
1.1 dsieger 9442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9443: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9444: <p>Whenever a variable is defined in the pkgsrc
9445: infrastructure, the location and the way of definition provide
9446: much information about the intended use of that variable.
9447: Additionally, more documentation may be found in a header
9448: comment or in this pkgsrc guide.</p>
9449: <p>A special file is
9450: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9451: variables that are intended to be user-defined. They are either
9452: defined using the <code class="literal">?=</code> operator or they are
9453: left undefined because defining them to anything would
1.23 wiz 9454: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9455: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9456: file.</p>
9457: <p>Outside this file, the following conventions apply:
9458: Variables that are defined using the <code class="literal">?=</code>
9459: operator may be overridden by a package.</p>
9460: <p>Variables that are defined using the <code class="literal">=</code>
9461: operator may be used read-only at run-time.</p>
9462: <p>Variables whose name starts with an underscore must not be
9463: accessed outside the pkgsrc infrastructure at all. They may
9464: change without further notice.</p>
1.41 asau 9465: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9466: <h3 class="title">Note</h3>
9467: <p>These conventions are currently not applied
9468: consistently to the complete pkgsrc
9469: infrastructure.</p>
9470: </div>
9471: </div>
1.41 asau 9472: <div class="sect1">
1.1 dsieger 9473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9474: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9475: <p>All variables that contain lists of things should default
9476: to being empty. Two examples that do not follow this rule are
9477: <code class="varname">USE_LANGUAGES</code> and
9478: <code class="varname">DISTFILES</code>. These variables cannot simply be
9479: modified using the <code class="literal">+=</code> operator in package
9480: <code class="filename">Makefile</code>s (or other files included by
9481: them), since there is no guarantee whether the variable is
9482: already set or not, and what its value is. In the case of
1.23 wiz 9483: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9484: the default value and just define it as in the following
9485: example.</p>
9486: <pre class="programlisting">
9487: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9488: </pre>
9489: <p>Because of the selection of this default value, the same
9490: value appears in many package Makefiles. Similarly for
9491: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9492: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9493: doesn't stand out. Nevertheless it is mentioned in many
9494: files.</p>
9495: </div>
1.41 asau 9496: <div class="sect1">
1.1 dsieger 9497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9498: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 9499: <div class="sect2">
1.1 dsieger 9500: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9501: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 9502: <p>Variable evaluation takes place either at load time or at
9503: runtime, depending on the context in which they occur. The
9504: contexts where variables are evaluated at load time are:</p>
1.41 asau 9505: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9506: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9507: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9508: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9509: <code class="literal">.for</code>,</p></li>
1.23 wiz 9510: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9511: </ul></div>
9512: <p>A special exception are references to the iteration
9513: variables of <code class="literal">.for</code> loops, which are expanded
9514: inline, no matter in which context they appear.</p>
9515: <p>As the values of variables may change during load time,
9516: care must be taken not to evaluate them by accident. Typical
9517: examples for variables that should not be evaluated at load time
9518: are <code class="varname">DEPENDS</code> and
9519: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9520: clear, here is an example:</p>
9521: <pre class="programlisting">
9522: CONFIGURE_ARGS= # none
9523: CFLAGS= -O
9524: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9525:
9526: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9527:
9528: CFLAGS+= -Wall
1.111 sevan 9529: </pre>
1.1 dsieger 9530: <p>This code shows how the use of the <code class="literal">:=</code>
9531: operator can quickly lead to unexpected results. The first
9532: paragraph is fairly common code. The second paragraph evaluates
9533: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9534: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9535: <code class="literal">-Wall</code> is appended to the
9536: <code class="varname">CFLAGS</code>, but this addition will not appear in
9537: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9538: paragraphs from above typically occur in completely unrelated
9539: files.</p>
9540: </div>
1.41 asau 9541: <div class="sect2">
1.1 dsieger 9542: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9543: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9544: <p>After all the files have been loaded, the values of the
9545: variables cannot be changed anymore. Variables that are used in
9546: the shell commands are expanded at this point.</p>
9547: </div>
9548: </div>
1.41 asau 9549: <div class="sect1">
1.1 dsieger 9550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9551: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9552: <p>There are many ways in which the definition and use of a
1.108 rillig 9553: variable can be restricted in order to detect bugs and violations
9554: of the (mostly unwritten) policies. A package can be checked with
9555: <code class="literal">pkglint -Wall</code> to see whether it meets these
9556: rules.</p>
1.1 dsieger 9557: </div>
1.41 asau 9558: <div class="sect1">
1.1 dsieger 9559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9560: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9561: <p>Most of the <code class="filename">.mk</code> files fall into one
9562: of the following classes. Cases where a file falls into more
9563: than one class should be avoided as it often leads to subtle
9564: bugs.</p>
1.41 asau 9565: <div class="sect2">
1.1 dsieger 9566: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9567: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9568: <p>In a traditional imperative programming language some of
9569: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9570: procedures. They take some input parameters and—after
9571: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9572: variables in <code class="filename">Makefile</code>s have global scope
9573: care must be taken not to use parameter names that have already
9574: another meaning. For example, <code class="varname">PKGNAME</code> is a
9575: bad choice for a parameter name.</p>
9576: <p>Procedures are completely evaluated at preprocessing time.
9577: That is, when calling a procedure all input parameters must be
9578: completely resolvable. For example,
9579: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9580: parameter since it is very likely that further text will be
9581: added after calling the procedure, which would effectively apply
9582: the procedure to only a part of the variable. Also, references
1.108 rillig 9583: to other variables will be modified after calling the
1.1 dsieger 9584: procedure.</p>
9585: <p>A procedure can declare its output parameters either as
9586: suitable for use in preprocessing directives or as only
9587: available at runtime. The latter alternative is for variables
9588: that contain references to other runtime variables.</p>
9589: <p>Procedures shall be written such that it is possible to
9590: call the procedure more than once. That is, the file must not
9591: contain multiple-inclusion guards.</p>
9592: <p>Examples for procedures are
9593: <code class="filename">mk/bsd.options.mk</code> and
9594: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9595: that the parameters are evaluated at load time, they should be
9596: assigned using the <code class="literal">:=</code> operator, which should
9597: be used only for this purpose.</p>
9598: </div>
1.41 asau 9599: <div class="sect2">
1.1 dsieger 9600: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9601: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9602: <p>Action files take some input parameters and may define
9603: runtime variables. They shall not define loadtime variables.
9604: There are action files that are included implicitly by the
9605: pkgsrc infrastructure, while other must be included
9606: explicitly.</p>
9607: <p>An example for action files is
9608: <code class="filename">mk/subst.mk</code>.</p>
9609: </div>
9610: </div>
1.41 asau 9611: <div class="sect1">
1.1 dsieger 9612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9613: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 9614: <p>Package <code class="filename">Makefile</code>s usually consist of
9615: a set of variable definitions, and include the file
9616: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9617: Before that, they may also include various other
9618: <code class="filename">*.mk</code> files if they need to query the
9619: availability of certain features like the type of compiler or
9620: the X11 implementation. Due to the heavy use of preprocessor
9621: directives like <code class="literal">.if</code> and
9622: <code class="literal">.for</code>, the order in which the files are loaded
9623: matters.</p>
9624: <p>This section describes at which point the various files
9625: are loaded and gives reasons for that order.</p>
1.41 asau 9626: <div class="sect2">
1.1 dsieger 9627: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9628: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 9629: </h3></div></div></div>
9630: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
9631: is to define some essential variables like
9632: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9633: <code class="varname">MACHINE_ARCH</code>.</p>
9634: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 9635: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 9636: After that, those variables
1.1 dsieger 9637: that have not been overridden by the user are loaded from
9638: <code class="filename">mk/defaults/mk.conf</code>.</p>
9639: <p>After the user settings, the system settings and platform
9640: settings are loaded, which may override the user
9641: settings.</p>
9642: <p>Then, the tool definitions are loaded. The tool wrappers
9643: are not yet in effect. This only happens when building a
9644: package, so the proper variables must be used instead of the
9645: direct tool names.</p>
9646: <p>As the last steps, some essential variables from the
9647: wrapper and the package system flavor are loaded, as well as the
9648: variables that have been cached in earlier phases of a package
9649: build.</p>
9650: </div>
1.41 asau 9651: <div class="sect2">
1.1 dsieger 9652: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9653: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 9654: </h3></div></div></div>
9655: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9656: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9657: loaded, which fill default values for those variables that have
9658: not been defined by the package. These variables may later
9659: be used even in unrelated files.</p>
9660: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9661: provides the target <code class="literal">error-check</code> that is added
9662: as a special dependency to all other targets that use
9663: <code class="varname">DELAYED_ERROR_MSG</code> or
9664: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9665: <p>Then, the package-specific hacks from
9666: <code class="filename">hacks.mk</code> are included.</p>
9667: <p>Then, various other files follow. Most of them don't have
9668: any dependencies on what they need to have included before or
9669: after them, though some do.</p>
9670: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9671: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9672: restricts the use of these variables to all the files that have
9673: been included before. Appearances in later files will be
9674: silently ignored.</p>
9675: <p>Then, the files for the main targets are included, in the
9676: order of later execution, though the actual order should not
9677: matter.</p>
9678: <p>At last, some more files are included that don't set any
9679: interesting variables but rather just define make targets to be
9680: executed.</p>
9681: </div>
9682: </div>
9683: </div>
1.41 asau 9684: <div class="chapter">
1.1 dsieger 9685: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9686: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 9687: <div class="toc">
9688: <p><b>Table of Contents</b></p>
1.100 leot 9689: <dl class="toc">
1.108 rillig 9690: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
9691: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9692: <dd><dl>
1.108 rillig 9693: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
9694: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1 dsieger 9695: </dl></dd>
9696: </dl>
9697: </div>
9698: <p>The pkgsrc infrastructure consists of a large codebase,
9699: and there are many corners where every little bit of a file is
9700: well thought out, making pkgsrc likely to fail as soon as
9701: anything is changed near those parts. To prevent most changes
9702: from breaking anything, a suite of regression tests should go
9703: along with every important part of the pkgsrc infrastructure.
9704: This chapter describes how regression tests work in pkgsrc and
9705: how you can add new tests.</p>
1.41 asau 9706: <div class="sect1">
1.1 dsieger 9707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9708: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.120 sevan 9709: <p>You first need to install the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10 hubertf 9710: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 9711: can simply run that command, which will run all tests in the
9712: <code class="filename">regress</code> category.</p>
9713: </div>
1.41 asau 9714: <div class="sect1">
1.1 dsieger 9715: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 9716: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.1 dsieger 9717: <p>Every directory in the <code class="filename">regress</code>
9718: category that contains a file called <code class="filename">spec</code>
9719: is considered a regression test. This file is a shell program
1.10 hubertf 9720: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 9721: The following functions can be overridden to suit your
9722: needs.</p>
1.41 asau 9723: <div class="sect2">
1.1 dsieger 9724: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9725: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
9726: <p>These functions do not take any parameters. Although they
9727: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9728: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9729: question</a> for details.</p>
1.41 asau 9730: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9731: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 9732: <dd><p>This function prepares the environment for the
9733: test. By default it does nothing.</p></dd>
1.108 rillig 9734: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9735: <dd>
9736: <p>This function runs the actual test. By default,
1.1 dsieger 9737: it calls <code class="varname">TEST_MAKE</code> with the arguments
9738: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9739: error messages into the file
1.108 rillig 9740: <code class="varname">TEST_OUTFILE</code>.</p>
9741: <p>When defining this function, make sure that all output that
9742: needs to be checked is written to the correct output file.
9743: Example:</p>
9744: <pre class="programlisting">
9745: do_test() {
1.112 rillig 9746: echo "Example output"
1.108 rillig 9747: } 1>$TEST_OUTFILE 2>&1
9748: </pre>
9749: </dd>
9750: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9751: <dd>
9752: <p>This function is run after the test and is
1.1 dsieger 9753: typically used to compare the actual output from the one that is
9754: expected. It can make use of the various helper functions from
1.108 rillig 9755: the next section. Example:</p>
9756: <pre class="programlisting">
9757: check_result() {
1.112 rillig 9758: exit_status 0
9759: output_require "Example"
9760: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9761: output_prohibit "no such file or directory"
1.108 rillig 9762: }
9763: </pre>
9764: </dd>
9765: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 9766: <dd><p>This function cleans everything up after the
9767: test has been run. By default it does nothing.</p></dd>
9768: </dl></div>
9769: </div>
1.41 asau 9770: <div class="sect2">
1.1 dsieger 9771: <div class="titlepage"><div><div><h3 class="title">
1.108 rillig 9772: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.41 asau 9773: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9774: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 9775: <dd><p>This function compares the exitcode of the
1.108 rillig 9776: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 9777: If they differ, the test will fail.</p></dd>
1.108 rillig 9778: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9779: <dd>
9780: <p>This function checks for each of its parameters
9781: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 9782: extended regular expression. If it does not, the test will
1.108 rillig 9783: fail. Example:</p>
9784: <pre class="programlisting">
9785: output_require "looks fine"
9786: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9787: </pre>
9788: </dd>
1.1 dsieger 9789: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9790: <dd><p>This function checks for each of its parameters
1.10 hubertf 9791: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 9792: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9793: If any of the regular expressions matches, the test will
9794: fail.</p></dd>
9795: </dl></div>
9796: </div>
9797: </div>
9798: </div>
1.41 asau 9799: <div class="chapter">
1.1 dsieger 9800: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9801: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 9802: <div class="toc">
9803: <p><b>Table of Contents</b></p>
1.108 rillig 9804: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.1 dsieger 9805: </div>
9806: <p>The pkgsrc system has already been ported to many
9807: operating systems, hardware architectures and compilers. This
9808: chapter explains the necessary steps to make pkgsrc even more
9809: portable.</p>
1.41 asau 9810: <div class="sect1">
1.1 dsieger 9811: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9812: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 9813: <p>To port pkgsrc to a new operating system (called
9814: <code class="literal">MyOS</code> in this example), you need to touch the
9815: following files:</p>
1.41 asau 9816: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9817: <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>
9818: <dd><p>This file contains some basic definitions, for
9819: example the name of the C
9820: compiler.</p></dd>
9821: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
9822: <dd><p>Insert code that defines the variables
9823: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
9824: <code class="varname">LOWER_OS_VERSION</code>,
9825: <code class="varname">LOWER_VENDOR</code>,
9826: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
9827: <code class="varname">APPEND_ELF</code>, and the other variables that
9828: appear in this file.</p></dd>
9829: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9830: <dd><p>This file contains the platform-specific
9831: definitions that are used by pkgsrc. Start by copying one of the
9832: other files and edit it to your
9833: needs.</p></dd>
9834: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
9835: <dd><p>This file defines the paths to all the tools
9836: that are needed by one or the other package in pkgsrc, as well
9837: as by pkgsrc itself. Find out where these tools are on your
9838: platform and add them.</p></dd>
9839: </dl></div>
9840: <p>Now, you should be able to build some basic packages, like
1.120 sevan 9841: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1 dsieger 9842: </div>
9843: </div>
9844: </div>
1.41 asau 9845: <div class="appendix">
9846: <div class="titlepage"><div><div><h1 class="title">
9847: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 9848: <div class="toc">
9849: <p><b>Table of Contents</b></p>
1.100 leot 9850: <dl class="toc">
1.1 dsieger 9851: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
9852: <dd><dl>
9853: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
9854: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
9855: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 9856: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 9857: </dl></dd>
9858: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
9859: </dl>
9860: </div>
9861: <p>We checked to find a piece of software that wasn't in the packages
9862: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 9863: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 9864: present in the tree is beyond us, but it's useful for the purposes of
9865: this exercise.</p>
1.41 asau 9866: <div class="sect1">
1.1 dsieger 9867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9868: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 9869: <div class="sect2">
1.1 dsieger 9870: <div class="titlepage"><div><div><h3 class="title">
9871: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
9872: <pre class="programlisting">
9873: # $NetBSD$
9874: #
9875:
9876: DISTNAME= bison-1.25
9877: CATEGORIES= devel
9878: MASTER_SITES= ${MASTER_SITE_GNU}
9879:
1.29 dholland 9880: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 9881: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
9882: COMMENT= GNU yacc clone
9883:
9884: GNU_CONFIGURE= yes
1.46 wiz 9885: INFO_FILES= yes
1.1 dsieger 9886:
9887: .include "../../mk/bsd.pkg.mk"
9888: </pre>
9889: </div>
1.41 asau 9890: <div class="sect2">
1.1 dsieger 9891: <div class="titlepage"><div><div><h3 class="title">
9892: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
9893: <pre class="programlisting">
9894: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.125 leot 9895: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 9896: of the NetBSD source tree is beyond me.
9897: </pre>
9898: </div>
1.41 asau 9899: <div class="sect2">
1.1 dsieger 9900: <div class="titlepage"><div><div><h3 class="title">
9901: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
9902: <pre class="programlisting">
9903: @comment $NetBSD$
9904: bin/bison
9905: man/man1/bison.1.gz
9906: share/bison.simple
9907: share/bison.hairy
9908: </pre>
9909: </div>
1.41 asau 9910: <div class="sect2">
1.1 dsieger 9911: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 9912: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 9913: </h3></div></div></div>
9914: <p>The NetBSD package system comes with
1.120 sevan 9915: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 9916: which helps to check the contents of these
9917: files. After installation it is quite easy to use, just change to the
9918: directory of the package you wish to examine and execute
1.10 hubertf 9919: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 9920: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
9921: looks fine.</pre>
9922: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 9923: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 9924: -Wall</strong></span> for a very thorough check.</p>
9925: </div>
9926: </div>
1.41 asau 9927: <div class="sect1">
1.1 dsieger 9928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9929: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
9930: <p>Create the directory where the package lives,
9931: plus any auxiliary directories:</p>
9932: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
9933: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
9934: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
9935: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
9936: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 9937: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 9938: then continue with fetching the distfile:</p>
9939: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
9940: >> bison-1.25.tar.gz doesn't seem to exist on this system.
9941: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
9942: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9943: ftp: Error retrieving file: 500 Internal error
9944:
9945: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
9946: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9947: ftp: Error retrieving file: 500 Internal error
9948:
9949: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
9950: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
9951: Successfully retrieved file.</pre>
9952: <p>Generate the checksum of the distfile into
9953: <code class="filename">distinfo</code>:</p>
9954: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
9955: <p>Now compile:</p>
9956: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
9957: >> Checksum OK for bison-1.25.tar.gz.
9958: ===> Extracting for bison-1.25
9959: ===> Patching for bison-1.25
9960: ===> Ignoring empty patch directory
9961: ===> Configuring for bison-1.25
9962: creating cache ./config.cache
9963: checking for gcc... cc
9964: checking whether we are using GNU C... yes
9965: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
9966: checking how to run the C preprocessor... cc -E
9967: checking for minix/config.h... no
9968: checking for POSIXized ISC... no
9969: checking whether cross-compiling... no
9970: checking for ANSI C header files... yes
9971: checking for string.h... yes
9972: checking for stdlib.h... yes
9973: checking for memory.h... yes
9974: checking for working const... yes
9975: checking for working alloca.h... no
9976: checking for alloca... yes
9977: checking for strerror... yes
9978: updating cache ./config.cache
9979: creating ./config.status
9980: creating Makefile
9981: ===> Building for bison-1.25
9982: 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
9983: 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
9984: 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
9985: 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
9986: 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
9987: 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
9988: 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
9989: 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
9990: 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
9991: 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
9992: 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
9993: 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
9994: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
9995: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
9996: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
9997: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reduce.c
9998: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
9999: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g warshall.c
10000: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
10001: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
10002: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt1.c
10003: 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
10004: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10005: rm -f bison.s1
10006: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10007: <p>Everything seems OK, so install the files:</p>
10008: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10009: >> Checksum OK for bison-1.25.tar.gz.
10010: ===> Installing for bison-1.25
10011: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10012: rm -f /usr/pkg/bin/bison
10013: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10014: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10015: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10016: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10017: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10018: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10019: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10020: ===> Registering installation for bison-1.25</pre>
10021: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10022: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10023: binary package, do this now:</p>
10024: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10025: >> Checksum OK for bison-1.25.tar.gz.
10026: ===> Building package for bison-1.25
10027: Creating package bison-1.25.tgz
10028: Registering depends:.
10029: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10030: <p>Now that you don't need the source and object files
10031: any more, clean up:</p>
10032: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10033: ===> Cleaning for bison-1.25</pre>
10034: </div>
10035: </div>
1.41 asau 10036: <div class="appendix">
10037: <div class="titlepage"><div><div><h1 class="title">
10038: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10039: <div class="toc">
10040: <p><b>Table of Contents</b></p>
1.100 leot 10041: <dl class="toc">
1.1 dsieger 10042: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10043: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10044: </dl>
10045: </div>
1.41 asau 10046: <div class="sect1">
1.1 dsieger 10047: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10048: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10049: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10050: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10051: => figlet221.tar.gz doesn't seem to exist on this system.
10052: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10053: => [172219 bytes]
10054: Connected to ftp.plig.net.
10055: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10056: 331 Guest login ok, send your complete e-mail address as password.
10057: 230-You are user #5 of 500 simultaneous users allowed.
10058: 230-
10059: 230- ___ _ _ _
10060: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10061: 230- | _| _| . |_| . | | | . |_| . | _| . |
10062: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10063: 230- |_| |_| |___| |___|
10064: 230-
10065: 230-** Welcome to ftp.plig.org **
10066: 230-
10067: 230-Please note that all transfers from this FTP site are logged. If you
10068: 230-do not like this, please disconnect now.
10069: 230-
1.18 snj 10070: 230-This archive is available via
1.1 dsieger 10071: 230-
10072: 230-HTTP: http://ftp.plig.org/
10073: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10074: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10075: 230-
10076: 230-Please email comments, bug reports and requests for packages to be
10077: 230-mirrored to ftp-admin@plig.org.
10078: 230-
10079: 230-
10080: 230 Logged in anonymously.
10081: Remote system type is UNIX.
10082: Using binary mode to transfer files.
10083: 200 Type okay.
10084: 250 "/pub" is new cwd.
10085: 250-"/pub/figlet" is new cwd.
10086: 250-
10087: 250-Welcome to the figlet archive at ftp.figlet.org
10088: 250-
10089: 250- ftp://ftp.figlet.org/pub/figlet/
10090: 250-
10091: 250-The official FIGlet web page is:
10092: 250- http://www.figlet.org/
10093: 250-
10094: 250-If you have questions, please mailto:info@figlet.org. If you want to
10095: 250-contribute a font or something else, you can email us.
10096: 250
10097: 250 "/pub/figlet/program" is new cwd.
10098: 250 "/pub/figlet/program/unix" is new cwd.
10099: local: figlet221.tar.gz remote: figlet221.tar.gz
10100: 502 Unimplemented command.
10101: 227 Entering Passive Mode (195,40,6,41,246,104)
10102: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10103: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10104: 226 Transfer completed.
10105: 172219 bytes received in 00:02 (75.99 KB/s)
10106: 221 Goodbye.
10107: => Checksum OK for figlet221.tar.gz.
10108: ===> Extracting for figlet-2.2.1nb2
10109: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10110: ===> Patching for figlet-2.2.1nb2
10111: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10112: ===> Overriding tools for figlet-2.2.1nb2
10113: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10114: ===> Configuring for figlet-2.2.1nb2
10115: ===> Building for figlet-2.2.1nb2
10116: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10117: chmod a+x figlet
10118: gcc -O2 -o chkfont chkfont.c
10119: => Unwrapping files-to-be-installed.
10120: <code class="prompt">#</code>
10121: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10122: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10123: ===> Installing for figlet-2.2.1nb2
10124: install -d -o root -g wheel -m 755 /usr/pkg/bin
10125: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10126: mkdir -p /usr/pkg/share/figlet
10127: cp figlet /usr/pkg/bin
10128: cp chkfont /usr/pkg/bin
10129: chmod 555 figlist showfigfonts
10130: cp figlist /usr/pkg/bin
10131: cp showfigfonts /usr/pkg/bin
10132: cp fonts/*.flf /usr/pkg/share/figlet
10133: cp fonts/*.flc /usr/pkg/share/figlet
10134: cp figlet.6 /usr/pkg/man/man6
10135: ===> Registering installation for figlet-2.2.1nb2
10136: <code class="prompt">#</code></pre>
10137: </div>
1.41 asau 10138: <div class="sect1">
1.1 dsieger 10139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10140: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10141: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10142: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10143: ===> Packaging figlet-2.2.1nb2
10144: ===> Building binary package for figlet-2.2.1nb2
10145: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10146: Using SrcDir value of /usr/pkg
10147: Registering depends:.
10148: <code class="prompt">#</code></pre>
10149: </div>
10150: </div>
1.41 asau 10151: <div class="appendix">
10152: <div class="titlepage"><div><div><h1 class="title">
10153: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10154: <div class="toc">
10155: <p><b>Table of Contents</b></p>
1.100 leot 10156: <dl class="toc">
1.23 wiz 10157: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10158: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10159: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10160: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10161: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10162: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10163: source packages</a></span></dt>
10164: </dl>
10165: </div>
10166: <p>As in other big projects, the directory layout of pkgsrc
10167: is quite complex for newbies. This chapter explains where you
10168: find things on the FTP server. The base directory on
1.10 hubertf 10169: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1 dsieger 10170: On other servers it may be different, but inside this directory,
10171: everything should look the same, no matter on which server you
10172: are. This directory contains some subdirectories, which are
10173: explained below.</p>
1.41 asau 10174: <div class="sect1">
1.1 dsieger 10175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10176: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10177: <p>The directory <code class="filename">distfiles</code> contains lots
10178: of archive files from all pkgsrc packages, which are mirrored
10179: here. The subdirectories are called after their package names
10180: and are used when the distributed files have names that don't
10181: explicitly contain a version number or are otherwise too generic
10182: (for example <code class="filename">release.tar.gz</code>).</p>
10183: </div>
1.41 asau 10184: <div class="sect1">
1.1 dsieger 10185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10186: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10187: <p>This directory contains things that individual pkgsrc
10188: developers find worth publishing.</p>
10189: </div>
1.41 asau 10190: <div class="sect1">
1.1 dsieger 10191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10192: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10193: <p>This directory contains binary packages for the various
10194: platforms that are supported by pkgsrc.
10195: Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.41 asau 10196: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10197: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10198: operating system for which the packages have been built. The
1.10 hubertf 10199: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10200: command, so it may differ from the one you are used to
10201: hear.</p></li>
1.23 wiz 10202: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10203: architecture of the platform for which the packages have been
1.10 hubertf 10204: built. It also includes the <code class="varname">ABI</code> (Application
10205: Binary Interface) for platforms that have several of
10206: them.</p></li>
1.23 wiz 10207: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10208: the operating system. For version numbers that change often (for
10209: example NetBSD-current), the often-changing part should be
10210: replaced with an <code class="literal">x</code>, for example
10211: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10212: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10213: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10214: for a stable branch, or <code class="literal">head</code> for packages
10215: built from the HEAD branch. The latter should only be used when
10216: the packages are updated on a regular basis. Otherwise the date
10217: from checking out pkgsrc should be appended, for example
10218: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10219: </ul></div>
10220: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10221: can quickly click through the directories on the
10222: server and find the best binary packages for their machines. Since they
10223: usually know the operating system and the hardware architecture, OPSYS
10224: and ARCH are placed first. After these choices, they can select the
10225: best combination of OSVERSION and TAG together, since it is usually the
10226: case that packages stay compatible between different version of the
10227: operating system.</p>
10228: <p>In each of these directories, there is a
10229: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10230: <code class="filename">All</code> which contains all binary packages.
10231: Besides that, there are various category directories that
10232: contain symbolic links to the real binary packages.</p>
10233: </div>
1.41 asau 10234: <div class="sect1">
1.1 dsieger 10235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10236: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10237: <p>Here are the reports from bulk builds, for those who want
10238: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10239: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 10240: </div>
1.41 asau 10241: <div class="sect1">
1.8 rillig 10242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10243: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10244: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10245: source packages</h2></div></div></div>
1.23 wiz 10246: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10247: that is the files that define how to create binary packages from
10248: source archives.</p>
10249: <p>The directory <code class="filename">pkgsrc</code> contains a
10250: snapshot of the CVS repository, which is updated regularly. The
10251: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10252: directory, ready to be downloaded as a whole.</p>
10253: <p>In the directories for the quarterly branches, there is an
10254: additional file called
1.22 jakllsch 10255: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.1 dsieger 10256: which contains the state of pkgsrc when it was branched.</p>
10257: </div>
10258: </div>
1.41 asau 10259: <div class="appendix">
10260: <div class="titlepage"><div><div><h1 class="title">
10261: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10262: <div class="toc">
10263: <p><b>Table of Contents</b></p>
1.100 leot 10264: <dl class="toc">
1.1 dsieger 10265: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10266: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10267: </dl>
10268: </div>
10269: <p>This section contains information on editing the pkgsrc
10270: guide itself.</p>
1.41 asau 10271: <div class="sect1">
1.1 dsieger 10272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10273: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10274: <p>The pkgsrc guide's source code is stored in
10275: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10276: are created from it:</p>
1.41 asau 10277: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10278: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10279: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10280: <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>
10281: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 10282: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10283: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 10284: PostScript version of the pkgsrc guide.</p></li>
10285: </ul></div>
10286: </div>
1.41 asau 10287: <div class="sect1">
1.1 dsieger 10288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10289: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10290: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10291: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10292: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10293: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10294: documentation) installed. These are automatically installed when
1.120 sevan 10295: you install the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41 asau 10296: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10297: right directory. All further steps will take place
10298: here.</p></li>
1.41 asau 10299: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10300: <code class="filename">files/</code>.</p></li>
1.41 asau 10301: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10302: guide for valid XML and to build the final output files. If you
10303: get any errors at this stage, you can just edit the files, as
10304: there are only symbolic links in the working directory, pointing
10305: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10306: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10307: commit)</strong></span></p></li>
1.41 asau 10308: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10309: regenerate the output files with the proper RCS
10310: Ids.</p></li>
1.41 asau 10311: <li class="step">
1.10 hubertf 10312: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10313: commit the files in both <code class="filename">pkgsrc/doc</code> and
10314: <code class="filename">htdocs</code>.</p>
1.41 asau 10315: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10316: <h3 class="title">Note</h3>
10317: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10318: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10319: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10320: directory.</p>
10321: </div>
10322: </li>
10323: </ol></div>
10324: </div>
10325: </div>
10326: </div></body>
10327: </html>
CVSweb <webmaster@jp.NetBSD.org>