Annotation of pkgsrc/doc/pkgsrc.html, revision 1.193
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.193 ! dholland 33: <div><p class="copyright">Copyright © 1994-2014 The NetBSD Foundation, Inc</p></div>
! 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.27 2014/09/19 04:53:09 jnemeth Exp $</p></div>
1.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
48: <dl>
49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
1.157 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
1.82 rillig 78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
81: <dd><dl>
1.151 obache 82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 92: </dl></dd>
93: </dl></dd>
94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
97: <dd><dl>
98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
103: <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>
104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
105: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 106: </dl></dd>
107: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
108: <dd><dl>
109: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
110: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
111: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
112: </dl></dd>
113: </dl></dd>
114: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
115: <dd><dl>
116: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
117: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 118: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 119: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 120: <dd><dl>
1.103 wiz 121: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 122: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
123: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 124: </dl></dd>
1.103 wiz 125: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
126: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 127: </dl></dd>
128: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
129: <dd><dl>
130: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
131: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 132: </dl></dd>
133: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
134: builds)</a></span></dt>
1.75 rillig 135: <dd><dl>
1.180 wiz 136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
138: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
139: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 140: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 142: </dl></dd>
143: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
144: <dd><dl>
1.128 wiz 145: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
146: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.193 ! dholland 151: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
! 152: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
! 153: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
! 154: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
! 155: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
! 156: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
! 157: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
! 158: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
! 159: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
! 160: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 161: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.193 ! dholland 162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
! 163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
! 164: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
! 165: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
! 166: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
! 167: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
! 168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 169: </dl></dd>
170: </dl></dd>
171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
172: <dd><dl>
1.106 rillig 173: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 174: <dd><dl>
1.106 rillig 175: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 176: <dd><dl>
1.106 rillig 177: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 178: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 179: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 180: </dl></dd>
1.106 rillig 181: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
182: <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>
183: </dl></dd>
184: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
185: <dd><dl>
1.128 wiz 186: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
187: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 188: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
189: <dd><dl>
190: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
193: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
194: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
195: </dl></dd>
196: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
197: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
198: <dd><dl>
199: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
201: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
202: </dl></dd>
1.128 wiz 203: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
204: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 205: </dl></dd>
1.128 wiz 206: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 207: <dd><dl>
208: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 209: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 210: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
211: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
212: <dd><dl>
213: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
214: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
215: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
216: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
217: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
218: </dl></dd>
219: </dl></dd>
220: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
221: <dd><dl>
222: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 223: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
224: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 225: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
226: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 227: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106 rillig 228: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
229: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
230: </dl></dd>
231: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
232: <dd><dl>
233: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 234: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 235: <dd><dl>
236: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 237: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
238: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
239: and
240: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
241: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 242: </dl></dd>
1.128 wiz 243: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 244: <dd><dl>
1.128 wiz 245: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 246: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
247: </dl></dd>
248: </dl></dd>
249: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
250: <dd><dl>
251: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
254: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
255: </dl></dd>
256: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
257: <dd><dl>
1.128 wiz 258: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 259: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
260: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
261: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
262: </dl></dd>
263: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
264: <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>
265: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
266: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
267: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
268: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
269: <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>
270: </dl></dd>
271: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
272: <dd><dl>
273: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 274: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 275: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 276: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 277: </dl></dd>
278: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
281: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
282: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
283: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 284: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 285: <dd><dl>
286: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
287: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
288: </dl></dd>
1.128 wiz 289: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 299: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
300: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
301: </dl></dd>
302: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
303: <dd><dl>
304: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
305: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
306: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
307: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 315: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
1.128 wiz 326: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <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>
330: </dl></dd>
1.128 wiz 331: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 332: <dd><dl>
333: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
336: </dl></dd>
337: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
338: <dd><dl>
339: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
340: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
341: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 342: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
343: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 344: </dl></dd>
1.128 wiz 345: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 346: <dd><dl>
347: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
348: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 349: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.106 rillig 350: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
351: </dl></dd>
1.128 wiz 352: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 353: <dd><dl>
354: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
355: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
356: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
357: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
358: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
359: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
360: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
361: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 362: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 363: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 364: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
365: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
366: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
367: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
368: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
369: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
370: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
371: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 372: emulation</a></span></dt>
1.106 rillig 373: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
374: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 375: </dl></dd>
1.106 rillig 376: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 377: </dl></dd>
1.106 rillig 378: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
379: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 380: <dd><dl>
1.106 rillig 381: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
382: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
383: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 384: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 385: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 386: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
387: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 388: </dl></dd>
389: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
390: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
391: <dd><dl>
392: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
393: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
394: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
395: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 396: </dl></dd>
1.75 rillig 397: </dl></dd>
398: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
399: <dd><dl>
1.106 rillig 400: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 401: <dd><dl>
1.106 rillig 402: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
403: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 405: <dd><dl>
1.106 rillig 406: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
407: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 408: </dl></dd>
1.106 rillig 409: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
410: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 411: <dd><dl>
1.106 rillig 412: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
413: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 414: </dl></dd>
1.106 rillig 415: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 416: <dd><dl>
1.128 wiz 417: <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>
418: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 419: </dl></dd>
420: </dl></dd>
1.106 rillig 421: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 422: <dd><dl>
1.106 rillig 423: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
424: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 426: <dd><dl>
1.106 rillig 427: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
428: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 429: </dl></dd>
430: </dl></dd>
1.106 rillig 431: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 432: <dd><dl>
1.106 rillig 433: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
434: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 435: </dl></dd>
436: </dl></dd>
437: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
440: <dd><dl>
441: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
442: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
443: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 444: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 445: </dl></dd>
446: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
447: </dl></dd>
448: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
449: <dd><dl>
450: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
451: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
452: </dl></dd>
1.76 rillig 453: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
454: <dd><dl>
1.128 wiz 455: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
456: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
457: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
458: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
459: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
460: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 461: source packages</a></span></dt>
462: </dl></dd>
1.75 rillig 463: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
464: <dd><dl>
1.79 rillig 465: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 466: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
467: </dl></dd>
468: </dl>
469: </div>
1.82 rillig 470: <div class="list-of-tables">
471: <p><b>List of Tables</b></p>
472: <dl>
473: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
474: </dt>
1.106 rillig 475: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 476: </dt>
1.106 rillig 477: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 478: </dt>
1.82 rillig 479: </dl>
480: </div>
1.148 asau 481: <div class="chapter">
482: <div class="titlepage"><div><div><h1 class="title">
483: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 484: <div class="toc">
485: <p><b>Table of Contents</b></p>
486: <dl>
487: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 488: <dd><dl>
489: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
490: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
491: </dl></dd>
1.75 rillig 492: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
493: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 494: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 495: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
496: </dl>
497: </div>
1.148 asau 498: <div class="sect1">
1.75 rillig 499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
500: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 501: <p>There is a lot of software freely available for Unix-based
502: systems, which is usually available in form of the source code. Before
503: such software can be used, it needs to be configured to the local
504: system, compiled and installed, and this is exactly what The NetBSD
505: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
506: to handle binary packages, so that not every user has to build the
507: packages for himself, which is a time-costly task.</p>
1.75 rillig 508: <p>pkgsrc currently contains several thousand packages,
509: including:</p>
1.148 asau 510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 511: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75 rillig 512: web server</p></li>
1.189 snj 513: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 514: web browser</p></li>
1.189 snj 515: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 516: Desktop Environment</p></li>
1.189 snj 517: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75 rillig 518: Desktop Environment</p></li>
519: </ul></div>
520: <p>...just to name a few.</p>
521: <p>pkgsrc has built-in support for handling varying dependencies,
522: such as pthreads and X11, and extended features such as IPv6 support on
523: a range of platforms.</p>
1.148 asau 524: <div class="sect2">
1.82 rillig 525: <div class="titlepage"><div><div><h3 class="title">
526: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
527: <p>
528: pkgsrc provides the following key features:
529: </p>
1.148 asau 530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 531: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 532: and installation of binary packages. The source and latest
533: patches are retrieved from a master or mirror download site, checksum
534: verified, then built on your system. Support for binary-only
535: distributions is available for both native platforms and NetBSD
536: emulated platforms.</p></li>
1.128 wiz 537: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 538: including binaries, libraries, man pages and other
539: documentation.</p></li>
1.128 wiz 540: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 541: are handled automatically. The configuration files of various
542: packages are handled automatically during updates, so local changes
543: are preserved.</p></li>
1.128 wiz 544: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 545: consists of highly portable code. This allows the greatest speed of
1.132 spz 546: development when porting to a new platform. This portability also
1.82 rillig 547: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
548: platforms</em></span>.</p></li>
1.128 wiz 549: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 550: international encryption requirements and build-time options for a
551: large number of packages are all set in a simple, central
552: configuration file.</p></li>
1.128 wiz 553: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 554: freely available under a BSD license, so you may extend and adapt
555: pkgsrc to your needs. Support for local packages and patches is
556: available right out of the box, so you can configure it specifically
557: for your environment.</p></li>
558: </ul></div>
1.91 rillig 559: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 561: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 562: — That means, if a package contains bugs, it's better to find
1.91 rillig 563: them and to complain about them rather than to just install the package
564: and hope that it works. There are numerous checks in pkgsrc that try to
1.189 snj 565: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91 rillig 566: of shell scripts), and post-installation checks (installed files,
567: references to shared libraries, script interpreters).</p></li>
1.128 wiz 568: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 569: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 570: pkgsrc has been ported to many operating systems. Care is taken that
571: packages behave the same on all platforms.</p></li>
572: </ul></div>
1.82 rillig 573: </div>
1.148 asau 574: <div class="sect2">
1.82 rillig 575: <div class="titlepage"><div><div><h3 class="title">
576: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
577: <p>pkgsrc consists of both a source distribution and a binary
578: distribution for these operating systems. After retrieving the required
579: source or binaries, you can be up and running with pkgsrc in just
580: minutes!</p>
1.75 rillig 581: <p>pkgsrc was derived from FreeBSD's ports system, and
582: initially developed for NetBSD only. Since then, pkgsrc has
583: grown a lot, and now supports the following platforms:</p>
1.82 rillig 584: <div class="table">
585: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 586: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 587: <colgroup>
588: <col>
589: <col>
590: </colgroup>
591: <thead><tr>
592: <th>Platform</th>
593: <th>Date Support Added</th>
594: </tr></thead>
595: <tbody>
596: <tr>
1.110 hubertf 597: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 598: <td align="center">Aug 1997</td>
599: </tr>
600: <tr>
1.110 hubertf 601: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 602: <td align="center">Mar 1999</td>
603: </tr>
604: <tr>
1.110 hubertf 605: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 606: <td align="center">Jun 1999</td>
607: </tr>
608: <tr>
609: <td>
1.110 hubertf 610: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
611: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 612: </td>
613: <td align="center">Oct 2001</td>
614: </tr>
615: <tr>
1.110 hubertf 616: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 617: <td align="center">Nov 2002</td>
618: </tr>
619: <tr>
1.110 hubertf 620: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 621: <td align="center">Nov 2002</td>
622: </tr>
623: <tr>
1.110 hubertf 624: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 625: <td align="center">Dec 2002</td>
626: </tr>
627: <tr>
628: <td>BSD/OS</td>
629: <td align="center">Dec 2003</td>
630: </tr>
631: <tr>
1.110 hubertf 632: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 633: <td align="center">Dec 2003</td>
634: </tr>
635: <tr>
636: <td>
1.110 hubertf 637: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 638: (Microsoft Windows Services for Unix)
639: </td>
640: <td align="center">Mar 2004</td>
641: </tr>
642: <tr>
1.110 hubertf 643: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 644: <td align="center">Oct 2004</td>
645: </tr>
646: <tr>
1.110 hubertf 647: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 648: <td align="center">Nov 2004</td>
649: </tr>
1.98 wiz 650: <tr>
1.110 hubertf 651: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 652: <td align="center">Apr 2007</td>
653: </tr>
1.128 wiz 654: <tr>
655: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
656: <td align="center">Sep 2010</td>
657: </tr>
1.151 obache 658: <tr>
659: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 660: <td align="center">Jan 2011</td>
1.151 obache 661: </tr>
662: <tr>
663: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
664: <td align="center">Nov 2011</td>
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>
669: </tr>
1.166 jnemeth 670: <tr>
671: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
672: <td align="center">Jul 2013</td>
673: </tr>
1.82 rillig 674: </tbody>
1.91 rillig 675: </table></div>
1.82 rillig 676: </div>
1.91 rillig 677: <br class="table-break">
1.82 rillig 678: </div>
1.75 rillig 679: </div>
1.148 asau 680: <div class="sect1">
1.75 rillig 681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
682: <a name="overview"></a>1.2. Overview</h2></div></div></div>
683: <p>This document is divided into three parts. The first,
1.110 hubertf 684: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 685: describes how one can use one of the packages in the Package
686: Collection, either by installing a precompiled binary package,
1.93 rillig 687: or by building one's own copy using the NetBSD package system.
1.110 hubertf 688: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75 rillig 689: package so it can be easily built by other NetBSD users without
690: knowing about the package's building details. The third part,
1.110 hubertf 691: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 692: is intended for those who want to understand how pkgsrc is
693: implemented.</p>
694: <p>This document is available in various formats:
1.110 hubertf 695: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75 rillig 696: </div>
1.148 asau 697: <div class="sect1">
1.75 rillig 698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
699: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 700: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
701: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 702: terminology used within this document.</p>
1.148 asau 703: <div class="variablelist"><dl class="variablelist">
1.75 rillig 704: <dt><span class="term">Package</span></dt>
705: <dd><p>A set of files and building instructions
706: that describe what's necessary
707: to build a certain piece of software using
708: pkgsrc. Packages are traditionally stored under
1.76 rillig 709: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 710: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 711: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 712: is part of the NetBSD operating system and can be bootstrapped
713: to run on non-NetBSD operating systems as well. It handles
714: building (compiling), installing, and removing of
715: packages.</p></dd>
1.75 rillig 716: <dt><span class="term">Distfile</span></dt>
717: <dd><p>This term describes the file or files that are
718: provided by the author of the piece of software to
719: distribute his work. All the changes necessary to build on
720: NetBSD are reflected in the corresponding package. Usually
721: the distfile is in the form of a compressed tar-archive,
722: but other types are possible, too. Distfiles are usually
723: stored below
1.76 rillig 724: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 725: <dt><span class="term">Port</span></dt>
726: <dd><p>This is the term used by FreeBSD and OpenBSD people
727: for what we call a package.
1.128 wiz 728: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 729: architecture.</p></dd>
730: <dt><span class="term">Precompiled/binary package</span></dt>
731: <dd>
732: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 733: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 734: file so it can be installed on machines of the same
735: machine architecture without the need to
736: recompile. Packages are usually generated in
1.76 rillig 737: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 738: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 739: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 740: especially in the context of precompiled packages.</p>
741: </dd>
742: <dt><span class="term">Program</span></dt>
1.88 wiz 743: <dd><p>The piece of software to be installed which will be
744: constructed from all the files in the distfile by the
745: actions defined in the corresponding package.</p></dd>
1.75 rillig 746: </dl></div>
1.148 asau 747: <div class="sect2">
1.75 rillig 748: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 749: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 750: <div class="variablelist"><dl class="variablelist">
1.75 rillig 751: <dt><span class="term">pkgsrc users</span></dt>
752: <dd>
753: <p>The
754: pkgsrc users are people who use the packages provided by pkgsrc.
755: Typically they are system administrators. The people using the
1.128 wiz 756: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
757: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 758: <p>There are two kinds of pkgsrc users: Some only want to
759: install pre-built binary packages. Others build the pkgsrc
760: packages from source, either for installing them directly or for
1.110 hubertf 761: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75 rillig 762: documentation.</p>
763: </dd>
764: <dt><span class="term">package maintainers</span></dt>
765: <dd><p>A
1.110 hubertf 766: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75 rillig 767: <dt><span class="term">infrastructure developers</span></dt>
768: <dd><p>These people are involved in all those files
1.76 rillig 769: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 770: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75 rillig 771: too.</p></dd>
772: </dl></div>
773: </div>
774: </div>
1.148 asau 775: <div class="sect1">
1.75 rillig 776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
777: <a name="typography"></a>1.4. Typography</h2></div></div></div>
778: <p>When giving examples for commands, shell prompts are used to
779: show if the command should/can be issued as root, or if
1.128 wiz 780: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 781: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
782: shell prompt, assuming they use the C-shell or tcsh.</p>
783: </div>
784: </div>
1.148 asau 785: <div class="part">
1.75 rillig 786: <div class="titlepage"><div><div><h1 class="title">
787: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
788: <div class="toc">
789: <p><b>Table of Contents</b></p>
790: <dl>
791: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
792: <dd><dl>
793: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
794: <dd><dl>
1.157 asau 795: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 796: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 797: </dl></dd>
798: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
799: <dd><dl>
800: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
801: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
802: </dl></dd>
803: </dl></dd>
804: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
805: <dd><dl>
1.82 rillig 806: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
807: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
808: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
809: <dd><dl>
1.151 obache 810: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
811: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
812: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 813: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
814: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
815: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
816: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
817: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
818: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
819: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 820: </dl></dd>
821: </dl></dd>
822: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
823: <dd><dl>
824: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
825: <dd><dl>
826: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
827: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 828: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
829: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
830: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
831: <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>
832: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
833: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 834: </dl></dd>
835: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
836: <dd><dl>
837: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
838: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
839: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
840: </dl></dd>
841: </dl></dd>
842: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
843: <dd><dl>
844: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
845: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 846: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 847: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 848: <dd><dl>
1.103 wiz 849: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 850: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
851: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 852: </dl></dd>
1.103 wiz 853: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
854: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 855: </dl></dd>
856: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
857: <dd><dl>
858: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
859: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 860: </dl></dd>
861: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
862: builds)</a></span></dt>
1.75 rillig 863: <dd><dl>
1.180 wiz 864: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
865: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
866: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
867: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 868: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
869: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 870: </dl></dd>
871: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
872: <dd><dl>
1.128 wiz 873: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
874: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 875: </dl></dd>
876: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
877: <dd><dl>
878: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.193 ! dholland 879: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
! 880: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
! 881: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
! 882: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
! 883: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
! 884: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
! 885: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
! 886: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
! 887: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
! 888: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 889: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.193 ! dholland 890: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
! 891: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
! 892: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
! 893: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
! 894: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
! 895: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
! 896: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 897: </dl></dd>
898: </dl>
899: </div>
1.148 asau 900: <div class="chapter">
1.75 rillig 901: <div class="titlepage"><div><div><h2 class="title">
902: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
903: <div class="toc">
904: <p><b>Table of Contents</b></p>
905: <dl>
906: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
907: <dd><dl>
1.157 asau 908: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 909: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 910: </dl></dd>
911: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
912: <dd><dl>
913: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
914: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
915: </dl></dd>
916: </dl>
917: </div>
1.91 rillig 918: <p>Before you download and extract the files, you need to decide
919: where you want to extract them. When using pkgsrc as root user, pkgsrc
920: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
921: free to install the sources and binary packages wherever you want in
922: your filesystem, provided that the pathname does not contain white-space
923: or other characters that are interpreted specially by the shell and some
924: other programs. A safe bet is to use only letters, digits, underscores
925: and dashes.</p>
1.148 asau 926: <div class="sect1">
1.75 rillig 927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
928: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
929: <p>Before you download any pkgsrc files, you should decide
930: whether you want the <span class="emphasis"><em>current</em></span> branch or the
931: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
932: quarterly basis from the current branch and only gets modified
933: for security updates. The names of the stable branches are built
934: from the year and the quarter, for example
1.188 snj 935: <code class="literal">2014Q3</code>.</p>
1.75 rillig 936: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 937: want to download pkgsrc. You can get it as a tar file or via CVS.
938: Both ways are described here.</p>
1.157 asau 939: <p>Note that tar archive contains CVS working copy.
940: Thus you can switch to using CVS at any later time.</p>
1.148 asau 941: <div class="sect2">
1.75 rillig 942: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 943: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 944: <p>The primary download location for all pkgsrc files is
1.157 asau 945: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
946: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
947: (it points to the same location).
948: There are a number of subdirectories for different purposes,
949: 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>
950: <p>The tar archive for the current branch is in the directory
951: <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.75 rillig 952: It is autogenerated daily.</p>
1.157 asau 953: <p>To save download time we provide bzip2- and
954: xz-compressed archives which are published at
955: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
956: and
957: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
958: respectively.
959: </p>
960: <p>You can fetch the same files using FTP.</p>
1.188 snj 961: <p>The tar file for the stable branch 2014Q3 is in the
962: directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112 weinem 963: <p>To download a pkgsrc stable tarball, run:</p>
964: <pre class="screen">
1.166 jnemeth 965: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.126 jakllsch 966: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 967: stable branch to be downloaded, for example,
1.188 snj 968: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
969: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 970: or your web browser.</p>
1.112 weinem 971: <p>Then, extract it with:</p>
1.188 snj 972: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 973: <p>This will create the directory <code class="filename">pkgsrc/</code>
974: in <code class="filename">/usr/</code> and all the package source will be
975: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
976: <p>To download pkgsrc-current, run:</p>
977: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75 rillig 978: </div>
1.148 asau 979: <div class="sect2">
1.75 rillig 980: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 981: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
982: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 983: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.128 wiz 984: </pre>
985: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.188 snj 986: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.128 wiz 987: <p>This will create the directory <code class="filename">pkgsrc/</code>
988: in your <code class="filename">/usr/</code> directory and all the package source
989: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
990: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 991: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 992: </pre>
1.188 snj 993: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 994: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146 wiz 995: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128 wiz 996: </pre>
997: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
998: For Bourne shells, you can set it in your <code class="filename">.profile</code>
999: or better globally in <code class="filename">/etc/profile</code>:</p>
1000: <pre class="programlisting">
1001: # set CVS remote shell command
1002: CVS_RSH=ssh
1003: export CVS_RSH
1004: </pre>
1005: <p>By default, CVS doesn't do things like most people would expect it to do.
1006: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1007: in your home directory and saving the following lines to it.
1008: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1009: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1010: <pre class="programlisting">
1011: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1012: cvs -q -z2
1.101 rillig 1013: checkout -P
1.103 wiz 1014: update -dP
1015: diff -upN
1.101 rillig 1016: rdiff -u
1.128 wiz 1017: release -d
1.101 rillig 1018: </pre>
1.75 rillig 1019: </div>
1020: </div>
1.148 asau 1021: <div class="sect1">
1.75 rillig 1022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1023: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1024: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1025: (which also works if you have first installed it via a tar
1026: file). It saves bandwidth and hard disk activity, compared to
1027: downloading the tar file again.</p>
1.148 asau 1028: <div class="sect2">
1.75 rillig 1029: <div class="titlepage"><div><div><h3 class="title">
1030: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1031: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1032: <h3 class="title">Warning</h3>
1.77 rillig 1033: <p>When updating from a tar file, you first need to
1034: completely remove the old pkgsrc directory. Otherwise those
1035: files that have been removed from pkgsrc in the mean time will
1036: not be removed on your local disk, resulting in inconsistencies.
1037: When removing the old files, any changes that you have done to
1038: the pkgsrc files will be lost after updating. Therefore updating
1039: via CVS is strongly recommended.</p>
1.75 rillig 1040: </div>
1.82 rillig 1041: <p>Note that by default the distfiles and the binary packages
1042: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1043: before updating. You can also configure pkgsrc to store distfiles
1044: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1045: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1046: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1047: <p>To update pkgsrc from a tar file, download the tar file as
1048: explained above. Then, make sure that you have not made any
1049: changes to the files in the pkgsrc directory. Remove the pkgsrc
1050: directory and extract the new tar file. Done.</p>
1051: </div>
1.148 asau 1052: <div class="sect2">
1.75 rillig 1053: <div class="titlepage"><div><div><h3 class="title">
1054: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1055: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1056: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1057: </pre>
1058: <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>
1059: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1060: </pre>
1.148 asau 1061: <div class="sect3">
1.75 rillig 1062: <div class="titlepage"><div><div><h4 class="title">
1063: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1064: <p>When updating pkgsrc, the CVS program keeps track of the
1065: branch you selected. But if you, for whatever reason, want to
1066: switch from the stable branch to the current one, you can do it
1.128 wiz 1067: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1068: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1069: back to the stable branch, add the
1.188 snj 1070: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.75 rillig 1071: </div>
1.148 asau 1072: <div class="sect3">
1.75 rillig 1073: <div class="titlepage"><div><div><h4 class="title">
1074: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1075: <p>When you update pkgsrc, the CVS program will only touch
1076: those files that are registered in the CVS repository. That
1077: means that any packages that you created on your own will stay
1078: unmodified. If you change files that are managed by CVS, later
1079: updates will try to merge your changes with those that have been
1080: done by others. See the CVS manual, chapter
1.128 wiz 1081: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1082: </div>
1083: </div>
1084: </div>
1085: </div>
1.148 asau 1086: <div class="chapter">
1.75 rillig 1087: <div class="titlepage"><div><div><h2 class="title">
1088: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1089: <div class="toc">
1090: <p><b>Table of Contents</b></p>
1091: <dl>
1.82 rillig 1092: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1093: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1094: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1095: <dd><dl>
1.151 obache 1096: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1097: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1098: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 1099: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1100: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1101: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1102: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1103: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1104: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1105: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 1106: </dl></dd>
1107: </dl>
1108: </div>
1.148 asau 1109: <div class="sect1">
1.75 rillig 1110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1111: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1112: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.82 rillig 1113: </div>
1.148 asau 1114: <div class="sect1">
1.82 rillig 1115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1116: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1117: <p>pkgsrc can be bootstrapped for use in two different modes:
1118: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1119: to privileged one all programs are installed under one particular user
1.149 asau 1120: and cannot utilise privileged operations (packages don't create
1121: special users and all special file permissions like setuid are ignored).
1122: </p>
1.82 rillig 1123: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1124: <pre class="screen">
1.167 asau 1125: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75 rillig 1126: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1127: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1128: </pre>
1.149 asau 1129: <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>
1130: <p>By default, in privileged mode pkgsrc uses
1131: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1132: where programs will be installed in,
1.87 wiz 1133: and <code class="filename">/var/db/pkg</code> for the package database
1.149 asau 1134: directory where pkgsrc will do its internal bookkeeping,
1135: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1136: where packages install their persistent data.
1137: In unprivileged mode pkgsrc uses
1138: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1139: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1140: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1141: </p>
1142: <p>You can change default layout using command-line arguments.
1143: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1144: </p>
1.148 asau 1145: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1146: <h3 class="title">Note</h3>
1.110 hubertf 1147: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1148: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1149: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1150: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1151: </div>
1.149 asau 1152: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1153: <h3 class="title">Note</h3>
1154: <p>It is possible to bootstrap multiple instances of pkgsrc
1155: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1156: corresponding to the installation you're working with to build
1157: and install packages.
1158: </p>
1159: </div>
1.75 rillig 1160: </div>
1.148 asau 1161: <div class="sect1">
1.75 rillig 1162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1163: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1164: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 asau 1165: <div class="sect2">
1.75 rillig 1166: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1167: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1168: <p>Cygwin 1.7.x and later are supported.</p>
1169: <p>You need to install minimal base packages in `Base' category
1170: plus any of compiler, gcc, gcc4, and/or clang.
1171: For gcc and gcc4, C and C++ compiler will be installed by default,
1172: but you can install Fortran compiler additionally
1173: because it will be required to use libtool.
1174: If it is not installed (or too old), Fortran compiler will be
1175: installed with pkgsrc automatically.</p>
1176: <p>As noted in
1177: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1178: su(1) command has been in Cygwin distribution, but it has never worked.
1179: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1180: </p>
1181: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1182: then pick "Run as administrator".</p></li></ul></div>
1183: </div>
1184: <div class="sect2">
1185: <div class="titlepage"><div><div><h3 class="title">
1186: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.148 asau 1187: <p>Darwin 5.x and up are supported.</p>
1188: <p>Before you start, you need to download and install
1189: the Mac OS X Developer Tools from Apple's Developer Connection.
1190: This requires (free) membership. See
1.126 jakllsch 1191: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 asau 1192: for details. Also, make sure you install X11 (an optional
1193: package included with the Developer Tools) if you intend
1194: to build packages that use the X11 Window System.
1195: (If you don't want or need the full Xcode GUI,
1196: download and install Command Line Tools for Xcode.)</p>
1.75 rillig 1197: </div>
1.148 asau 1198: <div class="sect2">
1.75 rillig 1199: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1200: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136 dholland 1201: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1202: other versions may work.</p>
1.75 rillig 1203: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1204: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1205: <div class="orderedlist"><ol class="orderedlist" type="1">
1206: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1207: <code class="filename">/var/db/pkg</code>. It is therefore
1208: recommended that you choose a different location (e.g.
1209: <code class="filename">/usr/pkgdb</code>) by
1210: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1211: <li class="listitem">
1.75 rillig 1212: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1213: good idea to move them out of the way to avoid confusion, e.g.</p>
1214: <pre class="screen">
1215: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1216: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1217: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1218: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1219: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1220: </pre>
1.75 rillig 1221: </li>
1.128 wiz 1222: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1223: <code class="filename">/etc/mk.conf.example</code> file
1224: when you use the bootstrap script.</p></li>
1.75 rillig 1225: </ol></div>
1226: </div>
1.148 asau 1227: <div class="sect2">
1.75 rillig 1228: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1229: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1230: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1231: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1232: <p> You should install ncurses (libncurses and libncurses-dev)
1233: packages.</p>
1234: </div>
1235: <div class="sect2">
1236: <div class="titlepage"><div><div><h3 class="title">
1237: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75 rillig 1238: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1239: providing a Unix-like environment with a tighter kernel integration than
1240: available with Cygwin. It is part of the Windows Services for Unix
1241: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1242: (not including XP Home), or 2003. SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93 rillig 1243: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1244: are not officially supported. (The main difference in 3.0/3.1 is lack
1245: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 wiz 1246: <p>Services for Unix Applications (aka SUA) is an integrated
1247: component of Windows Server 2003 R2 (5.2), Windows Vista and
1248: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1249: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1250: 6.1 (64bit) subsystems have been tested. Other versions may
1251: work as well. The Interix 5.x subsystem has not yet been tested
1252: with pkgsrc.</p>
1.148 asau 1253: <div class="sect3">
1.75 rillig 1254: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1255: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1256: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1257: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 asau 1258: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1259: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1260: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1261: <li class="listitem"><p>Remote Connectivity</p></li>
1262: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1263: </ul></div>
1264: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1265: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1266: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1267: pkgsrc (or from a binary package).</p>
1.75 rillig 1268: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1269: not need to be installed, but Remote Connectivity itself should be
1270: installed in order to have a working inetd.</p>
1.75 rillig 1271: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1272: behavior for Interix programs, and whether to make pathnames default to
1273: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1274: enabled. (Without case-sensitivity, a large number of packages including
1275: perl will not build.)</p>
1.75 rillig 1276: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1277: works (via the Data Execution Prevention feature). In order to use
1278: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1279: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1280: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1281: support contract; however, Debian Interix Port has made most Interix
1282: hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.93 rillig 1283: <p>In addition to the hotfix noted above, it may be necessary to
1284: disable Data Execution Prevention entirely to make Interix functional.
1285: This may happen only with certain types of CPUs; the cause is not fully
1286: understood at this time. If gcc or other applications still segfault
1287: repeatedly after installing one of the hotfixes note above, the
1288: following option can be added to the appropriate "boot.ini" line on the
1289: Windows boot drive: /NoExecute=AlwaysOff
1290: (WARNING, this will disable DEP completely, which may be a security
1291: risk if applications are often run as a user in the Administrators
1292: group!)</p>
1.75 rillig 1293: </div>
1.148 asau 1294: <div class="sect3">
1.75 rillig 1295: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1296: <a name="platform.interix-sfu-postinstall"></a>3.3.5.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75 rillig 1297: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1298: with pkgsrc, note the following things.</p>
1.148 asau 1299: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1300: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1301: Windows Services for UNIX, then click Change. In the installer, choose
1302: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1303: <li class="listitem">
1.75 rillig 1304: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1305: change the following registry key:</p>
1.75 rillig 1306: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1307: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1308: </li>
1.128 wiz 1309: <li class="listitem">
1.75 rillig 1310: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1311: following registry key:</p>
1.75 rillig 1312: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1313: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1314: </li>
1315: </ul></div>
1316: </div>
1.148 asau 1317: <div class="sect3">
1.75 rillig 1318: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1319: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1320: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1321: running "pkg_add") must be a member of the local Administrators
1322: group. Such a user must also be used to run the bootstrap. This is
1323: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1324: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1325: automatically complain if this is not the case. This ensures that
1326: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1327: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1328: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1329: NOT be used in conjunction with pkgsrc. If you choose to use them at
1330: the same time as the pkgsrc packages, ensure that you use the proper
1331: pkg_* tools for each type of binary package.</p>
1.75 rillig 1332: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1333: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1334: don't have a termcap/terminfo entry for it, but the following .termcap
1335: entry provides adequate emulation in most cases:</p>
1.75 rillig 1336: <pre class="programlisting">
1.100 rillig 1337: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1338: </pre>
1.75 rillig 1339: </div>
1.148 asau 1340: <div class="sect3">
1.75 rillig 1341: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1342: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1343: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1344: for a full Unix-like platform, it has some drawbacks that should
1345: be noted for those desiring to make the most of Interix.</p>
1.148 asau 1346: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1347: <li class="listitem">
1.75 rillig 1348: <p><span class="strong"><strong>X11:</strong></span></p>
1349: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1350: and can run X11 based applications, but it does
1351: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1352: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1353: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1354: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1355: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1356: and the free X11 server included with
1.110 hubertf 1357: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1358: </li>
1.128 wiz 1359: <li class="listitem">
1.75 rillig 1360: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1361: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1362: Win32 applications, it does not currently support various X11
1363: protocol extensions for acceleration (such as MIT-SHM or DGA).
1364: Most interactive applications to a local X server will run
1365: reasonably fast, but full motion video and other graphics
1366: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1367: </li>
1.128 wiz 1368: <li class="listitem">
1.75 rillig 1369: <p><span class="strong"><strong>Audio:</strong></span></p>
1370: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1371: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1372: audio system on Interix. Unlike on most platforms, the
1.189 snj 1373: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.110 hubertf 1374: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1375: server component. To output audio via an Interix host, the
1.189 snj 1376: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87 wiz 1377: must also be installed.</p>
1.75 rillig 1378: </li>
1.128 wiz 1379: <li class="listitem">
1.75 rillig 1380: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1381: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1382: is not currently possible to access CD/DVD drives, USB devices,
1383: or SCSI devices through non-filesystem means. Among other things,
1384: this makes it impossible to use Interix directly for CD/DVD
1385: burning.</p>
1.75 rillig 1386: </li>
1.128 wiz 1387: <li class="listitem">
1.75 rillig 1388: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1389: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1390: drives are also not directly accessible in Interix. However,
1391: support is in work to make tape drive access possible by using
1392: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1393: esound server).</p>
1.75 rillig 1394: </li>
1395: </ul></div>
1396: </div>
1.148 asau 1397: <div class="sect3">
1.75 rillig 1398: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1399: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1400: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1401: Windows system; any member of the local Administrators group will
1402: suffice. However, some packages currently assume that the user
1403: named "root" is the privileged user. To accommodate these, you
1404: may create such a user; make sure it is in the local group
1405: Administrators (or your language equivalent).</p>
1.110 hubertf 1406: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1407: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1408: time being, install packages as the local Administrator (or
1409: your language equivalent), or run the following command after
1410: installing a package to work around the issue:</p>
1.75 rillig 1411: <pre class="screen">
1.87 wiz 1412: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1413: </pre>
1.75 rillig 1414: </div>
1415: </div>
1.148 asau 1416: <div class="sect2">
1.75 rillig 1417: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1418: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75 rillig 1419: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1420: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1421: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1422: compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75 rillig 1423: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.189 snj 1424: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87 wiz 1425: etc.</p>
1.86 schwarz 1426: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1427: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1428: you start out using "abi=n32", that's what all your packages will be built
1429: with.</p>
1430: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1431: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1432: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1433: try to link n32 object files with lib64 or vice versa. Check your
1434: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1435: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1436: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1437: as it appears that IRIX linker occasionally runs into issues when trying to
1438: link over a network-mounted file system.</p>
1.75 rillig 1439: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1440: as imake(1), but you may want to set some options depending on your local
1441: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1442: course, your compiler's man pages for details.</p>
1.75 rillig 1443: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1444:
1.87 wiz 1445: </p>
1.75 rillig 1446: <pre class="programlisting">
1.100 rillig 1447: PKGSRC_COMPILER= mipspro
1.87 wiz 1448: </pre>
1.75 rillig 1449: <p>
1.1 grant 1450:
1.110 hubertf 1451: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1452: are using gcc and may end up passing invalid flags to the compiler. Note that
1453: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1454: default.</p>
1.75 rillig 1455: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1456: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1457: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1458: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1459: '--preserve-path' flag.</p>
1.75 rillig 1460: </div>
1.148 asau 1461: <div class="sect2">
1.75 rillig 1462: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1463: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87 wiz 1464: <p>Some versions of Linux (for example Debian GNU/Linux) need
1465: either libtermcap or libcurses (libncurses). Installing the
1466: distributions libncurses-dev package (or equivalent) should fix
1467: the problem.</p>
1468: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1469: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1470: i386 have been tested.</p>
1.75 rillig 1471: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1472: directory:</p>
1.75 rillig 1473: <pre class="programlisting">
1.138 wiz 1474: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1475: </pre>
1.148 asau 1476: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1477: <h3 class="title">Note</h3>
1.138 wiz 1478: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1479: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1480: <p>For icc 10.1 neither of these appears to be necessary.</p>
1481: </div>
1482: <p>Use a value for ICCBASE that corresponds to the directory
1483: where icc is installed. After bootstrapping, set
1484: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137 wiz 1485: <pre class="programlisting">
1.138 wiz 1486: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1487: </pre>
1.138 wiz 1488: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1489: <code class="filename">/opt/intel_cc_80</code>. This is the default
1490: install directory for icc 8.0. If you are using a more recent
1491: version, be sure to set the correct path explicitly.
1492: </p>
1.75 rillig 1493: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1494: provided by icc, so binaries can be run on other systems which do not
1495: have the shared libraries installed.</p>
1496: <p>Libtool, however, extracts a list of libraries from the
1.189 snj 1497: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87 wiz 1498: records it, throwing away the -Bstatic and -Bdynamic options
1499: interspersed between the libraries. This means that
1500: libtool-linked C++ shared libraries will have a runtime
1501: dependency on the icc libraries until this is fixed in
1502: libtool.</p>
1.75 rillig 1503: </div>
1.148 asau 1504: <div class="sect2">
1.75 rillig 1505: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1506: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163 bsiegert 1507: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1508: Older versions might also work. Releases before #10 are not
1509: supported.</p>
1510: <p>The package tools of the (older) native ports tree,
1511: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1512: have the same names as the ones used by pkgsrc. Care should be taken
1513: that the right tools are used. When installing packages from source,
1514: use the <code class="filename">bmake</code> command for pkgsrc and
1515: <code class="filename">mmake</code> for MirPorts.</p>
1516: <p>pkgsrc and MirPorts use the same location for the package
1517: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1518: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1519: tree is self-contained. This is also the default setting used in the
1520: binary package builds.</p>
1521: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1522: server. The bootstrap kit there already contains the
1523: <span class="command"><strong>pkgin</strong></span> package manager. See the
1524: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1525: page for more details.</p>
1526: </div>
1527: <div class="sect2">
1528: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1529: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136 dholland 1530: <p>OpenBSD 5.1 has been tested and supported,
1531: other versions may work.</p>
1.75 rillig 1532: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1533: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1534: <div class="orderedlist"><ol class="orderedlist" type="1">
1535: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1536: <code class="filename">/var/db/pkg</code>. It is therefore
1537: recommended that you choose a different location (e.g.
1538: <code class="filename">/usr/pkgdb</code>) by
1539: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1540: <li class="listitem">
1.75 rillig 1541: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1542: good idea to move them out of the way to avoid confusion, e.g.</p>
1543: <pre class="screen">
1544: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1545: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1546: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1547: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1548: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1549: </pre>
1.75 rillig 1550: </li>
1.128 wiz 1551: <li class="listitem">
1.110 hubertf 1552: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1553: <code class="filename">/etc/mk.conf.example</code> file
1554: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1555: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1556: as well. You can work around this by enclosing all the pkgsrc-specific parts
1557: of the file with:</p>
1558: <pre class="programlisting">
1.100 rillig 1559: .ifdef BSD_PKG_MK
1560: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1561: .else
1562: # OpenBSD stuff
1563: .endif
1.87 wiz 1564: </pre>
1.75 rillig 1565: </li>
1566: </ol></div>
1567: </div>
1.148 asau 1568: <div class="sect2">
1.75 rillig 1569: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1570: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142 wiz 1571: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1572: You will need a working C compiler. Both gcc 4.5.3 and
1.87 wiz 1573: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1574: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1575: process and to build packages.</p>
1.148 asau 1576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1577: <li class="listitem"><p>SUNWsprot</p></li>
1578: <li class="listitem"><p>SUNWarc</p></li>
1579: <li class="listitem"><p>SUNWbtool</p></li>
1580: <li class="listitem"><p>SUNWtoo</p></li>
1581: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1582: </ul></div>
1.78 rillig 1583: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1584: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1585: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1586: your $prefix are in your <code class="varname">PATH</code>. This includes
1587: <code class="filename">/usr/ccs/{bin,lib}</code>
1588: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148 asau 1589: <div class="sect3">
1.75 rillig 1590: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1591: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1592: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1593: for building all packages.</p>
1.75 rillig 1594: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1595: then either build gcc from
1.189 snj 1596: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.87 wiz 1597: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1598: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75 rillig 1599: </div>
1.148 asau 1600: <div class="sect3">
1.75 rillig 1601: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1602: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1603: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1604: 5.0)</p>
1.148 asau 1605: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1606: <li class="listitem"><p>SPROcc
1.87 wiz 1607: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1608: <li class="listitem"><p>SPROcpl
1.87 wiz 1609: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1610: <li class="listitem"><p>SPROild
1.87 wiz 1611: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1612: <li class="listitem"><p>SPROlang
1.87 wiz 1613: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1614: </ul></div>
1.96 rillig 1615: <p>You should set the following variables in your
1.110 hubertf 1616: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1617: <pre class="programlisting">
1.100 rillig 1618: CC= cc
1619: CXX= CC
1620: CPP= cc -E
1621: CXXCPP= CC -E
1.96 rillig 1622: </pre>
1.148 asau 1623: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1624: <h3 class="title">Note</h3>
1625: <p>The <code class="varname">CPP</code> setting might break some
1626: packages that use the C preprocessor for processing things other
1627: than C source code.</p>
1628: </div>
1.75 rillig 1629: </div>
1.148 asau 1630: <div class="sect3">
1.75 rillig 1631: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1632: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1633: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1634: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1635: <pre class="programlisting">
1.100 rillig 1636: PKGSRC_COMPILER= sunpro
1637: ABI= 64
1.96 rillig 1638: </pre>
1.148 asau 1639: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1640: <h3 class="title">Note</h3>
1641: <p>This setting has been tested for the SPARC
1642: architecture. Intel and AMD machines need some more
1643: work.</p>
1644: </div>
1.75 rillig 1645: </div>
1.148 asau 1646: <div class="sect3">
1.75 rillig 1647: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1648: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110 hubertf 1649: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1650: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1651: The workaround is to use another shell for the configure
1.189 snj 1652: scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.110 hubertf 1653: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1654: <pre class="programlisting">
1.100 rillig 1655: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1656: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1657: </pre>
1.189 snj 1658: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.75 rillig 1659: </div>
1660: </div>
1661: </div>
1662: </div>
1.148 asau 1663: <div class="chapter">
1.75 rillig 1664: <div class="titlepage"><div><div><h2 class="title">
1665: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1666: <div class="toc">
1667: <p><b>Table of Contents</b></p>
1668: <dl>
1669: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1670: <dd><dl>
1671: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1672: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1673: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1674: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1675: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1676: <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>
1677: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1678: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1679: </dl></dd>
1680: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1681: <dd><dl>
1682: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1683: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1684: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1685: </dl></dd>
1686: </dl>
1687: </div>
1688: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1689: is to only install the package tools and to use binary packages
1.128 wiz 1690: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1691: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1692: of pkgsrc, too. Then you are able to build your own packages,
1693: and you can still use binary packages from someone else.</p>
1.148 asau 1694: <div class="sect1">
1.75 rillig 1695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1696: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1697: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1698: server and its mirrors, there are collections of binary packages,
1699: ready to be installed. These binary packages have been built using the
1700: default settings for the directories, that is:</p>
1.148 asau 1701: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1702: <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>
1703: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1704: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109 rillig 1705: </ul></div>
1706: <p>If you cannot use these directories for whatever reasons (maybe
1707: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1708: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.148 asau 1709: <div class="sect2">
1.75 rillig 1710: <div class="titlepage"><div><div><h3 class="title">
1711: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1712: <p>To install binary packages, you first need to know from where
1713: to get them. The first place where you should look is on the main
1.110 hubertf 1714: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105 weinem 1715: <p>This directory contains binary packages for multiple
1716: platforms. First, select your operating system. (Ignore the
1717: directories with version numbers attached to it, they just exist for
1718: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1719: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1720: <p>In this directory, you often find a file called
1721: <code class="filename">bootstrap.tar.gz</code> which contains the package
1722: management tools. If the file is missing, it is likely that your
1723: operating system already provides those tools. Download the file and
1724: extract it in the <code class="filename">/</code> directory. It will create
1725: the directories <code class="filename">/usr/pkg</code> (containing the tools
1726: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1727: (the database of installed packages).</p>
1.75 rillig 1728: </div>
1.148 asau 1729: <div class="sect2">
1.75 rillig 1730: <div class="titlepage"><div><div><h3 class="title">
1731: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1732: <p>In the directory from the last section, there is a
1733: subdirectory called <code class="filename">All</code>, which contains all the
1734: binary packages that are available for the platform, excluding those
1735: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1736: medium you are using).</p>
1.109 rillig 1737: <p>To install packages directly from an FTP or HTTP server, run
1738: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1739: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1740: <pre class="screen">
1741: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1742: <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>
1743: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1744: </pre>
1745: <p>Instead of URLs, you can also use local paths, for example if
1746: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1747: repository. If you want to install packages from multiple sources,
1748: you can separate them by a semicolon in
1749: <code class="varname">PKG_PATH</code>.</p>
1750: <p>After these preparations, installing a package is very
1751: easy:</p>
1752: <pre class="screen">
1753: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1754: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1755: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1756: </pre>
1.75 rillig 1757: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1758: package in question will be installed, too, assuming they are
1759: present where you install from.</p>
1.128 wiz 1760: <p>Adding packages might install vulnerable packages.
1761: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1762: regularly, especially after installing new packages, and verify
1763: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1764: <p>After you've installed packages, be sure to have
1.88 wiz 1765: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1766: <code class="varname">PATH</code> so you can actually start the just
1767: installed program.</p>
1.75 rillig 1768: </div>
1.148 asau 1769: <div class="sect2">
1.75 rillig 1770: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1771: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1772: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1773: installed from source code or from a binary package. The
1.110 hubertf 1774: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1775: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1776: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1777: name can be given with or without version number. Wildcards can
1778: also be used to deinstall a set of packages, for example
1779: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1780: so that the shell does not expand them before
1781: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1782: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1783: removes all the packages that require the package in question
1784: and then removes the package itself. For example:
1.82 rillig 1785:
1.88 wiz 1786: </p>
1.82 rillig 1787: <pre class="screen">
1.88 wiz 1788: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1789: </pre>
1.82 rillig 1790: <p>
1791:
1.88 wiz 1792: will remove jpeg and all the packages that used it; this allows
1793: upgrading the jpeg package.</p>
1.82 rillig 1794: </div>
1.148 asau 1795: <div class="sect2">
1.82 rillig 1796: <div class="titlepage"><div><div><h3 class="title">
1797: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1798: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1799: installed packages or binary package files.</p>
1.82 rillig 1800: </div>
1.148 asau 1801: <div class="sect2">
1.82 rillig 1802: <div class="titlepage"><div><div><h3 class="title">
1803: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1804: <p>
1.88 wiz 1805: The NetBSD Security-Officer and Packages Groups maintain a list of
1806: known security vulnerabilities to packages which are (or have been)
1807: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1808: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88 wiz 1809: </p>
1.82 rillig 1810: <p>
1.125 wiz 1811: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1812: this list can be downloaded
1813: automatically, and a security audit of all packages installed on a system
1814: can take place.
1815: </p>
1.82 rillig 1816: <p>
1.125 wiz 1817: There are two components to auditing. The first
1818: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1819: is for downloading
1.88 wiz 1820: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1821: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1822: installed packages are vulnerable. If a package is vulnerable, you
1823: will see output similar to the following:
1824: </p>
1.82 rillig 1825: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1826: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1827: <p>
1.125 wiz 1828: You may wish to have the
1.110 hubertf 1829: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1830: file downloaded daily so that
1831: it remains current. This may be done by adding an appropriate entry
1.189 snj 1832: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1833: </p>
1834: <pre class="screen">
1835: # download vulnerabilities file
1836: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1837: </pre>
1838: <p>
1839: will update the vulnerability list every day at 3AM. You may wish to do
1840: this more often than once a day.
1841:
1842: In addition, you may wish to run the package audit from the daily
1843: security script. This may be accomplished by adding the following
1844: line to <code class="filename">/etc/security.local</code>:
1845: </p>
1846: <pre class="screen">
1847: /usr/sbin/pkg_admin audit
1848: </pre>
1849: <p>
1.88 wiz 1850: </p>
1.82 rillig 1851: </div>
1.148 asau 1852: <div class="sect2">
1.82 rillig 1853: <div class="titlepage"><div><div><h3 class="title">
1854: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1855: <p>
1.189 snj 1856: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128 wiz 1857: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1858: argument to check if your packages are up-to-date, e.g.
1859: </p>
1860: <pre class="screen">
1861: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1862: ...
1.88 wiz 1863: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1864: </pre>
1.110 hubertf 1865: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1866: package on your system and rebuild any dependencies.
1867: </p>
1.82 rillig 1868: </div>
1.148 asau 1869: <div class="sect2">
1.82 rillig 1870: <div class="titlepage"><div><div><h3 class="title">
1871: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1872: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1873: administrative functions on the package system.</p>
1.82 rillig 1874: </div>
1.148 asau 1875: <div class="sect2">
1.82 rillig 1876: <div class="titlepage"><div><div><h3 class="title">
1877: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1878: <p>Please pay very careful attention to the warnings
1.189 snj 1879: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88 wiz 1880: inherent dangers of installing binary packages which you did
1881: not create yourself, and the security holes that can be
1882: introduced onto your system by indiscriminate adding of such
1883: files.</p>
1.75 rillig 1884: <p>The same warning of course applies to every package you
1.88 wiz 1885: install from source when you haven't completely read and
1886: understood the source code of the package, the compiler that
1887: is used to build the package and all the other tools that are
1888: involved.</p>
1.75 rillig 1889: </div>
1890: </div>
1.148 asau 1891: <div class="sect1">
1.75 rillig 1892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1893: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1894: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1895: directory now contains a set of packages, organized into
1896: categories. You can browse the online index of packages, or run
1.110 hubertf 1897: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1898: directory to build local <code class="filename">README.html</code> files for
1.189 snj 1899: all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88 wiz 1900: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1901: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1902: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1903: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1904: different <code class="varname">LOCALBASE</code> definitions on the same
1905: system (inside a chroot is an exception). </p>
1906: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1907: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.88 wiz 1908: instructions how to create your own packages.</p>
1.148 asau 1909: <div class="sect2">
1.75 rillig 1910: <div class="titlepage"><div><div><h3 class="title">
1911: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1912: <p>To build packages from source, you need a working C
1.88 wiz 1913: compiler. On NetBSD, you need to install the
1.128 wiz 1914: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1915: sets. If you want to build X11-related packages, the
1.128 wiz 1916: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1917: sets are required, too.</p>
1.75 rillig 1918: </div>
1.148 asau 1919: <div class="sect2">
1.75 rillig 1920: <div class="titlepage"><div><div><h3 class="title">
1921: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1922: <p>The first step for building a package is downloading the
1.88 wiz 1923: distfiles (i.e. the unmodified source). If they have not yet been
1924: downloaded, pkgsrc will fetch them automatically.</p>
1925: <p>If you have all files that you need in the
1926: <code class="filename">distfiles</code> directory,
1927: you don't need to connect. If the distfiles are on CD-ROM, you can
1928: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1929: </p>
1.82 rillig 1930: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1931: <p>
1.110 hubertf 1932: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1933: <p>By default a list of distribution sites will be randomly
1934: intermixed to prevent huge load on servers which holding popular
1935: packages (for example, SourceForge.net mirrors). Thus, every
1936: time when you need to fetch yet another distfile all the mirrors
1937: will be tried in new (random) order. You can turn this feature
1938: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1939: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1940: <p>You can overwrite some of the major distribution sites to
1941: fit to sites that are close to your own. By setting one or two
1942: variables you can modify the order in which the master sites are
1943: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1944: delimited list of domain suffixes.
1945: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1946: contains a whitespace delimited list of regular expressions. It
1947: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1948: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1949: some examples. This may save some of your bandwidth and
1950: time.</p>
1.75 rillig 1951: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1952: if you want to keep the settings, by editing the
1.110 hubertf 1953: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1954: and adding the definitions there.</p>
1.82 rillig 1955: <p>
1.88 wiz 1956: If a package depends on many other packages (such as
1.189 snj 1957: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88 wiz 1958: alternate between periods of
1959: downloading source, and compiling. To ensure you have all the source
1960: downloaded initially you can run the command:
1961: </p>
1.82 rillig 1962: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1963: <p>
1.88 wiz 1964: which will output and run a set of shell commands to fetch the
1965: necessary files into the <code class="filename">distfiles</code> directory. You can
1966: also choose to download the files manually.
1967: </p>
1.75 rillig 1968: </div>
1.148 asau 1969: <div class="sect2">
1.75 rillig 1970: <div class="titlepage"><div><div><h3 class="title">
1971: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1972: <p>
1.88 wiz 1973: Once the software has downloaded, any patches will be applied, then it
1974: will be compiled for you. This may take some time depending on your
1975: computer, and how many other packages the software depends on and their
1976: compile time.
1977: </p>
1.148 asau 1978: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1979: <h3 class="title">Note</h3>
1980: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1981: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1982: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1983: </div>
1.87 wiz 1984: <p>For example, type</p>
1.88 wiz 1985: <pre class="screen">
1986: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1987: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1988: </pre>
1.75 rillig 1989: <p>at the shell prompt to build the various components of the
1.88 wiz 1990: package.</p>
1.82 rillig 1991: <p>The next stage is to actually install the newly compiled
1.88 wiz 1992: program onto your system. Do this by entering:
1.82 rillig 1993:
1.88 wiz 1994: </p>
1.82 rillig 1995: <pre class="screen">
1.88 wiz 1996: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1997: </pre>
1.82 rillig 1998: <p>
1999:
1.88 wiz 2000: while you are still in the directory for whatever package you
2001: are installing.</p>
1.82 rillig 2002: <p>Installing the package on your system may require you to
1.88 wiz 2003: be root. However, pkgsrc has a
2004: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2005: to only become root for the actual installation step.</p>
1.82 rillig 2006: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2007: You can now enter:
1.82 rillig 2008:
1.88 wiz 2009: </p>
1.82 rillig 2010: <pre class="screen">
1.88 wiz 2011: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2012: </pre>
1.82 rillig 2013: <p>
2014:
1.88 wiz 2015: to remove the compiled files in the work directory, as you shouldn't need
2016: them any more. If other packages were also added to your system
2017: (dependencies) to allow your program to compile, you can tidy these up
2018: also with the command:</p>
1.82 rillig 2019: <pre class="screen">
1.88 wiz 2020: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2021: </pre>
1.75 rillig 2022: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2023: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88 wiz 2024: <p>The program is installed under the default root of the
2025: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2026: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2027: variable in your environment, and it will use that value as the
2028: root of your packages tree. So, to use
2029: <code class="filename">/usr/local</code>, set
2030: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2031: Please note that you should use a directory which is dedicated to
2032: packages and not shared with other programs (i.e., do not try and
2033: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2034: to add any of your own files or directories (such as
2035: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2036: <code class="filename">pkgsrc/</code>) below the
2037: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2038: conflicts between programs and other files installed by the
2039: package system and whatever else may have been installed
2040: there.</p>
1.110 hubertf 2041: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2042: alter some configuration options at build time. Have a look at
2043: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2044: of what will be set there by default. Environment variables such
2045: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2046: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2047: set them each time you want to use pkgsrc.</p>
1.128 wiz 2048: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2049: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 2050: or being installed. This may be for debugging purposes, or out of
2051: simple curiosity. A number of utility values have been added to
2052: help with this.</p>
1.128 wiz 2053: <div class="orderedlist"><ol class="orderedlist" type="1">
2054: <li class="listitem">
1.189 snj 2055: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 2056: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2057: information will be displayed. For example,</p>
1.75 rillig 2058: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2059: <p>will show all the commands that are invoked, up to and
1.128 wiz 2060: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 2061: </li>
1.128 wiz 2062: <li class="listitem">
1.189 snj 2063: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2064: definition, then the <code class="varname">VARNAME</code> definition
2065: should be used, in conjunction with the show-var
1.189 snj 2066: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2067: variable <code class="varname">LOCALBASE</code>:</p>
2068: <pre class="screen">
2069: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2070: /usr/pkg
2071: <code class="prompt">%</code>
1.88 wiz 2072: </pre>
1.75 rillig 2073: </li>
2074: </ol></div>
2075: <p>If you want to install a binary package that you've either
1.88 wiz 2076: created yourself (see next section), that you put into
2077: pkgsrc/packages manually or that is located on a remote FTP
2078: server, you can use the "bin-install" target. This target will
1.189 snj 2079: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 2080: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2081: sites searched is kept in the variable
2082: <code class="varname">BINPKG_SITES</code>, which defaults to
1.189 snj 2083: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 2084: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2085: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2086: details.</p>
2087: <p>A final word of warning: If you set up a system that has a
2088: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2089: set that before any packages are installed, as you cannot use
2090: several directories for the same purpose. Doing so will result in
2091: pkgsrc not being able to properly detect your installed packages,
2092: and fail miserably. Note also that precompiled binary packages are
2093: usually built with the default <code class="varname">LOCALBASE</code> of
2094: <code class="filename">/usr/pkg</code>, and that you should
2095: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2096: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2097: </div>
2098: </div>
2099: </div>
1.148 asau 2100: <div class="chapter">
1.75 rillig 2101: <div class="titlepage"><div><div><h2 class="title">
2102: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2103: <div class="toc">
2104: <p><b>Table of Contents</b></p>
2105: <dl>
2106: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2107: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2108: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2109: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2110: <dd><dl>
1.103 wiz 2111: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2112: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2113: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 2114: </dl></dd>
1.103 wiz 2115: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2116: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2117: </dl>
2118: </div>
1.104 rillig 2119: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2120: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2121: that file depends on the installation. On NetBSD, when you use
1.189 snj 2122: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 2123: <code class="filename">/etc/</code>. In all other cases the default location is
2124: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2125: bootstrap program to install the binary packages.</p>
2126: <p>During the bootstrap, an example configuration file is created. To
2127: use that, you have to create the directory
2128: <code class="filename">${PREFIX}/etc</code> and copy the example file
2129: there.</p>
2130: <p>The format of the configuration file is that of the usual
2131: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2132: is done by setting variables in this file. Note that you can define all
2133: kinds of variables, and no special error checking (for example for
2134: spelling mistakes) takes place, so you have to try it out to see if it
2135: works.</p>
1.148 asau 2136: <div class="sect1">
1.75 rillig 2137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2138: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2139: <p>In this section, you can find some variables that apply to all
1.89 rillig 2140: pkgsrc packages. A complete list of the variables that can be
2141: configured by the user is available in
2142: <code class="filename">mk/defaults/mk.conf</code>, together with some
2143: comments that describe each variable's intent.</p>
1.148 asau 2144: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2145: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2146: packages will be installed. The default is
1.76 rillig 2147: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2148: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2149: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2150: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2151: installed. The default is
1.76 rillig 2152: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2153: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2154: X11 is installed on the system. The default is
1.76 rillig 2155: <code class="filename">/usr/X11R6</code>.</p></li>
1.128 wiz 2156: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2157: downloaded copies of the original source distributions used
2158: for building pkgsrc packages. The default is
1.76 rillig 2159: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2160: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2161: database about installed packages is stored. The default is
2162: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2163: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2164: If set, override the packages'
2165: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2166: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2167: Backup location(s) for distribution files and patch files
2168: if not found locally or in
1.76 rillig 2169: <code class="filename">${MASTER_SITES}</code> or
2170: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2171: The defaults are
1.132 spz 2172: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2173: and
1.76 rillig 2174: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2175: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2176: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2177: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2178: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2179: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2180: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2181: List of acceptable licenses. License names are case-sensitive.
2182: Whenever you try to build a package whose license is not in this
2183: list, you will get an error message. If the license condition is
2184: simple enough, the error message will include specific
2185: instructions on how to change this variable.</p></li>
1.75 rillig 2186: </ul></div>
2187: </div>
1.148 asau 2188: <div class="sect1">
1.75 rillig 2189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2190: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2191: <p>XXX
2192: </p>
1.148 asau 2193: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2194: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2195: directory for the binary packages. The default is
1.76 rillig 2196: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2197: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2198: The top level directory where, if defined, the separate
2199: working directories will get created, and symbolically
1.76 rillig 2200: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2201: This is useful for building packages on several
1.76 rillig 2202: architectures, then <code class="filename">${PKGSRCDIR}</code>
2203: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2204: is local to every architecture. (It should be noted that
2205: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2206: — it is an internal definition which refers to the
1.75 rillig 2207: root of the pkgsrc tree. It is possible to have many
2208: pkgsrc tree instances.)</p></li>
1.128 wiz 2209: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2210: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2211: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2212: information.</p></li>
1.128 wiz 2213: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2214: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2215: BSD-style Makefile. If this is not set,
2216: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2217: <code class="filename">/dev/null</code> to avoid picking up
2218: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2219: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2220: By default, dependencies are only installed, and no binary
2221: package is created for them. You can set this variable to
1.174 asau 2222: <code class="literal">package-install</code> to automatically create binary
1.190 wiz 2223: packages after installing dependencies. Please note that the
2224: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code>can be set to
2225: <code class="literal">yes</code> to preserve binary packages when
2226: using the <code class="literal">install</code> as well.</p></li>
1.75 rillig 2227: </ul></div>
2228: </div>
1.148 asau 2229: <div class="sect1">
1.75 rillig 2230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2231: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2232: <p>Most packages support installation into a
1.103 wiz 2233: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2234: to be built, before the actual filesystem is touched. DESTDIR
2235: support exists in two variations:</p>
1.148 asau 2236: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2237: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 2238: installation and packaging is still run as root.</p></li>
2239: <li class="listitem"><p>Full DESTDIR support can run the complete
2240: build, installation and packaging as normal user. Root
2241: privileges are only needed to add packages.</p></li>
2242: </ul></div>
2243: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2244: you can set
2245: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2246: so it's preferable to convert a package to DESTDIR instead.</p>
1.103 wiz 2247: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2248: clean</code></strong> needs to be run as root.</p>
1.118 imil 2249: <p>Considering the <code class="filename">foo/bar</code> package,
2250: DESTDIR full support can be tested using the following commands
2251:
2252: </p>
2253: <pre class="programlisting">
2254: <code class="prompt">$</code> id
2255: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2256: <code class="prompt">$</code> mkdir $HOME/packages
2257: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2258: </pre>
2259: <p>
2260:
2261: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2262: should be needed
2263:
2264: </p>
2265: <pre class="programlisting">
1.174 asau 2266: <code class="prompt">$</code> make stage-install
1.118 imil 2267: </pre>
2268: <p>
2269:
2270: Create a package without root privileges
2271:
2272: </p>
2273: <pre class="programlisting">
1.174 asau 2274: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 2275: </pre>
2276: <p>
2277:
2278: For the following command, you must be able to gain root
1.189 snj 2279: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 2280:
2281: </p>
2282: <pre class="programlisting">
1.174 asau 2283: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 2284: </pre>
2285: <p>
2286:
2287: Then, as a simple user
2288:
2289: </p>
2290: <pre class="programlisting">
2291: <code class="prompt">$</code> make clean
2292: </pre>
2293: <p>
2294:
2295: </p>
1.103 wiz 2296: </div>
1.148 asau 2297: <div class="sect1">
1.103 wiz 2298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2299: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 2300: <div class="sect2">
1.78 rillig 2301: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2302: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2303: <p>By default, pkgsrc will use GCC to build packages. This may be
2304: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 2305: <div class="variablelist"><dl class="variablelist">
1.89 rillig 2306: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2307: <dd>
2308: <p>This is a list of values specifying the chain of
2309: compilers to invoke when building packages. Valid values
2310: are:</p>
1.148 asau 2311: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 2312: <li class="listitem"><p><code class="varname">ccc</code>:
2313: Compaq C Compilers (Tru64)</p></li>
2314: <li class="listitem"><p><code class="varname">ccache</code>:
2315: compiler cache (chainable)</p></li>
2316: <li class="listitem"><p><code class="varname">clang</code>:
2317: Clang C and Objective-C compiler</p></li>
1.128 wiz 2318: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2319: distributed C/C++ (chainable)</p></li>
1.174 asau 2320: <li class="listitem"><p><code class="varname">f2c</code>:
2321: Fortran 77 to C compiler (chainable)</p></li>
2322: <li class="listitem"><p><code class="varname">icc</code>:
2323: Intel C++ Compiler (Linux)</p></li>
2324: <li class="listitem"><p><code class="varname">ido</code>:
2325: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 2326: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2327: GNU C/C++ Compiler</p></li>
1.174 asau 2328: <li class="listitem"><p><code class="varname">hp</code>:
2329: HP-UX C/aC++ compilers</p></li>
1.128 wiz 2330: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2331: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 2332: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 2333: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2334: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2335: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 2336: <li class="listitem"><p><code class="varname">xlc</code>:
2337: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89 rillig 2338: </ul></div>
2339: <p>The default is
1.128 wiz 2340: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2341: <code class="varname">ccache</code> and/or
2342: <code class="varname">distcc</code> with an appropriate
2343: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2344: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2345: variable should always be terminated with a value for
2346: a real compiler. Note that only one real compiler
1.128 wiz 2347: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2348: is not allowed).</p>
1.89 rillig 2349: </dd>
2350: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2351: <dd><p>This specifies the minimum version of GCC to use
2352: when building packages. If the system GCC doesn't
2353: satisfy this requirement, then pkgsrc will build and
2354: install one of the GCC packages to use instead.</p></dd>
2355: </dl></div>
2356: </div>
1.148 asau 2357: <div class="sect2">
1.89 rillig 2358: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2359: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 2360: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2361: please make sure to use the <code class="literal">+=</code> operator
2362: instead of the <code class="literal">=</code> operator:</p>
2363: <pre class="programlisting">
1.100 rillig 2364: CFLAGS+= -your -flags
1.78 rillig 2365: </pre>
2366: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2367: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2368: need to add their own flags. You may want to take a look
1.189 snj 2369: at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128 wiz 2370: package if you're interested in optimization specifically
2371: for the current CPU. </p>
1.78 rillig 2372: </div>
1.148 asau 2373: <div class="sect2">
1.88 wiz 2374: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2375: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 2376: <p>If you want to pass flags to the linker, both in the configure
2377: step and the build step, you can do this in two ways. Either set
2378: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2379: between the two is that <code class="varname">LIBS</code> will be appended to
2380: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2381: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2382: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2383: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2384: <code class="varname">CFLAGS</code>, if you do not wish to override these
2385: settings, use the <code class="literal">+=</code> operator:</p>
2386: <pre class="programlisting">
1.100 rillig 2387: LDFLAGS+= -your -linkerflags
1.88 wiz 2388: </pre>
2389: </div>
1.78 rillig 2390: </div>
1.148 asau 2391: <div class="sect1">
1.78 rillig 2392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2393: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2394: <p>XXX
2395: </p>
1.148 asau 2396: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2397: <li class="listitem">
1.75 rillig 2398: <p><code class="varname">PKG_DEVELOPER</code>:
2399: Run some sanity checks that package developers want:
2400: </p>
1.148 asau 2401: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2402: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2403: fuzz</p></li>
1.128 wiz 2404: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2405: binaries will find their shared libs.</p></li>
1.75 rillig 2406: </ul></div>
2407: <p>
1.87 wiz 2408: </p>
1.75 rillig 2409: </li>
1.128 wiz 2410: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2411: of debugging output which is displayed whilst making and
2412: installing the package. The default value for this is 0,
2413: which will not display the commands as they are executed
2414: (normal, default, quiet operation); the value 1 will display
2415: all shell commands before their invocation, and the value 2
2416: will display both the shell commands before their invocation,
1.110 hubertf 2417: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2418: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2419: </ul></div>
2420: <p>
2421: </p>
2422: </div>
1.148 asau 2423: <div class="sect1">
1.75 rillig 2424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2425: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2426: <p>Some packages have build time options, usually to select
2427: between different dependencies, enable optional support for big
2428: dependencies or enable experimental features.</p>
1.75 rillig 2429: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2430: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2431: show-options</strong></span>, for example:</p>
1.75 rillig 2432: <pre class="programlisting">
2433: The following options are supported by this package:
2434: ssl Enable SSL support.
2435: Exactly one of the following gecko options is required:
2436: firefox Use firefox as gecko rendering engine.
2437: mozilla Use mozilla as gecko rendering engine.
2438: At most one of the following database options may be selected:
2439: mysql Enable support for MySQL database.
2440: pgsql Enable support for PostgreSQL database.
1.1 grant 2441:
1.75 rillig 2442: These options are enabled by default: firefox
2443: These options are currently enabled: mozilla ssl
1.1 grant 2444: </pre>
1.75 rillig 2445: <p>The following variables can be defined in
1.110 hubertf 2446: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2447: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2448: which can be used to select or disable options for all packages
2449: that support them, and
2450: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2451: which can be used to select or disable options specifically for
2452: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2453: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2454: are disabled. A few examples:</p>
1.75 rillig 2455: <pre class="screen">
1.110 hubertf 2456: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75 rillig 2457: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2458: PKG_OPTIONS.kdebase= debug -sasl
2459: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2460: <p>It is important to note that options that were specifically
1.120 snj 2461: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2462: you do not wish to include the option. If you are unsure you can view
2463: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2464: <p>The following settings are consulted in the order given, and
2465: the last setting that selects or disables an option is
2466: used:</p>
1.128 wiz 2467: <div class="orderedlist"><ol class="orderedlist" type="1">
2468: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2469: maintainer</p></li>
1.128 wiz 2470: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2471: variables (see below)</p></li>
1.128 wiz 2472: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2473: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2474: </ol></div>
2475: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2476: selected is used, all others are automatically disabled. If an
2477: option of the group is explicitly disabled, the previously
2478: selected option, if any, is used. It is an error if no option
2479: from a required group of options is selected, and building the
2480: package will fail.</p>
2481: <p>Before the options framework was introduced, build options
2482: were selected by setting a variable (often named
2483: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2484: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2485: transition to the options framework for the user, these legacy
2486: variables are converted to the appropriate options setting
2487: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2488: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2489: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2490: directly. Support for the legacy variables will be removed
2491: eventually.</p>
1.75 rillig 2492: </div>
2493: </div>
1.148 asau 2494: <div class="chapter">
1.75 rillig 2495: <div class="titlepage"><div><div><h2 class="title">
2496: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2497: <div class="toc">
2498: <p><b>Table of Contents</b></p>
2499: <dl>
2500: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2501: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2502: </dl>
2503: </div>
1.148 asau 2504: <div class="sect1">
1.75 rillig 2505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2506: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2507: <p>Once you have built and installed a package, you can create
2508: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.189 snj 2509: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2510: the same package on a group of hosts and wasting CPU time. It also
2511: provides a simple means for others to install your package, should
2512: you distribute it.</p>
2513: <p>To create a binary package, change into the appropriate
1.110 hubertf 2514: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2515: package</strong></span>:</p>
2516: <pre class="screen">
2517: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2518: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2519: </pre>
2520: <p>This will build and install your package (if not already done),
2521: and then build a binary package from what was installed. You can
1.110 hubertf 2522: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2523: it. Binary packages are created by default in
2524: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2525: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.189 snj 2526: continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.110 hubertf 2527: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2528: such a binary package.</p>
1.75 rillig 2529: </div>
1.148 asau 2530: <div class="sect1">
1.75 rillig 2531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2532: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2533: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.106 rillig 2534: </div>
2535: </div>
1.148 asau 2536: <div class="chapter">
1.106 rillig 2537: <div class="titlepage"><div><div><h2 class="title">
2538: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2539: builds)</h2></div></div></div>
2540: <div class="toc">
2541: <p><b>Table of Contents</b></p>
2542: <dl>
1.180 wiz 2543: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2544: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2545: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2546: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 2547: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2548: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2549: </dl>
2550: </div>
1.180 wiz 2551: <p>For a number of reasons you may want to build binary packages
2552: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2553: For instance, when you have multiple machines that should run the same software,
2554: it is wasted time if they all build their packages themselves from source.
2555: Or you may want to build a list of packages you want and check them before
2556: deploying onto production system.
2557: There is a way of getting a set of binary packages:
1.174 asau 2558: The bulk build system, or pbulk ("p" stands for "parallel).
2559: This chapter describes how to set it up so that the packages
1.106 rillig 2560: are most likely to be usable later.</p>
1.148 asau 2561: <div class="sect1">
1.106 rillig 2562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2563: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2564: <p>First of all, you have to decide whether you build all packages
2565: or a limited set of them. Full bulk builds usually consume a lot more resources,
2566: both space and time, than builds for some practical sets of packages.
2567: There exists a number of particularly heavy packages that are not actually
2568: interesting to a wide audience.
2569:
2570: For a limited bulk builds you need to make a list of packages you want to build.
2571: Note, that all their dependencies will be built, so you don't need to track them manually.
2572: </p>
2573: <p>During bulk builds various packages are installed and deinstalled
2574: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2575: so make sure that you don't need any package during the builds.
2576: Essentially, you should provide fresh system, either a chroot environment
2577: or something even more restrictive, depending on what the operating system provides,
2578: or dedicate the whole physical machine.
2579: As a useful side effect this makes sure that bulk builds cannot
2580: break anything in your system. There have been numerous cases where
1.106 rillig 2581: certain packages tried to install files outside the
2582: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2583: <code class="filename">/etc</code>.
2584: </p>
1.106 rillig 2585: </div>
1.148 asau 2586: <div class="sect1">
1.106 rillig 2587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2588: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2589: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2590: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2591: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2592: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2593: </ul></div>
1.148 asau 2594: <div class="sect2">
1.116 rillig 2595: <div class="titlepage"><div><div><h3 class="title">
1.180 wiz 2596: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.178 asau 2597: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2598: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2599: Configure network access to fetch distribution files.
2600: Create user with name "pbulk".</p>
2601: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2602: <pre class="screen">
1.181 wiz 2603: <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>
2604: <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>
2605: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178 asau 2606: </pre>
2607: <p>Or any other way that fits (e.g., curl, wget).</p>
2608: <p>Deploy and configure pbulk tools, e.g.:</p>
2609: <pre class="screen">
2610: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2611: <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>
2612: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2613: </pre>
2614: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2615: <h3 class="title">Note</h3>
2616: <p><code class="filename">mk.conf.frag</code> is a fragment of
2617: <code class="filename">mk.conf</code> that contains settings you want to
2618: apply to packages you build. For instance,</p>
2619: <pre class="programlisting">
2620: PKG_DEVELOPER= yes # perform more checks
2621: X11_TYPE= modular # use pkgsrc X11
2622: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2623: </pre>
2624: </div>
2625: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2626: with your list of packages one per line without empty lines or comments. E.g.:</p>
2627: <pre class="programlisting">
2628: www/firefox
2629: mail/thunderbird
2630: misc/libreoffice4
2631: </pre>
1.179 asau 2632: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2633: and make final amendments, if wanted.</p>
1.178 asau 2634: <p>Start it:</p>
2635: <pre class="screen">
2636: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2637: </pre>
2638: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2639: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2640: </p>
2641: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2642: <h3 class="title">Note</h3>
2643: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2644: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2645: The script is kept small enough for better understanding.</p>
2646: </div>
2647: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2648: <h3 class="title">Note</h3>
2649: <p>The <code class="filename">pbulk.sh</code> script supports running
2650: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2651: </div>
1.106 rillig 2652: </div>
2653: </div>
1.148 asau 2654: <div class="sect1">
1.106 rillig 2655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2656: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2657: <p>A complete bulk build requires lots of disk space. Some of the
2658: disk space can be read-only, some other must be writable. Some can be on
2659: remote filesystems (such as NFS) and some should be local. Some can be
2660: temporary filesystems, others must survive a sudden reboot.</p>
2661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2662: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2663: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2664: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2665: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2666: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2667: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2668: </ul></div>
2669: </div>
2670: <div class="sect1">
2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2672: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2673: <p>After your pkgsrc bulk-build has completed, you may wish to
2674: create a CD-ROM set of the resulting binary packages to assist
2675: in installing packages on other machines. The
1.189 snj 2676: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87 wiz 2677: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2678: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2679: way that keeps all the dependencies for a given package on the same
2680: CD as that package.</p>
1.148 asau 2681: <div class="sect2">
1.75 rillig 2682: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2683: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2684: <p>Complete documentation for cdpack is found in the cdpack(1)
2685: man page. The following short example assumes that the binary
2686: packages are left in
2687: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2688: sufficient disk space exists in <code class="filename">/u2</code> to
2689: hold the ISO 9660 images.</p>
2690: <pre class="screen">
2691: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2692: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2693: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2694: </pre>
2695: <p>If you wish to include a common set of files
2696: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2697: etc.) on each CD in the collection, then you need to create a
2698: directory which contains these files. e.g.</p>
2699: <pre class="screen">
2700: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2701: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2702: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2703: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2704: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2705: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2706: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2707: </pre>
1.75 rillig 2708: <p>Now create the images:</p>
2709: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76 rillig 2710: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2711: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2712: in their root directories.</p>
1.75 rillig 2713: </div>
2714: </div>
2715: </div>
1.148 asau 2716: <div class="chapter">
1.75 rillig 2717: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2718: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2719: <div class="toc">
2720: <p><b>Table of Contents</b></p>
2721: <dl>
1.128 wiz 2722: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2723: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90 rillig 2724: </dl>
2725: </div>
2726: <p>The files that are installed by pkgsrc are organized in a way that
2727: is similar to what you find in the <code class="filename">/usr</code> directory
2728: of the base system. But some details are different. This is because
2729: pkgsrc initially came from FreeBSD and had adopted its file system
2730: hierarchy. Later it was largely influenced by NetBSD. But no matter
2731: which operating system you are using pkgsrc with, you can expect the
2732: same layout for pkgsrc.</p>
1.91 rillig 2733: <p>There are mainly four root directories for pkgsrc, which are all
2734: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2735: When pkgsrc has been installed as root, the default locations
2736: are:</p>
2737: <pre class="programlisting">
1.100 rillig 2738: LOCALBASE= /usr/pkg
2739: PKG_SYSCONFBASE= /usr/pkg/etc
2740: VARBASE= /var
2741: PKG_DBDIR= /var/db/pkg
1.91 rillig 2742: </pre>
2743: <p>In unprivileged mode (when pkgsrc has been installed as any other
2744: user), the default locations are:</p>
2745: <pre class="programlisting">
1.100 rillig 2746: LOCALBASE= ${HOME}/pkg
2747: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2748: VARBASE= ${HOME}/pkg/var
2749: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 2750: </pre>
2751: <p>What these four directories are for, and what they look like is
2752: explained below.</p>
1.148 asau 2753: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2754: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2755: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2756: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2757: the well-known subdirectories like <code class="filename">bin</code>,
2758: <code class="filename">include</code>, <code class="filename">lib</code>,
2759: <code class="filename">share</code> and
2760: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2761: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2762: <code class="filename">/var</code> in the base system. Some programs (especially
2763: games, network daemons) need write access to it during normal
2764: operation.</p></li>
1.128 wiz 2765: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2766: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2767: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 2768: itself.</p></li>
2769: </ul></div>
1.148 asau 2770: <div class="sect1">
1.90 rillig 2771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2772: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2773: </h2></div></div></div>
1.90 rillig 2774: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2775: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2776: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2777: <dt><span class="term"><code class="filename">bin</code></span></dt>
2778: <dd><p>Contains executable programs that are intended to be
2779: directly used by the end user.</p></dd>
2780: <dt><span class="term"><code class="filename">emul</code></span></dt>
2781: <dd><p>Contains files for the emulation layers of various other
2782: operating systems, especially for
2783: NetBSD.</p></dd>
2784: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2785: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2786: <dd><p>Contains
2787: the configuration files.</p></dd>
2788: <dt><span class="term"><code class="filename">include</code></span></dt>
2789: <dd><p>Contains headers for the C and C++ programming
2790: languages.</p></dd>
2791: <dt><span class="term"><code class="filename">info</code></span></dt>
2792: <dd><p>Contains GNU info files of various
2793: packages.</p></dd>
2794: <dt><span class="term"><code class="filename">lib</code></span></dt>
2795: <dd><p>Contains shared and static
2796: libraries.</p></dd>
2797: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2798: <dd><p>Contains data files that don't change after
2799: installation. Other data files belong into
2800: <code class="filename">${VARBASE}</code>.</p></dd>
2801: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2802: <dd><p>Contains programs that are not intended to be used by
2803: end users, such as helper programs or network
2804: daemons.</p></dd>
2805: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2806: <dd><p>Contains programs that are intended to be executed as
2807: CGI scripts by a web server.</p></dd>
2808: <dt><span class="term"><code class="filename">man</code> (the usual value of
2809: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2810: <dd><p>Contains brief
2811: documentation in form of manual pages.</p></dd>
2812: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2813: <dd><p>Contains programs that are intended to be used only by
2814: the super-user.</p></dd>
2815: <dt><span class="term"><code class="filename">share</code></span></dt>
2816: <dd><p>Contains platform-independent data files that don't
2817: change after installation.</p></dd>
2818: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2819: <dd><p>Contains documentation files provided by the
2820: packages.</p></dd>
2821: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2822: <dd><p>Contains example files provided by the packages. Among
2823: others, the original configuration files are saved here and copied to
2824: <code class="filename">${PKG_SYSCONFDIR}</code> during
2825: installation.</p></dd>
2826: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2827: <dd><p>Contains the original files for rc.d
2828: scripts.</p></dd>
2829: <dt><span class="term"><code class="filename">var</code> (the usual location of
2830: <code class="filename">${VARBASE}</code>)</span></dt>
2831: <dd><p>Contains files
2832: that may be modified after
2833: installation.</p></dd>
2834: </dl></div>
2835: </div>
1.148 asau 2836: <div class="sect1">
1.90 rillig 2837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2838: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2839: </h2></div></div></div>
1.148 asau 2840: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2841: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2842: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2843: <dd><p>Contains
2844: information about the currently installed
2845: packages.</p></dd>
2846: <dt><span class="term"><code class="filename">games</code></span></dt>
2847: <dd><p>Contains highscore
2848: files.</p></dd>
2849: <dt><span class="term"><code class="filename">log</code></span></dt>
2850: <dd><p>Contains log files.</p></dd>
2851: <dt><span class="term"><code class="filename">run</code></span></dt>
2852: <dd><p>Contains informational files about daemons that are
2853: currently running.</p></dd>
2854: </dl></div>
2855: </div>
2856: </div>
1.148 asau 2857: <div class="chapter">
1.90 rillig 2858: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2859: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2860: <div class="toc">
2861: <p><b>Table of Contents</b></p>
2862: <dl>
1.106 rillig 2863: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.193 ! dholland 2864: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
! 2865: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
! 2866: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
! 2867: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
! 2868: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
! 2869: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
! 2870: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
! 2871: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
! 2872: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
! 2873: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2874: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.193 ! dholland 2875: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
! 2876: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
! 2877: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
! 2878: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
! 2879: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
! 2880: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
! 2881: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 2882: </dl>
2883: </div>
2884: <p>This section contains hints, tips & tricks on special things in
2885: pkgsrc that we didn't find a better place for in the previous chapters, and
2886: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2887: <div class="sect1">
1.75 rillig 2888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2889: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2890: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2891: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2892: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 2893: This is a general purpose list for most issues regarding
2894: pkgsrc, regardless of platform, e.g. soliciting user help
2895: for pkgsrc configuration, unexpected build failures, using
2896: particular packages, upgrading pkgsrc installations,
2897: questions regarding the pkgsrc release branches, etc. General announcements or
2898: proposals for changes that impact the pkgsrc user community,
2899: e.g. major infrastructure changes, new features, package
2900: removals, etc., may also be posted.</p></li>
1.128 wiz 2901: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 2902: A list where the results of pkgsrc bulk builds are sent and
2903: discussed.</p></li>
1.128 wiz 2904: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 2905: This list is for those who are interested in getting a
2906: commit message for every change committed to pkgsrc. It is
2907: also available in digest form, meaning one daily message
2908: containing all commit messages for changes to the package
2909: source tree in that 24 hour period.</p></li>
2910: </ul></div>
2911: <p>To subscribe, do:</p>
2912: <pre class="programlisting">
1.100 rillig 2913: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2914: </pre>
2915: <p>Archives for all these mailing lists are available from
1.110 hubertf 2916: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2917: </div>
1.148 asau 2918: <div class="sect1">
1.75 rillig 2919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 2920: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
! 2921: <p>Pkgviews is tightly integrated with buildlink. You can find a
! 2922: pkgviews User's guide in
! 2923: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
! 2924: </div>
! 2925: <div class="sect1">
! 2926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 2927: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2928: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2929: a number of useful utilities for both users and developers of pkgsrc. This
2930: section attempts only to make the reader aware of the utilities and when
2931: they might be useful, and not to duplicate the documentation that comes
2932: with each package.</p>
2933: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.189 snj 2934: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75 rillig 2935: Symlinks for use by buildlink.</p></li></ul></div>
2936: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2937: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2938: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75 rillig 2939: Calculates various kinds of checksums (including SHA1).</p></li>
1.189 snj 2940: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75 rillig 2941: Compatibility library for pkgsrc tools.</p></li>
1.189 snj 2942: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87 wiz 2943: non-BSD systems due to lack of native mtree.</p></li>
1.189 snj 2944: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75 rillig 2945: Up-to-date replacement for
1.76 rillig 2946: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2947: systems where pkg_install is not present.</p></li>
2948: </ul></div>
2949: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2951: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75 rillig 2952: Create a binary package from an
1.110 hubertf 2953: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2954: save the old package.</p></li>
1.189 snj 2955: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75 rillig 2956: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2957: from multiple locations. It currently supports the following
2958: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.189 snj 2959: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117 jnemeth 2960: the best compiler flags to optimise code for your current
1.128 wiz 2961: CPU and compiler. </p></li>
1.75 rillig 2962: </ul></div>
2963: <p>Utilities for keeping track of installed packages, being up to date,
2964: etc:</p>
1.148 asau 2965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2966: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173 wiz 2967: update tool similar to apt(1). Download, install, and upgrade
2968: binary packages easily.</p></li>
1.189 snj 2969: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75 rillig 2970: packages whose installed versions do not match the latest pkgsrc
2971: entries.</p></li>
1.189 snj 2972: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75 rillig 2973: dependency graphs of packages, to aid in choosing a strategy for
2974: updating.</p></li>
1.189 snj 2975: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2976: graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2977: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112 weinem 2978: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.189 snj 2979: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75 rillig 2980: does various checks on the complete pkgsrc system.</p></li>
1.189 snj 2981: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75 rillig 2982: packages you have installed.</p></li>
2983: </ul></div>
2984: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2985: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2986: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75 rillig 2987: making and maintaining patches for a package (includes pkgdiff,
2988: pkgvi, mkpatches, etc.).</p></li>
1.189 snj 2989: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75 rillig 2990: converting to pkgsrc.</p></li>
2991: </ul></div>
2992: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2993: utilities)</p>
1.148 asau 2994: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2995: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75 rillig 2996: packages in a chrooted area.</p></li>
1.189 snj 2997: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75 rillig 2998: kernel version for chrooted cross builds.</p></li>
2999: </ul></div>
3000: </div>
1.148 asau 3001: <div class="sect1">
1.75 rillig 3002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3003: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3004: <p>If you want to use pkgsrc as non-root user, you can set some
3005: variables to make pkgsrc work under these conditions. At the very least,
1.128 wiz 3006: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 3007: will turn on unprivileged mode and set multiple related variables to allow
3008: installation of packages as non-root.</p>
3009: <p>In case the defaults are not enough, you may want to tune some other
3010: variables used. For example, if the automatic user/group detection leads
3011: to incorrect values (or not the ones you would like to use), you can change
3012: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3013: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3014: <p>As regards bootstrapping, please note that the
1.110 hubertf 3015: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3016: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3017: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3018: installation targets. These directories can be overridden by the
1.128 wiz 3019: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3020: that allow finer tuning of the tree layout.</p>
3021: </div>
1.148 asau 3022: <div class="sect1">
1.75 rillig 3023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3024: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3025: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3026: enable this feature by adding the option
3027: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3028: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3029: distfile is found, pkgsrc will try to resume it.</p>
3030: <p>You can also
1.168 wiz 3031: use a different program than the platform default program by changing the
1.117 jnemeth 3032: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3033: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3034: by using the value manual. A value of custom disables the system defaults
3035: and dependency tracking for the fetch program. In that case you have to
3036: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3037: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3038: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3039: <p>For example, if you want to use
1.117 jnemeth 3040: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3041: like:</p>
3042: <pre class="programlisting">
1.117 jnemeth 3043: FETCH_USING= wget
1.1 grant 3044: </pre>
1.75 rillig 3045: </div>
1.148 asau 3046: <div class="sect1">
1.75 rillig 3047: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3048: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 3049: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3050: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3051: you will have to add the following line into
1.110 hubertf 3052: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3053: <pre class="programlisting">
1.103 wiz 3054: X11_TYPE=modular
1.1 grant 3055: </pre>
1.148 asau 3056: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3057: <h3 class="title">Note</h3>
1.103 wiz 3058: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3059: </p>
1.75 rillig 3060: </div>
3061: </div>
1.148 asau 3062: <div class="sect1">
1.75 rillig 3063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3064: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3065: <p>If you are sitting behind a firewall which does not allow direct
3066: connections to Internet hosts (i.e. non-NAT), you may specify the
3067: relevant proxy hosts. This is done using an environment variable in the
3068: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 3069: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3070: port 80 as the proxy port number. So the proxy environment variables
3071: are:</p>
3072: <pre class="programlisting">
1.100 rillig 3073: ftp_proxy=ftp://orpheus.amdahl.com:80/
3074: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3075: </pre>
1.75 rillig 3076: </div>
1.148 asau 3077: <div class="sect1">
1.75 rillig 3078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3079: <a name="fetch-https"></a>9.8. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 3080: <p>Some fetch tools are not prepared to support HTTPS by default
3081: (for example, the one in NetBSD 6.0), or the one installed by the
3082: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3083: dependency graph).</p>
3084: <p>Usually you won't notice, because distribution files are
3085: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3086: be often enough if you are following pkgsrc-current. In that case, set
3087: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3088: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3089: with HTTPS support by default. Of course, these tools need to be
3090: installed before you can use them this way.</p>
3091: </div>
3092: <div class="sect1">
3093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3094: <a name="passive-ftp"></a>9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3095: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3096: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3097: the first available command from the following list:</p>
1.148 asau 3098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3099: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3100: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3101: </ul></div>
3102: <p>On a default NetBSD installation, this will be
1.76 rillig 3103: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3104: connections first, and falls back to active connections if the server
3105: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3106: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3107: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3108: <p>Having that option present will prevent
1.76 rillig 3109: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3110: transfers.</p>
3111: </div>
1.148 asau 3112: <div class="sect1">
1.75 rillig 3113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3114: <a name="fetching-all-distfiles"></a>9.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3115: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3116: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3117: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 3118: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3119: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3120: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3121: resulting list to your machine at work/school and use it there. If you
1.189 snj 3122: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 3123: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3124: URL:</p>
3125: <p>At home:</p>
3126: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3127: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3128: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3129: <p>At work:</p>
3130: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3131: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3132: home.</p>
3133: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3134: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3135: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3136: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3137: directly by running:</p>
1.75 rillig 3138: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3139: <p>If you even decide to ignore
3140: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3141: by running:</p>
3142: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3143: </div>
1.148 asau 3144: <div class="sect1">
1.75 rillig 3145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3146: <a name="tmac.andoc-missing"></a>9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 3147: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.189 snj 3148: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75 rillig 3149: package, you get the error from make that it doesn't know how to make
1.76 rillig 3150: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3151: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3152: the NetBSD base distribution on your machine. It is recommended to do
3153: that to format man pages.</p>
1.189 snj 3154: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75 rillig 3155: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3156: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3157: </div>
1.148 asau 3158: <div class="sect1">
1.75 rillig 3159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3160: <a name="bsd.own.mk-missing"></a>9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.87 wiz 3161: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3162: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3163: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3164: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3165: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3166: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3167: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3168: -r</strong></span>).</p>
3169: </div>
1.148 asau 3170: <div class="sect1">
1.75 rillig 3171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3172: <a name="using-sudo-with-pkgsrc"></a>9.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3173: <p>When installing packages as non-root user and using the just-in-time
1.189 snj 3174: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75 rillig 3175: password for each required package installed. To avoid this, the sudo
3176: package can be used, which does password caching over a limited time. To
3177: use it, install sudo (either as binary package or from
1.189 snj 3178: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110 hubertf 3179: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3180: <span class="emphasis"><em>after</em></span> the definition of the
3181: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3182: <pre class="programlisting">
1.100 rillig 3183: .if exists(${LOCALBASE}/bin/sudo)
3184: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3185: .endif
1.1 grant 3186: </pre>
1.75 rillig 3187: </div>
1.148 asau 3188: <div class="sect1">
1.75 rillig 3189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3190: <a name="faq.conf"></a>9.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3191: <p>As the system administrator, you can choose where configuration files
3192: are installed. The default settings make all these files go into
1.76 rillig 3193: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3194: be suboptimal depending on your expectations (e.g., a read-only,
3195: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3196: configuration of the provided packages).</p>
3197: <p>In order to change the defaults, you can modify the
3198: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3199: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3200: directory; some common examples include <code class="filename">/etc</code> or
3201: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3202: <p>Furthermore, you can change this value on a per-package basis by
3203: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3204: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3205: package you would like to modify, that is, the contents of
3206: <code class="varname">PKGBASE</code>.</p>
3207: <p>Note that after changing these settings, you must rebuild and
3208: reinstall any affected packages.</p>
3209: </div>
1.148 asau 3210: <div class="sect1">
1.75 rillig 3211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3212: <a name="audit-packages"></a>9.15. Automated security checks</h2></div></div></div>
1.75 rillig 3213: <p>Please be aware that there can often be bugs in third-party software,
3214: and some of these bugs can leave a machine vulnerable to exploitation by
3215: attackers. In an effort to lessen the exposure, the NetBSD packages team
3216: maintains a database of known-exploits to packages which have at one time
3217: been included in pkgsrc. The database can be downloaded automatically, and
3218: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3219: do this, refer to the following two tools (installed as part of the
1.189 snj 3220: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128 wiz 3221: <div class="orderedlist"><ol class="orderedlist" type="1">
3222: <li class="listitem">
1.122 reed 3223: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3224: download a list of the security vulnerabilities information. This list
1.132 spz 3225: is kept up to date by the pkgsrc security team, and is distributed
3226: from the NetBSD ftp server:</p>
3227: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.75 rillig 3228: </li>
1.128 wiz 3229: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3230: current machine, checking each known vulnerability. If a
1.75 rillig 3231: vulnerable package is installed, it will be shown by output to stdout,
3232: including a description of the type of vulnerability, and a URL
3233: containing more information.</p></li>
3234: </ol></div>
1.114 jmcneill 3235: <p>Use of these tools is strongly recommended! After
1.128 wiz 3236: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3237: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3238: pkg_install</code></strong>.</p>
1.87 wiz 3239: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3240: perform a security check before building any package. See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, “Variables affecting the build process”</a> for ways to control this
1.87 wiz 3241: check.</p>
1.75 rillig 3242: </div>
1.148 asau 3243: <div class="sect1">
1.75 rillig 3244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3245: <a name="ufaq-cflags"></a>9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3246: <p>When you add your own preferences to the
3247: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3248: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3249: environment variables to the <code class="filename">./configure</code>
1.189 snj 3250: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3251: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3252: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3253: package.</p>
3254: <p>Currently there is no solution to this problem. If you
3255: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3256: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3257: directory and then inspect any <code class="filename">Makefile</code> and
3258: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3259: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3260: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3261: programmers write so bad code that it only works for the
3262: specific combination of <code class="varname">CFLAGS</code> they have
3263: chosen.</p>
3264: </div>
1.148 asau 3265: <div class="sect1">
1.80 rillig 3266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3267: <a name="ufaq-fail"></a>9.17. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3268: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3269: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3270: case that occurs often is that people only update pkgsrc in
3271: parts, because of performance reasons. Since pkgsrc is one large
3272: system, not a collection of many small systems, there are
3273: sometimes changes that only work when the whole pkgsrc tree is
3274: updated.</p></li>
1.148 asau 3275: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3276: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3277: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3278: files.</p></li>
1.148 asau 3279: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3280: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3281: verify this.</p></li>
1.148 asau 3282: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3283: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3284: </ol></div>
3285: </div>
1.148 asau 3286: <div class="sect1">
1.88 wiz 3287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.193 ! dholland 3288: <a name="faq.rcs-conflicts"></a>9.18. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.89 rillig 3289: <p>You have modified a file from pkgsrc, and someone else has
3290: modified that same file afterwards in the CVS repository. Both changes
3291: are in the same region of the file, so when you updated pkgsrc, the
3292: <code class="literal">cvs</code> command marked the conflicting changes in the
3293: file. Because of these markers, the file is no longer a valid
3294: <code class="filename">Makefile</code>.</p>
3295: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3296: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3297: -dP</strong></span> in that directory to download the current version.</p>
3298: </div>
1.75 rillig 3299: </div>
3300: </div>
1.148 asau 3301: <div class="part">
1.75 rillig 3302: <div class="titlepage"><div><div><h1 class="title">
3303: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3304: <div class="partintro">
1.77 rillig 3305: <div></div>
3306: <p>This part of the book deals with creating and
1.128 wiz 3307: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3308: guide on creating a new package. The remaining chapters are more
3309: like a reference manual for pkgsrc.</p>
1.75 rillig 3310: <div class="toc">
3311: <p><b>Table of Contents</b></p>
3312: <dl>
1.106 rillig 3313: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3314: <dd><dl>
1.106 rillig 3315: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3316: <dd><dl>
1.106 rillig 3317: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3318: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3319: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3320: </dl></dd>
1.106 rillig 3321: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3322: <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>
3323: </dl></dd>
3324: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3325: <dd><dl>
1.128 wiz 3326: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3327: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3328: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3329: <dd><dl>
3330: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3331: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3332: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3333: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3334: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3335: </dl></dd>
3336: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3337: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3338: <dd><dl>
3339: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3340: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3341: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3342: </dl></dd>
1.128 wiz 3343: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3344: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3345: </dl></dd>
1.128 wiz 3346: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3347: <dd><dl>
3348: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3349: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3350: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3351: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3352: <dd><dl>
3353: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3354: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3355: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3356: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3357: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3358: </dl></dd>
3359: </dl></dd>
3360: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3361: <dd><dl>
3362: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 3363: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3364: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 3365: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3366: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 3367: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106 rillig 3368: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3369: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3370: </dl></dd>
3371: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3372: <dd><dl>
3373: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 3374: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3375: <dd><dl>
3376: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 3377: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3378: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3379: and
3380: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3381: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3382: </dl></dd>
1.128 wiz 3383: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 3384: <dd><dl>
1.128 wiz 3385: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 3386: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3387: </dl></dd>
3388: </dl></dd>
3389: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3390: <dd><dl>
3391: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3392: <dd><dl>
3393: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3394: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3395: </dl></dd>
3396: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3397: <dd><dl>
1.128 wiz 3398: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 3399: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3400: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3401: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3402: </dl></dd>
3403: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3404: <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>
3405: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3406: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3407: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3408: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3409: <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>
3410: </dl></dd>
3411: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3412: <dd><dl>
3413: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3414: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 3415: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3416: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3417: </dl></dd>
3418: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3419: <dd><dl>
3420: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3421: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3422: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3423: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3424: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 3425: <dd><dl>
3426: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3427: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3428: </dl></dd>
1.128 wiz 3429: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3430: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3431: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3432: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3433: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3434: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3435: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3436: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3437: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3438: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 3439: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3440: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3441: </dl></dd>
3442: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3443: <dd><dl>
3444: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3445: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3446: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3447: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3448: </dl></dd>
3449: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3450: <dd><dl>
3451: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3452: <dd><dl>
3453: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3454: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 3455: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3456: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3457: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3458: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3459: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3460: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3461: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3462: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3463: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3464: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3465: </dl></dd>
1.128 wiz 3466: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 3467: <dd><dl>
3468: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3469: <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>
3470: </dl></dd>
1.128 wiz 3471: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 3472: <dd><dl>
3473: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3474: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3475: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3476: </dl></dd>
3477: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3478: <dd><dl>
3479: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3480: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3481: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 3482: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3483: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 3484: </dl></dd>
1.128 wiz 3485: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 3486: <dd><dl>
3487: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3488: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3489: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.106 rillig 3490: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3491: </dl></dd>
1.128 wiz 3492: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 3493: <dd><dl>
3494: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3495: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3496: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3497: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3498: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3499: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3500: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3501: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3502: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3503: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3504: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3505: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3506: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3507: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3508: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3509: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3510: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3511: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3512: emulation</a></span></dt>
1.106 rillig 3513: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3514: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3515: </dl></dd>
1.106 rillig 3516: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3517: </dl></dd>
1.106 rillig 3518: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3519: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3520: <dd><dl>
1.106 rillig 3521: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3522: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3523: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 3524: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3525: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3526: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3527: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3528: </dl></dd>
3529: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3530: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3531: <dd><dl>
3532: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3533: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3534: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3535: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3536: </dl></dd>
1.75 rillig 3537: </dl>
3538: </div>
1.77 rillig 3539: </div>
1.148 asau 3540: <div class="chapter">
1.77 rillig 3541: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3542: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3543: <div class="toc">
3544: <p><b>Table of Contents</b></p>
3545: <dl>
1.106 rillig 3546: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3547: <dd><dl>
1.106 rillig 3548: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3549: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3550: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3551: </dl></dd>
1.106 rillig 3552: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3553: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91 rillig 3554: </dl>
3555: </div>
1.77 rillig 3556: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3557: most likely have a URL from where you can download the source
3558: code. Starting with this URL, creating a package involves only a
3559: few steps.</p>
1.128 wiz 3560: <div class="procedure"><ol class="procedure" type="1">
1.189 snj 3561: <li class="step"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148 asau 3562: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3563: category in which you want to place your package. You can also create a
3564: directory of your own (maybe called <code class="filename">local</code>). In that
3565: category directory, create another directory for your package and change
3566: into it.</p></li>
1.148 asau 3567: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3568: you for a URL. Enter the URL of the distribution file (in most cases a
3569: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3570: of your package are created automatically. The distribution file is
3571: extracted automatically to fill in some details in the
3572: <code class="filename">Makefile</code> that would otherwise have to be done
3573: manually.</p></li>
1.148 asau 3574: <li class="step">
1.91 rillig 3575: <p>Examine the extracted files to determine the dependencies of
3576: your package. Ideally, this is mentioned in some
3577: <code class="filename">README</code> file, but things may differ. For each of
3578: these dependencies, look where it exists in pkgsrc, and if there is a
3579: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3580: line to your package <code class="filename">Makefile</code> which includes that
3581: file just before the last line. If the
1.132 spz 3582: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3583: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3584: <p>If you just need binaries from a package, add a
1.91 rillig 3585: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3586: version of the dependency and where it can be found in pkgsrc. This line
3587: should be placed in the third paragraph. If the dependency is only
3588: needed for building the package, but not when using it, use
3589: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3590: Your package may then look like this:</p>
1.77 rillig 3591: <pre class="programlisting">
1.100 rillig 3592: [...]
1.77 rillig 3593:
1.174 asau 3594: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3595: DEPENDS+= screen-[0-9]*:../../misc/screen
3596: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3597:
1.100 rillig 3598: [...]
1.77 rillig 3599:
1.100 rillig 3600: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3601: .include "../../devel/glib2/buildlink3.mk"
3602: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3603: </pre>
3604: </li>
1.148 asau 3605: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3606: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.110 hubertf 3607: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3608: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3609: -e</strong></span>, which outputs additional
3610: explanations.</p></li>
1.148 asau 3611: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3612: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, “Common types of packages”</a>. After you have followed the instructions
1.91 rillig 3613: over there, you can hopefully continue here.</p></li>
1.148 asau 3614: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3615: directory from the extracted files. Besides these files, a lot of cache
3616: files and other system information has been saved in the working
3617: directory, which may become wrong after you edited the
3618: <code class="filename">Makefile</code>.</p></li>
1.148 asau 3619: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3620: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.148 asau 3621: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3622: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3623: everything works.</p></li>
1.148 asau 3624: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3625: contains a list of the files that are installed by the package, is
1.110 hubertf 3626: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3627: >PLIST</strong></span> to generate a probably correct list. Check
3628: the file using your preferred text editor to see if the list of
3629: files looks plausible.</p></li>
1.148 asau 3630: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3631: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3632: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3633: has been registered in the database of installed files, but with an
1.110 hubertf 3634: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3635: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3636: registered with the list of files from
3637: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3638: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3639: package from the set of installed files.</p></li>
1.77 rillig 3640: </ol></div>
1.148 asau 3641: <div class="sect1">
1.91 rillig 3642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3643: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3644: <div class="sect2">
1.91 rillig 3645: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3646: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3647: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3648: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3649: </div>
1.148 asau 3650: <div class="sect2">
1.91 rillig 3651: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 3652: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3653: <p>KDE3 applications should always include
1.91 rillig 3654: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174 asau 3655: settings that are typical of KDE3 packages.</p>
1.91 rillig 3656: </div>
1.148 asau 3657: <div class="sect2">
1.118 imil 3658: <div class="titlepage"><div><div><h3 class="title">
3659: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3660: <p>Python modules and programs packages are easily created using a
3661: set of predefined variables.</p>
3662: <p>
1.171 wiz 3663: If some Python versions are not supported by the software, set the
3664: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3665: that are not supported, e.g.
1.118 imil 3666: </p>
3667: <pre class="programlisting">
1.172 wiz 3668: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.118 imil 3669: </pre>
3670: <p>
3671: If the packaged software is a Python module, include
1.128 wiz 3672: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3673: In this case, the package directory should be called
1.128 wiz 3674: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3675: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3676: </p>
3677: <pre class="programlisting">
3678: DISTNAME= foopymodule-1.2.10
3679: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3680: </pre>
1.171 wiz 3681: <p>If it is an application, include
3682: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3683: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3684: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3685: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3686: For example:
1.118 imil 3687: </p>
3688: <pre class="programlisting">
1.142 wiz 3689: REPLACE_PYTHON= *.py
1.118 imil 3690: </pre>
1.171 wiz 3691: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3692: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3693: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3694: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3695: so pkgsrc will use this framework.
3696: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3697: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3698: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3699: to the name of the script.</p>
3700: <p>Otherwise, if the packaged software is egg-aware, you only need
3701: to include
3702: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3703: <p>Some Python modules have separate distributions for Python-2.x
3704: and Python-3.x support. In pkgsrc this is handled by the
3705: <code class="filename">versioned_dependencies.mk</code> file. Set
3706: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3707: packages that should be depended upon and include
3708: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3709: then the pkgsrc infrastructure will depend on the appropriate package
3710: version. For example:
3711: </p>
3712: <pre class="programlisting">
3713: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3714: </pre>
3715: <p>
3716: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3717: of supported packages.</p>
1.118 imil 3718: </div>
1.91 rillig 3719: </div>
1.148 asau 3720: <div class="sect1">
1.91 rillig 3721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3722: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3723: <div class="sect2">
1.91 rillig 3724: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3725: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3726: <div class="sect3">
1.91 rillig 3727: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3728: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3729: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3730: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3731: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3732: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3733: <pre class="programlisting">
1.100 rillig 3734: <code class="prompt">$</code> mkdir www/nvu
3735: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3736: </pre>
3737: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3738: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3739: <pre class="programlisting">
1.100 rillig 3740: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3741: </pre>
3742: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3743: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3744: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3745: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3746: <code class="varname">COMMENT</code> fields. Then the package
3747: <code class="filename">Makefile</code> looked like that:</p>
3748: <pre class="programlisting">
1.100 rillig 3749: # $NetBSD$
3750: #
1.91 rillig 3751:
1.100 rillig 3752: DISTNAME= nvu-1.0-sources
3753: PKGNAME= nvu-1.0
3754: CATEGORIES= www
3755: MASTER_SITES= http://cvs.nvu.com/download/
3756: EXTRACT_SUFX= .tar.bz2
3757:
3758: MAINTAINER= rillig@NetBSD.org
3759: HOMEPAGE= http://cvs.nvu.com/
3760: COMMENT= Web Authoring System
1.91 rillig 3761:
1.100 rillig 3762: # url2pkg-marker (please do not remove this line.)
3763: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3764: </pre>
3765: <p>Then, I quit the editor and watched pkgsrc downloading a large
3766: source archive:</p>
3767: <pre class="programlisting">
1.100 rillig 3768: url2pkg> Running "make makesum" ...
3769: => Required installed package digest>=20010302: digest-20060826 found
3770: => Fetching nvu-1.0-sources.tar.bz2
3771: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3772: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3773: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3774: url2pkg> Running "make extract" ...
3775: => Required installed package digest>=20010302: digest-20060826 found
3776: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3777: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3778: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3779: ===> Installing dependencies for nvu-1.0
3780: ===> Overriding tools for nvu-1.0
3781: ===> Extracting for nvu-1.0
3782: url2pkg> Adjusting the Makefile.
1.91 rillig 3783:
1.100 rillig 3784: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3785:
1.100 rillig 3786: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3787: </pre>
3788: </div>
1.148 asau 3789: <div class="sect3">
1.91 rillig 3790: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3791: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91 rillig 3792: <p>Now that the package has been extracted, let's see what's inside
3793: it. The package has a <code class="filename">README.txt</code>, but that only
3794: says something about mozilla, so it's probably useless for seeing what
3795: dependencies this package has. But since there is a GNU configure script
3796: in the package, let's hope that it will complain about everything it
3797: needs.</p>
3798: <pre class="programlisting">
1.100 rillig 3799: <code class="prompt">$</code> bmake
3800: => Required installed package digest>=20010302: digest-20060826 found
3801: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3802: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3803: ===> Patching for nvu-1.0
3804: ===> Creating toolchain wrappers for nvu-1.0
3805: ===> Configuring for nvu-1.0
3806: [...]
3807: configure: error: Perl 5.004 or higher is required.
3808: [...]
3809: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3810: [...]
1.91 rillig 3811: </pre>
3812: <p>That worked quite well. So I opened the package Makefile in my
3813: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3814: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3815: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3816: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3817: from scratch.</p>
3818: <pre class="programlisting">
1.100 rillig 3819: <code class="prompt">$</code> bmake clean
3820: ===> Cleaning for nvu-1.0
3821: <code class="prompt">$</code> bmake
3822: [...]
3823: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3824: GNU Make. You will not be able to build Mozilla without GNU Make.
3825: [...]
1.91 rillig 3826: </pre>
1.128 wiz 3827: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3828: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3829: <pre class="programlisting">
1.100 rillig 3830: [...]
3831: checking for GTK - version >= 1.2.0... no
3832: *** Could not run GTK test program, checking why...
3833: [...]
1.91 rillig 3834: </pre>
3835: <p>Now to the other dependencies. The first question is: Where is the
3836: GTK package hidden in pkgsrc?</p>
3837: <pre class="programlisting">
1.100 rillig 3838: <code class="prompt">$</code> echo ../../*/gtk*
3839: [many packages ...]
3840: <code class="prompt">$</code> echo ../../*/gtk
3841: ../../x11/gtk
3842: <code class="prompt">$</code> echo ../../*/gtk2
3843: ../../x11/gtk2
3844: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3845: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3846: </pre>
3847: <p>The first try was definitely too broad. The second one had exactly
3848: one result, which is very good. But there is one pitfall with GNOME
3849: packages. Before GNOME 2 had been released, there were already many
3850: GNOME 1 packages in pkgsrc. To be able to continue to use these
3851: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3852: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3853: whether this was the case here, and indeed it was.</p>
3854: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3855: file, adding the dependency is very easy. I just inserted an
3856: <code class="literal">.include</code> line before the last line of the package
3857: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3858: <pre class="programlisting">
1.100 rillig 3859: [...]
3860: .include "../../x11/gtk2/buildlink3.mk"
3861: .include "../../mk/bsd.pkg.mk
1.91 rillig 3862: </pre>
1.110 hubertf 3863: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3864: was:</p>
3865: <pre class="programlisting">
1.100 rillig 3866: [...]
3867: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3868: checking for GTK - version >= 1.2.0... no
3869: *** Could not run GTK test program, checking why...
3870: *** The test program failed to compile or link. See the file config.log for the
3871: *** exact error that occured. This usually means GTK was incorrectly installed
3872: *** or that you have moved GTK since it was installed. In the latter case, you
3873: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3874: configure: error: Test for GTK failed.
3875: [...]
1.91 rillig 3876: </pre>
1.128 wiz 3877: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3878: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3879: told me that this package really wanted to have the GNOME 1 version of
3880: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3881: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3882: So I changed the <code class="literal">x11/gtk2</code> to
3883: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3884: and tried again.</p>
3885: <pre class="programlisting">
1.100 rillig 3886: [...]
1.166 jnemeth 3887: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3888: In file included from xpidl.c:42:
3889: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3890: In file included from xpidl.c:42:
3891: xpidl.h:132: error: parse error before "IDL_ns"
3892: [...]
1.91 rillig 3893: </pre>
3894: <p>The package still does not find all of its dependencies. Now the
3895: question is: Which package provides the
3896: <code class="filename">libIDL/IDL.h</code> header file?</p>
3897: <pre class="programlisting">
1.100 rillig 3898: <code class="prompt">$</code> echo ../../*/*idl*
3899: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3900: <code class="prompt">$</code> echo ../../*/*IDL*
3901: ../../net/libIDL
1.91 rillig 3902: </pre>
3903: <p>Let's take the one from the second try. So I included the
3904: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3905: again. But the error didn't change. After digging through some of the
3906: code, I concluded that the build process of the package was broken and
3907: couldn't have ever worked, but since the Mozilla source tree is quite
3908: large, I didn't want to fix it. So I added the following to the package
3909: <code class="filename">Makefile</code> and tried again:</p>
3910: <pre class="programlisting">
1.100 rillig 3911: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3912: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 3913: </pre>
3914: <p>The latter line is needed because the package expects the library
3915: <code class="filename">libIDL.so</code>, but only
3916: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3917: wrapper to rewrite that on the fly.</p>
3918: <p>The next problem was related to a recent change of the FreeType
1.189 snj 3919: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.91 rillig 3920: which patch files were relevant for this issue and copied them to the
3921: <code class="filename">patches</code> directory. Then I retried, fixed the
3922: patches so that they applied cleanly and retried again. This time,
3923: everything worked.</p>
3924: </div>
1.148 asau 3925: <div class="sect3">
1.91 rillig 3926: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3927: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3928: <pre class="programlisting">
1.100 rillig 3929: <code class="prompt">$</code> bmake CHECK_FILES=no install
3930: [...]
3931: <code class="prompt">$</code> bmake print-PLIST >PLIST
3932: <code class="prompt">$</code> bmake deinstall
3933: <code class="prompt">$</code> bmake install
1.91 rillig 3934: </pre>
3935: </div>
3936: </div>
3937: </div>
1.77 rillig 3938: </div>
1.148 asau 3939: <div class="chapter">
1.75 rillig 3940: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3941: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3942: <div class="toc">
3943: <p><b>Table of Contents</b></p>
3944: <dl>
1.128 wiz 3945: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3946: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3947: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3948: <dd><dl>
3949: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3950: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3951: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3952: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3953: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3954: </dl></dd>
3955: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3956: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3957: <dd><dl>
3958: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3959: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3960: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3961: </dl></dd>
1.128 wiz 3962: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3963: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 3964: </dl>
3965: </div>
1.87 wiz 3966: <p>Whenever you're preparing a package, there are a number of
3967: files involved which are described in the following
3968: sections.</p>
1.148 asau 3969: <div class="sect1">
1.75 rillig 3970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3971: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 3972: </h2></div></div></div>
1.75 rillig 3973: <p>Building, installation and creation of a binary package are all
1.87 wiz 3974: controlled by the package's <code class="filename">Makefile</code>.
3975: The <code class="filename">Makefile</code> describes various things about
3976: a package, for example from where to get it, how to configure,
3977: build, and install it.</p>
1.76 rillig 3978: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3979: sections that describe the package.</p>
1.75 rillig 3980: <p>In the first section there are the following variables, which
1.87 wiz 3981: should appear exactly in the order given here. The order and
3982: grouping of the variables is mostly historical and has no further
3983: meaning.</p>
1.148 asau 3984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3985: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3986: distribution file to be downloaded from the package's
3987: website.</p></li>
1.128 wiz 3988: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3989: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3990: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 3991: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3992: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 3993: directory name together with the version number. It must match the
3994: regular expression
3995: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3996: starts with a letter or digit, and contains only letters, digits,
3997: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 3998: <li class="listitem">
1.75 rillig 3999: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4000: which the package fits in. You can choose any of the top-level
4001: directories of pkgsrc for it.</p>
1.75 rillig 4002: <p>Currently the following values are available for
1.87 wiz 4003: <code class="varname">CATEGORIES</code>. If more than
4004: one is used, they need to be separated by spaces:</p>
1.75 rillig 4005: <pre class="programlisting">
1.100 rillig 4006: archivers cross geography meta-pkgs security
4007: audio databases graphics misc shells
4008: benchmarks devel ham multimedia sysutils
4009: biology editors inputmethod net textproc
4010: cad emulators lang news time
4011: chat finance mail parallel wm
4012: comms fonts math pkgtools www
4013: converters games mbone print x11
4014: </pre>
1.75 rillig 4015: </li>
1.128 wiz 4016: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4017: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4018: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4019: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4020: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.75 rillig 4021: </ul></div>
4022: <p>The second section contains information about separately
1.87 wiz 4023: downloaded patches, if any.
4024: </p>
1.148 asau 4025: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190 wiz 4026: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87 wiz 4027: Name(s) of additional files that contain distribution patches.
4028: There is no default. pkgsrc will look for them at
4029: <code class="varname">PATCH_SITES</code>.
4030: They will automatically be uncompressed before patching if
4031: the names end with <code class="filename">.gz</code> or
4032: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4033: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4034: Primary location(s) for distribution patch files (see
1.190 wiz 4035: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
4036: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
4037: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
4038: help find the correct files to patch. It defaults to
4039: <span class="command"><strong>-p0</strong></span>.</p></li>
1.75 rillig 4040: </ul></div>
4041: <p>The third section contains the following variables.
1.87 wiz 4042: </p>
1.148 asau 4043: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4044: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4045: address of the person who feels responsible for this package,
4046: and who is most likely to look at problems or questions regarding
1.189 snj 4047: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114 jmcneill 4048: Other developers may contact the <code class="varname">MAINTAINER</code>
4049: before making changes to the package, but are not required to
4050: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4051: to yourself. If you really can't maintain the package for future
4052: updates, set it to
1.110 hubertf 4053: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4054: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4055: of <code class="varname">MAINTAINER</code> when you do not want other
4056: developers to update or change the package without contacting
4057: you first. A package Makefile should contain one of
4058: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4059: not both. </p></li>
1.128 wiz 4060: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4061: find more information about the package.</p></li>
1.128 wiz 4062: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4063: description of the package (should not include the package
4064: name).</p></li>
1.75 rillig 4065: </ul></div>
4066: <p>Other variables that affect the build:
1.87 wiz 4067: </p>
1.148 asau 4068: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4069: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4070: interesting distribution files of the package are found. The
4071: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4072: works for most packages.</p>
1.75 rillig 4073: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4074: (most GNU software does, for instance), but extracts itself in
4075: the current directory, you should set
4076: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4077: <p>If a package doesn't create a subdirectory with the
4078: name of <code class="varname">DISTNAME</code> but some different name,
4079: set <code class="varname">WRKSRC</code> to point to the proper name in
4080: <code class="filename">${WRKDIR}</code>, for example
4081: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.189 snj 4082: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75 rillig 4083: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4084: taken from the <code class="varname">WRKDIR_BASENAME</code>
4085: variable. By default, its value is
4086: <code class="filename">work</code>. If you want to use the same
4087: pkgsrc tree for building different kinds of binary packages,
4088: you can change the variable according to your needs. Two
4089: other variables handle common cases of setting
4090: <code class="varname">WRKDIR_BASENAME</code> individually. If
4091: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4092: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4093: the host's name is attached to the directory name. If
4094: <code class="varname">OBJMACHINE</code> is defined, the platform name
4095: is attached, which might look like
4096: <code class="filename">work.i386</code> or
4097: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4098: </li></ul></div>
4099: <p>Please pay attention to the following gotchas:</p>
1.148 asau 4100: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4101: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4102: installed in compressed form by the package. For packages using
4103: BSD-style makefiles which honor MANZ, there is
4104: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4105: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4106: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4107: below).</p></li>
1.128 wiz 4108: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.75 rillig 4109: </ul></div>
4110: </div>
1.148 asau 4111: <div class="sect1">
1.75 rillig 4112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4113: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4114: </h2></div></div></div>
1.76 rillig 4115: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4116: digest, or checksum, of each distfile needed for the package. This
4117: ensures that the distfiles retrieved from the Internet have not been
4118: corrupted during transfer or altered by a malign force to introduce
4119: a security hole. Due to recent rumor about weaknesses of digest
4120: algorithms, all distfiles are protected using both SHA1 and RMD160
4121: message digests, as well as the file size.</p>
1.76 rillig 4122: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4123: checksums for all the patches found in the
1.110 hubertf 4124: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.76 rillig 4125: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4126: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4127: command.</p>
1.75 rillig 4128: <p>Some packages have different sets of distfiles depending on
1.189 snj 4129: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87 wiz 4130: <code class="filename">distinfo</code> file and care should be taken when
4131: upgrading such a package to ensure distfile information is not
4132: lost.</p>
1.75 rillig 4133: </div>
1.148 asau 4134: <div class="sect1">
1.75 rillig 4135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4136: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4137: <p>Many packages still don't work out-of-the box on the various
4138: platforms that are supported by pkgsrc. Therefore, a number of custom
4139: patch files are needed to make the package work. These patch files are
4140: found in the <code class="filename">patches/</code> directory.</p>
4141: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4142: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4143: extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.130 wiz 4144: order</a>.</p>
1.148 asau 4145: <div class="sect2">
1.93 rillig 4146: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4147: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4148: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4149: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4150: problems. (To force patches to apply with fuzz you can set
4151: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4152: should contain only changes for a single file, and no file should be
1.93 rillig 4153: patched by more than one patch file. This helps to keep future
4154: modifications simple.</p>
4155: <p>Each patch file is structured as follows: In the first line,
4156: there is the RCS Id of the patch itself. The second line should be
4157: empty for aesthetic reasons. After that, there should be a comment for
4158: each change that the patch does. There are a number of standard
4159: cases:</p>
1.148 asau 4160: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4161: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4162: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4163: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4164: platform and other environment (for example, the compiler) that the
4165: patch is needed for.</p></li>
4166: </ul></div>
1.130 wiz 4167: <p>In all, the patch should be commented so that any
1.93 rillig 4168: developer who knows the code of the application can make some use of
4169: the patch. Special care should be taken for the upstream developers,
4170: since we generally want that they accept our patches, so we have less
4171: work in the future.</p>
4172: </div>
1.148 asau 4173: <div class="sect2">
1.93 rillig 4174: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4175: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4176: <p>One important thing to mention is to pay attention that no RCS
4177: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4178: later checked into the NetBSD CVS tree. Use the
1.189 snj 4179: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93 rillig 4180: problems.</p>
1.87 wiz 4181: <p>For even more automation, we recommend using
1.110 hubertf 4182: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4183: whole set of patches. You just have to backup files before you
4184: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4185: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4186: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4187: you upgrade a package this way, you can easily compare the new
4188: set of patches with the previously existing one with
1.130 wiz 4189: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4190: are replaced by new files, so carefully check if you want to take all
4191: the changes.</p>
1.87 wiz 4192: <p>When you have finished a package, remember to generate
1.110 hubertf 4193: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4194: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.87 wiz 4195: <p>When adding a patch that corrects a problem in the
4196: distfile (rather than e.g. enforcing pkgsrc's view of where
4197: man pages should go), send the patch as a bug report to the
4198: maintainer. This benefits non-pkgsrc users of the package,
4199: and usually makes it possible to remove the patch in future
4200: version.</p>
1.101 rillig 4201: <p>The file names of the patch files are usually of the form
1.130 wiz 4202: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4203: Many packages still use the previous convention
4204: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4205: but new patches should be of the form containing the filename.
1.189 snj 4206: <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.130 wiz 4207: automatically.</p>
1.93 rillig 4208: </div>
1.148 asau 4209: <div class="sect2">
1.93 rillig 4210: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4211: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4212: <p>If you want to share patches between multiple packages
4213: in pkgsrc, e.g. because they use the same distfiles, set
4214: <code class="varname">PATCHDIR</code> to the path where the patch files
4215: can be found, e.g.:</p>
4216: <pre class="programlisting">
1.100 rillig 4217: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4218: </pre>
1.75 rillig 4219: <p>Patch files that are distributed by the author or other
1.87 wiz 4220: maintainers can be listed in
4221: <code class="varname">PATCHFILES</code>.</p>
4222: <p>If it is desired to store any patches that should not be
4223: committed into pkgsrc, they can be kept outside the pkgsrc
4224: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4225: directory tree there is expected to have the same
1.128 wiz 4226: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4227: patches are expected to be stored inside these dirs (also
4228: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4229: example, if you want to keep a private patch for
4230: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4231: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4232: files in the named directory are expected to be patch files,
4233: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4234: applied</em></span>.</p>
1.93 rillig 4235: </div>
1.148 asau 4236: <div class="sect2">
1.85 jmmv 4237: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4238: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4239: <p>When fixing a portability issue in the code do not use
4240: preprocessor magic to check for the current operating system nor
4241: platform. Doing so hurts portability to other platforms because
4242: the OS-specific details are not abstracted appropriately.</p>
4243: <p>The general rule to follow is: instead of checking for the
4244: operating system the application is being built on, check for the
4245: specific <span class="emphasis"><em>features</em></span> you need. For example,
4246: instead of assuming that kqueue is available under NetBSD and
4247: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4248: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4249: yes, this generally involves patching the
1.110 hubertf 4250: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4251: that prevents some OSes from adopting interfaces from other OSes
4252: (e.g. Linux implementing kqueue), something that the above checks
4253: cannot take into account.</p>
4254: <p>Of course, checking for features generally involves more
4255: work on the developer's side, but the resulting changes are
1.87 wiz 4256: cleaner and there are chances they will work on many other
1.85 jmmv 4257: platforms. Not to mention that there are higher chances of being
4258: later integrated into the mainstream sources. Remember:
4259: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4260: <p>Some typical examples:</p>
4261: <div class="table">
1.106 rillig 4262: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4263: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4264: <colgroup>
4265: <col>
4266: <col>
4267: <col>
4268: </colgroup>
4269: <thead><tr>
4270: <th>Where</th>
4271: <th>Incorrect</th>
4272: <th>Correct</th>
4273: </tr></thead>
4274: <tbody>
4275: <tr>
4276: <td>configure script</td>
4277: <td>
1.100 rillig 4278: <pre class="programlisting">
4279: case ${target_os} in
4280: netbsd*) have_kvm=yes ;;
4281: *) have_kvm=no ;;
4282: esac
4283: </pre>
1.85 jmmv 4284: </td>
4285: <td>
1.100 rillig 4286: <pre class="programlisting">
4287: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4288: </pre>
1.85 jmmv 4289: </td>
4290: </tr>
4291: <tr>
4292: <td>C source file</td>
4293: <td>
1.100 rillig 4294: <pre class="programlisting">
4295: #if defined(__NetBSD__)
4296: # include <sys/event.h>
4297: #endif
4298: </pre>
1.85 jmmv 4299: </td>
4300: <td>
1.100 rillig 4301: <pre class="programlisting">
4302: #if defined(HAVE_SYS_EVENT_H)
4303: # include <sys/event.h>
4304: #endif
4305: </pre>
1.85 jmmv 4306: </td>
4307: </tr>
4308: <tr>
4309: <td>C source file</td>
4310: <td>
1.100 rillig 4311: <pre class="programlisting">
4312: int
4313: monitor_file(...)
4314: {
4315: #if defined(__NetBSD__)
4316: int fd = kqueue();
4317: ...
4318: #else
4319: ...
4320: #endif
4321: }
4322: </pre>
1.85 jmmv 4323: </td>
4324: <td>
1.100 rillig 4325: <pre class="programlisting">
4326: int
4327: monitor_file(...)
4328: {
4329: #if defined(HAVE_KQUEUE)
4330: int fd = kqueue();
4331: ...
4332: #else
4333: ...
4334: #endif
4335: }
4336: </pre>
1.85 jmmv 4337: </td>
4338: </tr>
4339: </tbody>
1.91 rillig 4340: </table></div>
1.85 jmmv 4341: </div>
1.91 rillig 4342: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4343: 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
4344: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4345: 2</a>). It summarizes multiple details on how to make
4346: software easier to package; all the suggestions in it were
4347: collected from our experience in pkgsrc work, so they are possibly
4348: helpful when creating patches too.</p>
4349: </div>
1.148 asau 4350: <div class="sect2">
1.85 jmmv 4351: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4352: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4353: <p>Always, always, <span class="strong"><strong>always</strong></span>
4354: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4355: improvements you do to a package to the mainstream developers.
4356: This is the only way to get their attention on portability issues
4357: and to ensure that future versions can be built out-of-the box on
4358: NetBSD. Furthermore, any user that gets newer distfiles will get
4359: the fixes straight from the packaged code.</p>
1.93 rillig 4360: <p>This generally involves cleaning up the patches
4361: (because sometimes the patches that are
1.147 wiz 4362: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4363: appropriate trackers for the projects and working with the
4364: mainstream authors to accept your changes. It is
4365: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4366: the packages in pkgsrc are kept simple and thus further changes
4367: can be done without much hassle.</p>
1.130 wiz 4368: <p>When you have done this, please add a URL to the upstream
4369: bug report to the patch comment.</p>
1.85 jmmv 4370: <p>Support the idea of free software!</p>
4371: </div>
1.75 rillig 4372: </div>
1.148 asau 4373: <div class="sect1">
1.75 rillig 4374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4375: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 4376: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4377: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4378: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4379: any credits where they are due. Please bear in mind that others do not
4380: share your sense of humour (or spelling idiosyncrasies), and that others
4381: will read everything that you write here.</p></dd>
1.76 rillig 4382: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4383: <dd><p>This file governs the files that are installed on your
4384: system: all the binaries, manual pages, etc. There are other
4385: directives which may be entered in this file, to control the
4386: creation and deletion of directories, and the location of
1.110 hubertf 4387: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87 wiz 4388: information.</p></dd>
1.75 rillig 4389: </dl></div>
4390: </div>
1.148 asau 4391: <div class="sect1">
1.75 rillig 4392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4393: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 4394: <div class="sect2">
1.78 rillig 4395: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4396: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 4397: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4398: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4399: <dd>
1.189 snj 4400: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 4401: First time after package extraction and before files are
4402: moved in place, the second time after the files to install
4403: are moved in place. This can be used to do any custom
4404: procedures not possible with @exec commands in
1.189 snj 4405: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4406: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.
1.135 wiz 4407: Please note that you can modify variables in it easily by using
4408: <code class="varname">FILES_SUBST</code> in the package's
4409: <code class="filename">Makefile</code>:</p>
4410: <pre class="programlisting">
4411: FILES_SUBST+= SOMEVAR="somevalue"
4412: </pre>
4413: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4414: <code class="filename">INSTALL</code>. By default, substitution is
4415: performed for <code class="varname">PREFIX</code>,
4416: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4417: <code class="varname">VARBASE</code>, and a few others, type
4418: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4419: complete list.</p>
4420: </dd>
1.76 rillig 4421: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4422: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4423: this script's responsibility to clean up any additional messy details
4424: around the package's installation, since all pkg_delete knows is how to
4425: delete the files created in the original distribution.
1.189 snj 4426: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4427: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135 wiz 4428: The same methods to replace variables can be used as for
4429: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4430: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4431: <dd>
4432: <p>This file is displayed after installation of the package.
1.87 wiz 4433: Useful for things like legal notices on almost-free
4434: software and hints for updating config files after
4435: installing modules for apache, PHP etc.
4436: Please note that you can modify variables in it easily by using
4437: <code class="varname">MESSAGE_SUBST</code> in the package's
4438: <code class="filename">Makefile</code>:</p>
1.75 rillig 4439: <pre class="programlisting">
1.100 rillig 4440: MESSAGE_SUBST+= SOMEVAR="somevalue"
4441: </pre>
1.128 wiz 4442: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4443: <code class="filename">MESSAGE</code>. By default, substitution is
4444: performed for <code class="varname">PKGNAME</code>,
4445: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4446: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4447: <code class="varname">X11BASE</code>,
4448: <code class="varname">PKG_SYSCONFDIR</code>,
4449: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4450: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4451: <p>You can display a different or additional files by
4452: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4453: default is <code class="filename">MESSAGE</code>, if the file
4454: exists.</p>
1.75 rillig 4455: </dd>
1.78 rillig 4456: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 4457: <dd>
4458: <p>This file is used by the alternatives framework.
4459: It creates, configures, and destroys generic wrappers used to
4460: run programs with similar interfaces.
4461: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4462: for more information.</p>
4463: <p>Each line of the file contains two filenames, first
4464: the wrapper and then the alternative provided by the package.
4465: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4466: </dd>
1.78 rillig 4467: </dl></div>
4468: </div>
1.148 asau 4469: <div class="sect2">
1.78 rillig 4470: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4471: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4472: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4473: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4474: <dd><p>This file contains arbitrary things that could
4475: also go into a <code class="filename">Makefile</code>, but its purpose is
4476: to be used by more than one package. This file should only be
4477: used when the packages that will use the file are known in
4478: advance. For other purposes it is often better to write a
4479: <code class="filename">*.mk</code> file and give it a good name that
4480: describes what it does.</p></dd>
4481: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4482: <dd><p>This file contains the dependency information
1.110 hubertf 4483: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78 rillig 4484: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4485: <dd><p>This file contains workarounds for compiler bugs
4486: and similar things. It is included automatically by the pkgsrc
4487: infrastructure, so you don't need an extra
4488: <code class="literal">.include</code> line for
4489: it.</p></dd>
4490: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4491: <dd><p>This file contains the code for the
1.110 hubertf 4492: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78 rillig 4493: selected by the user. If a package has only one or two options,
4494: it is equally acceptable to put the code directly into the
4495: <code class="filename">Makefile</code>.</p></dd>
4496: </dl></div>
4497: </div>
1.148 asau 4498: <div class="sect2">
1.78 rillig 4499: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4500: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4501: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4502: <dt><span class="term"><code class="filename">README*</code></span></dt>
4503: <dd><p>These files do not take place in the creation of
4504: a package and thus are purely informative to the package
4505: developer.</p></dd>
4506: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4507: <dd><p>This file contains things that need to be done
4508: to make the package even
4509: better.</p></dd>
1.75 rillig 4510: </dl></div>
4511: </div>
1.78 rillig 4512: </div>
1.148 asau 4513: <div class="sect1">
1.75 rillig 4514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4515: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4516: </h2></div></div></div>
1.110 hubertf 4517: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4518: unpacked into the directory denoted by
4519: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4520: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4521: directory is also used to keep various timestamp files.
4522: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4523: The default is <code class="filename">${.CURDIR}/work</code>
4524: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4525: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4526: </div>
1.148 asau 4527: <div class="sect1">
1.75 rillig 4528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4529: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4530: </h2></div></div></div>
1.75 rillig 4531: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4532: to configuration or building, you could place these files here and use
1.110 hubertf 4533: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4534: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4535: this. Alternatively, you could simply diff the file against
4536: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4537: the creation of this file.</p>
4538: <p>If you want to share files in this way with other
4539: packages, set the <code class="varname">FILESDIR</code> variable to point
4540: to the other package's <code class="filename">files</code> directory,
4541: e.g.:</p>
4542: <pre class="programlisting">
1.100 rillig 4543: FILESDIR=${.CURDIR}/../xemacs/files
4544: </pre>
1.75 rillig 4545: </div>
4546: </div>
1.148 asau 4547: <div class="chapter">
1.75 rillig 4548: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4549: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4550: <div class="toc">
4551: <p><b>Table of Contents</b></p>
4552: <dl>
1.106 rillig 4553: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4554: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4555: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4556: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4557: <dd><dl>
4558: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4559: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4560: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4561: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4562: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4563: </dl></dd>
4564: </dl>
4565: </div>
1.76 rillig 4566: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4567: each of which forms a well-defined part of the pkgsrc system. Using
1.189 snj 4568: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75 rillig 4569: like pkgsrc requires some discipline to keep the code correct and
4570: understandable.</p>
1.76 rillig 4571: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4572: programming are variables (which are actually macros) and shell
4573: commands. Among these shell commands may even be more complex ones
1.189 snj 4574: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75 rillig 4575: as intended it is necessary to quote all variables correctly when they
4576: are used.</p>
4577: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4578: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4579: with them.</p>
1.148 asau 4580: <div class="sect1">
1.75 rillig 4581: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4582: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4583: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4584: <p>When you are creating a file as a
4585: target of a rule, always write the data to a temporary file first
4586: and finally rename that file. Otherwise there might occur an error
4587: in the middle of generating the file, and when the user runs
1.189 snj 4588: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97 rillig 4589: regenerated properly. Example:</p>
4590: <pre class="programlisting">
1.100 rillig 4591: wrong:
4592: @echo "line 1" > ${.TARGET}
4593: @echo "line 2" >> ${.TARGET}
4594: @false
4595:
4596: correct:
4597: @echo "line 1" > ${.TARGET}.tmp
4598: @echo "line 2" >> ${.TARGET}.tmp
4599: @false
4600: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4601: </pre>
1.110 hubertf 4602: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4603: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4604: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4605: correct</strong></span> gives an error message twice, as expected.</p>
1.189 snj 4606: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4607: <code class="literal">${.TARGET}</code> in case of error, but this only
4608: happens when it is interrupted, for example by pressing
4609: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.189 snj 4610: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4611: </li></ul></div>
4612: </div>
1.148 asau 4613: <div class="sect1">
1.97 rillig 4614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4615: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4616: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4617: can be processed using the five operators ``='', ``+='', ``?='',
1.189 snj 4618: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4619: page.</p>
4620: <p>When a variable's value is parsed from a
1.76 rillig 4621: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4622: backslash character ``\'' are handled specially. If a backslash is
4623: followed by a newline, any whitespace immediately in front of the
4624: backslash, the backslash, the newline, and any whitespace
4625: immediately behind the newline are replaced with a single space. A
4626: backslash character and an immediately following hash character are
4627: replaced with a single hash character. Otherwise, the backslash is
4628: passed as is. In a variable assignment, any hash character that is
4629: not preceded by a backslash starts a comment that continues upto the
4630: end of the logical line.</p>
4631: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4632: the only way to create a variable consisting of a single backslash
4633: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4634: <p>So far for defining variables. The other thing you can do with
4635: variables is evaluating them. A variable is evaluated when it is
4636: part of the right side of the ``:='' or the ``!='' operator, or
4637: directly before executing a shell command which the variable is part
1.189 snj 4638: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75 rillig 4639: is, variables are not evaluated until there's no other way. The
4640: ``modifiers'' mentioned in the man page also evaluate the
4641: variable.</p>
4642: <p>Some of the modifiers split the string into words and then
4643: operate on the words, others operate on the string as a whole. When
4644: a string is split into words, it is split as you would expect
1.189 snj 4645: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.126 jakllsch 4646: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4647: loop does not follow the shell quoting rules but splits at sequences
4648: of whitespace.</p>
4649: <p>There are several types of variables that should be handled
4650: differently. Strings and two types of lists.</p>
1.148 asau 4651: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4652: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4653: characters. Nevertheless, you should restrict yourself to only
4654: using printable characters. Examples are
4655: <code class="varname">PREFIX</code> and
4656: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4657: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4658: are never exported to any shell command. Their elements are
4659: separated by whitespace. Therefore, the elements themselves cannot
4660: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4661: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4662: Examples are <code class="varname">DEPENDS</code> and
4663: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4664: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4665: may be exported to a shell command. Their elements can contain any
4666: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4667: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4668: <code class="varname">DISTFILES</code> and
4669: <code class="varname">MASTER_SITES</code>.</p></li>
4670: </ul></div>
1.148 asau 4671: <div class="sect2">
1.75 rillig 4672: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4673: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4674: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4675: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4676: are reserved for use by the pkgsrc infrastructure. They shall
4677: not be used by package
1.76 rillig 4678: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4679: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4680: lowercase variable names for the iteration
4681: variables.</p></li>
1.128 wiz 4682: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4683: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4684: <code class="varname">DISTFILES</code>.</p></li>
4685: </ul></div>
4686: </div>
4687: </div>
1.148 asau 4688: <div class="sect1">
1.75 rillig 4689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4690: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4691: <p>This section presents you with some code snippets you should
4692: use in your own code. If you don't find anything appropriate here,
4693: you should test your code and add it here.</p>
1.148 asau 4694: <div class="sect2">
1.75 rillig 4695: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4696: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4697: <pre class="programlisting">
1.100 rillig 4698: STRING= foo * bar `date`
4699: INT_LIST= # empty
4700: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4701: EXT_LIST= # empty
4702: ANOTHER_EXT_LIST= a=b c=d
4703:
4704: INT_LIST+= ${STRING} # 1
4705: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4706: EXT_LIST+= ${STRING:Q} # 3
4707: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4708: </pre>
1.75 rillig 4709: <p>When you add a string to an external list (example 3), it
4710: must be quoted. In all other cases, you must not add a quoting
4711: level. You must not merge internal and external lists, unless you
4712: are sure that all entries are correctly interpreted in both
4713: lists.</p>
4714: </div>
1.148 asau 4715: <div class="sect2">
1.75 rillig 4716: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4717: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 4718: <pre class="programlisting">
1.100 rillig 4719: EXT_LIST= # empty
4720: .for i in ${INT_LIST}
4721: EXT_LIST+= ${i:Q}""
4722: .endfor
1.1 grant 4723: </pre>
1.75 rillig 4724: <p>This code converts the internal list
4725: <code class="varname">INT_LIST</code> into the external list
4726: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4727: are unquoted they must be quoted here. The reason for appending
4728: <code class="varname">""</code> is explained below.</p>
4729: </div>
1.148 asau 4730: <div class="sect2">
1.75 rillig 4731: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4732: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4733: <p>Sometimes you may want to print an arbitrary string. There
4734: are many ways to get it wrong and only few that can handle every
4735: nastiness.</p>
1.75 rillig 4736: <pre class="programlisting">
1.100 rillig 4737: STRING= foo bar < > * `date` $$HOME ' "
4738: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4739:
1.100 rillig 4740: all:
4741: echo ${STRING} # 1
4742: echo "${STRING}" # 2
4743: echo "${STRING:Q}" # 3
4744: echo ${STRING:Q} # 4
4745: echo x${STRING:Q} | sed 1s,.,, # 5
4746: printf "%s\\n" ${STRING:Q}"" # 6
4747: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4748: </pre>
1.75 rillig 4749: <p>Example 1 leads to a syntax error in the shell, as the
4750: characters are just copied.</p>
4751: <p>Example 2 leads to a syntax error too, and if you leave out
4752: the last " character from <code class="varname">${STRING}</code>,
1.189 snj 4753: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75 rillig 4754: variable would be evaluated, too.</p>
4755: <p>Example 3 outputs each space character preceded by a
4756: backslash (or not), depending on the implementation of the
1.189 snj 4757: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75 rillig 4758: <p>Example 4 handles correctly every string that does not start
4759: with a dash. In that case, the result depends on the
1.189 snj 4760: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75 rillig 4761: guarantee that your input does not start with a dash, this form is
4762: appropriate.</p>
4763: <p>Example 5 handles even the case of a leading dash
4764: correctly.</p>
1.79 rillig 4765: <p>Example 6 also works with every string and is the
4766: light-weight solution, since it does not involve a pipe, which has
4767: its own problems.</p>
1.75 rillig 4768: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4769: because the quoting has already been done when adding elements to
4770: the list.</p>
4771: <p>As internal lists shall not be passed to the shell, there is
4772: no example for it.</p>
4773: </div>
1.148 asau 4774: <div class="sect2">
1.75 rillig 4775: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4776: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4777: <p>There are many possible sources of wrongly quoted variables.
4778: This section lists some of the commonly known ones.</p>
1.148 asau 4779: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4780: <li class="listitem">
1.75 rillig 4781: <p>Whenever you use the value of a list, think
4782: about what happens to leading or trailing whitespace. If the
4783: list is a well-formed shell expression, you can apply the
4784: <code class="varname">:M*</code> modifier to strip leading and trailing
4785: whitespace from each word. The <code class="varname">:M</code> operator
4786: first splits its argument according to the rules of the shell,
4787: and then creates a new list consisting of all words that match
4788: the shell glob expression <code class="varname">*</code>, that is: all.
4789: One class of situations where this is needed is when adding a
4790: variable like <code class="varname">CPPFLAGS</code> to
4791: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4792: invokes other configure scripts, it strips the leading and
4793: trailing whitespace from the variable and then passes it to the
4794: other configure scripts. But these configure scripts expect the
4795: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4796: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4797: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4798: here is how we do it:</p>
4799: <pre class="programlisting">
1.100 rillig 4800: CPPFLAGS= # empty
4801: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4802: CPPFLAGS+= ${MY_CPPFLAGS}
4803:
4804: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4805:
4806: all:
4807: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4808: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4809: </pre>
1.75 rillig 4810: </li>
1.128 wiz 4811: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 4812: <code class="varname">${PREFIX}</code> is a properly quoted shell
4813: expression, but there is the C compiler after it, which also
4814: expects a properly quoted string (this time in C syntax). The
4815: version above is therefore only correct if
4816: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4817: or double quotes. If you want to allow these, you have to add
4818: another layer of quoting to each variable that is used as a C
4819: string literal. You cannot use the <code class="varname">:Q</code>
4820: operator for it, as this operator only works for the
4821: shell.</p></li>
1.128 wiz 4822: <li class="listitem">
1.75 rillig 4823: <p>Whenever a variable can be empty, the
4824: <code class="varname">:Q</code> operator can have surprising results. Here
4825: are two completely different cases which can be solved with the
4826: same trick.</p>
4827: <pre class="programlisting">
1.100 rillig 4828: EMPTY= # empty
4829: empty_test:
4830: for i in a ${EMPTY:Q} c; do \
4831: echo "$$i"; \
4832: done
4833:
4834: for_test:
4835: .for i in a:\ a:\test.txt
4836: echo ${i:Q}
4837: echo "foo"
4838: .endfor
1.1 grant 4839: </pre>
1.75 rillig 4840: <p>The first example will only print two of the three lines
4841: we might have expected. This is because
4842: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4843: the shell cannot see. The workaround is to write
4844: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4845: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4846: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4847: <p>The second example will only print three lines instead of
4848: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4849: This is because the backslash of the value
4850: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.189 snj 4851: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
4852: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75 rillig 4853: <code class="varname">${i:Q}""</code>.</p>
4854: </li>
4855: </ul></div>
4856: </div>
1.148 asau 4857: <div class="sect2">
1.75 rillig 4858: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4859: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 4860: <p>The pkgsrc bmake program does not handle the following
4861: assignment correctly. In case <code class="varname">_othervar_</code>
4862: contains a ``-'' character, one of the closing braces is included
4863: in <code class="varname">${VAR}</code> after this code executes.</p>
4864: <pre class="programlisting">
1.100 rillig 4865: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 4866: </pre>
1.75 rillig 4867: <p>For a more complex code snippet and a workaround, see the
1.189 snj 4868: package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
1.75 rillig 4869: <code class="varname">bug1</code>.</p>
4870: </div>
4871: </div>
4872: </div>
1.148 asau 4873: <div class="chapter">
1.75 rillig 4874: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4875: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4876: <div class="toc">
4877: <p><b>Table of Contents</b></p>
4878: <dl>
1.106 rillig 4879: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4880: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4881: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 4882: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4883: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4884: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106 rillig 4885: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
4886: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 4887: </dl>
4888: </div>
1.87 wiz 4889: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4890: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4891: the package (relative to the <code class="filename">${PREFIX}</code>
4892: directory it's been installed in) plus some additional statements
1.189 snj 4893: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 4894: This chapter addresses some issues that need attention when
4895: dealing with the <code class="filename">PLIST</code> file (or files, see
4896: below!).</p>
1.148 asau 4897: <div class="sect1">
1.75 rillig 4898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4899: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4900: <p>Be sure to add a RCS ID line as the first thing in any
4901: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4902: <pre class="programlisting">
1.100 rillig 4903: @comment $NetBSD$
1.87 wiz 4904: </pre>
1.75 rillig 4905: </div>
1.148 asau 4906: <div class="sect1">
1.75 rillig 4907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4908: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4909: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4910: to output a PLIST that matches any new files since the package
1.110 hubertf 4911: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.87 wiz 4912: more information on this target.</p>
1.75 rillig 4913: </div>
1.148 asau 4914: <div class="sect1">
1.75 rillig 4915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 4916: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4917: </h2></div></div></div>
1.87 wiz 4918: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 4919: <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, “Sharing directories between packages”</a>, you may have noticed that
4920: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 4921: <code class="varname">@comment</code>s instead of real
4922: <code class="varname">@dirrm</code> lines. You can also do this for
4923: specific directories and files, so that the results of that
4924: command are very close to reality. This helps <span class="emphasis"><em>a
4925: lot</em></span> during the update of packages.</p>
4926: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4927: of AWK patterns and actions that are used to filter the output of
4928: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4929: scripting you like to it, but be careful with quoting.</p>
4930: <p>For example, to get all files inside the
4931: <code class="filename">libdata/foo</code> directory removed from the
4932: resulting PLIST:</p>
4933: <pre class="programlisting">
1.100 rillig 4934: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 4935: </pre>
4936: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4937: to a specific (shared) directory converted to
4938: <code class="varname">@comment</code>s:</p>
1.75 rillig 4939: <pre class="programlisting">
1.100 rillig 4940: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 4941: </pre>
1.75 rillig 4942: </div>
1.148 asau 4943: <div class="sect1">
1.75 rillig 4944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4945: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4946: <p>A number of variables are substituted automatically in
4947: PLISTs when a package is installed on a system. This includes the
4948: following variables:</p>
1.148 asau 4949: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4950: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4951: <dd>
4952: <p>Some packages like emacs and perl embed information
1.87 wiz 4953: about which architecture they were built on into the
4954: pathnames where they install their files. To handle this
4955: case, PLIST will be preprocessed before actually used, and
4956: the symbol
1.128 wiz 4957: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4958: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4959: same is done if the string
4960: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4961: PLIST somewhere - use this on packages that have GNU
4962: autoconf-created configure scripts.</p>
1.148 asau 4963: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4964: <h3 class="title">Legacy note</h3>
4965: <p>There used to be a symbol
1.128 wiz 4966: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4967: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4968: -m</strong></span>, but that's no longer supported and has
4969: been removed.</p>
1.75 rillig 4970: </div>
4971: </dd>
4972: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4973: <dd>
4974: <p>Some packages want to embed the OS name and version
1.87 wiz 4975: into some paths. To do this, use these variables in the
4976: <code class="filename">PLIST</code>:
4977: </p>
1.148 asau 4978: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4979: <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>
4980: <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>
4981: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.75 rillig 4982: </ul></div>
4983: </dd>
4984: </dl></div>
1.87 wiz 4985: <p>For a complete list of values which are replaced by
4986: default, please look in <code class="filename">bsd.pkg.mk</code> (and
4987: search for <code class="varname">PLIST_SUBST</code>).</p>
4988: <p>If you want to change other variables not listed above, you
4989: can add variables and their expansions to this variable in the
1.110 hubertf 4990: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.75 rillig 4991: <pre class="programlisting">
1.100 rillig 4992: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 4993: </pre>
1.128 wiz 4994: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4995: in the <code class="filename">PLIST</code> with
1.128 wiz 4996: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4997: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4998: the common case of conditionally including some
4999: <code class="filename">PLIST</code> entries. It can be done by adding
5000: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5001: setting the corresponding <code class="varname">PLIST.foo</code> variable
5002: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 5003: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 5004: in the <code class="filename">PLIST</code> with either
1.128 wiz 5005: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5006: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5007: For example, in <code class="filename">Makefile</code>:</p>
5008: <pre class="programlisting">
5009: PLIST_VARS+= foo
5010: .if <em class="replaceable"><code>condition</code></em>
5011: PLIST.foo= yes
5012: .else
5013: </pre>
5014: <p>And then in <code class="filename">PLIST</code>:</p>
5015: <pre class="programlisting">
5016: @comment $NetBSD$
5017: bin/bar
5018: man/man1/bar.1
5019: ${PLIST.foo}bin/foo
5020: ${PLIST.foo}man/man1/foo.1
5021: ${PLIST.foo}share/bar/foo.data
5022: ${PLIST.foo}@dirrm share/bar
5023: </pre>
1.75 rillig 5024: </div>
1.148 asau 5025: <div class="sect1">
1.75 rillig 5026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5027: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5028: <p>Man pages should be installed in compressed form if
1.87 wiz 5029: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5030: and uncompressed otherwise. To handle this in the
1.128 wiz 5031: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5032: appended/removed automatically for man pages according to
5033: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5034: or not, see above for details. This modification of the
5035: <code class="filename">PLIST</code> file is done on a copy of it, not
5036: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5037: </div>
1.148 asau 5038: <div class="sect1">
1.75 rillig 5039: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5040: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5041: </h2></div></div></div>
1.76 rillig 5042: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5043: in generating the binary package, set the variable
5044: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.189 snj 5045: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 5046: important. The default for <code class="varname">PLIST_SRC</code> is
5047: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5048: </div>
1.148 asau 5049: <div class="sect1">
1.75 rillig 5050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5051: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5052: <p>Some packages decide to install a different set of files based on
1.87 wiz 5053: the operating system being used. These differences can be
5054: automatically handled by using the following files:</p>
1.148 asau 5055: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5056: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5057: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5058: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5059: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5060: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5061: </ul></div>
5062: </div>
1.148 asau 5063: <div class="sect1">
1.75 rillig 5064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5065: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5066: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5067: multiple (and unrelated) packages install files. These
1.125 wiz 5068: directories were problematic because you had to add special
5069: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5070: centralized package handle them.</p>
1.125 wiz 5071: <p>In pkgsrc, it is now easy: Each package should create
5072: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5073: will remove any directories left empty after uninstalling a
5074: package.</p>
5075: <p>If a package needs an empty directory to work, create
5076: the directory during installation as usual, and also add an
5077: entry to the PLIST:
5078: </p>
1.87 wiz 5079: <pre class="programlisting">
1.125 wiz 5080: @pkgdir path/to/empty/directory
1.87 wiz 5081: </pre>
1.125 wiz 5082: <p>
5083: </p>
1.75 rillig 5084: </div>
5085: </div>
1.148 asau 5086: <div class="chapter">
1.75 rillig 5087: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5088: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5089: <div class="toc">
5090: <p><b>Table of Contents</b></p>
5091: <dl>
1.106 rillig 5092: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5093: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5094: <dd><dl>
1.106 rillig 5095: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5096: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5097: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5098: and
5099: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5100: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5101: </dl></dd>
1.128 wiz 5102: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 5103: <dd><dl>
1.128 wiz 5104: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 5105: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 5106: </dl></dd>
5107: </dl>
5108: </div>
5109: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5110: are seen by a package's configure and build processes. This is implemented
5111: in a two step process:</p>
1.128 wiz 5112: <div class="orderedlist"><ol class="orderedlist" type="1">
5113: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5114: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5115: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5116: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5117: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5118: <code class="option">-L${LOCALBASE}/lib</code> into references to
5119: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5120: native compiler on some operating systems look like GCC, so that
5121: packages that expect GCC won't require modifications to build with
5122: those native compilers.</p></li>
1.75 rillig 5123: </ol></div>
5124: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5125: package may be built consistently despite what other software may be
5126: installed. Please note that the normal system header and library paths,
5127: e.g. <code class="filename">/usr/include</code>,
5128: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5129: designed to insulate the package build from non-system-supplied
5130: software.</p>
1.148 asau 5131: <div class="sect1">
1.75 rillig 5132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5133: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5134: <p>The process of converting packages to use the buildlink3
1.128 wiz 5135: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5136: The things to keep in mind are:</p>
1.128 wiz 5137: <div class="orderedlist"><ol class="orderedlist" type="1">
5138: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5139: instead of the actual toolchain. Some packages are tricky,
5140: and the only way to know for sure is the check
5141: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5142: wrappers are being invoked.</p></li>
1.128 wiz 5143: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5144: the package Makefile, e.g. Java VMs, standalone shells,
5145: etc., because the code to symlink files into
5146: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5147: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5148: </p></li>
1.128 wiz 5149: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5150: <code class="filename">buildlink3.mk</code> files that you list in a
5151: package's Makefile are added as dependencies for that package.
5152: </p></li>
1.75 rillig 5153: </ol></div>
1.87 wiz 5154: <p>If a dependency on a particular package is required for its libraries and
5155: headers, then we replace:</p>
1.75 rillig 5156: <pre class="programlisting">
1.100 rillig 5157: DEPENDS+= foo>=1.1.0:../../category/foo
5158: </pre>
1.75 rillig 5159: <p>with</p>
5160: <pre class="programlisting">
1.100 rillig 5161: .include "../../category/foo/buildlink3.mk"
5162: </pre>
1.75 rillig 5163: <p>The buildlink3.mk files usually define the required dependencies.
5164: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5165: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5166: <pre class="programlisting">
1.100 rillig 5167: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5168: .include "../../category/foo/buildlink3.mk"
5169: </pre>
1.76 rillig 5170: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5171: files in <code class="filename">pkgsrc/mk</code>
5172: that handle special package issues:</p>
1.148 asau 5173: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5174: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5175: the native or a pkgsrc Berkeley DB implementation based on
5176: the values of <code class="varname">BDB_ACCEPTED</code> and
5177: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5178: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5179: comes with neither Curses nor NCurses, this will take care
1.189 snj 5180: to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.128 wiz 5181: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5182: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5183: adding a dependency on Heimdal or MIT-krb5 for packages that
5184: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5185: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5186: system-provided Motif installation or adds a dependency on
1.189 snj 5187: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>. The user can set
1.128 wiz 5188: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.151 obache 5189: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5190: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5191: which Motif version will be used.</p></li>
1.161 ryoon 5192: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 5193: system-provided GNU readline or editline (libedit) installation,
1.189 snj 5194: or adds a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
5195: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.161 ryoon 5196: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5197: If your package really needs GNU readline library, its Makefile
5198: should include <code class="filename">devel/readline/buildlink3.mk</code>
5199: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 5200: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5201: variables that may be used by packages that use the
5202: Open Sound System (OSS) API.</p></li>
1.128 wiz 5203: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5204: any of the Postgres versions in the variable
5205: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5206: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5207: the file for more information.</p></li>
1.128 wiz 5208: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5209: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.189 snj 5210: a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.128 wiz 5211: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5212: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5213: library.</p></li>
1.75 rillig 5214: </ul></div>
1.76 rillig 5215: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5216: files provide a more complete
5217: description of how to use them properly.</p>
1.75 rillig 5218: </div>
1.148 asau 5219: <div class="sect1">
1.75 rillig 5220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5221: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5222: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5223: included by Makefiles to indicate the need to compile and link
5224: against header files and libraries provided by the package. A
5225: <code class="filename">buildlink3.mk</code> file should always provide
5226: enough information to add the correct type of dependency
5227: relationship and include any other
5228: <code class="filename">buildlink3.mk</code> files that it needs to find
5229: headers and libraries that it needs in turn.</p>
5230: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.189 snj 5231: file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87 wiz 5232: package is highly recommended. For most packages, the following
5233: command will generate a good starting point for
5234: <code class="filename">buildlink3.mk</code> files:</p>
5235: <pre class="screen">
5236: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5237: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5238: </pre>
1.148 asau 5239: <div class="sect2">
1.75 rillig 5240: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5241: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5242: <p>The following real-life example
1.87 wiz 5243: <code class="filename">buildlink3.mk</code> is taken
5244: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5245: <pre class="programlisting">
1.120 snj 5246: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5247:
1.120 snj 5248: BUILDLINK_TREE+= tiff
1.1 grant 5249:
1.120 snj 5250: .if !defined(TIFF_BUILDLINK3_MK)
5251: TIFF_BUILDLINK3_MK:=
1.87 wiz 5252:
1.120 snj 5253: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5254: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5255: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5256:
1.100 rillig 5257: .include "../../devel/zlib/buildlink3.mk"
5258: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5259: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5260:
1.120 snj 5261: BUILDLINK_TREE+= -tiff
1.100 rillig 5262: </pre>
1.87 wiz 5263: <p>The header and footer manipulate
1.120 snj 5264: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5265: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5266: the dependency tree.</p>
5267: <p>The main section is protected from multiple inclusion
1.87 wiz 5268: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5269: added. Several important variables are set in the section:</p>
1.148 asau 5270: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5271: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5272: is the actual dependency recorded in the installed
5273: package; this should always be set using
1.110 hubertf 5274: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5275: we're appending to any pre-existing list of values. This
5276: variable should be set to the first version of the
1.133 wiz 5277: package that had an backwards-incompatible API change.
1.87 wiz 5278: </p></li>
1.128 wiz 5279: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5280: is the location of the <em class="replaceable"><code>pkg</code></em>
5281: pkgsrc directory.</p></li>
1.128 wiz 5282: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5283: (not shown above) controls whether we use
5284: <code class="varname">BUILD_DEPENDS</code> or
5285: <code class="varname">DEPENDS</code> to add the dependency on
5286: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5287: selected by setting
5288: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5289: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5290: used.</p></li>
1.128 wiz 5291: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5292: and
5293: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5294: (not shown above) are lists of subdirectories of
1.76 rillig 5295: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5296: to add to the header and library search paths. These
1.128 wiz 5297: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5298: respectively.</p></li>
1.128 wiz 5299: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5300: (not shown above) is the list of preprocessor flags to add
5301: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5302: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5303: should be avoided and instead be handled using
5304: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5305: above.</p></li>
1.75 rillig 5306: </ul></div>
1.87 wiz 5307: <p>The following variables are all optionally defined within
5308: this second section (protected against multiple inclusion) and
5309: control which package files are symlinked into
5310: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5311: transformed during the symlinking:</p>
1.148 asau 5312: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5313: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5314: (not shown above) is a shell glob pattern relative to
1.76 rillig 5315: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5316: to be symlinked into
1.76 rillig 5317: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5318: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5319: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5320: (not shown above) is a shell pipeline that
5321: outputs to stdout a list of files relative to
5322: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5323: The resulting files are to be symlinked
5324: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5325: this takes the <code class="filename">+CONTENTS</code> of a
5326: <em class="replaceable"><code>pkg</code></em> and filters it through
5327: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5328: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5329: (not shown above) is a filter command that filters
1.76 rillig 5330: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5331: relative to
1.76 rillig 5332: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.193 ! dholland 5333: on stdout. By default for overwrite packages,
1.75 rillig 5334: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5335: outputs the contents of the <code class="filename">include</code>
5336: and <code class="filename">lib</code> directories in the package
1.193 ! dholland 5337: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
! 5338: it outputs any libtool archives in
! 5339: <code class="filename">lib</code> directories.</p></li>
1.128 wiz 5340: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5341: (not shown above) is a list of sed arguments used to
5342: transform the name of the source filename into a
1.110 hubertf 5343: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5344: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5345: </ul></div>
1.120 snj 5346: <p>This section can additionally include any
1.87 wiz 5347: <code class="filename">buildlink3.mk</code> needed for
5348: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5349: Including these <code class="filename">buildlink3.mk</code> files
5350: means that the headers and libraries for these
5351: dependencies are also symlinked into
5352: <code class="filename">${BUILDLINK_DIR}</code>
5353: whenever the <em class="replaceable"><code>pkg</code></em>
5354: <code class="filename">buildlink3.mk</code>
1.120 snj 5355: file is included. Dependencies are only added for directly
5356: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 5357: <p>When providing a <code class="filename">buildlink3.mk</code> and
5358: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 5359: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 5360: header files are automatically exposed when the package is
5361: use.</p>
5362: <p>In particular, if only an executable
5363: (<code class="filename">bin/foo</code>) is linked against a library, that
5364: library does not need to be propagated in the
5365: <code class="filename">buildlink3.mk</code> file.</p>
5366: <p>The following steps should help you decide if a
5367: <code class="filename">buildlink3.mk</code> file needs to be included:
5368: </p>
5369: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5370: <li class="listitem"><p>Look at the installed header files: What
5371: headers do they include? The packages providing these files
5372: must be buildlinked.</p></li>
1.155 wiz 5373: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5374: libraries and look against what other libraries they link.
5375: Some of the packages providing these probably need to be
5376: buildlinked; however, it's not automatic, since e.g. GTK on
5377: some systems pulls in the X libraries, so they will show up in
5378: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 5379: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 5380: used as a hint.</p></li>
1.153 wiz 5381: </ul></div>
5382: <p>
5383: </p>
1.75 rillig 5384: </div>
1.148 asau 5385: <div class="sect2">
1.75 rillig 5386: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5387: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5388: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5389: and
5390: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5391: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5392: <p>These two variables differ in that one describes source
5393: compatibility (API) and the other binary compatibility (ABI).
5394: The difference is that a change in the API breaks compilation of
5395: programs while changes in the ABI stop compiled programs from
5396: running.</p>
5397: <p>Changes to the
1.134 wiz 5398: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5399: variable in a <code class="filename">buildlink3.mk</code> file happen
5400: very rarely. One possible reason is that all packages depending
5401: on this already need a newer version. In case it is bumped see
5402: the description below.</p>
5403: <p>The most common example of an ABI change is that the major
5404: version of a shared library is increased. In this case,
5405: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5406: should be adjusted to require at least the new package version.
5407: Then the packages that depend on this package need their
5408: <code class="varname">PKGREVISION</code>s increased and, if they have
5409: <code class="filename">buildlink3.mk</code> files, their
5410: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5411: adjusted, too. This is needed so pkgsrc will require the correct
5412: package dependency and not settle for an older one when building
5413: the source.</p>
1.110 hubertf 5414: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5415: more information about dependencies on other packages,
5416: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5417: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5418: <p>Please take careful consideration before adjusting
5419: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5420: or
5421: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5422: as we don't want to cause unneeded package deletions and
5423: rebuilds. In many cases, new versions of packages work just
5424: fine with older dependencies.</p>
5425: <p>Also it is not needed to set
1.133 wiz 5426: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5427: when it is identical to
1.87 wiz 5428: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5429: </div>
5430: </div>
1.148 asau 5431: <div class="sect1">
1.75 rillig 5432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5433: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5434: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5435: coincide with headers and libraries present in the base system.
1.76 rillig 5436: Aside from a <code class="filename">buildlink3.mk</code> file, these
5437: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5438: file that includes the necessary checks to decide whether using
5439: the built-in software or the pkgsrc software is
1.87 wiz 5440: appropriate.</p>
5441: <p>The only requirements of a builtin.mk file for
5442: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5443: <div class="orderedlist"><ol class="orderedlist" type="1">
5444: <li class="listitem"><p>It should set
1.87 wiz 5445: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5446: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5447: after it is included.</p></li>
1.128 wiz 5448: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5449: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5450: which is already set before the
5451: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5452: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5453: is <span class="emphasis"><em>very</em></span> important and takes careful
5454: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5455: </ol></div>
1.148 asau 5456: <div class="sect2">
1.75 rillig 5457: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5458: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75 rillig 5459: <p>The following is the recommended template for builtin.mk
1.87 wiz 5460: files:</p>
1.75 rillig 5461: <pre class="programlisting">
1.100 rillig 5462: .if !defined(IS_BUILTIN.foo)
5463: #
5464: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5465: # genuinely exists in the system or not.
5466: #
5467: IS_BUILTIN.foo?= no
5468:
5469: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5470: # version can be determined.
5471: #
5472: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5473: BUILTIN_PKG.foo?= foo-1.0
5474: . endif
5475: .endif # IS_BUILTIN.foo
5476:
5477: .if !defined(USE_BUILTIN.foo)
5478: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5479: . if defined(BUILTIN_PKG.foo)
5480: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5481: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5482: USE_BUILTIN.foo!= \
5483: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5484: && ${ECHO} "yes" || ${ECHO} "no"
5485: . endif
5486: . endfor
5487: . endif
5488: .endif # USE_BUILTIN.foo
5489:
5490: CHECK_BUILTIN.foo?= no
5491: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5492: #
5493: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5494: # "yes" or "no".
5495: #
5496: .endif # CHECK_BUILTIN.foo
5497: </pre>
1.87 wiz 5498: <p>The first section sets
5499: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5500: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5501: in the base system. This should not be a base system software
5502: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5503: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5504: included as part of the base system. This variable is only
5505: used internally within the <code class="filename">builtin.mk</code>
5506: file.</p>
5507: <p>The second section sets
5508: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5509: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5510: system if it exists (if
5511: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5512: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5513: within the <code class="filename">builtin.mk</code> file.</p>
5514: <p>The third section sets
5515: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5516: and is <span class="emphasis"><em>required</em></span> in all
5517: <code class="filename">builtin.mk</code> files. The code in this
5518: section must make the determination whether the built-in
5519: software is adequate to satisfy the dependencies listed in
5520: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5521: This is typically done by comparing
5522: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5523: against each of the dependencies in
5524: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5525: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5526: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5527: end of the <code class="filename">builtin.mk</code> file. Note that
5528: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5529: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5530: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5531: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5532: that the built-in version of the software is similar enough to
5533: be used as a replacement.</p>
5534: <p>The last section is guarded by
5535: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5536: and includes code that uses the value of
5537: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5538: set in the previous section. This typically includes, e.g.,
5539: adding additional dependency restrictions and listing additional
5540: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5541: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5542: </div>
1.148 asau 5543: <div class="sect2">
1.75 rillig 5544: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5545: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5546: <p>When building packages, it's possible to choose whether to set
5547: a global preference for using either the built-in (native)
5548: version or the pkgsrc version of software to satisfy a
5549: dependency. This is controlled by setting
5550: <code class="varname">PREFER_PKGSRC</code> and
5551: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5552: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.87 wiz 5553: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5554: use the pkgsrc versions of software, while
5555: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5556: built-in versions. Preferences are determined by the most
5557: specific instance of the package in either
5558: <code class="varname">PREFER_PKGSRC</code> or
5559: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5560: in neither or in both variables, then
5561: <code class="varname">PREFER_PKGSRC</code> has precedence over
5562: <code class="varname">PREFER_NATIVE</code>. For example, to require
5563: using pkgsrc versions of software for all but the most basic
5564: bits on a NetBSD system, you can set:</p>
5565: <pre class="programlisting">
1.100 rillig 5566: PREFER_PKGSRC= yes
5567: PREFER_NATIVE= getopt skey tcp_wrappers
5568: </pre>
1.87 wiz 5569: <p>A package <span class="emphasis"><em>must</em></span> have a
5570: <code class="filename">builtin.mk</code>
5571: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5572: otherwise it is simply ignored in that list.</p>
1.75 rillig 5573: </div>
5574: </div>
5575: </div>
1.148 asau 5576: <div class="chapter">
1.75 rillig 5577: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5578: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5579: <div class="toc">
5580: <p><b>Table of Contents</b></p>
5581: <dl>
1.106 rillig 5582: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 5583: <dd><dl>
1.106 rillig 5584: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5585: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5586: </dl></dd>
1.106 rillig 5587: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5588: <dd><dl>
1.128 wiz 5589: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 5590: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5591: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5592: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5593: </dl></dd>
5594: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5595: <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>
5596: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5597: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5598: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5599: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5600: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75 rillig 5601: </dl>
5602: </div>
5603: <p>This chapter describes the framework known as
5604: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5605: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5606: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5607: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5608: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5609: provided that packages are correctly designed.</p></li>
1.128 wiz 5610: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5611: <li class="listitem"><p>Registration of system users and groups.</p></li>
5612: <li class="listitem"><p>Registration of system shells.</p></li>
5613: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5614: </ul></div>
5615: <p>The following sections inspect each of the above points in detail.</p>
5616: <p>You may be thinking that many of the things described here could be
5617: easily done with simple code in the package's post-installation target
5618: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5619: as the code in them is only executed when building from source. Machines
5620: using binary packages could not benefit from it at all (as the code itself
5621: could be unavailable). Therefore, the only way to achieve any of the items
5622: described above is by means of the installation scripts, which are
5623: automatically generated by pkginstall.</p>
1.148 asau 5624: <div class="sect1">
1.75 rillig 5625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5626: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5627: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5628: of files and directories that belong to a package. The names used in it
1.76 rillig 5629: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5630: which means that it cannot register files outside this directory (absolute
5631: path names are not allowed). Despite this restriction, some packages need
5632: to install files outside this location; e.g., under
1.76 rillig 5633: <code class="filename">${VARBASE}</code> or
1.87 wiz 5634: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5635: is to create such files during installation time by using
5636: installation scripts.</p>
5637: <p>The generic installation scripts are shell scripts that can
5638: contain arbitrary code. The list of scripts to execute is taken from
5639: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5640: <code class="filename">INSTALL</code>. A similar variable exists for package
5641: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5642: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5643: commands, so they have the potential to create and manage files
5644: anywhere in the file system.</p>
5645: <p>Using these general installation files is not recommended, but
5646: may be needed in some special cases. One reason for avoiding them is
5647: that the user has to trust the packager that there is no unwanted or
5648: simply erroneous code included in the installation script. Also,
5649: previously there were many similar scripts for the same functionality,
5650: and fixing a common error involved finding and changing all of
5651: them.</p>
5652: <p>The pkginstall framework offers another, standardized way. It
5653: provides generic scripts to abstract the manipulation of such files
5654: and directories based on variables set in the package's
5655: <code class="filename">Makefile</code>. The rest of this section describes
5656: these variables.</p>
1.148 asau 5657: <div class="sect2">
1.75 rillig 5658: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5659: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5660: <p>The following variables can be set to request the creation of
5661: directories anywhere in the file system:</p>
1.148 asau 5662: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5663: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5664: contain a list of directories that should be created and should attempt
5665: to be destroyed by the installation scripts. The difference between
5666: the two is that the latter prompts the administrator to remove any
5667: directories that may be left after deinstallation (because they were
5668: not empty), while the former does not.</p></li>
1.128 wiz 5669: <li class="listitem">
1.75 rillig 5670: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5671: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5672: which directories should be created and should attempt to be destroyed
5673: by the installation scripts. Each tuple holds the following values,
5674: separated by spaces: the directory name, its owner, its group and its
5675: numerical mode. For example:</p>
5676: <pre class="programlisting">
1.100 rillig 5677: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5678: </pre>
1.75 rillig 5679: <p>The difference between the two is exactly the same as their
5680: non-<code class="varname">PERMS</code> counterparts.</p>
5681: </li>
5682: </ul></div>
5683: </div>
1.148 asau 5684: <div class="sect2">
1.75 rillig 5685: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5686: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5687: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5688: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5689: To overcome this problem, the only solution is to extract the file in the
5690: known place (i.e., inside the installation prefix) and copy it to the
5691: appropriate location during installation (done by the installation scripts
5692: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5693: file</em></span> in the following paragraphs, which describe the variables
5694: that can be used to automatically and consistently handle files outside the
5695: installation prefix:</p>
1.148 asau 5696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5697: <li class="listitem">
1.75 rillig 5698: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5699: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5700: During installation time, the master file is copied to the target one
5701: if and only if the latter does not exist. Upon deinstallation, the
5702: target file is removed provided that it was not modified by the
5703: installation.</p>
5704: <p>The difference between the two is that the latter prompts the
5705: administrator to remove any files that may be left after
5706: deinstallation (because they were not empty), while the former does
5707: not.</p>
5708: </li>
1.128 wiz 5709: <li class="listitem">
1.75 rillig 5710: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5711: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5712: files as well as their target locations. For each of them, it also
5713: specifies their owner, their group and their numeric permissions, in
5714: this order. For example:</p>
5715: <pre class="programlisting">
1.137 wiz 5716: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5717: </pre>
1.75 rillig 5718: <p>The difference between the two is exactly the same as their
5719: non-<code class="varname">PERMS</code> counterparts.</p>
5720: </li>
5721: </ul></div>
5722: </div>
5723: </div>
1.148 asau 5724: <div class="sect1">
1.75 rillig 5725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5726: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5727: <p>Configuration files are special in the sense that they are installed
5728: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5729: need special treatment during installation (most of which is automated by
5730: pkginstall). The main concept you must bear in mind is that files marked
5731: as configuration files are automatically copied to the right place (somewhere
5732: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5733: and only if</em></span> they didn't exist before. Similarly, they will not
5734: be removed if they have local modifications. This ensures that
5735: administrators never lose any custom changes they may have made.</p>
1.148 asau 5736: <div class="sect2">
1.75 rillig 5737: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5738: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 5739: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5740: specifies where configuration files shall be installed. Its contents are
5741: set based upon the following variables:</p>
1.148 asau 5742: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5743: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5744: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5745: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5746: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5747: Packages must not use it directly.</p></li>
1.128 wiz 5748: <li class="listitem">
1.75 rillig 5749: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5750: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5751: for the package being built shall be installed. The definition of this
5752: variable only makes sense in the package's
1.76 rillig 5753: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5754: <p>As an example, consider the Apache package,
1.189 snj 5755: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.75 rillig 5756: configuration files under the
1.76 rillig 5757: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5758: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5759: Makefile.</p>
5760: </li>
1.128 wiz 5761: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5762: variable that holds this package's configuration directory (if
5763: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5764: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5765: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5766: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5767: directory where the configuration files for the package identified by
5768: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5769: </ul></div>
5770: <p>Based on the above variables, pkginstall determines the value of
5771: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5772: variable that can be used within a package to refer to its configuration
5773: directory. The algorithm used to set its value is basically the
5774: following:</p>
1.128 wiz 5775: <div class="orderedlist"><ol class="orderedlist" type="1">
5776: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5777: its value is used.</p></li>
1.128 wiz 5778: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5779: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5780: <code class="filename">Makefile</code>, the resulting value is
5781: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5782: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5783: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5784: </ol></div>
1.76 rillig 5785: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5786: 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
5787: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5788: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5789: </div>
1.148 asau 5790: <div class="sect2">
1.75 rillig 5791: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5792: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5793: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5794: known place, you need to teach each package where it shall install its
5795: files. In some cases you will have to patch the package Makefiles to
5796: achieve it. If you are lucky, though, it may be as easy as passing an
5797: extra flag to the configuration script; this is the case of GNU Autoconf-
5798: generated files:</p>
5799: <pre class="programlisting">
1.100 rillig 5800: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5801: </pre>
1.75 rillig 5802: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5803: for</em></span> its configuration files, not where they will be originally
5804: installed (although the difference is never explicit,
5805: unfortunately).</p>
5806: </div>
1.148 asau 5807: <div class="sect2">
1.75 rillig 5808: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5809: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5810: <p>As said before, pkginstall automatically handles configuration files.
5811: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5812: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5813: directly</strong></span>. Bad news is that many software installation scripts
5814: will, out of the box, mess with the contents of that directory. So what is
5815: the correct procedure to fix this issue?</p>
5816: <p>You must teach the package (usually by manually patching it) to
5817: install any configuration files under the examples hierarchy,
1.76 rillig 5818: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5819: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5820: has the original copies available.</p>
5821: <p>Once the required configuration files are in place (i.e., under the
5822: examples hierarchy), the pkginstall framework can use them as master copies
5823: during the package installation to update what is in
1.76 rillig 5824: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5825: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5826: used. Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.75 rillig 5827: about their syntax and their purpose. Here is an example, taken from the
1.189 snj 5828: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75 rillig 5829: <pre class="programlisting">
1.100 rillig 5830: EGDIR= ${PREFIX}/share/doc/mutt/samples
5831: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5832: </pre>
1.75 rillig 5833: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5834: package and has no meaning outside it.</p>
5835: </div>
1.148 asau 5836: <div class="sect2">
1.75 rillig 5837: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5838: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5839: <p>The automatic copying of config files can be toggled by setting the
5840: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5841: installation.</p>
5842: </div>
5843: </div>
1.148 asau 5844: <div class="sect1">
1.75 rillig 5845: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5846: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5847: <p>System startup scripts are special files because they must be
5848: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5849: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.75 rillig 5850: can be used. However, pkginstall provides a special mechanism to handle
5851: these files.</p>
5852: <p>In order to provide system startup scripts, the package has
5853: to:</p>
1.128 wiz 5854: <div class="orderedlist"><ol class="orderedlist" type="1">
5855: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5856: the <code class="literal">.sh</code> suffix appended. Considering the
1.189 snj 5857: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76 rillig 5858: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5859: <li class="listitem">
1.75 rillig 5860: <p>Tell pkginstall to handle it, appending the name of the script,
5861: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5862: Continuing the previous example:</p>
5863: <pre class="programlisting">
1.100 rillig 5864: RCD_SCRIPTS+= cupsd
1.1 grant 5865: </pre>
1.75 rillig 5866: </li>
5867: </ol></div>
5868: <p>Once this is done, pkginstall will do the following steps for each
5869: script in an automated fashion:</p>
1.128 wiz 5870: <div class="orderedlist"><ol class="orderedlist" type="1">
5871: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5872: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5873: variable.</p></li>
1.128 wiz 5874: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5875: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5876: that this master file must be explicitly registered in the
1.76 rillig 5877: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5878: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5879: from the examples hierarchy into the system-wide startup scripts
5880: directory.</p></li>
5881: </ol></div>
1.148 asau 5882: <div class="sect2">
1.75 rillig 5883: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5884: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5885: <p>The automatic copying of config files can be toggled by setting the
5886: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5887: installation. Note that the scripts will be always copied inside the
1.76 rillig 5888: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5889: matter what the value of this variable is.</p>
5890: </div>
5891: </div>
1.148 asau 5892: <div class="sect1">
1.75 rillig 5893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5894: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5895: <p>If a package needs to create special users and/or groups during
5896: installation, it can do so by using the pkginstall framework.</p>
5897: <p>Users can be created by adding entries to the
5898: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5899: syntax:</p>
5900: <pre class="programlisting">
1.100 rillig 5901: user:group
1.1 grant 5902: </pre>
1.87 wiz 5903: <p>Further specification of user details may be done by setting
5904: per-user variables.
5905: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5906: numeric UID for the user.
5907: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5908: user's description or comment.
5909: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5910: user's home directory, and defaults to
5911: <code class="filename">/nonexistent</code> if not specified.
5912: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5913: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5914: not specified.</p>
1.75 rillig 5915: <p>Similarly, groups can be created by adding entries to the
5916: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5917: <pre class="programlisting">
1.100 rillig 5918: group
1.1 grant 5919: </pre>
1.93 rillig 5920: <p>The numeric GID of the group may be set by defining
1.75 rillig 5921: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5922: <p>If a package needs to create the users and groups at an earlier
5923: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5924: either <code class="literal">configure</code> or <code class="literal">build</code> to
5925: indicate the phase before which the users and groups are created. In
5926: this case, the numeric UIDs and GIDs of the created users and groups
5927: are automatically hardcoded into the final installation scripts.</p>
5928: </div>
1.148 asau 5929: <div class="sect1">
1.75 rillig 5930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5931: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5932: <p>Packages that install system shells should register them in the shell
1.76 rillig 5933: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5934: administrator. This must be done from the installation scripts to keep
5935: binary packages working on any system. pkginstall provides an easy way to
5936: accomplish this task.</p>
5937: <p>When a package provides a shell interpreter, it has to set the
5938: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5939: add some hooks to the installation scripts to handle it. Consider the
1.189 snj 5940: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75 rillig 5941: <pre class="programlisting">
1.100 rillig 5942: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5943: </pre>
1.148 asau 5944: <div class="sect2">
1.75 rillig 5945: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5946: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5947: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5948: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5949: environment variable to <code class="literal">NO</code>.</p>
5950: </div>
5951: </div>
1.148 asau 5952: <div class="sect1">
1.75 rillig 5953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5954: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5955: <p>Packages that install X11 fonts should update the database files
5956: that index the fonts within each fonts directory. This can easily be
5957: accomplished within the pkginstall framework.</p>
5958: <p>When a package installs X11 fonts, it must list the directories in
5959: which fonts are installed in the
5960: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5961: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5962: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.75 rillig 5963: installation scripts to run the appropriate commands to update the fonts
5964: database files within each of those directories. For convenience, if the
5965: directory path is relative, it is taken to be relative to the package's
1.189 snj 5966: installation prefix. Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75 rillig 5967: <pre class="programlisting">
1.175 wiz 5968: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5969: </pre>
1.148 asau 5970: <div class="sect2">
1.75 rillig 5971: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5972: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5973: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5974: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5975: environment variable to <code class="literal">NO</code>.</p>
5976: </div>
5977: </div>
5978: </div>
1.148 asau 5979: <div class="chapter">
1.75 rillig 5980: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5981: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 5982: <div class="toc">
5983: <p><b>Table of Contents</b></p>
5984: <dl>
1.106 rillig 5985: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 5986: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 5987: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 5988: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 5989: </dl>
5990: </div>
5991: <p>Many packages have the ability to be built to support different
1.76 rillig 5992: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 5993: in pkgsrc that provides generic handling of those options that
5994: determine different ways in which the packages can be built. It's
5995: possible for the user to specify exactly which sets of options will be
5996: built into a package or to allow a set of global default options
5997: apply.</p>
1.107 rillig 5998: <p>There are two broad classes of behaviors that one might want to
5999: control via options. One is whether some particular feature is
6000: enabled in a program that will be built anyway, often by including or
6001: not including a dependency on some other package. The other is
6002: whether or not an additional program will be built as part of the
6003: package. Generally, it is better to make a split package for such
6004: additional programs instead of using options, because it enables
6005: binary packages to be built which can then be added separately. For
6006: example, the foo package might have minimal dependencies (those
6007: packages without which foo doesn't make sense), and then the foo-gfoo
6008: package might include the GTK frontend program gfoo. This is better
6009: than including a gtk option to foo that adds gfoo, because either that
6010: option is default, in which case binary users can't get foo without
6011: gfoo, or not default, in which case they can't get gfoo. With split
6012: packages, they can install foo without having GTK, and later decide to
6013: install gfoo (pulling in GTK at that time). This is an advantage to
6014: source users too, avoiding the need for rebuilds.</p>
6015: <p>Plugins with widely varying dependencies should usually be split
6016: instead of options.</p>
6017: <p>It is often more work to maintain split packages, especially if
6018: the upstream package does not support this. The decision of split
6019: vs. option should be made based on the likelihood that users will want
6020: or object to the various pieces, the size of the dependencies that are
6021: included, and the amount of work.</p>
6022: <p>A further consideration is licensing. Non-free parts, or parts
6023: that depend on non-free dependencies (especially plugins) should
6024: almost always be split if feasible.</p>
1.148 asau 6025: <div class="sect1">
1.75 rillig 6026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6027: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6028: <p>Global default options are listed in
6029: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6030: that should be built into every package if that option is supported.
1.110 hubertf 6031: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6032: </div>
1.148 asau 6033: <div class="sect1">
1.75 rillig 6034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6035: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6036: </h2></div></div></div>
1.75 rillig 6037: <p>The following example shows how
1.76 rillig 6038: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6039: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6040: <code class="filename">Makefile</code>, or in a file,
6041: e.g. <code class="filename">options.mk</code>, that is included by the
6042: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6043: <pre class="programlisting">
1.100 rillig 6044: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6045: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6046: PKG_OPTIONS_OPTIONAL_GROUPS= database
6047: PKG_OPTIONS_GROUP.database= mysql pgsql
6048: PKG_SUGGESTED_OPTIONS= wibble-foo
6049: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6050: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6051:
6052: .include "../../mk/bsd.prefs.mk"
6053:
6054: # this package was previously named wibble2
6055: .if defined(PKG_OPTIONS.wibble2)
6056: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6057: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6058: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6059: .endif
6060:
6061: .include "../../mk/bsd.options.mk"
6062:
6063: # Package-specific option-handling
6064:
6065: ###
6066: ### FOO support
6067: ###
6068: .if !empty(PKG_OPTIONS:Mwibble-foo)
6069: CONFIGURE_ARGS+= --enable-foo
6070: .endif
6071:
6072: ###
6073: ### LDAP support
6074: ###
6075: .if !empty(PKG_OPTIONS:Mldap)
6076: . include "../../databases/openldap-client/buildlink3.mk"
6077: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6078: .endif
6079:
6080: ###
6081: ### database support
6082: ###
6083: .if !empty(PKG_OPTIONS:Mmysql)
6084: . include "../../mk/mysql.buildlink3.mk"
6085: .endif
6086: .if !empty(PKG_OPTIONS:Mpgsql)
6087: . include "../../mk/pgsql.buildlink3.mk"
6088: .endif
1.75 rillig 6089: </pre>
6090: <p>The first section contains the information about which build
6091: options are supported by the package, and any default options settings
6092: if needed.</p>
1.128 wiz 6093: <div class="orderedlist"><ol class="orderedlist" type="1">
6094: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.189 snj 6095: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75 rillig 6096: options. It should be set to
1.78 rillig 6097: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6098: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6099: at the point where the options are processed.</p></li>
1.128 wiz 6100: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6101: build options supported by the package.</p></li>
1.128 wiz 6102: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6103: list of names of groups of mutually exclusive options. The options in
6104: each group are listed in
6105: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6106: The most specific setting of any option from the group takes
6107: precedence over all other options in the group. Options from the
6108: groups will be automatically added to
6109: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6110: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6111: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6112: packages will fail if no option from the group is
6113: selected.</p></li>
1.128 wiz 6114: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6115: of names of sets of options. At least one option from each set must
6116: be selected. The options in each set are listed in
6117: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6118: Options from the sets will be automatically added to
6119: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6120: fail if no option from the set is selected.</p></li>
1.128 wiz 6121: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6122: build options which are enabled by default.</p></li>
1.128 wiz 6123: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6124: of
1.128 wiz 6125: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.110 hubertf 6126: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6127: their option counterparts. Pairs should be added with
1.128 wiz 6128: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6129: warning will be issued if the user uses a legacy
6130: variable.</p></li>
1.128 wiz 6131: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6132: of
1.128 wiz 6133: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.75 rillig 6134: pairs that map options that have been renamed to their new
1.128 wiz 6135: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6136: the listing of global legacy options. A warning will be issued if
6137: the user uses a legacy option.</p></li>
1.128 wiz 6138: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6139: options implied by deprecated variables used. This can be used for
6140: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6141: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6142: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6143: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6144: a list of warnings about deprecated variables or options used, and
6145: what to use instead.</p></li>
6146: </ol></div>
6147: <p>A package should never modify
6148: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6149: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6150: To suggest a default set of options, use
6151: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6152: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6153: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6154: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6155: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6156: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6157: happen with platform-specific options if none of them is supported on
6158: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6159: empty list and the package is otherwise treated as not using the
6160: options framework.</p>
1.76 rillig 6161: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6162: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6163: build options, properly filtered to remove unsupported and duplicate
6164: options.</p>
6165: <p>The remaining sections contain the logic that is specific to
6166: each option. The correct way to check for an option is to check
6167: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6168: <pre class="programlisting">
1.100 rillig 6169: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6170: </pre>
6171: </div>
1.148 asau 6172: <div class="sect1">
1.75 rillig 6173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6174: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6175: <p>Options that enable similar features in different packages (like
6176: optional support for a library) should use a common name in all
6177: packages that support it (like the name of the library). If another
6178: package already has an option with the same meaning, use the same
6179: name.</p>
6180: <p>Options that enable features specific to one package, where it's
6181: unlikely that another (unrelated) package has the same (or a similar)
6182: optional feature, should use a name prefixed with
6183: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6184: <p>If a group of related packages share an optional feature
6185: specific to that group, prefix it with the name of the
1.128 wiz 6186: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6187: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6188: <p>For new options, add a line to
1.76 rillig 6189: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6190: fields, separated by tab. The first field is the option name, the
6191: second its description. The description should be a whole sentence
6192: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6193: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6194: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6195: </div>
1.148 asau 6196: <div class="sect1">
1.107 rillig 6197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6198: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6199: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107 rillig 6200: different dependencies based on the options with which the package was
6201: built. For querying these options, the file
6202: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6203: typical example looks like this:</p>
6204: <pre class="programlisting">
6205: pkgbase := libpurple
6206: .include "../../mk/pkg-build-options.mk"
6207:
6208: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6209: ...
6210: .endif
6211: </pre>
6212: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6213: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6214: options of the libpurple package, which can then be queried like
6215: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6216: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6217: details.</p>
6218: </div>
1.75 rillig 6219: </div>
1.148 asau 6220: <div class="chapter">
1.75 rillig 6221: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6222: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6223: <div class="toc">
6224: <p><b>Table of Contents</b></p>
6225: <dl>
1.106 rillig 6226: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6227: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6228: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6229: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6230: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 6231: <dd><dl>
6232: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6233: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6234: </dl></dd>
1.128 wiz 6235: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6236: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6237: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6238: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6239: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6240: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6241: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6242: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6243: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6244: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 6245: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6246: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6247: </dl>
6248: </div>
1.148 asau 6249: <div class="sect1">
1.75 rillig 6250: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6251: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6252: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6253: built. Building a package is separated into different
6254: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6255: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6256: described in the following sections. Each phase is split into
1.87 wiz 6257: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6258: containing phase, prefixed by one of <code class="varname">pre-</code>,
6259: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6260: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6261: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6262: <p>Never override the regular targets (like
6263: <code class="varname">fetch</code>), if you have to, override the
6264: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6265: <p>The basic steps for building a program are always the same. First
1.87 wiz 6266: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6267: the local system and then extracted. After any pkgsrc-specific patches
6268: to compile properly are applied, the software can be configured, then
6269: built (usually by compiling), and finally the generated binaries, etc.
6270: can be put into place on the system.</p>
1.97 rillig 6271: <p>To get more details about what is happening at each step,
6272: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6273: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6274: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6275: </div>
1.148 asau 6276: <div class="sect1">
1.75 rillig 6277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6278: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6279: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6280: the next section, here's a brief discussion on where programs are
6281: installed, and which variables influence this.</p>
1.75 rillig 6282: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6283: where all files of the final program shall be installed. It is
6284: usually set to <code class="varname">LOCALBASE</code>
6285: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6286: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6287: <code class="varname">PREFIX</code> needs to be put
6288: into the various places in the program's source where paths to
1.110 hubertf 6289: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.75 rillig 6290: <p>When choosing which of these variables to use,
1.87 wiz 6291: follow the following rules:</p>
1.148 asau 6292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6293: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6294: where the current pkg will be installed. When referring to a
6295: pkg's own installation path, use
1.128 wiz 6296: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6297: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6298: are installed. If you need to construct a -I or -L argument
6299: to the compiler to find includes and libraries installed by
1.128 wiz 6300: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6301: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6302: installed all packages in <code class="filename">/usr/local</code>. As
6303: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6304: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6305: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6306: distribution (from xsrc, etc.) is installed. When looking for
6307: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6308: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6309: <li class="listitem">
1.88 wiz 6310: <p>X11-based packages are special in that they may be
6311: installed in either <code class="varname">X11BASE</code> or
6312: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6313: <p>Usually, X11 packages should be installed under
1.88 wiz 6314: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6315: will need to include
6316: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6317: request the presence of X11 and to get the right compilation
6318: flags.</p>
1.75 rillig 6319: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6320: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6321: files. These packages are special and they must be placed under
6322: <code class="varname">X11BASE</code>. To accomplish this, set either
6323: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6324: your package.</p>
1.75 rillig 6325: <p>Some notes: If you need
1.87 wiz 6326: to find includes or libraries installed by a pkg that has
6327: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6328: its pkg <code class="filename">Makefile</code>, you need to look in
6329: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6330: <code class="filename">${LOCALBASE}</code>. To force installation of
6331: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.189 snj 6332: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87 wiz 6333: is enabled by default.</p>
1.75 rillig 6334: </li>
1.128 wiz 6335: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6336: the installed location of an X11
6337: package. <code class="varname">X11PREFIX</code> will be set to
6338: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6339: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6340: installed.</p></li>
1.128 wiz 6341: <li class="listitem">
1.88 wiz 6342: <p>If xpkgwedge is installed, it is possible to have some
6343: packages installed in <code class="varname">X11BASE</code> and some in
6344: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6345: installed package, the <code class="varname">EVAL_PREFIX</code>
6346: definition can be used. It takes pairs in the format
1.189 snj 6347: <span class="quote">“<span class="quote">DIRNAME=<package></span>”</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 6348: variable <code class="varname">DIRNAME</code> will be set to the prefix
6349: of the installed package <package>, or
1.128 wiz 6350: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6351: installed.</p>
1.75 rillig 6352: <p>This is best illustrated by example.</p>
6353: <p>The following lines are taken from
1.87 wiz 6354: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6355: <pre class="programlisting">
1.100 rillig 6356: EVAL_PREFIX+= GTKDIR=gtk+
6357: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6358: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6359: CONFIGURE_ARGS+= --enable-multibyte
6360: </pre>
1.88 wiz 6361: <p>Specific defaults can be defined for the packages
6362: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6363: definition of the form:</p>
1.75 rillig 6364: <pre class="programlisting">
1.100 rillig 6365: GTKDIR_DEFAULT= ${LOCALBASE}
6366: </pre>
1.75 rillig 6367: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6368: to the first definition in
6369: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6370: </li>
1.128 wiz 6371: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.189 snj 6372: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 6373: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6374: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6375: </ul></div>
6376: </div>
1.148 asau 6377: <div class="sect1">
1.75 rillig 6378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6379: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6380: <p>When building a package, various directories are used to store
1.87 wiz 6381: source files, temporary files, pkgsrc-internal files, and so on. These
6382: directories are explained here.</p>
1.75 rillig 6383: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6384: are two common base directories for these relative directories:
6385: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6386: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6387: inside the package itself.</p>
1.148 asau 6388: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6389: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6390: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6391: root directory. Generally, you don't need
6392: it.</p></dd>
1.97 rillig 6393: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6394: <dd><p>This is an absolute pathname that points to the
6395: current package.</p></dd>
1.75 rillig 6396: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6397: <dd><p>This is a pathname relative to
1.87 wiz 6398: <code class="varname">PKGSRCDIR</code> that points to the current
6399: package.</p></dd>
1.75 rillig 6400: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6401: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6402: where all work takes place. The distfiles are extracted to this
1.87 wiz 6403: directory. It also contains temporary directories and log files used by
6404: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6405: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6406: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6407: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6408: where the distfiles are extracted. It is usually a direct subdirectory
6409: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6410: that isn't hidden. This variable may be changed by a package
6411: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6412: </dl></div>
1.114 jmcneill 6413: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6414: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6415: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6416: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6417: If users would like to have their pkgsrc trees behave in a
6418: read-only manner, then the value of
6419: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6420: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6421: </div>
1.148 asau 6422: <div class="sect1">
1.75 rillig 6423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6424: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6425: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6426: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6427: phase. This will automatically run all phases that are required for this
6428: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6429: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6430: the package will be built, but not installed.</p>
1.75 rillig 6431: </div>
1.148 asau 6432: <div class="sect1">
1.75 rillig 6433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6434: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6435: <p>The first step in building a package is to fetch the
1.88 wiz 6436: distribution files (distfiles) from the sites that are providing
6437: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6438: phase.</p>
1.148 asau 6439: <div class="sect2">
1.81 rillig 6440: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6441: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 6442: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6443: defines all URLs from where the distfile, whose name is
6444: derived from the <code class="varname">DISTNAME</code> variable, is
6445: fetched. The more complicated cases are described
6446: below.</p>
6447: <p>The variable <code class="varname">DISTFILES</code> specifies
6448: the list of distfiles that have to be fetched. Its value
1.174 asau 6449: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6450: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 6451: so that most packages don't need to define it at all.
6452: <code class="varname">EXTRACT_SUFX</code> is
6453: <code class="literal">.tar.gz</code> by default, but can be changed
6454: freely. Note that if your package requires additional
6455: distfiles to the default one, you cannot just append the
6456: additional filenames using the <code class="literal">+=</code>
6457: operator, but you have write for example:</p>
1.81 rillig 6458: <pre class="programlisting">
1.174 asau 6459: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 6460: </pre>
1.88 wiz 6461: <p>Each distfile is fetched from a list of sites, usually
6462: <code class="varname">MASTER_SITES</code>. If the package has multiple
6463: <code class="varname">DISTFILES</code> or multiple
6464: <code class="varname">PATCHFILES</code> from different sites, you can
6465: set
6466: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6467: to the list of URLs where the file
6468: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6469: (including the suffix) can be found.</p>
6470: <pre class="programlisting">
1.100 rillig 6471: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6472: DISTFILES+= foo-file.tar.gz
6473: SITES.foo-file.tar.gz= \
6474: http://www.somewhere.com/somehow/ \
6475: http://www.somewhereelse.com/mirror/somehow/
6476: </pre>
1.81 rillig 6477: <p>When actually fetching the distfiles, each item from
1.88 wiz 6478: <code class="varname">MASTER_SITES</code> or
6479: <code class="varname">SITES.*</code> gets the name of each distfile
6480: appended to it, without an intermediate slash. Therefore,
6481: all site values have to end with a slash or other separator
6482: character. This allows for example to set
6483: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6484: that gets the name of the distfile as a parameter. In this
6485: case, the definition would look like:</p>
1.81 rillig 6486: <pre class="programlisting">
1.100 rillig 6487: MASTER_SITES= http://www.example.com/download.cgi?file=
6488: </pre>
1.125 wiz 6489: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 6490: In that case the URL is taken as is, fetched and the result
6491: stored under the name of the distfile. You can use this style
6492: for the case when the download URL style does not match the
6493: above common case. For example, if permanent download URL is a
6494: redirector to the real download URL, or the download file name
6495: is offered by an HTTP Content-Disposition header. In the
6496: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6497: created instead of the default
6498: <code class="filename">v1.0.0.tar.gz</code>.</p>
6499: <pre class="programlisting">
6500: DISTNAME= foo-1.0.0
6501: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6502: </pre>
1.81 rillig 6503: <p>There are some predefined values for
1.88 wiz 6504: <code class="varname">MASTER_SITES</code>, which can be used in
6505: packages. The names of the variables should speak for
6506: themselves.</p>
6507: <pre class="programlisting">
1.100 rillig 6508: ${MASTER_SITE_APACHE}
6509: ${MASTER_SITE_BACKUP}
6510: ${MASTER_SITE_CYGWIN}
6511: ${MASTER_SITE_DEBIAN}
6512: ${MASTER_SITE_FREEBSD}
6513: ${MASTER_SITE_FREEBSD_LOCAL}
6514: ${MASTER_SITE_GENTOO}
6515: ${MASTER_SITE_GNOME}
6516: ${MASTER_SITE_GNU}
6517: ${MASTER_SITE_GNUSTEP}
1.174 asau 6518: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 6519: ${MASTER_SITE_IFARCHIVE}
6520: ${MASTER_SITE_KDE}
6521: ${MASTER_SITE_MOZILLA}
1.174 asau 6522: ${MASTER_SITE_MOZILLA_ALL}
6523: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 6524: ${MASTER_SITE_MYSQL}
1.174 asau 6525: ${MASTER_SITE_NETLIB}
1.100 rillig 6526: ${MASTER_SITE_OPENOFFICE}
6527: ${MASTER_SITE_PERL_CPAN}
6528: ${MASTER_SITE_PGSQL}
1.174 asau 6529: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 6530: ${MASTER_SITE_R_CRAN}
6531: ${MASTER_SITE_SOURCEFORGE}
6532: ${MASTER_SITE_SOURCEFORGE_JP}
6533: ${MASTER_SITE_SUNSITE}
6534: ${MASTER_SITE_SUSE}
6535: ${MASTER_SITE_TEX_CTAN}
6536: ${MASTER_SITE_XCONTRIB}
6537: ${MASTER_SITE_XEMACS}
1.174 asau 6538: ${MASTER_SITE_XORG}
1.100 rillig 6539: </pre>
1.88 wiz 6540: <p>Some explanations for the less self-explaining ones:
6541: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6542: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.132 spz 6543: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.88 wiz 6544: <p>If you choose one of these predefined sites, you may
6545: want to specify a subdirectory of that site. Since these
6546: macros may expand to more than one actual site, you
6547: <span class="emphasis"><em>must</em></span> use the following construct to
6548: specify a subdirectory:</p>
1.81 rillig 6549: <pre class="programlisting">
1.100 rillig 6550: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6551: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6552: </pre>
1.81 rillig 6553: <p>Note the trailing slash after the subdirectory
1.88 wiz 6554: name.</p>
1.81 rillig 6555: </div>
1.148 asau 6556: <div class="sect2">
1.81 rillig 6557: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6558: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6559: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6560: all the distfiles exist in a local directory
1.93 rillig 6561: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6562: user). If the files do not exist, they are fetched using
6563: commands of the form</p>
1.75 rillig 6564: <pre class="programlisting">
1.100 rillig 6565: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6566: </pre>
1.88 wiz 6567: <p>where <code class="literal">${site}</code> varies through
6568: several possibilities in turn: first,
6569: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6570: sites specified in either <code class="varname">SITES.file</code> if
6571: defined, else <code class="varname">MASTER_SITES</code> or
6572: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6573: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6574: all except the first and the last can be optionally sorted
6575: by the user, via setting either
6576: <code class="varname">MASTER_SORT_RANDOM</code>, and
6577: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6578: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6579: <p> The specific command and arguments used depend on the
6580: <code class="varname">FETCH_USING</code> parameter. The example above is
6581: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6582: <p>The distfiles mirror run by the NetBSD Foundation uses the
6583: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6584: distfiles, if they are freely distributable. Packages setting
6585: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6586: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6587: mirrored.</p>
1.81 rillig 6588: </div>
1.75 rillig 6589: </div>
1.148 asau 6590: <div class="sect1">
1.75 rillig 6591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6592: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6593: <p>After the distfile(s) are fetched, their checksum is
6594: generated and compared with the checksums stored in the
6595: distinfo file. If the checksums don't match, the build is
6596: aborted. This is to ensure the same distfile is used for
6597: building, and that the distfile wasn't changed, e.g. by some
6598: malign force, deliberately changed distfiles on the master
6599: distribution site or network lossage.</p>
1.75 rillig 6600: </div>
1.148 asau 6601: <div class="sect1">
1.75 rillig 6602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6603: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6604: <p>When the distfiles are present on the local system, they
1.88 wiz 6605: need to be extracted, as they usually come in the form of some
6606: compressed archive format.</p>
1.75 rillig 6607: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6608: extracted. If you only need some of them, you can set the
6609: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6610: files.</p>
6611: <p>Extracting the files is usually done by a little
1.93 rillig 6612: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6613: already knows how to extract various archive formats, so most
6614: likely you will not need to change anything here. But if you
6615: need, the following variables may help you:</p>
1.148 asau 6616: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6617: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6618: <dd><p>Use these variables to override the default
1.88 wiz 6619: options for an extract command, which are defined in
1.93 rillig 6620: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6621: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6622: <dd><p>This variable can be set to
1.114 jmcneill 6623: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6624: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6625: absolute pathname pointing to the command with which tar
1.114 jmcneill 6626: archives should be extracted. It is preferred to choose bsdtar over gtar
6627: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6628: </dl></div>
1.88 wiz 6629: <p>If the <code class="filename">extract</code> program doesn't
6630: serve your needs, you can also override the
6631: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6632: command used for extracting the files. This command is
6633: executed in the <code class="filename">${WRKSRC}</code>
6634: directory. During execution of this command, the shell
6635: variable <code class="varname">extract_file</code> holds the absolute
6636: pathname of the file that is going to be extracted.</p>
1.75 rillig 6637: <p>And if that still does not suffice, you can override the
1.88 wiz 6638: <code class="varname">do-extract</code> target in the package
6639: Makefile.</p>
1.75 rillig 6640: </div>
1.148 asau 6641: <div class="sect1">
1.75 rillig 6642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6643: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6644: <p>After extraction, all the patches named by the
1.88 wiz 6645: <code class="varname">PATCHFILES</code>, those present in the patches
6646: subdirectory of the package as well as in
6647: $LOCALPATCHES/$PKGPATH (e.g.
6648: <code class="filename">/usr/local/patches/graphics/png</code>) are
6649: applied. Patchfiles ending in <code class="filename">.Z</code> or
6650: <code class="filename">.gz</code> are uncompressed before they are
6651: applied, files ending in <code class="filename">.orig</code> or
6652: <code class="filename">.rej</code> are ignored. Any special options to
1.189 snj 6653: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.110 hubertf 6654: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more details.</p>
1.189 snj 6655: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 6656: it fail if the patches apply with some lines of fuzz. Please
6657: fix (regen) the patches so that they apply cleanly. The
6658: rationale behind this is that patches that don't apply cleanly
6659: may end up being applied in the wrong place, and cause severe
6660: harm there.</p>
1.75 rillig 6661: </div>
1.148 asau 6662: <div class="sect1">
1.75 rillig 6663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6664: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6665: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88 wiz 6666: </p>
1.75 rillig 6667: </div>
1.148 asau 6668: <div class="sect1">
1.75 rillig 6669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6670: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6671: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6672: linkers. The following variables can be used to tweak the
6673: wrappers.</p>
1.148 asau 6674: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6675: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6676: <dd><p>The command used to print progress
1.88 wiz 6677: messages. Does nothing by default. Set to
6678: <code class="literal">${ECHO}</code> to see the progress
6679: messages.</p></dd>
1.75 rillig 6680: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6681: <dd><p>This variable can be set to
1.88 wiz 6682: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6683: depending on whether you want additional information in the
6684: wrapper log file.</p></dd>
1.75 rillig 6685: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6686: <dd><p>This variable can be set to
1.88 wiz 6687: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6688: on whether the wrapper should use its cache, which will
6689: improve the speed. The default value is
6690: <code class="literal">yes</code>, but is forced to
6691: <code class="literal">no</code> if the platform does not support
6692: it.</p></dd>
1.75 rillig 6693: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6694: <dd><p>A list of reordering commands. A reordering
6695: command has the form
6696: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6697: It ensures that that
6698: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6699: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6700: </p></dd>
1.75 rillig 6701: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6702: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6703: investigate further]</p></dd>
1.75 rillig 6704: </dl></div>
6705: </div>
1.148 asau 6706: <div class="sect1">
1.75 rillig 6707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6708: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6709: <p>Most pieces of software need information on the header
6710: files, system calls, and library routines which are available
6711: on the platform they run on. The process of determining this
6712: information is known as configuration, and is usually
6713: automated. In most cases, a script is supplied with the
6714: distfiles, and its invocation results in generation of header
6715: files, Makefiles, etc.</p>
6716: <p>If the package contains a configure script, this can be
6717: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6718: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6719: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6720: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6721: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6722: <pre class="programlisting">
1.100 rillig 6723: .for d in ${CONFIGURE_DIRS}
6724: cd ${WRKSRC} \
6725: && cd ${d} \
6726: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6727: .endfor
6728: </pre>
1.88 wiz 6729: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6730: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6731: <code class="varname">WRKSRC</code>. In each of these directories, the
6732: configure script is run with the environment
6733: <code class="varname">CONFIGURE_ENV</code> and arguments
6734: <code class="varname">CONFIGURE_ARGS</code>. The variables
6735: <code class="varname">CONFIGURE_ENV</code>,
6736: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6737: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6738: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6739: package.</p>
1.144 wiz 6740: <p>If the program uses the Perl way of configuration (mainly Perl
6741: modules, but not only), i.e. a file called
6742: <code class="filename">Makefile.PL</code>, it should include
6743: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6744: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6745: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6746: <p>If the program uses an <code class="filename">Imakefile</code>
6747: for configuration, the appropriate steps can be invoked by
6748: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6749: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6750: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6751: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6752: xmkmf's environment by adding them to the
6753: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6754: <p>If the program uses <code class="filename">cmake</code>
6755: for configuration, the appropriate steps can be invoked by
1.128 wiz 6756: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6757: You can add variables to cmake's environment by adding them to the
6758: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6759: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6760: The top directory argument is given by the
6761: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6762: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6763: <p>If there is no configure step at all, set
1.128 wiz 6764: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6765: </div>
1.148 asau 6766: <div class="sect1">
1.75 rillig 6767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6768: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6769: <p>For building a package, a rough equivalent of the
6770: following code is executed.</p>
1.75 rillig 6771: <pre class="programlisting">
1.100 rillig 6772: .for d in ${BUILD_DIRS}
6773: cd ${WRKSRC} \
6774: && cd ${d} \
6775: && env ${MAKE_ENV} \
6776: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6777: -f ${MAKE_FILE} \
6778: ${BUILD_TARGET}
6779: .endfor
6780: </pre>
1.88 wiz 6781: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6782: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6783: <code class="varname">WRKSRC</code>. In each of these directories,
6784: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6785: <code class="varname">MAKE_ENV</code> and arguments
6786: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6787: <code class="varname">MAKE_ENV</code>,
6788: <code class="varname">BUILD_MAKE_FLAGS</code>,
6789: <code class="varname">MAKE_FILE</code> and
6790: <code class="varname">BUILD_TARGET</code> may all be changed by the
6791: package.</p>
1.75 rillig 6792: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6793: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6794: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6795: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6796: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6797: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6798: <p>If there is no build step at all, set
1.128 wiz 6799: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6800: </div>
1.148 asau 6801: <div class="sect1">
1.75 rillig 6802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6803: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6804: <p>[TODO]</p>
6805: </div>
1.148 asau 6806: <div class="sect1">
1.75 rillig 6807: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6808: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6809: <p>Once the build stage has completed, the final step is to
1.88 wiz 6810: install the software in public directories, so users can
6811: access the programs and files.</p>
1.75 rillig 6812: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6813: equivalent of the following code is executed. Additionally,
6814: before and after this code, much magic is performed to do
6815: consistency checks, registering the package, and so on.</p>
6816: <pre class="programlisting">
1.100 rillig 6817: .for d in ${INSTALL_DIRS}
6818: cd ${WRKSRC} \
6819: && cd ${d} \
6820: && env ${MAKE_ENV} \
6821: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6822: -f ${MAKE_FILE} \
6823: ${INSTALL_TARGET}
6824: .endfor
6825: </pre>
1.75 rillig 6826: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6827: <span class="emphasis"><em>build</em></span> phase.
6828: <code class="varname">INSTALL_DIRS</code> defaults to
6829: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6830: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6831: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6832: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6833: defined.</p>
1.75 rillig 6834: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6835: variables are useful. They are all variations of the
1.189 snj 6836: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 6837: permissions preset. <code class="varname">INSTALL</code> is the plain
6838: install command. The specialized variants, together with their
6839: intended use, are:</p>
1.148 asau 6840: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6841: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6842: <dd><p>directories that contain
6843: binaries</p></dd>
1.75 rillig 6844: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6845: <dd><p>directories that contain
6846: scripts</p></dd>
1.75 rillig 6847: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6848: <dd><p>directories that contain shared and static
6849: libraries</p></dd>
1.75 rillig 6850: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6851: <dd><p>directories that contain data
6852: files</p></dd>
1.75 rillig 6853: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6854: <dd><p>directories that contain man
6855: pages</p></dd>
1.75 rillig 6856: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6857: <dd><p>binaries that can be stripped from debugging
6858: symbols</p></dd>
1.75 rillig 6859: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6860: <dd><p>binaries that cannot be
6861: stripped</p></dd>
1.75 rillig 6862: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6863: <dd><p>game
6864: binaries</p></dd>
1.75 rillig 6865: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6866: <dd><p>shared and static
6867: libraries</p></dd>
1.75 rillig 6868: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6869: <dd><p>data files</p></dd>
6870: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6871: <dd><p>data files for
6872: games</p></dd>
1.75 rillig 6873: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6874: <dd><p>man pages</p></dd>
6875: </dl></div>
6876: <p>Some other variables are:</p>
1.148 asau 6877: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6878: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6879: <dd><p>A list of directories relative to
1.88 wiz 6880: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6881: beginning of the <span class="emphasis"><em>install</em></span> phase.
6882: The package is supposed to create all needed directories itself
6883: before installing files to it and list all other directories here.
6884: </p></dd>
1.75 rillig 6885: </dl></div>
1.97 rillig 6886: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6887: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6888: mostly relevant for packages in the <code class="filename">regress</code>
6889: category.</p>
1.75 rillig 6890: </div>
1.148 asau 6891: <div class="sect1">
1.75 rillig 6892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6893: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6894: <p>Once the install stage has completed, a binary package of
6895: the installed files can be built. These binary packages can be
6896: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6897: the <span class="command"><strong>make bin-install</strong></span> or by using
6898: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6899: <p>By default, the binary packages are created in
6900: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6901: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6902: one for each category in the <code class="varname">CATEGORIES</code>
6903: variable. <code class="varname">PACKAGES</code> defaults to
6904: <code class="filename">pkgsrc/packages</code>.</p>
6905: </div>
1.148 asau 6906: <div class="sect1">
1.88 wiz 6907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6908: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6909: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6910: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6911: to clean the work directories of all dependencies too, use
1.110 hubertf 6912: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6913: </div>
1.148 asau 6914: <div class="sect1">
1.75 rillig 6915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6916: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6917: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6918: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6919: <dd><p>For any of the main targets described in the
6920: previous section, two auxiliary targets exist with
1.128 wiz 6921: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.87 wiz 6922: prefix for the main target's name. These targets are
1.88 wiz 6923: invoked before and after the main target is called,
6924: allowing extra configuration or installation steps be
6925: performed from a package's Makefile, for example, which
6926: a program's configure script or install target
6927: omitted.</p></dd>
1.75 rillig 6928: <dt><span class="term">do-*</span></dt>
1.88 wiz 6929: <dd><p>Should one of the main targets do the wrong thing,
6930: and should there be no variable to fix this, you can
6931: redefine it with the do-* target. (Note that redefining
6932: the target itself instead of the do-* target is a bad
6933: idea, as the pre-* and post-* targets won't be called
6934: anymore, etc.) You will not usually need to do
6935: this.</p></dd>
1.75 rillig 6936: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6937: <dd>
1.110 hubertf 6938: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6939: you noticed some file was not installed properly, you
6940: can repeat the installation with this target, which will
1.128 wiz 6941: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6942: <p>This is the default value of
6943: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6944: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6945: package</strong></span>, where the defaults are
1.128 wiz 6946: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6947: respectively.</p>
6948: </dd>
1.75 rillig 6949: <dt><span class="term">deinstall</span></dt>
6950: <dd>
1.189 snj 6951: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 6952: current directory, effectively de-installing the
6953: package. The following variables can be used to tune the
6954: behaviour:</p>
1.148 asau 6955: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6956: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.189 snj 6957: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 6958: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6959: <dd><p>Remove all packages that require (depend on)
6960: the given package. This can be used to remove any
6961: packages that may have been pulled in by a given
1.110 hubertf 6962: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6963: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6964: <code class="filename">pkgsrc/x11/kde</code>, this is
6965: likely to remove whole KDE. Works by adding
1.189 snj 6966: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 6967: command line.</p></dd>
1.75 rillig 6968: </dl></div>
6969: </dd>
1.88 wiz 6970: <dt><span class="term">bin-install</span></dt>
6971: <dd><p>Install a binary package from local disk and via FTP
6972: from a list of sites (see the
6973: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6974: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6975: available anywhere. The arguments given to
1.110 hubertf 6976: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6977: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6978: operation, etc.</p></dd>
1.75 rillig 6979: <dt><span class="term">update</span></dt>
6980: <dd>
1.88 wiz 6981: <p>This target causes the current package to be
6982: updated to the latest version. The package and all
6983: depending packages first get de-installed, then current
6984: versions of the corresponding packages get compiled and
6985: installed. This is similar to manually noting which
6986: packages are currently installed, then performing a
1.110 hubertf 6987: series of <span class="command"><strong>make deinstall</strong></span> and
6988: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 6989: <code class="varname">UPDATE_TARGET</code> is set to) for these
6990: packages.</p>
1.128 wiz 6991: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 6992: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 6993: update</strong></span> was interrupted for some reason.
6994: However, in this case, make sure you don't call
1.110 hubertf 6995: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 6996: list of dependent packages in <code class="varname">WRKDIR</code>.
6997: Otherwise, you lose the ability to automatically update
6998: the current package along with the dependent packages
6999: you have installed.</p>
1.110 hubertf 7000: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7001: update</strong></span> will only work as long as the package
7002: tree remains unchanged. If the source code for one of
7003: the packages to be updated has been changed, resuming
1.110 hubertf 7004: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7005: fail!</p>
7006: <p>The following variables can be used either on the
1.110 hubertf 7007: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7008: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7009: update</strong></span>:</p>
1.148 asau 7010: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7011: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7012: <dd><p>Install target to recursively use for the
7013: updated package and the dependent packages.
7014: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7015: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7016: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7017: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7018: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7019: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7020: endless loop!</p></dd>
1.75 rillig 7021: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7022: <dd><p>Don't clean up after updating. Useful if
7023: you want to leave the work sources of the updated
7024: packages around for inspection or other purposes.
7025: Be sure you eventually clean up the source tree
1.128 wiz 7026: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7027: or you may run into troubles with old source code
7028: still lying around on your next
1.110 hubertf 7029: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7030: update</strong></span>.</p></dd>
1.75 rillig 7031: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7032: <dd><p>Deinstall each package before installing
7033: (making <code class="varname">DEPENDS_TARGET</code>). This
7034: may be necessary if the
1.128 wiz 7035: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7036: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7037: update</strong></span>.</p></dd>
1.75 rillig 7038: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7039: <dd><p>Allows you to disable recursion and hardcode
7040: the target for packages. The default is
1.128 wiz 7041: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7042: facilitating a recursive update of prerequisite
7043: packages. Only set
7044: <code class="varname">DEPENDS_TARGET</code> if you want to
7045: disable recursive updates. Use
7046: <code class="varname">UPDATE_TARGET</code> instead to just
7047: set a specific target for each package to be
1.110 hubertf 7048: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7049: (see above).</p></dd>
1.75 rillig 7050: </dl></div>
7051: </dd>
7052: <dt><span class="term">clean-update</span></dt>
7053: <dd>
1.88 wiz 7054: <p>Clean the source tree for all packages that would
1.110 hubertf 7055: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7056: from the current directory. This target should not be
7057: used if the current package (or any of its depending
7058: packages) have already been de-installed (e.g., after
1.110 hubertf 7059: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7060: some packages you intended to update. As a rule of
7061: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7062: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7063: and only if you have a dirty package tree (e.g., if you
7064: used <code class="varname">NOCLEAN</code>).</p>
7065: <p>If you are unsure about whether your tree is
1.110 hubertf 7066: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7067: clean</strong></span> at the top of the tree, or use the
7068: following sequence of commands from the directory of the
7069: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7070: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7071: time, otherwise you lose all the packages you wanted to
7072: update!):</p>
1.87 wiz 7073: <pre class="screen">
7074: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7075: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7076: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7077: </pre>
1.88 wiz 7078: <p>The following variables can be used either on the
1.110 hubertf 7079: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7080: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 7081: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7082: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7083: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7084: reconstruct the list of directories to update for
1.110 hubertf 7085: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7086: update</strong></span> successfully installed all
7087: packages you wanted to update. Normally, this is
1.110 hubertf 7088: done automatically on <span class="command"><strong>make
1.88 wiz 7089: update</strong></span>, but may have been suppressed by
7090: the <code class="varname">NOCLEAN</code> variable (see
7091: above).</p></dd>
1.75 rillig 7092: </dl></div>
7093: </dd>
1.88 wiz 7094: <dt><span class="term">replace</span></dt>
7095: <dd>
7096: <p>Update the installation of the current package. This
7097: differs from update in that it does not replace dependent
1.189 snj 7098: packages. You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88 wiz 7099: target to work.</p>
7100: <p><span class="emphasis"><em>Be careful when using this
7101: target!</em></span> There are no guarantees that dependent
7102: packages will still work, in particular they will most
1.110 hubertf 7103: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7104: library package whose shared library major version changed
7105: between your installed version and the new one. For this
7106: reason, this target is not officially supported and only
7107: recommended for advanced users.</p>
7108: </dd>
1.75 rillig 7109: <dt><span class="term">info</span></dt>
1.189 snj 7110: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 7111: package. You can use this to check which version of a
7112: package is installed.</p></dd>
7113: <dt><span class="term">index</span></dt>
7114: <dd>
7115: <p>This is a top-level command, i.e. it should be used in
7116: the <code class="filename">pkgsrc</code> directory. It creates a
7117: database of all packages in the local pkgsrc tree, including
7118: dependencies, comment, maintainer, and some other useful
7119: information. Individual entries are created by running
1.110 hubertf 7120: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7121: directories. This index file is saved as
7122: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7123: verbose format by running <span class="command"><strong>make
1.88 wiz 7124: print-index</strong></span>. You can search in it with
1.110 hubertf 7125: <span class="command"><strong>make search
1.88 wiz 7126: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7127: extract a list of all packages that depend on a particular
1.110 hubertf 7128: one by running <span class="command"><strong>make show-deps
1.88 wiz 7129: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7130: <p>Running this command takes a very long time, some
7131: hours even on fast machines!</p>
7132: </dd>
1.75 rillig 7133: <dt><span class="term">readme</span></dt>
1.88 wiz 7134: <dd>
7135: <p>This target generates a
7136: <code class="filename">README.html</code> file, which can be
1.189 snj 7137: viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.88 wiz 7138: contain references to any packages which are in the
7139: <code class="varname">PACKAGES</code> directory on the local
7140: host. The generated files can be made to refer to URLs
7141: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7142: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7143: wanted to generate <code class="filename">README.html</code>
7144: files which pointed to binary packages on the local
7145: machine, in the directory
7146: <code class="filename">/usr/packages</code>, set
7147: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7148: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7149: <code class="varname">${PACKAGES}</code> directory and its
7150: subdirectories will be searched for all the binary
7151: packages.</p>
7152: <p>The target can be run at the toplevel or in category
7153: directories, in which case it descends recursively.</p>
7154: </dd>
1.75 rillig 7155: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7156: <dd><p>This is a top-level command, run it in
7157: <code class="filename">pkgsrc</code>. Use this target to create a
7158: file <code class="filename">README-all.html</code> which contains a
7159: list of all packages currently available in the NetBSD
7160: Packages Collection, together with the category they belong
7161: to and a short description. This file is compiled from the
7162: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7163: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7164: readme</strong></span>.</p></dd>
1.75 rillig 7165: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7166: <dd><p>This is very much the same as the
1.128 wiz 7167: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7168: used when generating a pkgsrc tree to be written to a
7169: CD-ROM. This target also produces
7170: <code class="filename">README.html</code> files, and can be made
7171: to refer to URLs based on
7172: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7173: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7174: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7175: <dd><p>This target shows which distfiles and patchfiles
7176: are needed to build the package
7177: (<code class="varname">ALLFILES</code>, which contains all
7178: <code class="varname">DISTFILES</code> and
1.87 wiz 7179: <code class="varname">PATCHFILES</code>, but not
7180: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7181: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7182: <dd><p>This target shows nothing if the package is not
7183: installed. If a version of this package is installed,
7184: but is not the version provided in this version of
7185: pkgsrc, then a warning message is displayed. This target
7186: can be used to show which of your installed packages are
7187: downlevel, and so the old versions can be deleted, and
7188: the current ones added.</p></dd>
1.75 rillig 7189: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7190: <dd><p>This target shows the directory in the pkgsrc
7191: hierarchy from which the package can be built and
7192: installed. This may not be the same directory as the one
7193: from which the package was installed. This target is
7194: intended to be used by people who may wish to upgrade
7195: many packages on a single host, and can be invoked from
7196: the top-level pkgsrc Makefile by using the
1.128 wiz 7197: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7198: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7199: <dd><p>This target shows which installed packages match
7200: the current package's <code class="varname">DEPENDS</code>. Useful
7201: if out of date dependencies are causing build
7202: problems.</p></dd>
1.75 rillig 7203: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7204: <dd><p>After a package is installed, check all its
7205: binaries and (on ELF platforms) shared libraries to see
7206: if they find the shared libs they need. Run by default
1.110 hubertf 7207: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75 rillig 7208: <dt><span class="term">print-PLIST</span></dt>
7209: <dd>
1.128 wiz 7210: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7211: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7212: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7213: -newer work/.extract_done</strong></span>. An attempt is made
7214: to care for shared libs etc., but it is
1.87 wiz 7215: <span class="emphasis"><em>strongly</em></span> recommended to review the
7216: result before putting it into
7217: <code class="filename">PLIST</code>. On upgrades, it's useful to
7218: diff the output of this command against an already
7219: existing <code class="filename">PLIST</code> file.</p>
1.189 snj 7220: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 7221: other methods that don't update file access times, be
7222: sure to add these files manually to your
1.128 wiz 7223: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7224: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7225: them!</p>
1.128 wiz 7226: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.87 wiz 7227: information on this target.</p>
1.75 rillig 7228: </dd>
7229: <dt><span class="term">bulk-package</span></dt>
7230: <dd>
1.88 wiz 7231: <p>Used to do bulk builds. If an appropriate binary
7232: package already exists, no action is taken. If not, this
7233: target will compile, install and package it (and its
7234: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 7235: 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
7236: builds)</i></a>).
1.88 wiz 7237: After creating the binary package, the sources, the
7238: just-installed package and its required packages are
7239: removed, preserving free disk space.</p>
7240: <p><span class="emphasis"><em>Beware that this target may deinstall
7241: all packages installed on a system!</em></span></p>
1.75 rillig 7242: </dd>
7243: <dt><span class="term">bulk-install</span></dt>
7244: <dd>
1.88 wiz 7245: <p>Used during bulk-installs to install required
7246: packages. If an up-to-date binary package is available,
1.189 snj 7247: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110 hubertf 7248: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7249: but the installed binary won't be removed.</p>
1.88 wiz 7250: <p>A binary package is considered
1.128 wiz 7251: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.189 snj 7252: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148 asau 7253: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7254: <li class="listitem"><p>None of the package's files
1.88 wiz 7255: (<code class="filename">Makefile</code>, ...) were modified
7256: since it was built.</p></li>
1.128 wiz 7257: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7258: packages were modified since it was built.</p></li>
1.75 rillig 7259: </ul></div>
1.88 wiz 7260: <p><span class="emphasis"><em>Beware that this target may deinstall
7261: all packages installed on a system!</em></span></p>
1.75 rillig 7262: </dd>
7263: </dl></div>
7264: </div>
7265: </div>
1.148 asau 7266: <div class="chapter">
1.75 rillig 7267: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7268: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7269: <div class="toc">
7270: <p><b>Table of Contents</b></p>
7271: <dl>
1.106 rillig 7272: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7273: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7274: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7275: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7276: </dl>
7277: </div>
1.87 wiz 7278: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7279: by pkgsrc and also for individual packages to define what commands
7280: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7281: or for later run-time of an installed packaged (such as
7282: <code class="varname">DEPENDS</code>).
7283: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7284: package will not be used.</p>
7285: <p>When building a package, the replacement tools are
1.75 rillig 7286: made available in a directory (as symlinks or wrapper scripts)
7287: that is early in the executable search path. Just like the buildlink
1.87 wiz 7288: system, this helps with consistent builds.</p>
7289: <p>A tool may be needed to help build a specific package. For example,
7290: perl, GNU make (gmake) or yacc may be needed.</p>
7291: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7292: tool may be inefficient for building a package with pkgsrc.
7293: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7294: yacc) or a better sed.</p>
7295: <p>The tools used by a package can be listed by running
1.110 hubertf 7296: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 7297: <div class="sect1">
1.75 rillig 7298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7299: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7300: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7301: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7302: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7303: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7304: These can be seen by running:
1.110 hubertf 7305: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7306: <p>If a package needs a specific program to build
1.75 rillig 7307: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7308: to define the tools needed.</p>
1.75 rillig 7309: </div>
1.148 asau 7310: <div class="sect1">
1.75 rillig 7311: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7312: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7313: <p>In the following examples, the :run means that it is needed at
7314: run-time (and becomes a DEPENDS).
1.75 rillig 7315: The default is a build dependency which can be set with
7316: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7317: and pkg-config:build.)</p>
1.75 rillig 7318: <pre class="programlisting">
7319: USE_TOOLS+= gmake perl:run pkg-config
7320: </pre>
1.87 wiz 7321: <p>When using the tools framework, a
1.75 rillig 7322: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7323: which contains the full path to the appropriate tool. For example,
1.128 wiz 7324: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7325: on Linux systems.</p>
7326: <p>If you always need a pkgsrc version of the
1.75 rillig 7327: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7328: </p>
7329: </div>
1.148 asau 7330: <div class="sect1">
1.75 rillig 7331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7332: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7333: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7334: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7335: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7336: the name of the common tools. For example:</p>
7337: <pre class="programlisting">
7338: .if exists(/usr/bin/bzcat)
7339: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7340: .elif exists(/usr/bin/bzip2)
7341: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7342: .endif
1.69 rillig 7343:
1.75 rillig 7344: TOOLS_PLATFORM.true?= true # shell builtin
7345: </pre>
7346: </div>
1.148 asau 7347: <div class="sect1">
1.97 rillig 7348: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7349: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 asau 7350: <div class="qandaset">
1.193 ! dholland 7351: <a name="idm77799312"></a><dl>
1.106 rillig 7352: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7353: </dt>
1.106 rillig 7354: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7355: tools?</a>
7356: </dt>
1.106 rillig 7357: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7358: package is using while being built? I want to know whether it
7359: uses sed or not.</a>
7360: </dt>
7361: </dl>
1.148 asau 7362: <table border="0" style="width: 100%;">
7363: <colgroup>
1.97 rillig 7364: <col align="left" width="1%">
1.128 wiz 7365: <col>
1.148 asau 7366: </colgroup>
1.97 rillig 7367: <tbody>
1.148 asau 7368: <tr class="question">
1.97 rillig 7369: <td align="left" valign="top">
1.193 ! dholland 7370: <a name="tools.new"></a><a name="idm77798928"></a><p><b>18.4.1.</b></p>
1.97 rillig 7371: </td>
7372: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7373: </tr>
7374: <tr class="answer">
7375: <td align="left" valign="top"></td>
7376: <td align="left" valign="top"><p>TODO</p></td>
7377: </tr>
1.148 asau 7378: <tr class="question">
1.97 rillig 7379: <td align="left" valign="top">
1.193 ! dholland 7380: <a name="tools.listall"></a><a name="idm77797904"></a><p><b>18.4.2.</b></p>
1.97 rillig 7381: </td>
7382: <td align="left" valign="top"><p>How do I get a list of all available
7383: tools?</p></td>
7384: </tr>
7385: <tr class="answer">
7386: <td align="left" valign="top"></td>
7387: <td align="left" valign="top"><p>TODO</p></td>
7388: </tr>
1.148 asau 7389: <tr class="question">
1.97 rillig 7390: <td align="left" valign="top">
1.193 ! dholland 7391: <a name="tools.used"></a><a name="idm77796752"></a><p><b>18.4.3.</b></p>
1.97 rillig 7392: </td>
7393: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7394: package is using while being built? I want to know whether it
7395: uses sed or not.</p></td>
7396: </tr>
7397: <tr class="answer">
7398: <td align="left" valign="top"></td>
7399: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7400: to do it.)</p></td>
7401: </tr>
7402: </tbody>
7403: </table>
7404: </div>
7405: </div>
1.75 rillig 7406: </div>
1.148 asau 7407: <div class="chapter">
1.75 rillig 7408: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7409: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7410: <div class="toc">
7411: <p><b>Table of Contents</b></p>
7412: <dl>
1.106 rillig 7413: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7414: <dd><dl>
1.106 rillig 7415: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7416: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 7417: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7418: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7419: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7420: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7421: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7422: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7423: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7424: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7425: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7426: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7427: </dl></dd>
1.128 wiz 7428: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 7429: <dd><dl>
7430: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7431: <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>
7432: </dl></dd>
1.128 wiz 7433: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 7434: <dd><dl>
7435: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7436: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7437: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7438: </dl></dd>
7439: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7440: <dd><dl>
7441: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7442: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7443: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7444: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7445: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7446: </dl></dd>
1.128 wiz 7447: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 7448: <dd><dl>
7449: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7450: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7451: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.106 rillig 7452: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7453: </dl></dd>
1.128 wiz 7454: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 7455: <dd><dl>
7456: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7457: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7458: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7459: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7460: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7461: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7462: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7463: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7464: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7465: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7466: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7467: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7468: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7469: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7470: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7471: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7472: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7473: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7474: emulation</a></span></dt>
1.106 rillig 7475: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7476: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7477: </dl></dd>
1.106 rillig 7478: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7479: </dl>
7480: </div>
1.148 asau 7481: <div class="sect1">
1.75 rillig 7482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7483: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 asau 7484: <div class="sect2">
1.75 rillig 7485: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7486: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7487: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7488: different platforms. As a result, it is important to ensure,
7489: where possible, that packages in pkgsrc are portable. This
7490: chapter mentions some particular details you should pay
7491: attention to while working on pkgsrc.</p>
1.78 rillig 7492: </div>
1.148 asau 7493: <div class="sect2">
1.78 rillig 7494: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7495: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 7496: </h3></div></div></div>
1.78 rillig 7497: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7498: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7499: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7500: want to use those variables in the preprocessor directives of
1.189 snj 7501: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7502: <code class="literal">.for</code>), you need to include the file
7503: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7504: loads the user preferences.</p>
1.78 rillig 7505: <p>But note that some variables may not be completely defined
1.87 wiz 7506: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7507: included, as they may contain references to variables that are
7508: not yet defined. In shell commands this is no problem, since
7509: variables are actually macros, which are only expanded when they
7510: are used. But in the preprocessor directives mentioned above and
7511: in dependency lines (of the form <code class="literal">target:
7512: dependencies</code>) the variables are expanded at load
7513: time.</p>
1.148 asau 7514: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7515: <h3 class="title">Note</h3>
7516: <p>Currently there is no exhaustive list of all
1.87 wiz 7517: variables that tells you whether they can be used at load time
7518: or only at run time, but it is in preparation.</p>
1.78 rillig 7519: </div>
7520: </div>
1.148 asau 7521: <div class="sect2">
1.78 rillig 7522: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7523: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7524: <p>Occasionally, packages require interaction from the user,
7525: and this can be in a number of ways:</p>
1.148 asau 7526: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7527: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7528: interaction such as entering username/password or accepting a
7529: license on a web page.</p></li>
1.128 wiz 7530: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7531: passwords.</p></li>
1.128 wiz 7532: <li class="listitem"><p>help to configure the package before it is built</p></li>
7533: <li class="listitem"><p>help during the build process</p></li>
7534: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7535: </ul></div>
1.88 wiz 7536: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7537: provided to notify the pkgsrc mechanism of an interactive stage
7538: which will be needed, and this should be set in the package's
7539: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7540: <pre class="programlisting">
1.100 rillig 7541: INTERACTIVE_STAGE= build
1.87 wiz 7542: </pre>
1.78 rillig 7543: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7544: <pre class="programlisting">
1.100 rillig 7545: INTERACTIVE_STAGE= configure install
1.87 wiz 7546: </pre>
1.88 wiz 7547: <p>The user can then decide to skip this package by setting the
7548: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7549: </div>
1.148 asau 7550: <div class="sect2">
1.75 rillig 7551: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7552: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7553: <p>Authors of software can choose the licence under which
7554: software can be copied. This is due to copyright law, and reasons
7555: for license choices are outside the scope of pkgsrc. The pkgsrc
7556: system recognizes that there are a number of licenses which some
7557: users may find objectionable or difficult or impossible to comply
7558: with. The Free Software Foundation has declared some licenses
7559: "Free", and the Open Source Initiative has a definition of "Open
7560: Source". The pkgsrc system, as a policy choice, does not label
7561: packages which have licenses that are Free or Open Source.
7562: However, packages without a license meeting either of those tests
7563: are labeled with a license tag denoting the license. Note that a
7564: package with no license to copy trivially does not meet either the
7565: Free or Open Source test.</p>
7566: <p>For packages which are not Free or Open Source, pkgsrc will
7567: not build the package unless the user has indicated to pkgsrc that
7568: packages with that particular license may be built. Note that
7569: this documentation avoids the term "accepted the license". The
7570: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7571: accidentally building a package with a non-free license;
1.98 wiz 7572: judgement and responsibility remain with the user. (Installation
7573: of binary packages are not currently subject to this mechanism;
7574: this is a bug.)</p>
7575: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7576: or the GPL, and not the other. The free licenses are added to the
7577: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7578: user can override the default by setting the
7579: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7580: of "+=". The licenses accepted by default are:
7581: </p>
7582: <pre class="programlisting">
1.154 rodent 7583: apache-1.1 apache-2.0
7584: arphic-public
7585: artistic artistic-2.0
7586: boost-license
7587: cc-by-sa-v3.0
1.161 ryoon 7588: cc0-1.0-universal
1.154 rodent 7589: cddl-1.0
7590: cpl-1.0
7591: epl-v1.0
7592: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7593: gnu-gpl-v1
7594: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7595: gnu-gpl-v3 gnu-lgpl-v3
7596: ibm-public-license-1.0
7597: ipafont
7598: isc
7599: lppl-1.3c
7600: lucent
7601: miros
7602: mit
7603: mpl-1.0 mpl-1.1 mpl-2.0
7604: mplusfont
7605: ofl-v1.0 ofl-v1.1
7606: original-bsd modified-bsd 2-clause-bsd
7607: php
7608: png-license
7609: postgresql-license
7610: public-domain
7611: python-software-foundation
7612: qpl-v1.0
1.158 rodent 7613: sgi-free-software-b-v2.0
1.154 rodent 7614: sleepycat-public
7615: unlicense
7616: x11
7617: zlib
7618: zpl
1.121 jnemeth 7619: </pre>
7620: <p>
7621: </p>
1.78 rillig 7622: <p>The license tag mechanism is intended to address
1.87 wiz 7623: copyright-related issues surrounding building, installing and
7624: using a package, and not to address redistribution issues (see
7625: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7626: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7627: Packages with redistribution restrictions should set these
7628: tags.</p>
1.98 wiz 7629: <p>Denoting that a package may be copied according to a
7630: particular license is done by placing the license in
1.87 wiz 7631: <code class="filename">pkgsrc/licenses</code> and setting the
7632: <code class="varname">LICENSE</code> variable to a string identifying the
1.189 snj 7633: license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87 wiz 7634: <pre class="programlisting">
1.100 rillig 7635: LICENSE= xv-license
1.87 wiz 7636: </pre>
7637: <p>When trying to build, the user will get a notice that the
1.98 wiz 7638: package is covered by a license which has not been placed in the
7639: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7640: <pre class="programlisting">
1.100 rillig 7641: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7642: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7643: ===> To view the license, enter "/usr/bin/make show-license".
7644: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7645: ===> ACCEPTABLE_LICENSES+=xv-license
7646: *** Error code 1
1.87 wiz 7647: </pre>
1.110 hubertf 7648: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7649: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7650: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7651: convey to pkgsrc that it should not in the future fail because of
7652: that license:</p>
1.78 rillig 7653: <pre class="programlisting">
1.100 rillig 7654: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7655: </pre>
1.154 rodent 7656: <p>When adding a package with a new license, the following steps
7657: are required:</p>
7658: <div class="orderedlist"><ol class="orderedlist" type="1">
7659: <li class="listitem">
7660: <p>Check if the file can avoid the -license filename tag as described above by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.html" target="_top">Various Licenses and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name | Open Source Initiative</a>. If this is the case, additionally add the license filename to:</p>
7661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7662: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7663: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.158 rodent 7664: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154 rodent 7665: </ul></div>
7666: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7667: </li>
7668: <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>
7669: </ol></div>
1.98 wiz 7670: <p>When the license changes (in a way other than formatting),
7671: please make sure that the new license has a different name (e.g.,
7672: append the version number if it exists, or the date). Just
7673: because a user told pkgsrc to build programs under a previous
7674: version of a license does not mean that pkgsrc should build
1.99 rillig 7675: programs under the new licenses. The higher-level point is that
1.98 wiz 7676: pkgsrc does not evaluate licenses for reasonableness; the only
7677: test is a mechanistic test of whether a particular text has been
7678: approved by either of two bodies.</p>
1.78 rillig 7679: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7680: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7681: is deprecated because it does not crisply refer to a particular
7682: license text. Another problem with such usage is that it does not
7683: enable a user to tell pkgsrc to proceed for a single package
7684: without also telling pkgsrc to proceed for all packages with that
7685: tag.</p>
1.75 rillig 7686: </div>
1.148 asau 7687: <div class="sect2">
1.75 rillig 7688: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7689: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7690: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7691: Because a license tag is required unless the package is Free or
7692: Open Source, all packages with restrictions should have license
7693: tags. By declaring the restrictions, package tools can
7694: automatically refrain from e.g. placing binary packages on FTP
7695: sites.</p>
7696: <p>There are four restrictions that may be encoded, which are
7697: the cross product of sources (distfiles) and binaries not being
7698: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7699: language in any license, and because non-Free licenses tend to be
7700: different from each other, pkgsrc adopts a definition of FTP and
7701: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7702: should not be made available over the Internet at no charge.
7703: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7704: made available on some kind of media, together with other source
7705: and binary packages, and which is sold for a distribution charge.
7706: </p>
7707: <p>In order to encode these restrictions, the package system
1.87 wiz 7708: defines five make variables that can be set to note these
7709: restrictions:</p>
1.148 asau 7710: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7711: <li class="listitem">
1.75 rillig 7712: <p><code class="varname">RESTRICTED</code></p>
7713: <p>This variable should be set whenever a restriction
1.87 wiz 7714: exists (regardless of its kind). Set this variable to a
1.98 wiz 7715: string containing the reason for the restriction. It should
7716: be understood that those wanting to understand the restriction
7717: will have to read the license, and perhaps seek advice of
7718: counsel.</p>
1.75 rillig 7719: </li>
1.128 wiz 7720: <li class="listitem">
1.75 rillig 7721: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7722: <p>Binaries may not be placed on CD-ROM containing other
7723: binary packages, for which a distribution charge may be made.
7724: In this case, set this variable to
7725: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7726: </li>
1.128 wiz 7727: <li class="listitem">
1.75 rillig 7728: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7729: <p>Binaries may not made available on the Internet without
7730: charge. In this case, set this variable to
7731: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7732: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7733: </li>
1.128 wiz 7734: <li class="listitem">
1.75 rillig 7735: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7736: <p>Distfiles may not be placed on CD-ROM, together with
7737: other distfiles, for which a fee may be charged. In this
7738: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7739: </p>
1.75 rillig 7740: </li>
1.128 wiz 7741: <li class="listitem">
1.75 rillig 7742: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7743: <p>Distfiles may not made available via FTP at no charge.
7744: In this case, set this variable to
7745: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7746: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7747: </li>
7748: </ul></div>
1.139 wiz 7749: <p>Please note that packages will to be removed from pkgsrc
7750: when the distfiles are not distributable and cannot be obtained
7751: for a period of one full quarter branch. Packages with manual /
7752: interactive fetch must have a maintainer and it is his/her
7753: responsibility to ensure this.</p>
1.75 rillig 7754: </div>
1.148 asau 7755: <div class="sect2">
1.75 rillig 7756: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7757: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7758: <p>Your package may depend on some other package being present
1.88 wiz 7759: - and there are various ways of expressing this dependency.
7760: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7761: <code class="varname">DEPENDS</code> definitions, the
7762: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7763: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7764: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7765: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7766: <p>The basic difference between the two variables is as
1.87 wiz 7767: follows: The <code class="varname">DEPENDS</code> definition registers
7768: that pre-requisite in the binary package so it will be pulled in
7769: when the binary package is later installed, whilst the
7770: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7771: dependency that is only needed for building the package.</p>
1.75 rillig 7772: <p>This means that if you only need a package present whilst
1.87 wiz 7773: you are building, it should be noted as a
7774: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7775: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7776: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7777: <pre class="programlisting">
1.100 rillig 7778: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7779: </pre>
1.128 wiz 7780: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7781: may include any of the wildcard version numbers recognized by
1.189 snj 7782: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7783: <div class="orderedlist"><ol class="orderedlist" type="1">
7784: <li class="listitem">
1.75 rillig 7785: <p>If your package needs another package's binaries or
1.160 wiz 7786: libraries to build and run, and if that package has a
1.87 wiz 7787: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7788: <pre class="programlisting">
1.100 rillig 7789: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7790: </pre>
1.75 rillig 7791: </li>
1.128 wiz 7792: <li class="listitem">
1.160 wiz 7793: <p>If your package needs another package's binaries or
7794: libraries only for building, and if that package has a
7795: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7796: <pre class="programlisting">
7797: .include "../../graphics/jpeg/buildlink3.mk"
7798: </pre>
7799: <p>but set
7800: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7801: to make it a build dependency only. This case is rather
7802: rare.</p>
7803: </li>
7804: <li class="listitem">
1.132 spz 7805: <p>If your package needs binaries from another package to build,
7806: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7807: <pre class="programlisting">
1.132 spz 7808: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 7809: </pre>
1.75 rillig 7810: </li>
1.132 spz 7811: <li class="listitem"><p>If your package needs a library with which to link and
7812: there is no <code class="filename">buildlink3.mk</code> file
7813: available, create one. Using
7814: <code class="varname">DEPENDS</code> won't be sufficient because the
7815: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7816: <li class="listitem">
1.132 spz 7817: <p>If your package needs some executable to be able to run
7818: correctly and if there's no
7819: <code class="filename">buildlink3.mk</code> file, this is specified
7820: using the <code class="varname">DEPENDS</code> variable. The
1.189 snj 7821: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.132 spz 7822: be able to execute the latex binary from the teTeX package
7823: when it runs, and that is specified:</p>
1.75 rillig 7824: <pre class="programlisting">
1.132 spz 7825: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7826: </pre>
1.132 spz 7827: </li>
7828: <li class="listitem">
7829: <p>You can use wildcards in package dependencies. Note that
7830: such wildcard dependencies are retained when creating binary
7831: packages. The dependency is checked when installing the binary
7832: package and any package which matches the pattern will be
7833: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7834: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7835: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7836: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7837: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7838: <p>Wildcards can also be used to specify that a package
1.87 wiz 7839: will only build against a certain minimum version of a
7840: pre-requisite:</p>
1.75 rillig 7841: <pre class="programlisting">
1.132 spz 7842: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 7843: </pre>
1.132 spz 7844: <p>This means that the package will build using version 6.0
7845: of ImageMagick or newer. Such a dependency may be warranted
7846: if, for example, the command line options of an executable
7847: have changed.</p>
7848: <p>If you need to depend on minimum versions of libraries,
7849: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7850: <p>For security fixes, please update the package
1.110 hubertf 7851: vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, “Handling packages with security problems”</a> for more
1.87 wiz 7852: information.</p>
1.75 rillig 7853: </li>
1.165 bsiegert 7854: <li class="listitem">
7855: <p>If the package depends on either one of two (or more)
7856: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7857: comma-separated list between curly braces.</p>
7858: <p>As an example, take a package that depends on the Perl
7859: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7860: itself since version 5.10.0. This either/or dependency is
7861: expressed as:</p>
7862: <pre class="programlisting">
7863: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7864: </pre>
7865: </li>
1.75 rillig 7866: </ol></div>
7867: <p>If your package needs files from another package to build,
1.87 wiz 7868: add the relevant distribution files to
7869: <code class="varname">DISTFILES</code>, so they will be extracted
1.189 snj 7870: automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87 wiz 7871: (It relies on the jpeg sources being present in source form
7872: during the build.)</p>
1.75 rillig 7873: </div>
1.148 asau 7874: <div class="sect2">
1.75 rillig 7875: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7876: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7877: <p>Your package may conflict with other packages a user might
1.87 wiz 7878: already have installed on his system, e.g. if your package
1.88 wiz 7879: installs the same set of files as another package in the pkgsrc
1.190 wiz 7880: tree or has the same <code class="varname">PKGNAME</code>.</p>
7881: <p>These cases are handled automatically by the packaging tools
7882: at package installation time and do not need to be handled
7883: manually.</p>
7884: <p>In case the conflicts can not be recognized automatically
7885: (e.g., packages using the same config file location but no other
7886: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7887: space-separated list of packages (including version string) your
7888: package conflicts with.</p>
1.190 wiz 7889: <p>For example, if both <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
7890: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7891: use the same config file, you would set in
7892: <code class="filename">foo/bar/Makefile</code>:</p>
1.87 wiz 7893: <pre class="programlisting">
1.190 wiz 7894: CONFLICTS= baz-[0-9]*
1.87 wiz 7895: </pre>
1.190 wiz 7896: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75 rillig 7897: <pre class="programlisting">
1.190 wiz 7898: CONFLICTS= bar-[0-9]*
1.87 wiz 7899: </pre>
1.75 rillig 7900: </div>
1.148 asau 7901: <div class="sect2">
1.75 rillig 7902: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7903: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7904: <p>There are several reasons why a package might be
1.88 wiz 7905: instructed to not build under certain circumstances. If the
1.87 wiz 7906: package builds and runs on most platforms, the exceptions
1.193 ! dholland 7907: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
! 7908: the package builds and runs on a small handful of platforms,
! 7909: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
! 7910: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
! 7911: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
! 7912: (OS-version-platform) that can use glob-style
! 7913: wildcards.</p>
! 7914: <p>If a package is not appropriate for some platforms (as
! 7915: oopposed to merely broken), a different set of variables should be
! 7916: used as this affects failure reporting and statistics.
! 7917: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7918: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 ! dholland 7919: the package is appropriate for only a small handful of platforms
! 7920: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7921: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7922: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7923: (OS-version-platform) that can use glob-style
7924: wildcards.</p>
1.88 wiz 7925: <p>Some packages are tightly bound to a specific version of an
1.189 snj 7926: operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.88 wiz 7927: backwards compatible with other versions of the OS, and should be
7928: uploaded to a version specific directory on the FTP server. Mark
7929: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7930: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7931: the package system internals, but may be used in the
7932: future.</p>
1.75 rillig 7933: <p>If the package should be skipped (for example, because it
1.87 wiz 7934: provides functionality already provided by the system), set
1.88 wiz 7935: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7936: the package should fail because some preconditions are not met,
7937: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7938: message.</p>
1.75 rillig 7939: </div>
1.148 asau 7940: <div class="sect2">
1.75 rillig 7941: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7942: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7943: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7944: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7945: be set in the package Makefile. This will be carried into any
7946: binary package that is made from this pkgsrc entry. A
1.128 wiz 7947: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.189 snj 7948: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7949: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7950: </div>
1.148 asau 7951: <div class="sect2">
1.75 rillig 7952: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7953: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7954: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7955: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7956: and after committing that file, ask pkgsrc-security@NetBSD.org to
7957: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7958: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7959: <code class="varname">PKGREVISION</code> should be increased (this is of
7960: course not necessary if the problem is fixed by using a newer
7961: release of the software), and the pattern in the
7962: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7963: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7964: branch, be sure to submit a pullup request!</p>
1.75 rillig 7965: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7966: semi-automatically by a weekly cron job.</p>
1.75 rillig 7967: </div>
1.148 asau 7968: <div class="sect2">
1.75 rillig 7969: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7970: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 7971: <p>When making fixes to an existing package it can be useful
1.87 wiz 7972: to change the version number in <code class="varname">PKGNAME</code>. To
7973: avoid conflicting with future versions by the original author, a
1.128 wiz 7974: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 7975: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7976: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7977: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7978: <pre class="programlisting">
1.100 rillig 7979: DISTNAME= foo-17.42
7980: PKGREVISION= 9
1.87 wiz 7981: </pre>
1.75 rillig 7982: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7983: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7984: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7985: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7986: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7987: <p>When a new release of the package is released, the
1.87 wiz 7988: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7989: minor release of the above package, things should be like:</p>
1.75 rillig 7990: <pre class="programlisting">
1.100 rillig 7991: DISTNAME= foo-17.43
1.87 wiz 7992: </pre>
7993: <p><code class="varname">PKGREVISION</code> should be incremented for any
7994: non-trivial change in the resulting binary package. Without a
7995: <code class="varname">PKGREVISION</code> bump, someone with the previous
7996: version installed has no way of knowing that their package is out
7997: of date. Thus, changes without increasing
7998: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7999: trivial that no reasonable person would want to upgrade", and this
8000: is the rough test for when increasing
8001: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8002: changes that do not merit increasing
8003: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 8004: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8005: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 8006: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8007: or comments in Makefile.</p></li>
1.128 wiz 8008: <li class="listitem"><p>
1.100 rillig 8009: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 8010: <li class="listitem"><p>
1.100 rillig 8011: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8012: <li class="listitem"><p>
1.100 rillig 8013: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8014: </ul></div>
1.87 wiz 8015: <p>Examples of changes that do merit an increase to
8016: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 8017: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8018: <li class="listitem"><p>
1.100 rillig 8019: Security fixes</p></li>
1.128 wiz 8020: <li class="listitem"><p>
1.100 rillig 8021: Changes or additions to a patch file</p></li>
1.128 wiz 8022: <li class="listitem"><p>
1.100 rillig 8023: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8024: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8025: </ul></div>
1.78 rillig 8026: <p>PKGREVISION must also be incremented when dependencies have ABI
8027: changes.</p>
1.75 rillig 8028: </div>
1.148 asau 8029: <div class="sect2">
1.79 rillig 8030: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8031: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 8032: <p>When you want to replace the same text in multiple files
1.87 wiz 8033: or when the replacement text varies, patches alone cannot help.
8034: This is where the SUBST framework comes in. It provides an
8035: easy-to-use interface for replacing text in files.
8036: Example:</p>
8037: <pre class="programlisting">
1.100 rillig 8038: SUBST_CLASSES+= fix-paths
8039: SUBST_STAGE.fix-paths= pre-configure
8040: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8041: SUBST_FILES.fix-paths= src/*.c
8042: SUBST_FILES.fix-paths+= scripts/*.sh
8043: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8044: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8045: </pre>
1.79 rillig 8046: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8047: that are used to identify the different SUBST blocks that are
8048: defined. The SUBST framework is heavily used by pkgsrc, so it is
8049: important to always use the <code class="literal">+=</code> operator with
8050: this variable. Otherwise some substitutions may be
8051: skipped.</p>
1.79 rillig 8052: <p>The remaining variables of each SUBST block are
1.87 wiz 8053: parameterized with the identifier from the first line
8054: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8055: parameters to a function call.</p>
1.79 rillig 8056: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8057: which the replacement will take place. All combinations of
8058: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8059: <code class="literal">post-</code> together with a phase name are
8060: possible, though only few are actually used. Most commonly used
8061: are <code class="literal">post-patch</code> and
8062: <code class="literal">pre-configure</code>. Of these two,
8063: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8064: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8065: have the state after applying the patches but before making any
8066: other changes. This is especially useful when you are debugging
8067: a package in order to create new patches for it. Similarly,
8068: <code class="literal">post-build</code> is preferred over
8069: <code class="literal">pre-install</code>, because the install phase should
8070: generally be kept as simple as possible. When you use
8071: <code class="literal">post-build</code>, you have the same files in the
8072: working directory that will be installed later, so you can check
8073: if the substitution has succeeded.</p>
1.79 rillig 8074: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8075: that is printed just before the substitution is done.</p>
1.79 rillig 8076: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8077: globbing patterns that specifies the files in which the
8078: substitution will take place. The patterns are interpreted
8079: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8080: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.189 snj 8081: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87 wiz 8082: command should be prefixed with <code class="literal">-e</code>, so that
8083: all SUBST blocks look uniform.</p>
1.79 rillig 8084: <p>There are some more variables, but they are so seldomly
1.87 wiz 8085: used that they are only documented in the
8086: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8087: </div>
1.75 rillig 8088: </div>
1.148 asau 8089: <div class="sect1">
1.75 rillig 8090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8091: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8092: <div class="sect2">
1.75 rillig 8093: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8094: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8095: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8096: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8097: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8098: with the name of each file to download as an argument, expecting
8099: it to output the URL of the directory from which to download
1.189 snj 8100: it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87 wiz 8101: example of this usage.</p>
1.75 rillig 8102: <p>If the download can't be automated, because the user must
1.87 wiz 8103: submit personal information to apply for a password, or must pay
8104: for the source, or whatever, you can set
8105: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8106: displayed to the user before aborting the build. Example:</p>
8107: <pre class="programlisting">
1.100 rillig 8108: FETCH_MESSAGE= "Please download the files"
8109: FETCH_MESSAGE+= " "${DISTFILES:Q}
8110: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8111: </pre>
1.75 rillig 8112: </div>
1.148 asau 8113: <div class="sect2">
1.75 rillig 8114: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8115: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8116: <p>Sometimes authors of a software package make some
1.87 wiz 8117: modifications after the software was released, and they put up a
8118: new distfile without changing the package's version number. If a
8119: package is already in pkgsrc at that time, the checksum will
8120: no longer match. The contents of the new distfile should be
8121: compared against the old one before changing anything, to make
8122: sure the distfile was really updated on purpose, and that
8123: no trojan horse or so crept in.
1.97 rillig 8124: Please mention that the distfiles were compared and what was found
1.159 rodent 8125: in your commit message.</p>
8126: <p>Then, the correct way to work around this is to
1.87 wiz 8127: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8128: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8129: <code class="varname">DISTFILES</code> and
1.93 rillig 8130: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8131: subdirectory of the local distfiles directory.
1.110 hubertf 8132: (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
1.97 rillig 8133: In case this
1.87 wiz 8134: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8135: including the <code class="filename">nbX</code> suffix) or a date stamp
1.159 rodent 8136: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8137: <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>
8138: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8139: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8140: path in the filenames.
1.159 rodent 8141: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8142: Furthermore, a mail to the package's authors seems appropriate
8143: telling them that changing distfiles after releases without
8144: changing the file names is not good practice.</p>
1.75 rillig 8145: </div>
8146: </div>
1.148 asau 8147: <div class="sect1">
1.75 rillig 8148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8149: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8150: <div class="sect2">
1.75 rillig 8151: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8152: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8153: <p>pkgsrc supports many different machines, with different
1.87 wiz 8154: object formats like a.out and ELF, and varying abilities to do
8155: shared library and dynamic loading at all. To accompany this,
8156: varying commands and options have to be passed to the
8157: compiler, linker, etc. to get the Right Thing, which can be
8158: pretty annoying especially if you don't have all the machines
8159: at your hand to test things. The
1.189 snj 8160: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128 wiz 8161: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8162: both static and dynamic libraries from a set of source files,
8163: thus being platform-independent.</p>
8164: <p>Here's how to use libtool in a package in seven simple
8165: steps:</p>
1.128 wiz 8166: <div class="orderedlist"><ol class="orderedlist" type="1">
8167: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8168: Makefile.</p></li>
1.128 wiz 8169: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8170: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8171: add it to the definition of <code class="varname">CC</code>, if only
8172: libraries are being built in a given Makefile. This one command
8173: will build both PIC and non-PIC library objects, so you need not
8174: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8175: <li class="listitem">
1.75 rillig 8176: <p>For the linking of the library, remove any
1.128 wiz 8177: <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
8178: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8179: <pre class="programlisting">
1.100 rillig 8180: ${LIBTOOL} --mode=link \
8181: ${CC} -o ${.TARGET:.a=.la} \
8182: ${OBJS:.o=.lo} \
8183: -rpath ${PREFIX}/lib \
8184: -version-info major:minor
1.87 wiz 8185: </pre>
1.75 rillig 8186: <p>Note that the library is changed to have a
1.87 wiz 8187: <code class="filename">.la</code> extension, and the objects are
8188: changed to have a <code class="filename">.lo</code>
8189: extension. Change <code class="varname">OBJS</code> as
8190: necessary. This automatically creates all of the
8191: <code class="filename">.a</code>,
8192: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8193: necessary) in the build directory. Be sure to include
1.128 wiz 8194: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8195: minor are zero, as libtool will otherwise strip off the
8196: shared library version.</p>
1.75 rillig 8197: <p>From the libtool manual:</p>
8198: <pre class="programlisting">
1.100 rillig 8199: So, libtool library versions are described by three integers:
1.69 rillig 8200:
1.100 rillig 8201: CURRENT
8202: The most recent interface number that this library implements.
1.69 rillig 8203:
1.100 rillig 8204: REVISION
8205: The implementation number of the CURRENT interface.
1.69 rillig 8206:
1.100 rillig 8207: AGE
8208: The difference between the newest and oldest interfaces that
8209: this library implements. In other words, the library implements
8210: all the interface numbers in the range from number `CURRENT -
8211: AGE' to `CURRENT'.
1.1 grant 8212:
1.100 rillig 8213: If two libraries have identical CURRENT and AGE numbers, then the
8214: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8215: </pre>
1.128 wiz 8216: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8217: different results for a.out and ELF (excluding symlinks)
8218: in only one case. An ELF library of the form
1.128 wiz 8219: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8220: will have a symlink of
1.128 wiz 8221: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8222: on an a.out platform. This is handled
8223: automatically.</p>
1.128 wiz 8224: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8225: directory of the library being built.</p>
1.76 rillig 8226: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8227: <code class="filename">.la</code> file, the other files will be
8228: added automatically.</p>
1.75 rillig 8229: </li>
1.128 wiz 8230: <li class="listitem">
1.76 rillig 8231: <p>When linking shared object (<code class="filename">.so</code>)
1.189 snj 8232: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8233: shared libraries, use <span class="quote">“<span class="quote">-module
8234: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8235: tacked on.</p>
1.76 rillig 8236: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8237: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8238: </li>
1.128 wiz 8239: <li class="listitem">
1.75 rillig 8240: <p>When linking programs that depend on these libraries
1.87 wiz 8241: <span class="emphasis"><em>before</em></span> they are installed, preface
1.189 snj 8242: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8243: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8244: libraries (static or shared), but please be aware that
8245: libtool will not allow you to specify a relative path in
1.128 wiz 8246: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8247: expects you to change that argument to be the
8248: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8249: <pre class="programlisting">
1.100 rillig 8250: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8251: </pre>
1.75 rillig 8252: <p>should be changed to:</p>
8253: <pre class="programlisting">
1.100 rillig 8254: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8255: </pre>
1.75 rillig 8256: <p>and it will do the right thing with the libraries.</p>
8257: </li>
1.128 wiz 8258: <li class="listitem">
1.189 snj 8259: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8260: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8261: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8262: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8263: <pre class="programlisting">
1.126 jakllsch 8264: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8265: </pre>
1.76 rillig 8266: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8267: shared library, any needed symlinks, and run
1.189 snj 8268: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8269: </li>
1.128 wiz 8270: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8271: the <code class="filename">.la</code>
8272: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8273: </ol></div>
8274: </div>
1.148 asau 8275: <div class="sect2">
1.75 rillig 8276: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8277: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8278: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8279: package Makefile. This will override the package's own libtool
8280: in most cases. For older libtool using packages, libtool is
8281: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8282: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8283: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8284: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8285: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8286: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8287: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8288: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8289: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8290: libraries built and installed, then use
8291: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8292: <p>If your package makes use of the platform-independent library
1.87 wiz 8293: for loading dynamic shared objects, that comes with libtool
8294: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8295: <p>Some packages use libtool incorrectly so that the package
8296: may not work or build in some circumstances. Some of the more
8297: common errors are:</p>
1.148 asau 8298: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8299: <li class="listitem">
1.75 rillig 8300: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8301: executable or library. This in itself isn't a problem if one of two things
8302: has been done:</p>
1.128 wiz 8303: <div class="orderedlist"><ol class="orderedlist" type="1">
8304: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8305: <code class="filename">libfoo.la</code>, not
8306: <code class="filename">foo.la</code></p></li>
1.128 wiz 8307: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8308: </ol></div>
8309: </li>
1.128 wiz 8310: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8311: The function lt_dlinit() should be called and the macro
8312: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8313: executables.</p></li>
1.75 rillig 8314: </ul></div>
8315: </div>
1.148 asau 8316: <div class="sect2">
1.75 rillig 8317: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8318: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8319: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8320: to regenerate the configure script and Makefile.in makefile
8321: templates, then they should be executed in a pre-configure
8322: target.</p>
1.75 rillig 8323: <p>For packages that need only autoconf:</p>
8324: <pre class="programlisting">
1.100 rillig 8325: AUTOCONF_REQD= 2.50 # if default version is not good enough
8326: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8327: ...
1.1 grant 8328:
1.100 rillig 8329: pre-configure:
8330: cd ${WRKSRC} && autoconf
1.1 grant 8331:
1.100 rillig 8332: ...
1.87 wiz 8333: </pre>
1.75 rillig 8334: <p>and for packages that need automake and autoconf:</p>
8335: <pre class="programlisting">
1.100 rillig 8336: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8337: USE_TOOLS+= automake # use "automake14" for automake-1.4
8338: ...
8339:
8340: pre-configure:
8341: set -e; cd ${WRKSRC}; \
8342: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8343:
1.100 rillig 8344: ...
1.87 wiz 8345: </pre>
1.75 rillig 8346: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8347: require GNU Make.</p>
1.75 rillig 8348: <p>There are times when the configure process makes
1.87 wiz 8349: additional changes to the generated files, which then causes
8350: the build process to try to re-execute the automake sequence.
8351: This is prevented by touching various files in the configure
8352: stage. If this causes problems with your package you can set
8353: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8354: Makefile.</p>
1.75 rillig 8355: </div>
8356: </div>
1.148 asau 8357: <div class="sect1">
1.75 rillig 8358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8359: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 8360: <div class="sect2">
1.87 wiz 8361: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8362: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8363: <p>Compilers for the C, C++, and Fortran languages comes with
8364: the NetBSD base system. By default, pkgsrc assumes that a package
8365: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8366: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8367: <p>To declare which language's compiler a package needs, set
8368: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8369: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8370: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8371: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8372: written in C++, usually need a C compiler for the configure
8373: phase.</p>
8374: </div>
1.148 asau 8375: <div class="sect2">
1.87 wiz 8376: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8377: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8378: <p>If a program is written in Java, use the Java framework in
8379: pkgsrc. The package must include
8380: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8381: provides the following variables:</p>
1.148 asau 8382: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8383: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8384: dependency on the JDK is added. If
1.128 wiz 8385: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8386: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8387: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8388: JDK.</p></li>
1.128 wiz 8389: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8390: a package needs a Java2 implementation. The supported values
1.128 wiz 8391: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8392: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8393: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8394: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8395: above. This variable is not set by default.</p></li>
1.130 wiz 8396: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8397: automatically set to the runtime location of the used Java
8398: implementation dependency. It may be used to set
8399: <code class="varname">JAVA_HOME</code> to a good value if the program
8400: needs this variable to be defined.
8401: </p></li>
1.87 wiz 8402: </ul></div>
8403: </div>
1.148 asau 8404: <div class="sect2">
1.87 wiz 8405: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8406: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8407: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8408: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8409: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8410: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8411: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8412: that you want adjusted. Every occurrence of
8413: <code class="filename">*/bin/perl</code> in a she-bang line will be
8414: replaced with the full path to the perl executable.</p>
1.87 wiz 8415: <p>If a particular version of perl is needed, set the
8416: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8417: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8418: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.87 wiz 8419: about handling perl modules.</p>
8420: </div>
1.148 asau 8421: <div class="sect2">
1.87 wiz 8422: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8423: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8424: <p><code class="varname">REPLACE_SH</code>,
8425: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8426: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8427: hash bangs in files. Please use the appropriate one, prefering
8428: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8429: Each should contain a list of scripts, relative to
8430: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8431: occurrence of the matching shell in a she-bang line will be
8432: replaced with the full path to the shell executable.
1.147 wiz 8433: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8434: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8435: </div>
1.148 asau 8436: <div class="sect2">
1.147 wiz 8437: <div class="titlepage"><div><div><h3 class="title">
8438: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8439: <p>Currently, there is no special handling for other languages
8440: in pkgsrc. If a compiler package provides a
8441: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8442: just add a (build) dependency on the appropriate compiler
8443: package.</p>
8444: </div>
8445: </div>
1.148 asau 8446: <div class="sect1">
1.87 wiz 8447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8448: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8449: <p>The most common failures when building a package are that
8450: some platforms do not provide certain header files, functions or
8451: libraries, or they provide the functions in a library that the
8452: original package author didn't know. To work around this, you
8453: can rewrite the source code in most cases so that it does not
8454: use the missing functions or provides a replacement function.</p>
1.148 asau 8455: <div class="sect2">
1.77 rillig 8456: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8457: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8458: <p>If a package already comes with a GNU configure script, the
8459: preferred way to fix the build failure is to change the
8460: configure script, not the code. In the other cases, you can
8461: utilize the C preprocessor, which defines certain macros
8462: depending on the operating system and hardware architecture it
8463: compiles for. These macros can be queried using for example
8464: <code class="varname">#if defined(__i386)</code>. Almost every operating
8465: system, hardware architecture and compiler has its own macro.
8466: For example, if the macros <code class="varname">__GNUC__</code>,
8467: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8468: are all defined, you know that you are using NetBSD on an i386
8469: compatible CPU, and your compiler is GCC.</p>
8470: <p>The list of the following macros for hardware and
8471: operating system depends on the compiler that is used. For
8472: example, if you want to conditionally compile code on Solaris,
8473: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8474: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8475: <div class="sect3">
1.75 rillig 8476: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8477: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8478: <p>To distinguish between 4.4 BSD-derived systems and the
8479: rest of the world, you should use the following code.</p>
8480: <pre class="programlisting">
1.100 rillig 8481: #include <sys/param.h>
8482: #if (defined(BSD) && BSD >= 199306)
8483: /* BSD-specific code goes here */
8484: #else
8485: /* non-BSD-specific code goes here */
8486: #endif
1.75 rillig 8487: </pre>
1.77 rillig 8488: <p>If this distinction is not fine enough, you can also test
8489: for the following macros.</p>
1.75 rillig 8490: <pre class="programlisting">
1.151 obache 8491: Cygwin __CYGWIN__
8492: DragonFly __DragonFly__
1.100 rillig 8493: FreeBSD __FreeBSD__
1.151 obache 8494: Haiku __HAIKU__
1.100 rillig 8495: Interix __INTERIX
8496: IRIX __sgi (TODO: get a definite source for this)
8497: Linux linux, __linux, __linux__
1.193 ! dholland 8498: Mac OS X __APPLE__
1.151 obache 8499: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8500: Minix3 __minix
1.100 rillig 8501: NetBSD __NetBSD__
8502: OpenBSD __OpenBSD__
8503: Solaris sun, __sun
1.75 rillig 8504: </pre>
8505: </div>
1.148 asau 8506: <div class="sect3">
1.75 rillig 8507: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8508: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8509: <pre class="programlisting">
1.100 rillig 8510: i386 i386, __i386, __i386__
8511: MIPS __mips
8512: SPARC sparc, __sparc
1.75 rillig 8513: </pre>
8514: </div>
1.148 asau 8515: <div class="sect3">
1.75 rillig 8516: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8517: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8518: <pre class="programlisting">
1.100 rillig 8519: GCC __GNUC__ (major version), __GNUC_MINOR__
8520: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8521: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8522: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8523: </pre>
8524: </div>
8525: </div>
1.148 asau 8526: <div class="sect2">
1.78 rillig 8527: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8528: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8529: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8530: combinations of compiler version and architecture and almost
8531: always relation to optimisation being enabled. Common symptoms
8532: are gcc internal errors or never finishing compiling a
1.78 rillig 8533: file.</p>
8534: <p>Typically, a workaround involves testing the
8535: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8536: optimisation for that combination of file,
8537: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8538: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8539: number of examples.</p>
8540: </div>
1.148 asau 8541: <div class="sect2">
1.78 rillig 8542: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8543: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8544: </h3></div></div></div>
1.92 rillig 8545: <p>This error message often means that a package did not
1.78 rillig 8546: link to a shared library it needs. The following functions are
8547: known to cause this error message over and over.</p>
8548: <div class="informaltable">
8549: <a name="undefined-reference-functions"></a><table border="1">
8550: <colgroup>
8551: <col>
8552: <col>
8553: <col>
8554: </colgroup>
8555: <thead><tr>
8556: <th>Function</th>
8557: <th>Library</th>
8558: <th>Affected platforms</th>
8559: </tr></thead>
8560: <tbody>
8561: <tr>
8562: <td>accept, bind, connect</td>
8563: <td>-lsocket</td>
8564: <td>Solaris</td>
8565: </tr>
8566: <tr>
8567: <td>crypt</td>
8568: <td>-lcrypt</td>
8569: <td>DragonFly, NetBSD</td>
8570: </tr>
8571: <tr>
8572: <td>dlopen, dlsym</td>
8573: <td>-ldl</td>
8574: <td>Linux</td>
8575: </tr>
8576: <tr>
8577: <td>gethost*</td>
8578: <td>-lnsl</td>
8579: <td>Solaris</td>
8580: </tr>
8581: <tr>
8582: <td>inet_aton</td>
8583: <td>-lresolv</td>
8584: <td>Solaris</td>
8585: </tr>
8586: <tr>
8587: <td>nanosleep, sem_*, timer_*</td>
8588: <td>-lrt</td>
8589: <td>Solaris</td>
8590: </tr>
8591: <tr>
8592: <td>openpty</td>
8593: <td>-lutil</td>
8594: <td>Linux</td>
8595: </tr>
8596: </tbody>
8597: </table>
8598: </div>
8599: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8600: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8601: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8602: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8603: bmake</strong></span>.</p>
1.148 asau 8604: <div class="sect3">
1.92 rillig 8605: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8606: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8607: <p>When you are using the SunPro compiler, there is another
8608: possibility. That compiler cannot handle the following code:</p>
8609: <pre class="programlisting">
1.100 rillig 8610: extern int extern_func(int);
1.93 rillig 8611:
1.100 rillig 8612: static inline int
8613: inline_func(int x)
8614: {
1.92 rillig 8615: return extern_func(x);
1.100 rillig 8616: }
1.93 rillig 8617:
1.100 rillig 8618: int main(void)
8619: {
1.92 rillig 8620: return 0;
1.100 rillig 8621: }
1.92 rillig 8622: </pre>
8623: <p>It generates the code for <code class="function">inline_func</code> even if
8624: that function is never used. This code then refers to
8625: <code class="function">extern_func</code>, which can usually not be resolved. To
8626: solve this problem you can try to tell the package to disable inlining
8627: of functions.</p>
8628: </div>
1.87 wiz 8629: </div>
1.148 asau 8630: <div class="sect2">
1.87 wiz 8631: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8632: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8633: <p>Sometimes packages fail to build because the compiler runs
8634: into an operating system specific soft limit. With the
8635: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8636: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8637: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8638: Setting this variable is similar to running the shell builtin
1.110 hubertf 8639: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8640: segment size or maximum stack size of a process, respectively, to
8641: their hard limits.</p>
1.78 rillig 8642: </div>
1.75 rillig 8643: </div>
1.148 asau 8644: <div class="sect1">
1.75 rillig 8645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8646: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 8647: <div class="sect2">
1.75 rillig 8648: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8649: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8650: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8651: with some operating systems cannot create more than one
8652: directory at a time. As such, you should call
8653: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8654: <pre class="programlisting">
1.100 rillig 8655: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8656: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8657: </pre>
1.128 wiz 8658: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8659: dir2</code></span>”</span> to the
1.87 wiz 8660: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8661: automatically do the right thing.</p>
1.75 rillig 8662: </div>
1.148 asau 8663: <div class="sect2">
1.75 rillig 8664: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8665: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8666: <p>In general, documentation should be installed into
1.87 wiz 8667: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8668: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8669: includes the version number of the package).</p>
1.84 wiz 8670: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8671: directory where HTML documentation is installed with the
1.128 wiz 8672: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8673: is needed because otherwise the documentation ends up in
8674: <code class="filename">${PREFIX}/share/doc/html</code> or other
8675: places.</p>
8676: <p>An exception to the above is that library API documentation
1.189 snj 8677: generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87 wiz 8678: browsers (devhelp) should be left at their default location, which
8679: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8680: documentation can be recognized from files ending in
8681: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8682: (It is also acceptable to install such files in
8683: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8684: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8685: <code class="filename">.devhelp*</code> file must be directly in that
8686: directory then, no additional subdirectory level is allowed in
8687: this case. This is usually achieved by using
1.128 wiz 8688: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8689: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8690: though.)</p>
1.75 rillig 8691: </div>
1.148 asau 8692: <div class="sect2">
1.75 rillig 8693: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8694: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8695: <p>Certain packages, most of them in the games category, install
1.87 wiz 8696: a score file that allows all users on the system to record their
8697: highscores. In order for this to work, the binaries need to be
8698: installed setgid and the score files owned by the appropriate
1.142 wiz 8699: group and/or owner (traditionally the "games" user/group). Set
8700: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8701: following variables, documented in more detail in
8702: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8703: behaviour: <code class="varname">GAMEDATAMODE</code>,
8704: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8705: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 8706: <p>A package should therefore never hard code file ownership or
1.87 wiz 8707: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8708: <code class="varname">INSTALL_GAME_DATA</code> to set these
8709: correctly.</p>
1.75 rillig 8710: </div>
1.148 asau 8711: <div class="sect2">
1.75 rillig 8712: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8713: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8714: <p><code class="varname">DESTDIR</code> support means that a package
8715: installs into a staging directory, not the final location of the
8716: files. Then a binary package is created which can be used for
8717: installation as usual. There are two ways: Either the package must
1.128 wiz 8718: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8719: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8720: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8721: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 8722: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8723: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8724: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8725: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8726: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8727: the inclusion.</p></li>
1.128 wiz 8728: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8729: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8730: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8731: automatically. Many manual rules and pre/post-install often are
8732: incorrect; fix them.</p></li>
1.128 wiz 8733: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8734: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8735: <li class="listitem"><p>In general, packages should support
1.103 wiz 8736: <code class="varname">UNPRIVILEGED</code> to be able to use
8737: DESTDIR.</p></li>
8738: </ul></div>
8739: </div>
1.148 asau 8740: <div class="sect2">
1.103 wiz 8741: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8742: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8743: <p>Your package may also contain scripts with hardcoded paths to
8744: other interpreters besides (or as well as) perl. To correct the
8745: full pathname to the script interpreter, you need to set the
8746: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8747: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8748: <pre class="programlisting">
1.100 rillig 8749: REPLACE_INTERPRETER+= tcl
8750: REPLACE.tcl.old= .*/bin/tclsh
8751: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8752: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8753: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8754: </pre>
1.148 asau 8755: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8756: <h3 class="title">Note</h3>
8757: <p>Before March 2006, these variables were called
1.87 wiz 8758: <code class="varname">_REPLACE.*</code> and
8759: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8760: </div>
8761: </div>
1.148 asau 8762: <div class="sect2">
1.75 rillig 8763: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8764: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8765: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8766: the Makefile fragment
8767: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8768: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8769: configuration for such modules as well as various hooks to tune
8770: this configuration. See comments in this file for
8771: details.</p>
1.75 rillig 8772: <p>Perl5 modules will install into different places depending
1.87 wiz 8773: on the version of perl used during the build process. To
8774: address this, pkgsrc will append lines to the
8775: <code class="filename">PLIST</code> corresponding to the files listed in
8776: the installed <code class="filename">.packlist</code> file generated by
8777: most perl5 modules. This is invoked by defining
8778: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8779: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8780: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8781: e.g.:</p>
1.75 rillig 8782: <pre class="programlisting">
1.153 wiz 8783: PERL5_PACKLIST= auto/Pg/.packlist
1.87 wiz 8784: </pre>
1.153 wiz 8785: <p>The perl5 config variables
8786: <code class="varname">installarchlib</code>,
8787: <code class="varname">installscript</code>,
8788: <code class="varname">installvendorbin</code>,
8789: <code class="varname">installvendorscript</code>,
8790: <code class="varname">installvendorarch</code>,
8791: <code class="varname">installvendorlib</code>,
8792: <code class="varname">installvendorman1dir</code>, and
8793: <code class="varname">installvendorman3dir</code> represent those
8794: locations in which components of perl5 modules may be installed,
8795: provided as variable with uppercase and prefixed with
8796: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8797: and may be used by perl5 packages that don't have a packlist.
8798: These variables are also substituted for in the
8799: <code class="filename">PLIST</code> as uppercase prefixed with
8800: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8801: </div>
1.148 asau 8802: <div class="sect2">
1.75 rillig 8803: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8804: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8805: <p>Some packages install info files or use the
1.128 wiz 8806: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8807: commands. <code class="varname">INFO_FILES</code> should be defined in
8808: the package Makefile so that <code class="filename">INSTALL</code> and
8809: <code class="filename">DEINSTALL</code> scripts will be generated to
8810: handle registration of the info files in the Info directory
1.128 wiz 8811: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8812: files registration is either provided by the system, or by a
8813: special purpose package automatically added as dependency if
8814: needed.</p>
1.75 rillig 8815: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8816: <code class="filename">${PREFIX}</code> where info files are primarily
8817: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8818: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8819: <p>The info files for the package should be listed in the
1.87 wiz 8820: package <code class="filename">PLIST</code>; however any split info files
8821: need not be listed.</p>
1.128 wiz 8822: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8823: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8824: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8825: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8826: should be noted with the <code class="varname">TEXINFO_REQD</code>
8827: variable in the package <code class="filename">Makefile</code>. By
8828: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8829: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8830: does not match the required minimum, a build dependency on the
1.189 snj 8831: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87 wiz 8832: be added automatically.</p>
1.75 rillig 8833: <p>The build and installation process of the software provided
1.87 wiz 8834: by the package should not use the
1.110 hubertf 8835: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8836: info files is the task of the package
8837: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8838: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8839: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8840: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8841: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8842: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8843: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8844: no effect except the logging of a message. The script overriding
1.110 hubertf 8845: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8846: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8847: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8848: </div>
1.148 asau 8849: <div class="sect2">
1.75 rillig 8850: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8851: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8852: <p>All packages that install manual pages should install them
1.87 wiz 8853: into the same directory, so that there is one common place to look
8854: for them. In pkgsrc, this place is
8855: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8856: should be used in packages. The default for
8857: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8858: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8859: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8860: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8861: <h3 class="title">Note</h3>
1.87 wiz 8862: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8863: is far from complete.</p>
1.75 rillig 8864: </div>
1.81 rillig 8865: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8866: <code class="filename">man/</code> as the top level directory for the man
8867: page file entries, and the pkgsrc framework will convert as
8868: needed. In all other places, the correct
8869: <code class="varname">PKGMANDIR</code> must be used.</p>
8870: <p>Packages that are
8871: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8872: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8873: <code class="filename">./configure</code>
8874: --mandir switch to set where the man pages should be installed.
8875: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8876: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8877: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8878: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8879: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8880: Or if the <code class="filename">./configure</code> script uses
8881: a non-standard use of --mandir, you can set
8882: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8883: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.87 wiz 8884: information on installation of compressed manual pages.</p>
1.75 rillig 8885: </div>
1.148 asau 8886: <div class="sect2">
1.75 rillig 8887: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8888: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8889: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8890: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8891: you need to take some extra steps to make sure they get registered
8892: in the database:</p>
1.128 wiz 8893: <div class="orderedlist"><ol class="orderedlist" type="1">
8894: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8895: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8896: takes care of rebuilding the GConf database at installation and
1.87 wiz 8897: deinstallation time, and tells the package where to install
1.107 rillig 8898: GConf data files using some standard configure arguments. It
1.87 wiz 8899: also disallows any access to the database directly from the
8900: package.</p></li>
1.128 wiz 8901: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8902: <code class="filename">.schemas</code> files under
8903: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8904: installed under <code class="filename">${PREFIX}/etc</code>, you will
8905: need to manually patch the package.</p></li>
1.128 wiz 8906: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8907: directory, as they will be handled automatically. See
1.193 ! dholland 8908: <a class="xref" href="#faq.conf" title="9.14. How do I change the location of configuration files?">Section 9.14, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.128 wiz 8909: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8910: your <code class="filename">Makefile</code> with a list of all
8911: <code class="filename">.schemas</code> files installed by the package, if
8912: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8913: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8914: your <code class="filename">Makefile</code> with a
8915: list of all <code class="filename">.entries</code> files installed by the
8916: package, if any. Names must not contain any directories in
8917: them.</p></li>
1.75 rillig 8918: </ol></div>
8919: </div>
1.148 asau 8920: <div class="sect2">
1.75 rillig 8921: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 8922: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8923: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8924: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8925: get registered in the database:</p>
1.128 wiz 8926: <div class="orderedlist"><ol class="orderedlist" type="1">
8927: <li class="listitem"><p>Include
1.119 mishka 8928: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8929: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8930: takes care of rebuilding the scrollkeeper database at
8931: installation and deinstallation time, and disallows any access
8932: to it directly from the package.</p></li>
1.128 wiz 8933: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8934: <code class="filename">libdata/scrollkeeper</code> directory, as they
8935: will be handled automatically.</p></li>
1.128 wiz 8936: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 8937: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8938: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 8939: </ol></div>
8940: </div>
1.148 asau 8941: <div class="sect2">
1.75 rillig 8942: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8943: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8944: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8945: the fonts database in the directory where they get installed at
8946: installation and deinstallation time. This can be automatically
8947: done by using the pkginstall framework.</p>
1.75 rillig 8948: <p>You can list the directories where fonts are installed in the
1.87 wiz 8949: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8950: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 8951: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.87 wiz 8952: Also make sure that the database file
8953: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8954: <p>Note that you should not create new directories for fonts;
1.87 wiz 8955: instead use the standard ones to avoid that the user needs to
8956: manually configure his X server to find them.</p>
1.75 rillig 8957: </div>
1.148 asau 8958: <div class="sect2">
1.75 rillig 8959: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8960: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8961: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8962: take some extra steps to get them registered in the GTK2 database
8963: properly:</p>
1.128 wiz 8964: <div class="orderedlist"><ol class="orderedlist" type="1">
8965: <li class="listitem"><p>Include
1.87 wiz 8966: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8967: <code class="filename">buildlink3.mk</code> file. This takes care of
8968: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 8969: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 8970: your package installs GTK2 immodules.</p></li>
1.128 wiz 8971: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 8972: GTK2 loaders.</p></li>
1.128 wiz 8973: <li class="listitem">
1.87 wiz 8974: <p>Patch the package to not touch any of the GTK2
8975: databases directly. These are:</p>
1.148 asau 8976: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8977: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8978: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8979: </ul></div>
8980: </li>
1.128 wiz 8981: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 8982: any entries under the <code class="filename">libdata/gtk-2.0</code>
8983: directory, as they will be handled automatically.</p></li>
1.75 rillig 8984: </ol></div>
8985: </div>
1.148 asau 8986: <div class="sect2">
1.75 rillig 8987: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8988: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8989: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8990: registered in system-wide catalogs (like DTDs, sub-catalogs,
8991: etc.), you need to take some extra steps:</p>
1.128 wiz 8992: <div class="orderedlist"><ol class="orderedlist" type="1">
8993: <li class="listitem"><p>Include
1.87 wiz 8994: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8995: your <code class="filename">Makefile</code>, which takes care of
8996: registering those files in system-wide catalogs at
8997: installation and deinstallation time.</p></li>
1.128 wiz 8998: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8999: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9000: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9001: any XML catalogs installed by the package.</p></li>
1.128 wiz 9002: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9003: to be added to the SGML catalog. These come in groups of
9004: three strings; see xmlcatmgr(1) for more information
9005: (specifically, arguments recognized by the 'add' action).
9006: Note that you will normally not use this variable.</p></li>
1.128 wiz 9007: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9008: to be added to the XML catalog. These come in groups of three
9009: strings; see xmlcatmgr(1) for more information (specifically,
9010: arguments recognized by the 'add' action). Note that you will
9011: normally not use this variable.</p></li>
1.75 rillig 9012: </ol></div>
9013: </div>
1.148 asau 9014: <div class="sect2">
1.75 rillig 9015: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9016: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9017: <p>If a package provides extensions to the MIME database by
1.87 wiz 9018: installing <code class="filename">.xml</code> files inside
9019: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9020: need to take some extra steps to ensure that the database is kept
9021: consistent with respect to these new files:</p>
1.128 wiz 9022: <div class="orderedlist"><ol class="orderedlist" type="1">
9023: <li class="listitem"><p>Include
1.87 wiz 9024: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9025: (avoid using the <code class="filename">buildlink3.mk</code> file from
9026: this same directory, which is reserved for inclusion from
9027: other <code class="filename">buildlink3.mk</code> files). It takes
9028: care of rebuilding the MIME database at installation and
9029: deinstallation time, and disallows any access to it directly
9030: from the package.</p></li>
1.128 wiz 9031: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9032: <code class="filename">share/mime</code> directory,
9033: <span class="emphasis"><em>except</em></span> for files saved under
9034: <code class="filename">share/mime/packages</code>. The former are
9035: handled automatically by
9036: the update-mime-database program, but the latter are
9037: package-dependent and must be removed by the package that
9038: installed them in the first place.</p></li>
1.128 wiz 9039: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9040: from the PLIST. They will be handled by the shared-mime-info
9041: package.</p></li>
1.75 rillig 9042: </ol></div>
9043: </div>
1.148 asau 9044: <div class="sect2">
1.75 rillig 9045: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9046: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9047: <p>If a package uses intltool during its build, add
9048: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9049: which forces it to use the intltool package provided by pkgsrc,
9050: instead of the one bundled with the distribution file.</p>
1.75 rillig 9051: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9052: latest available version; this way, the package benefits of any
9053: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9054: </div>
1.148 asau 9055: <div class="sect2">
1.75 rillig 9056: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9057: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9058: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9059: the startup directory by default, but you can enable it, by adding
9060: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9061: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9062: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9063: it will automatically remove the scripts when the package is
9064: deinstalled.</p>
1.75 rillig 9065: </div>
1.148 asau 9066: <div class="sect2">
1.75 rillig 9067: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9068: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9069: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9070: the <code class="filename">ls-R</code> database of the tree needs to be
9071: updated.</p>
1.148 asau 9072: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9073: <h3 class="title">Note</h3>
1.125 wiz 9074: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9075: packages should install files
1.125 wiz 9076: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9077: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9078: </div>
1.128 wiz 9079: <div class="orderedlist"><ol class="orderedlist" type="1">
9080: <li class="listitem"><p>Include
1.125 wiz 9081: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9082: takes care of rebuilding the <code class="filename">ls-R</code>
9083: database at installation and deinstallation time.</p></li>
1.128 wiz 9084: <li class="listitem">
1.75 rillig 9085: <p>If your package installs files into a texmf
1.87 wiz 9086: tree other than the one
1.125 wiz 9087: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9088: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9089: trees that need database update.</p>
1.75 rillig 9090: <p>If your package also installs font map files that need
1.110 hubertf 9091: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9092: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9093: set <code class="varname">TEX_MAP_FILES</code> and/or
9094: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9095: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9096: be run automatically at installation/deinstallation to
9097: enable/disable font map files for TeX output
9098: drivers.</p>
1.75 rillig 9099: </li>
1.128 wiz 9100: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9101: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9102: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9103: </ol></div>
9104: </div>
1.148 asau 9105: <div class="sect2">
1.85 jmmv 9106: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9107: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9108: emulation</h3></div></div></div>
9109: <p>There are some packages that provide libraries and
9110: executables for running binaries from a one operating system
9111: on a different one (if the latter supports it). One example
9112: is running Linux binaries on NetBSD.</p>
1.189 snj 9113: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87 wiz 9114: helps in extracting and packaging Linux rpm packages.</p>
9115: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9116: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9117: if all libraries for each installed executable can be found by
9118: the dynamic linker. Since the standard dynamic linker is run,
9119: this fails for emulation packages, because the libraries used
9120: by the emulation are not in the standard directories.</p>
9121: </div>
1.148 asau 9122: <div class="sect2">
1.87 wiz 9123: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9124: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9125: <p>If a package installs images under the
1.87 wiz 9126: <code class="filename">share/icons/hicolor</code> and/or updates the
9127: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9128: database, you need to take some extra steps to make sure that the
9129: shared theme directory is handled appropriately and that the cache
9130: database is rebuilt:</p>
1.128 wiz 9131: <div class="orderedlist"><ol class="orderedlist" type="1">
9132: <li class="listitem"><p>Include
1.87 wiz 9133: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9134: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9135: entry that refers to the theme cache.</p></li>
1.128 wiz 9136: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9137: directories from the <code class="filename">share/icons/hicolor</code>
9138: hierarchy because they will be handled automatically.</p></li>
9139: </ol></div>
9140: <p>The best way to verify that the PLIST is correct with
9141: respect to the last two points is to regenerate it using
1.110 hubertf 9142: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9143: </div>
1.148 asau 9144: <div class="sect2">
1.85 jmmv 9145: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9146: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9147: <p>If a package installs <code class="filename">.desktop</code> files
9148: under <code class="filename">share/applications</code> and these include
1.159 rodent 9149: MIME information (MimeType key), you need to take extra steps to
9150: ensure that they are registered into the MIME database:</p>
1.128 wiz 9151: <div class="orderedlist"><ol class="orderedlist" type="1">
9152: <li class="listitem"><p>Include
1.85 jmmv 9153: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9154: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9155: <code class="filename">share/applications/mimeinfo.cache</code> file.
9156: It will be handled automatically.</p></li>
9157: </ol></div>
9158: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9159: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9160: print-PLIST</strong></span>.</p>
1.75 rillig 9161: </div>
9162: </div>
1.148 asau 9163: <div class="sect1">
1.87 wiz 9164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9165: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9166: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9167: immediately. In this case, one can plainly mark a package as broken. For
9168: this, one just sets the variable <code class="varname">BROKEN</code> to the
9169: reason why the package is broken (similar to the
9170: <code class="varname">RESTRICTED</code> variable). A user trying to build
9171: the package will immediately be shown this message, and the build
9172: will not be even tried.</p>
9173: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9174: intervals.</p>
9175: </div>
1.75 rillig 9176: </div>
1.148 asau 9177: <div class="chapter">
1.75 rillig 9178: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9179: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9180: <p>To check out all the gotchas when building a package, here are
9181: the steps that I do in order to get a package working. Please note
9182: this is basically the same as what was explained in the previous
9183: sections, only with some debugging aids.</p>
1.148 asau 9184: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9185: <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>
9186: <li class="listitem">
1.189 snj 9187: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88 wiz 9188: create a directory for a new package, change into it, then run
1.110 hubertf 9189: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9190: <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>
9191: <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>
9192: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9193: </li>
1.128 wiz 9194: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9195: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9196: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9197: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9198: configure step to the package's
9199: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9200: <li class="listitem">
1.75 rillig 9201: <p>Make the package compile, doing multiple rounds of</p>
9202: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9203: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9204: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9205: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9206: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9207: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9208: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9209: <p>Doing this step as non-root user will ensure that no files
9210: are modified that shouldn't be, especially during the build
1.110 hubertf 9211: phase. <span class="command"><strong>mkpatches</strong></span>,
9212: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.189 snj 9213: from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88 wiz 9214: package.</p>
1.75 rillig 9215: </li>
1.128 wiz 9216: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9217: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9218: <li class="listitem">
1.76 rillig 9219: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9220: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9221: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9222: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9223: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9224: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9225: <p>You usually need to be <code class="username">root</code> to do
9226: this. Look if there are any files left:</p>
1.75 rillig 9227: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9228: <p>If this reveals any files that are missing in
1.88 wiz 9229: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9230: </li>
1.128 wiz 9231: <li class="listitem">
1.88 wiz 9232: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9233: package again and make a binary package:</p>
1.75 rillig 9234: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9235: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9236: </li>
1.128 wiz 9237: <li class="listitem">
1.75 rillig 9238: <p>Delete the installed package:</p>
1.88 wiz 9239: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75 rillig 9240: </li>
1.128 wiz 9241: <li class="listitem">
1.110 hubertf 9242: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9243: command, which shouldn't find anything now:</p>
1.75 rillig 9244: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9245: </li>
1.128 wiz 9246: <li class="listitem">
1.75 rillig 9247: <p>Reinstall the binary package:</p>
1.93 rillig 9248: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75 rillig 9249: </li>
1.128 wiz 9250: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9251: <li class="listitem">
1.189 snj 9252: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88 wiz 9253: reports:</p>
1.75 rillig 9254: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9255: </li>
1.128 wiz 9256: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.75 rillig 9257: </ul></div>
9258: </div>
1.148 asau 9259: <div class="chapter">
1.75 rillig 9260: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9261: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9262: <div class="toc">
9263: <p><b>Table of Contents</b></p>
9264: <dl>
1.106 rillig 9265: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9266: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9267: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 9268: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9269: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9270: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9271: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9272: </dl>
9273: </div>
1.148 asau 9274: <div class="sect1">
1.75 rillig 9275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9276: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9277: <p>Our policy is that we accept binaries only from pkgsrc
9278: developers to guarantee that the packages don't contain any
9279: trojan horses etc. This is not to annoy anyone but rather to
9280: protect our users! You're still free to put up your home-made
9281: binary packages and tell the world where to get them. NetBSD
9282: developers doing bulk builds and wanting to upload them please
1.174 asau 9283: 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
9284: builds)</i></a>.</p>
1.75 rillig 9285: </div>
1.148 asau 9286: <div class="sect1">
1.75 rillig 9287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9288: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9289: <p>First, check that your package is complete, compiles and
1.110 hubertf 9290: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.189 snj 9291: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9292: archive that contains all files that make up the package.
1.87 wiz 9293: Finally, send this package to the pkgsrc bug tracking system,
1.189 snj 9294: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9295: that, go to the web page
1.110 hubertf 9296: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 9297: which contains some instructions and a link to a form where you
9298: can submit packages. The
1.189 snj 9299: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124 snj 9300: also available as a substitute for either of the above two tools.
9301: </p>
1.87 wiz 9302: <p>In the form of the problem report, the category should be
1.128 wiz 9303: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9304: and version number, and the description field should contain a
9305: short description of your package (contents of the COMMENT
9306: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9307: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9308: <p>If you want to submit several packages, please send a
9309: separate PR for each one, it's easier for us to track things
9310: that way.</p>
9311: <p>Alternatively, you can also import new packages into
1.128 wiz 9312: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9313: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9314: for details.</p>
9315: </div>
1.148 asau 9316: <div class="sect1">
1.75 rillig 9317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9318: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9319: <p>Please note all package additions, updates, moves, and
1.93 rillig 9320: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9321: important to keep this file up to date and conforming to the
9322: existing format, because it will be used by scripts to
1.110 hubertf 9323: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9324: sites. Additionally, check the
1.76 rillig 9325: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9326: for the package you updated or removed, in case it was mentioned
9327: there.</p>
9328: <p>When the <code class="varname">PKGREVISION</code> of a package is
9329: bumped, the change should appear in
1.93 rillig 9330: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9331: related or otherwise relevant. Mass bumps that result from a
9332: dependency being updated should not be mentioned. In all other
9333: cases it's the developer's decision.</p>
9334: <p>There is a make target that helps in creating proper
1.110 hubertf 9335: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9336: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9337: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9338: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9339: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9340: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9341: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9342: For new packages, or package moves or removals, set the
9343: <code class="varname">CTYPE</code> variable on the command line to "Added",
9344: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9345: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9346: not the same as your NetBSD login name. The target also automatically
9347: removes possibly existing entries for the package in the
9348: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9349: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9350: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9351: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9352: makes the cvs commands use the main repository.
9353: </p>
1.75 rillig 9354: </div>
1.148 asau 9355: <div class="sect1">
1.75 rillig 9356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9357: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9358: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9359: access to the pkgsrc repository.</p>
9360: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9361: Start by adding the directory and then files in the directory. Don't
9362: forget to add the new package to the category's
9363: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9364: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9365: <pre class="programlisting">
9366: <code class="prompt">$</code> cd .../pkgsrc/category
9367: <code class="prompt">$</code> cvs add pkgname
9368: <code class="prompt">$</code> cd pkgname
9369: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9370: <code class="prompt">$</code> cvs add patches/p*
9371: <code class="prompt">$</code> cvs status | less
1.141 wiz 9372: <code class="prompt">$</code> cvs commit
1.140 wiz 9373: <code class="prompt">$</code> cd ..
9374: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9375: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9376: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9377: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9378: </pre>
1.87 wiz 9379: <p>The commit message of the initial import should include part of the
1.76 rillig 9380: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9381: what the package is/does.</p>
1.140 wiz 9382: <p>Also mention the new package in
9383: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9384: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9385: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9386: </div>
1.148 asau 9387: <div class="sect1">
1.75 rillig 9388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9389: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9390: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9391: changes between old and new versions into the commit log when updating
1.87 wiz 9392: a package. There are various reasons for this:</p>
1.148 asau 9393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9394: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9395: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9396: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9397: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9398: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9399: repository is very useful for people who read the pkgsrc-changes mailing
9400: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9401: the package.</p></li>
1.75 rillig 9402: </ul></div>
1.87 wiz 9403: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9404: has been released, it should not automatically be upgraded in the CVS
9405: repository. We prefer to be conservative in the packages that are
9406: included in pkgsrc - development or beta packages are not really the
9407: best thing for most places in which pkgsrc is used. Please use your
9408: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9409: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9410: </div>
1.148 asau 9411: <div class="sect1">
1.75 rillig 9412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9413: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9414: <p>Renaming packages is not recommended.</p>
9415: <p>When renaming packages, be sure to fix any references to old name
9416: in other Makefiles, options, buildlink files, etc.</p>
9417: <p>Also When renaming a package, please define
9418: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9419: pattern(s) of the previous package name.
9420: This may be repeated for multiple renames.
9421: The new package would be an exact replacement.
9422: </p>
1.128 wiz 9423: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9424: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9425: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9426: not be an exact replacement but is a suggestion for the replaced
9427: functionality.</p>
9428: </div>
1.148 asau 9429: <div class="sect1">
1.122 reed 9430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9431: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9432: <p>It is preferred that packages are not renamed or moved, but if needed
9433: please follow these steps.
9434: </p>
1.128 wiz 9435: <div class="orderedlist"><ol class="orderedlist" type="1">
9436: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9437: <li class="listitem">
1.75 rillig 9438: <p>Remove all CVS dirs.</p>
1.87 wiz 9439: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9440: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87 wiz 9441: <p>and use that for further work.</p>
1.75 rillig 9442: </li>
1.128 wiz 9443: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9444: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9445: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9446: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9447: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9448: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9449: for doing an update using pkgsrc building; for example, it can
1.189 snj 9450: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122 reed 9451: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9452: new <code class="varname">PKGPATH</code> for that moved package. Note that
9453: it may have multiple matches, so the tool should also check on the
9454: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9455: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9456: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9457: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9458: place.</p></li>
1.128 wiz 9459: <li class="listitem">
1.75 rillig 9460: <p>Check if any package depends on it:
9461: </p>
9462: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9463: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9464: </li>
1.128 wiz 9465: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9466: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9467: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9468: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9469: <li class="listitem">
1.75 rillig 9470: <p>Commit the changed and removed files:</p>
9471: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 9472: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9473: </li>
9474: </ol></div>
9475: </div>
9476: </div>
1.148 asau 9477: <div class="chapter">
1.75 rillig 9478: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9479: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9480: <p>This section contains the answers to questions that may
9481: arise when you are writing a package. If you don't find your
9482: question answered here, first have a look in the other chapters,
9483: and if you still don't have the answer, ask on the
9484: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9485: <div class="qandaset">
1.193 ! dholland 9486: <a name="idm77235344"></a><dl>
1.106 rillig 9487: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9488: MAKEFLAGS, .MAKEFLAGS and
9489: MAKE_FLAGS?</a>
9490: </dt>
1.106 rillig 9491: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9492: MAKE, GMAKE and
9493: MAKE_PROGRAM?</a>
9494: </dt>
1.106 rillig 9495: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9496: CC, PKG_CC and
9497: PKGSRC_COMPILER?</a>
9498: </dt>
1.106 rillig 9499: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9500: BUILDLINK_LDFLAGS,
9501: BUILDLINK_LDADD and
9502: BUILDLINK_LIBS?</a>
9503: </dt>
1.106 rillig 9504: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9505: VARNAME=BUILDLINK_PREFIX.foo
9506: say it's empty?</a>
9507: </dt>
1.106 rillig 9508: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9509: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9510: don't understand the := inside
9511: it.</a>
9512: </dt>
1.106 rillig 9513: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9514: developers?</a>
9515: </dt>
1.106 rillig 9516: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9517: documentation?</a>
9518: </dt>
1.106 rillig 9519: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9520: do?</a>
9521: </dt>
1.75 rillig 9522: </dl>
1.148 asau 9523: <table border="0" style="width: 100%;">
9524: <colgroup>
1.75 rillig 9525: <col align="left" width="1%">
1.128 wiz 9526: <col>
1.148 asau 9527: </colgroup>
1.75 rillig 9528: <tbody>
1.148 asau 9529: <tr class="question">
1.75 rillig 9530: <td align="left" valign="top">
1.193 ! dholland 9531: <a name="devfaq.makeflags"></a><a name="idm77234960"></a><p><b>22.1.</b></p>
1.75 rillig 9532: </td>
9533: <td align="left" valign="top"><p>What is the difference between
9534: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9535: <code class="varname">MAKE_FLAGS</code>?</p></td>
9536: </tr>
9537: <tr class="answer">
1.91 rillig 9538: <td align="left" valign="top"></td>
1.75 rillig 9539: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.189 snj 9540: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 9541: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9542: the <code class="varname">MAKE_PROGRAM</code> when building the
9543: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9544: </tr>
1.148 asau 9545: <tr class="question">
1.75 rillig 9546: <td align="left" valign="top">
1.193 ! dholland 9547: <a name="devfaq.make"></a><a name="idm77230992"></a><p><b>22.2.</b></p>
1.75 rillig 9548: </td>
9549: <td align="left" valign="top"><p>What is the difference between
9550: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9551: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9552: </tr>
9553: <tr class="answer">
1.91 rillig 9554: <td align="left" valign="top"></td>
1.75 rillig 9555: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.189 snj 9556: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 9557: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9558: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9559: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9560: Make program that is used for building the
9561: package.</p></td>
9562: </tr>
1.148 asau 9563: <tr class="question">
1.75 rillig 9564: <td align="left" valign="top">
1.193 ! dholland 9565: <a name="devfaq.cc"></a><a name="idm77226512"></a><p><b>22.3.</b></p>
1.75 rillig 9566: </td>
9567: <td align="left" valign="top"><p>What is the difference between
9568: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9569: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9570: </tr>
9571: <tr class="answer">
1.91 rillig 9572: <td align="left" valign="top"></td>
1.75 rillig 9573: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9574: compiler, which can be configured by the pkgsrc user.
9575: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9576: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9577: path to a compiler, but the type of compiler that should be
1.76 rillig 9578: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9579: information about the latter variable.</p></td>
9580: </tr>
1.148 asau 9581: <tr class="question">
1.75 rillig 9582: <td align="left" valign="top">
1.193 ! dholland 9583: <a name="devfaq.bl3flags"></a><a name="idm77222416"></a><p><b>22.4.</b></p>
1.75 rillig 9584: </td>
9585: <td align="left" valign="top"><p>What is the difference between
9586: <code class="varname">BUILDLINK_LDFLAGS</code>,
9587: <code class="varname">BUILDLINK_LDADD</code> and
9588: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9589: </tr>
9590: <tr class="answer">
1.91 rillig 9591: <td align="left" valign="top"></td>
1.75 rillig 9592: <td align="left" valign="top"><p>[FIXME]</p></td>
9593: </tr>
1.148 asau 9594: <tr class="question">
1.75 rillig 9595: <td align="left" valign="top">
1.193 ! dholland 9596: <a name="devfaq.bl3prefix"></a><a name="idm77220240"></a><p><b>22.5.</b></p>
1.75 rillig 9597: </td>
1.110 hubertf 9598: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9599: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9600: say it's empty?</p></td>
9601: </tr>
9602: <tr class="answer">
1.91 rillig 9603: <td align="left" valign="top"></td>
1.75 rillig 9604: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9605: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9606: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9607: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9608: command.</p></td>
9609: </tr>
1.148 asau 9610: <tr class="question">
1.78 rillig 9611: <td align="left" valign="top">
1.193 ! dholland 9612: <a name="devfaq.master_sites"></a><a name="idm77208848"></a><p><b>22.6.</b></p>
1.78 rillig 9613: </td>
9614: <td align="left" valign="top"><p>What does
9615: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9616: don't understand the <code class="literal">:=</code> inside
9617: it.</p></td>
9618: </tr>
9619: <tr class="answer">
1.91 rillig 9620: <td align="left" valign="top"></td>
1.78 rillig 9621: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9622: assignment operator, like you might expect at first sight.
9623: Instead, it is a degenerate form of
9624: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.189 snj 9625: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78 rillig 9626: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9627: case of <code class="varname">MASTER_SITE_*</code>,
9628: <em class="replaceable"><code>old_string</code></em> is the empty string and
9629: <em class="replaceable"><code>new_string</code></em> is
9630: <code class="literal">package/</code>. That's where the
9631: <code class="literal">:</code> and the <code class="literal">=</code> fall
9632: together.</p></td>
9633: </tr>
1.148 asau 9634: <tr class="question">
1.78 rillig 9635: <td align="left" valign="top">
1.193 ! dholland 9636: <a name="devfaq.mailinglists"></a><a name="idm77200784"></a><p><b>22.7.</b></p>
1.78 rillig 9637: </td>
9638: <td align="left" valign="top"><p>Which mailing lists are there for package
9639: developers?</p></td>
9640: </tr>
9641: <tr class="answer">
1.91 rillig 9642: <td align="left" valign="top"></td>
1.148 asau 9643: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9644: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78 rillig 9645: <dd><p>This is a list for technical discussions related
9646: to pkgsrc development, e.g. soliciting feedback for changes to
9647: pkgsrc infrastructure, proposed new features, questions related
9648: to porting pkgsrc to a new platform, advice for maintaining a
9649: package, patches that affect many packages, help requests moved
9650: from pkgsrc-users when an infrastructure bug is found,
9651: etc.</p></dd>
1.110 hubertf 9652: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78 rillig 9653: <dd><p>All bug reports in category "pkg" sent with
1.189 snj 9654: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 9655: directly; use one of the other mailing
9656: lists.</p></dd>
9657: </dl></div></td>
9658: </tr>
1.148 asau 9659: <tr class="question">
1.80 rillig 9660: <td align="left" valign="top">
1.193 ! dholland 9661: <a name="devfaq.documentation"></a><a name="idm77197072"></a><p><b>22.8.</b></p>
1.80 rillig 9662: </td>
9663: <td align="left" valign="top"><p>Where is the pkgsrc
9664: documentation?</p></td>
9665: </tr>
9666: <tr class="answer">
1.91 rillig 9667: <td align="left" valign="top"></td>
1.80 rillig 9668: <td align="left" valign="top">
9669: <p>There are many places where you can find
9670: documentation about pkgsrc:</p>
1.148 asau 9671: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9672: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9673: of chapters that explain large parts of pkgsrc, but some
9674: chapters tend to be outdated. Which ones they are is hard to
9675: say.</p></li>
1.128 wiz 9676: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80 rillig 9677: about certain features, announcements of new parts of the pkgsrc
9678: infrastructure and sometimes even announcements that a certain
9679: feature has been marked as obsolete. The benefit here is that
9680: each message has a date appended to it.</p></li>
1.128 wiz 9681: <li class="listitem"><p>Many of the files in the
1.80 rillig 9682: <code class="filename">mk/</code> directory start with a comment that
9683: describes the purpose of the file and how it can be used by the
1.92 rillig 9684: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9685: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9686: help</strong></span>.</p></li>
1.128 wiz 9687: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9688: information, but they tend to be highly abbreviated, especially
9689: for actions that occur often. Some contain a detailed
9690: description of what has changed, but they are geared towards the
9691: other pkgsrc developers, not towards an average pkgsrc user.
9692: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9693: don't know what has been before, these messages may not be worth
9694: too much to you.</p></li>
1.128 wiz 9695: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9696: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9697: mind of the developer who wrote the code. To get this
1.110 hubertf 9698: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9699: to see who has written it and ask on the
9700: <code class="literal">tech-pkg</code> mailing list, so that others can
9701: find your questions later (see above). To be sure that the
9702: developer in charge reads the mail, you may CC him or
9703: her.</p></li>
9704: </ul></div>
9705: </td>
9706: </tr>
1.148 asau 9707: <tr class="question">
1.92 rillig 9708: <td align="left" valign="top">
1.193 ! dholland 9709: <a name="devfaq.too-much-time"></a><a name="idm77190544"></a><p><b>22.9.</b></p>
1.92 rillig 9710: </td>
9711: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9712: do?</p></td>
9713: </tr>
9714: <tr class="answer">
9715: <td align="left" valign="top"></td>
9716: <td align="left" valign="top">
1.93 rillig 9717: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9718: anyway.</p>
1.148 asau 9719: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9720: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.189 snj 9721: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.92 rillig 9722: will tell you about newer versions of installed packages that are
9723: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9724: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9725: — it contains a list of suggested new packages and a list of
1.92 rillig 9726: cleanups and enhancements for pkgsrc that would be nice to
9727: have.</p></li>
1.128 wiz 9728: <li class="listitem"><p>Review packages for which review was requested on
1.180 wiz 9729: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92 rillig 9730: mailing list.</p></li>
9731: </ul></div>
9732: </td>
9733: </tr>
1.75 rillig 9734: </tbody>
9735: </table>
9736: </div>
9737: </div>
1.148 asau 9738: <div class="chapter">
1.85 jmmv 9739: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9740: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9741: <div class="toc">
9742: <p><b>Table of Contents</b></p>
9743: <dl>
1.106 rillig 9744: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9745: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9746: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9747: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9748: </dl>
9749: </div>
1.110 hubertf 9750: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9751: site</a>:</p>
9752: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9753: environment, an intuitive and attractive desktop for users, and the
9754: GNOME development platform, an extensive framework for building
9755: applications that integrate into the rest of the desktop.</p></blockquote></div>
9756: <p>pkgsrc provides a seamless way to automatically build and install
9757: a complete GNOME environment <span class="emphasis"><em>under many different
9758: platforms</em></span>. We can say with confidence that pkgsrc is one of
9759: the most advanced build and packaging systems for GNOME due to its
9760: included technologies buildlink3, the wrappers and tools framework and
9761: automatic configuration file management. Lots of efforts are put into
9762: achieving a completely clean deinstallation of installed software
9763: components.</p>
1.110 hubertf 9764: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9765: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9766: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9767: pkgsrc as its preferred packaging system, contributing lots of
9768: portability fixes to make GNOME build and install under it.</p>
9769: <p>This chapter is aimed at pkgsrc developers and other people
9770: interested in helping our GNOME porting and packaging efforts. It
9771: provides instructions on how to manage the existing packages and some
9772: important information regarding their internals.</p>
1.148 asau 9773: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9774: <h3 class="title">We need your help!</h3>
9775: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9776: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9777: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9778: work</a> list! There is still a long way to go to get a
9779: fully-functional GNOME desktop under NetBSD and we need your help to
9780: achieve it!</p>
9781: </div>
1.148 asau 9782: <div class="sect1">
1.85 jmmv 9783: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9784: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9785: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9786: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 9787: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85 jmmv 9788: the core GNOME desktop environment. It only includes the necessary
9789: bits to get it to boot correctly, although it may lack important
9790: functionality for daily operation. The idea behind this package is
9791: to let end users build their own configurations on top of this one,
9792: first installing this meta package to achieve a functional setup and
9793: then adding individual applications.</p></li>
1.189 snj 9794: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85 jmmv 9795: complete installation of the GNOME platform and desktop as defined
9796: by the GNOME project; this is based on the components distributed in
9797: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9798: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9799: official FTP server. Developer-only tools found in those
9800: directories are not installed unless required by some other
9801: component to work properly. Similarly, packages from the bindings
9802: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9803: in unless required as a dependency for an end-user component. This
1.189 snj 9804: package "extends" <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
9805: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85 jmmv 9806: Installs all the tools required to build a GNOME component when
9807: fetched from the CVS repository. These are required to let the
1.110 hubertf 9808: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9809: </ul></div>
9810: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9811: sorted in a way that eases updates: a package may depend on other
9812: packages listed before it but not on any listed after it. It is very
9813: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9814: change it to alphabetical sorting!</em></span></p>
9815: </div>
1.148 asau 9816: <div class="sect1">
1.85 jmmv 9817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9818: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9819: <p>Almost all GNOME applications are written in C and use a common
9820: set of tools as their build system. Things get different with the new
9821: bindings to other languages (such as Python), but the following will
9822: give you a general idea on the minimum required tools:</p>
1.148 asau 9823: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9824: <li class="listitem">
1.85 jmmv 9825: <p>Almost all GNOME applications use the GNU Autotools as their
9826: build system. As a general rule you will need to tell this to your
9827: package:</p>
1.100 rillig 9828: <pre class="programlisting">
9829: GNU_CONFIGURE=yes
1.85 jmmv 9830: USE_LIBTOOL=yes
1.100 rillig 9831: USE_TOOLS+=gmake
9832: </pre>
1.85 jmmv 9833: </li>
1.128 wiz 9834: <li class="listitem">
1.85 jmmv 9835: <p>If the package uses pkg-config to detect dependencies, add this
9836: tool to the list of required utilities:</p>
9837: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.189 snj 9838: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85 jmmv 9839: the end of the build process to ensure that you did not miss to
9840: specify any dependency in your package and that the version
9841: requirements are all correct.</p>
9842: </li>
1.128 wiz 9843: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9844: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9845: to handle dependencies and to force the package to use the latest
9846: available version.</p></li>
1.128 wiz 9847: <li class="listitem">
1.85 jmmv 9848: <p>If the package uses gtk-doc (a documentation generation
9849: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9850: tool is rather big and the distfile should come with pregenerated
9851: documentation anyway; if it does not, it is a bug that you ought to
9852: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9853: the default):</p>
9854: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9855: <p>The default location of installed HTML files
9856: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9857: and should not be changed unless the package insists on installing
9858: them somewhere else. Otherwise programs as
1.110 hubertf 9859: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9860: do that with an entry similar to:</p>
9861: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9862: </li>
9863: </ul></div>
9864: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9865: files under the installation prefix to maintain databases. In this
9866: context, shared means that those exact same directories and files are
9867: used among several different packages, leading to conflicts in the
9868: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9869: handle the most common cases, so you have to forget about using
9870: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9871: omitting shared files from them. If you find yourself doing those,
9872: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9873: <p>The following table lists the common situations that result in
9874: using shared directories or files. For each of them, the appropriate
9875: solution is given. After applying the solution be sure to
9876: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9877: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9878: <div class="table">
1.106 rillig 9879: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9880: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9881: <colgroup>
9882: <col>
9883: <col>
9884: </colgroup>
9885: <thead><tr>
9886: <th>If the package...</th>
9887: <th>Then...</th>
9888: </tr></thead>
9889: <tbody>
9890: <tr>
9891: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9892: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.85 jmmv 9893: </tr>
9894: <tr>
9895: <td>Installs icons under the
9896: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9897: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9898: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.85 jmmv 9899: </tr>
9900: <tr>
9901: <td>Installs files under
9902: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9903: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.85 jmmv 9904: </tr>
9905: <tr>
9906: <td>Installs <code class="filename">.desktop</code> files under
9907: <code class="filename">share/applications</code> and these include MIME
9908: information.</td>
1.110 hubertf 9909: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.85 jmmv 9910: </tr>
9911: </tbody>
1.91 rillig 9912: </table></div>
1.85 jmmv 9913: </div>
1.91 rillig 9914: <br class="table-break">
1.85 jmmv 9915: </div>
1.148 asau 9916: <div class="sect1">
1.85 jmmv 9917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9918: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9919: <p>When seeing GNOME as a whole, there are two kinds of
9920: updates:</p>
1.148 asau 9921: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9922: <dt><span class="term">Major update</span></dt>
9923: <dd>
9924: <p>Given that there is still a very long way for GNOME 3 (if it
9925: ever appears), we consider a major update one that goes from a
9926: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9927: where <code class="literal">Y</code> is even and greater than
9928: <code class="literal">X</code>. These are hard to achieve because they
9929: introduce lots of changes in the components' code and almost all
9930: GNOME distfiles are updated to newer versions. Some of them can
9931: even break API and ABI compatibility with the previous major
9932: version series. As a result, the update needs to be done all at
9933: once to minimize breakage.</p>
9934: <p>A major update typically consists of around 80 package
9935: updates and the addition of some new ones.</p>
9936: </dd>
9937: <dt><span class="term">Minor update</span></dt>
9938: <dd>
9939: <p>We consider a minor update one that goes from a
9940: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9941: one where <code class="literal">Y</code> is greater than
9942: <code class="literal">X</code>. These are easy to achieve because they do
9943: not update all GNOME components, can be done in an incremental way
9944: and do not break API nor ABI compatibility.</p>
9945: <p>A minor update typically consists of around 50 package
9946: updates, although the numbers here may vary a lot.</p>
9947: </dd>
9948: </dl></div>
9949: <p>In order to update the GNOME components in pkgsrc to a new stable
9950: release (either major or minor), the following steps should be
9951: followed:</p>
1.128 wiz 9952: <div class="orderedlist"><ol class="orderedlist" type="1">
9953: <li class="listitem">
1.85 jmmv 9954: <p>Get a list of all the tarballs that form the new release by
9955: using the following commands. These will leave the full list of the
1.120 snj 9956: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 9957: file:</p>
1.88 wiz 9958: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9959: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9960: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9961: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9962: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9963: awk '{ print $9 }' >>list.txt</code></strong></pre>
9964: </li>
1.128 wiz 9965: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 9966: bump their version to the release you are updating them to. The
9967: three meta packages should be always consistent with versioning.
9968: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9969: in them.</p></li>
1.128 wiz 9970: <li class="listitem">
1.85 jmmv 9971: <p>For each meta package, update all its
9972: <code class="varname">DEPENDS</code> lines to match the latest versions as
9973: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9974: newer version (even if found in the FTP) because the meta packages
9975: are supposed to list the exact versions that form a specific GNOME
9976: release. Exceptions are permitted here if a newer version solves a
9977: serious issue in the overall desktop experience; these typically
9978: come in the form of a revision bump in pkgsrc, not in newer versions
9979: from the developers.</p>
9980: <p>Packages not listed in the <code class="filename">list.txt</code> file
9981: should be updated to the latest version available (if found in
9982: pkgsrc). This is the case, for example, of the dependencies on the
1.189 snj 9983: GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85 jmmv 9984: </li>
1.128 wiz 9985: <li class="listitem">
1.85 jmmv 9986: <p>Generate a patch from the modified meta packages and extract the
9987: list of "new" lines. This will provide you an outline on what
9988: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9989: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.85 jmmv 9990: </li>
1.128 wiz 9991: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 9992: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 9993: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 9994: of <code class="filename">todo.txt</code> and update the packages listed in
9995: it in order. For major desktop updates none of these should be
1.93 rillig 9996: committed until the entire set is completed because there are chances
1.85 jmmv 9997: of breaking not-yet-updated packages.</p></li>
1.128 wiz 9998: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 9999: the tree one by one with appropriate log messages. At the end,
10000: commit the three meta package updates and all the corresponding
10001: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10002: <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>
10003: </ol></div>
10004: </div>
1.148 asau 10005: <div class="sect1">
1.85 jmmv 10006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10007: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10008: <p>GNOME is a very big component in pkgsrc which approaches 100
10009: packages. Please, it is very important that you always, always,
10010: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10011: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.85 jmmv 10012: their attention on portability issues and to ensure that future versions
10013: can be built out-of-the box on NetBSD. The less custom patches in
10014: pkgsrc, the easier further updates are. Those developers in charge of
10015: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10016: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85 jmmv 10017: Bugzilla</a>. Not all components use these to track bugs, but most
10018: of them do. Do not be short on your reports: always provide detailed
10019: explanations of the current failure, how it can be improved to achieve
10020: maximum portability and, if at all possible, provide a patch against CVS
10021: head. The more verbose you are, the higher chances of your patch being
10022: accepted.</p>
10023: <p>Also, please avoid using preprocessor magic to fix portability
10024: issues. While the FreeBSD GNOME people are doing a great job in porting
10025: GNOME to their operating system, the official GNOME sources are now
10026: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10027: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10028: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 10029: details.</p>
10030: </div>
10031: </div>
1.75 rillig 10032: </div>
1.148 asau 10033: <div class="part">
1.75 rillig 10034: <div class="titlepage"><div><div><h1 class="title">
10035: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10036: <div class="partintro">
1.75 rillig 10037: <div></div>
10038: <p>This part of the guide deals with everything
10039: from the infrastructure that is behind the interfaces described
10040: in the developer's guide. A casual package maintainer should not
10041: need anything from this part.</p>
10042: <div class="toc">
10043: <p><b>Table of Contents</b></p>
10044: <dl>
1.106 rillig 10045: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10046: <dd><dl>
1.106 rillig 10047: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10048: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10049: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10050: <dd><dl>
1.106 rillig 10051: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10052: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10053: </dl></dd>
1.106 rillig 10054: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10055: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10056: <dd><dl>
1.106 rillig 10057: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10058: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10059: </dl></dd>
1.106 rillig 10060: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10061: <dd><dl>
1.128 wiz 10062: <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>
10063: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10064: </dl></dd>
10065: </dl></dd>
1.106 rillig 10066: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10067: <dd><dl>
1.106 rillig 10068: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10069: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10070: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10071: <dd><dl>
1.106 rillig 10072: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10073: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10074: </dl></dd>
10075: </dl></dd>
1.106 rillig 10076: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10077: <dd><dl>
1.106 rillig 10078: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10079: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10080: </dl></dd>
10081: </dl>
10082: </div>
10083: </div>
1.148 asau 10084: <div class="chapter">
1.75 rillig 10085: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10086: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10087: <div class="toc">
10088: <p><b>Table of Contents</b></p>
10089: <dl>
1.106 rillig 10090: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10091: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10092: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10093: <dd><dl>
1.106 rillig 10094: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10095: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10096: </dl></dd>
1.106 rillig 10097: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10098: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10099: <dd><dl>
1.106 rillig 10100: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10101: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10102: </dl></dd>
1.106 rillig 10103: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10104: <dd><dl>
1.128 wiz 10105: <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>
10106: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10107: </dl></dd>
10108: </dl>
10109: </div>
10110: <p>The pkgsrc infrastructure consists of many small Makefile
10111: fragments. Each such fragment needs a properly specified
10112: interface. This chapter explains how such an interface looks
10113: like.</p>
1.148 asau 10114: <div class="sect1">
1.75 rillig 10115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10116: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10117: <p>Whenever a variable is defined in the pkgsrc
10118: infrastructure, the location and the way of definition provide
10119: much information about the intended use of that variable.
10120: Additionally, more documentation may be found in a header
10121: comment or in this pkgsrc guide.</p>
10122: <p>A special file is
10123: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10124: variables that are intended to be user-defined. They are either
10125: defined using the <code class="literal">?=</code> operator or they are
10126: left undefined because defining them to anything would
1.128 wiz 10127: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10128: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10129: file.</p>
10130: <p>Outside this file, the following conventions apply:
10131: Variables that are defined using the <code class="literal">?=</code>
10132: operator may be overridden by a package.</p>
10133: <p>Variables that are defined using the <code class="literal">=</code>
10134: operator may be used read-only at run-time.</p>
10135: <p>Variables whose name starts with an underscore must not be
10136: accessed outside the pkgsrc infrastructure at all. They may
10137: change without further notice.</p>
1.148 asau 10138: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10139: <h3 class="title">Note</h3>
10140: <p>These conventions are currently not applied
10141: consistently to the complete pkgsrc
10142: infrastructure.</p>
10143: </div>
10144: </div>
1.148 asau 10145: <div class="sect1">
1.81 rillig 10146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10147: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10148: <p>All variables that contain lists of things should default
10149: to being empty. Two examples that do not follow this rule are
10150: <code class="varname">USE_LANGUAGES</code> and
10151: <code class="varname">DISTFILES</code>. These variables cannot simply be
10152: modified using the <code class="literal">+=</code> operator in package
10153: <code class="filename">Makefile</code>s (or other files included by
10154: them), since there is no guarantee whether the variable is
10155: already set or not, and what its value is. In the case of
1.128 wiz 10156: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10157: the default value and just define it as in the following
10158: example.</p>
10159: <pre class="programlisting">
1.100 rillig 10160: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10161: </pre>
10162: <p>Because of the selection of this default value, the same
10163: value appears in many package Makefiles. Similarly for
10164: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10165: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10166: doesn't stand out. Nevertheless it is mentioned in many
10167: files.</p>
10168: </div>
1.148 asau 10169: <div class="sect1">
1.81 rillig 10170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10171: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 10172: <div class="sect2">
1.75 rillig 10173: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10174: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10175: <p>Variable evaluation takes place either at load time or at
10176: runtime, depending on the context in which they occur. The
10177: contexts where variables are evaluated at load time are:</p>
1.148 asau 10178: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10179: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10180: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10181: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10182: <code class="literal">.for</code>,</p></li>
1.128 wiz 10183: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10184: </ul></div>
10185: <p>A special exception are references to the iteration
10186: variables of <code class="literal">.for</code> loops, which are expanded
10187: inline, no matter in which context they appear.</p>
10188: <p>As the values of variables may change during load time,
10189: care must be taken not to evaluate them by accident. Typical
10190: examples for variables that should not be evaluated at load time
10191: are <code class="varname">DEPENDS</code> and
10192: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10193: clear, here is an example:</p>
10194: <pre class="programlisting">
1.100 rillig 10195: CONFIGURE_ARGS= # none
10196: CFLAGS= -O
10197: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10198:
1.100 rillig 10199: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10200:
1.100 rillig 10201: CFLAGS+= -Wall
1.75 rillig 10202: </pre>
10203: <p>This code shows how the use of the <code class="literal">:=</code>
10204: operator can quickly lead to unexpected results. The first
10205: paragraph is fairly common code. The second paragraph evaluates
10206: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10207: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10208: <code class="literal">-Wall</code> is appended to the
10209: <code class="varname">CFLAGS</code>, but this addition will not appear in
10210: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10211: paragraphs from above typically occur in completely unrelated
10212: files.</p>
10213: </div>
1.148 asau 10214: <div class="sect2">
1.75 rillig 10215: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10216: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10217: <p>After all the files have been loaded, the values of the
10218: variables cannot be changed anymore. Variables that are used in
10219: the shell commands are expanded at this point.</p>
10220: </div>
10221: </div>
1.148 asau 10222: <div class="sect1">
1.75 rillig 10223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10224: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10225: <p>There are many ways in which the definition and use of a
10226: variable can be restricted in order to detect bugs and
10227: violations of the (mostly unwritten) policies. See the
10228: <code class="literal">pkglint</code> developer's documentation for further
10229: details.</p>
10230: </div>
1.148 asau 10231: <div class="sect1">
1.78 rillig 10232: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10233: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10234: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10235: of the following classes. Cases where a file falls into more
10236: than one class should be avoided as it often leads to subtle
10237: bugs.</p>
1.148 asau 10238: <div class="sect2">
1.75 rillig 10239: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10240: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10241: <p>In a traditional imperative programming language some of
1.76 rillig 10242: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10243: procedures. They take some input parameters and—after
10244: inclusion—provide a result in output parameters. Since all
1.76 rillig 10245: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10246: care must be taken not to use parameter names that have already
10247: another meaning. For example, <code class="varname">PKGNAME</code> is a
10248: bad choice for a parameter name.</p>
10249: <p>Procedures are completely evaluated at preprocessing time.
10250: That is, when calling a procedure all input parameters must be
10251: completely resolvable. For example,
10252: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10253: parameter since it is very likely that further text will be
10254: added after calling the procedure, which would effectively apply
10255: the procedure to only a part of the variable. Also, references
10256: to other variables wit will be modified after calling the
10257: procedure.</p>
10258: <p>A procedure can declare its output parameters either as
10259: suitable for use in preprocessing directives or as only
10260: available at runtime. The latter alternative is for variables
10261: that contain references to other runtime variables.</p>
10262: <p>Procedures shall be written such that it is possible to
10263: call the procedure more than once. That is, the file must not
10264: contain multiple-inclusion guards.</p>
10265: <p>Examples for procedures are
1.76 rillig 10266: <code class="filename">mk/bsd.options.mk</code> and
10267: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10268: that the parameters are evaluated at load time, they should be
10269: assigned using the <code class="literal">:=</code> operator, which should
10270: be used only for this purpose.</p>
10271: </div>
1.148 asau 10272: <div class="sect2">
1.75 rillig 10273: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10274: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10275: <p>Action files take some input parameters and may define
10276: runtime variables. They shall not define loadtime variables.
10277: There are action files that are included implicitly by the
10278: pkgsrc infrastructure, while other must be included
10279: explicitly.</p>
10280: <p>An example for action files is
1.76 rillig 10281: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10282: </div>
10283: </div>
1.148 asau 10284: <div class="sect1">
1.81 rillig 10285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10286: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10287: <p>Package <code class="filename">Makefile</code>s usually consist of
10288: a set of variable definitions, and include the file
10289: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10290: Before that, they may also include various other
10291: <code class="filename">*.mk</code> files if they need to query the
10292: availability of certain features like the type of compiler or
10293: the X11 implementation. Due to the heavy use of preprocessor
10294: directives like <code class="literal">.if</code> and
10295: <code class="literal">.for</code>, the order in which the files are loaded
10296: matters.</p>
10297: <p>This section describes at which point the various files
10298: are loaded and gives reasons for that order.</p>
1.148 asau 10299: <div class="sect2">
1.81 rillig 10300: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10301: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10302: </h3></div></div></div>
10303: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10304: is to define some essential variables like
10305: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10306: <code class="varname">MACHINE_ARCH</code>.</p>
10307: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10308: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 10309: After that, those variables
1.81 rillig 10310: that have not been overridden by the user are loaded from
10311: <code class="filename">mk/defaults/mk.conf</code>.</p>
10312: <p>After the user settings, the system settings and platform
10313: settings are loaded, which may override the user
10314: settings.</p>
10315: <p>Then, the tool definitions are loaded. The tool wrappers
10316: are not yet in effect. This only happens when building a
10317: package, so the proper variables must be used instead of the
10318: direct tool names.</p>
10319: <p>As the last steps, some essential variables from the
10320: wrapper and the package system flavor are loaded, as well as the
10321: variables that have been cached in earlier phases of a package
10322: build.</p>
10323: </div>
1.148 asau 10324: <div class="sect2">
1.81 rillig 10325: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10326: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10327: </h3></div></div></div>
1.81 rillig 10328: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10329: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10330: loaded, which fill default values for those variables that have
1.93 rillig 10331: not been defined by the package. These variables may later
1.81 rillig 10332: be used even in unrelated files.</p>
10333: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10334: provides the target <code class="literal">error-check</code> that is added
10335: as a special dependency to all other targets that use
10336: <code class="varname">DELAYED_ERROR_MSG</code> or
10337: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10338: <p>Then, the package-specific hacks from
10339: <code class="filename">hacks.mk</code> are included.</p>
10340: <p>Then, various other files follow. Most of them don't have
10341: any dependencies on what they need to have included before or
10342: after them, though some do.</p>
10343: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10344: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10345: restricts the use of these variables to all the files that have
10346: been included before. Appearances in later files will be
10347: silently ignored.</p>
10348: <p>Then, the files for the main targets are included, in the
10349: order of later execution, though the actual order should not
10350: matter.</p>
10351: <p>At last, some more files are included that don't set any
10352: interesting variables but rather just define make targets to be
10353: executed.</p>
10354: </div>
10355: </div>
1.75 rillig 10356: </div>
1.148 asau 10357: <div class="chapter">
1.75 rillig 10358: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10359: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10360: <div class="toc">
10361: <p><b>Table of Contents</b></p>
10362: <dl>
1.106 rillig 10363: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10364: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10365: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10366: <dd><dl>
1.106 rillig 10367: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10368: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10369: </dl></dd>
10370: </dl>
10371: </div>
10372: <p>The pkgsrc infrastructure consists of a large codebase,
10373: and there are many corners where every little bit of a file is
10374: well thought out, making pkgsrc likely to fail as soon as
10375: anything is changed near those parts. To prevent most changes
10376: from breaking anything, a suite of regression tests should go
10377: along with every important part of the pkgsrc infrastructure.
10378: This chapter describes how regression tests work in pkgsrc and
10379: how you can add new tests.</p>
1.148 asau 10380: <div class="sect1">
1.75 rillig 10381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10382: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10383: <p></p>
10384: </div>
1.148 asau 10385: <div class="sect1">
1.75 rillig 10386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10387: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.189 snj 10388: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110 hubertf 10389: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10390: can simply run that command, which will run all tests in the
1.76 rillig 10391: <code class="filename">regress</code> category.</p>
1.75 rillig 10392: </div>
1.148 asau 10393: <div class="sect1">
1.75 rillig 10394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10395: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10396: <p>Every directory in the <code class="filename">regress</code>
10397: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10398: is considered a regression test. This file is a shell program
1.110 hubertf 10399: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10400: The following functions can be overridden to suit your
10401: needs.</p>
1.148 asau 10402: <div class="sect2">
1.75 rillig 10403: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10404: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10405: <p>These functions do not take any parameters. They are all
1.128 wiz 10406: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10407: to check the exitcodes of any commands you run in the
10408: test.</p>
1.148 asau 10409: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10410: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10411: <dd><p>This function prepares the environment for the
10412: test. By default it does nothing.</p></dd>
10413: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10414: <dd><p>This function runs the actual test. By default,
10415: it calls <code class="varname">TEST_MAKE</code> with the arguments
10416: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10417: error messages into the file
10418: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10419: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10420: <dd><p>This function is run after the test and is
10421: typically used to compare the actual output from the one that is
10422: expected. It can make use of the various helper functions from
10423: the next section.</p></dd>
10424: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10425: <dd><p>This function cleans everything up after the
10426: test has been run. By default it does nothing.</p></dd>
10427: </dl></div>
10428: </div>
1.148 asau 10429: <div class="sect2">
1.75 rillig 10430: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10431: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 asau 10432: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10433: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10434: <dd><p>This function compares the exitcode of the
1.110 hubertf 10435: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10436: If they differ, the test will fail.</p></dd>
10437: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10438: <dd><p>This function checks for each of its parameters
1.110 hubertf 10439: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10440: extended regular expression. If it does not, the test will
10441: fail.</p></dd>
10442: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10443: <dd><p>This function checks for each of its parameters
1.110 hubertf 10444: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10445: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10446: If any of the regular expressions matches, the test will
10447: fail.</p></dd>
10448: </dl></div>
10449: </div>
10450: </div>
10451: </div>
1.148 asau 10452: <div class="chapter">
1.75 rillig 10453: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10454: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10455: <div class="toc">
10456: <p><b>Table of Contents</b></p>
10457: <dl>
1.106 rillig 10458: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10459: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10460: </dl>
10461: </div>
10462: <p>The pkgsrc system has already been ported to many
10463: operating systems, hardware architectures and compilers. This
10464: chapter explains the necessary steps to make pkgsrc even more
10465: portable.</p>
1.148 asau 10466: <div class="sect1">
1.75 rillig 10467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10468: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10469: <p>To port pkgsrc to a new operating system (called
10470: <code class="literal">MyOS</code> in this example), you need to touch the
10471: following files:</p>
1.148 asau 10472: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10473: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10474: <dd><p>This file contains some basic definitions, for
10475: example the name of the C
10476: compiler.</p></dd>
1.76 rillig 10477: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10478: <dd><p>Insert code that defines the variables
10479: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10480: <code class="varname">LOWER_OS_VERSION</code>,
10481: <code class="varname">LOWER_VENDOR</code>,
10482: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10483: <code class="varname">APPEND_ELF</code>, and the other variables that
10484: appear in this file.</p></dd>
1.93 rillig 10485: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10486: <dd><p>This file contains the platform-specific
10487: definitions that are used by pkgsrc. Start by copying one of the
10488: other files and edit it to your
10489: needs.</p></dd>
1.93 rillig 10490: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10491: <dd><p>This file defines the paths to all the tools
10492: that are needed by one or the other package in pkgsrc, as well
10493: as by pkgsrc itself. Find out where these tools are on your
10494: platform and add them.</p></dd>
10495: </dl></div>
10496: <p>Now, you should be able to build some basic packages, like
1.189 snj 10497: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75 rillig 10498: </div>
1.148 asau 10499: <div class="sect1">
1.75 rillig 10500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10501: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10502: <p>TODO</p>
10503: </div>
10504: </div>
10505: </div>
1.148 asau 10506: <div class="appendix">
10507: <div class="titlepage"><div><div><h1 class="title">
10508: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10509: <div class="toc">
10510: <p><b>Table of Contents</b></p>
10511: <dl>
10512: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10513: <dd><dl>
10514: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10515: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10516: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10517: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 10518: </dl></dd>
10519: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10520: </dl>
10521: </div>
10522: <p>We checked to find a piece of software that wasn't in the packages
10523: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10524: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10525: present in the tree is beyond us, but it's useful for the purposes of
10526: this exercise.</p>
1.148 asau 10527: <div class="sect1">
1.75 rillig 10528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10529: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10530: <div class="sect2">
1.75 rillig 10531: <div class="titlepage"><div><div><h3 class="title">
10532: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10533: <pre class="programlisting">
1.100 rillig 10534: # $NetBSD$
10535: #
1.1 grant 10536:
1.100 rillig 10537: DISTNAME= bison-1.25
10538: CATEGORIES= devel
10539: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10540:
1.136 dholland 10541: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10542: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10543: COMMENT= GNU yacc clone
1.1 grant 10544:
1.100 rillig 10545: GNU_CONFIGURE= yes
1.152 wiz 10546: INFO_FILES= yes
1.1 grant 10547:
1.100 rillig 10548: .include "../../mk/bsd.pkg.mk"
1.1 grant 10549: </pre>
1.75 rillig 10550: </div>
1.148 asau 10551: <div class="sect2">
1.75 rillig 10552: <div class="titlepage"><div><div><h3 class="title">
10553: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10554: <pre class="programlisting">
1.100 rillig 10555: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.189 snj 10556: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10557: of the NetBSD source tree is beyond me.
1.1 grant 10558: </pre>
1.75 rillig 10559: </div>
1.148 asau 10560: <div class="sect2">
1.75 rillig 10561: <div class="titlepage"><div><div><h3 class="title">
10562: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10563: <pre class="programlisting">
1.100 rillig 10564: @comment $NetBSD$
10565: bin/bison
10566: man/man1/bison.1.gz
10567: share/bison.simple
10568: share/bison.hairy
1.1 grant 10569: </pre>
1.75 rillig 10570: </div>
1.148 asau 10571: <div class="sect2">
1.75 rillig 10572: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10573: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10574: </h3></div></div></div>
1.75 rillig 10575: <p>The NetBSD package system comes with
1.189 snj 10576: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10577: which helps to check the contents of these
10578: files. After installation it is quite easy to use, just change to the
10579: directory of the package you wish to examine and execute
1.110 hubertf 10580: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10581: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10582: looks fine.</pre>
10583: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10584: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10585: -Wall</strong></span> for a very thorough check.</p>
10586: </div>
10587: </div>
1.148 asau 10588: <div class="sect1">
1.75 rillig 10589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10590: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10591: <p>Create the directory where the package lives,
10592: plus any auxiliary directories:</p>
10593: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10594: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10595: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10596: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10597: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10598: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10599: then continue with fetching the distfile:</p>
10600: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10601: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10602: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10603: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10604: ftp: Error retrieving file: 500 Internal error
10605:
10606: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10607: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10608: ftp: Error retrieving file: 500 Internal error
10609:
10610: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10611: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10612: Successfully retrieved file.</pre>
10613: <p>Generate the checksum of the distfile into
1.76 rillig 10614: <code class="filename">distinfo</code>:</p>
1.88 wiz 10615: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10616: <p>Now compile:</p>
10617: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10618: >> Checksum OK for bison-1.25.tar.gz.
10619: ===> Extracting for bison-1.25
10620: ===> Patching for bison-1.25
10621: ===> Ignoring empty patch directory
10622: ===> Configuring for bison-1.25
10623: creating cache ./config.cache
10624: checking for gcc... cc
10625: checking whether we are using GNU C... yes
10626: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10627: checking how to run the C preprocessor... cc -E
10628: checking for minix/config.h... no
10629: checking for POSIXized ISC... no
10630: checking whether cross-compiling... no
10631: checking for ANSI C header files... yes
10632: checking for string.h... yes
10633: checking for stdlib.h... yes
10634: checking for memory.h... yes
10635: checking for working const... yes
10636: checking for working alloca.h... no
10637: checking for alloca... yes
10638: checking for strerror... yes
10639: updating cache ./config.cache
10640: creating ./config.status
10641: creating Makefile
10642: ===> Building for bison-1.25
10643: 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
10644: 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
10645: 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
10646: 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
10647: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10648: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
1.1 grant 10649: 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
10650: 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
10651: 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
10652: 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
10653: 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
10654: 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
10655: 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
10656: 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
10657: 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
10658: 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
10659: 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
10660: 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
10661: 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
10662: 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
10663: 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
10664: 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
10665: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10666: rm -f bison.s1
1.75 rillig 10667: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10668: <p>Everything seems OK, so install the files:</p>
10669: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10670: >> Checksum OK for bison-1.25.tar.gz.
10671: ===> Installing for bison-1.25
10672: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10673: rm -f /usr/pkg/bin/bison
10674: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10675: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10676: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10677: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10678: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10679: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10680: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10681: ===> Registering installation for bison-1.25</pre>
10682: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10683: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10684: binary package, do this now:</p>
10685: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10686: >> Checksum OK for bison-1.25.tar.gz.
10687: ===> Building package for bison-1.25
10688: Creating package bison-1.25.tgz
10689: Registering depends:.
1.75 rillig 10690: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10691: <p>Now that you don't need the source and object files
10692: any more, clean up:</p>
10693: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10694: ===> Cleaning for bison-1.25</pre>
10695: </div>
10696: </div>
1.148 asau 10697: <div class="appendix">
10698: <div class="titlepage"><div><div><h1 class="title">
10699: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10700: <div class="toc">
10701: <p><b>Table of Contents</b></p>
10702: <dl>
10703: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10704: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10705: </dl>
10706: </div>
1.148 asau 10707: <div class="sect1">
1.75 rillig 10708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10709: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10710: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10711: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10712: => figlet221.tar.gz doesn't seem to exist on this system.
10713: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10714: => [172219 bytes]
10715: Connected to ftp.plig.net.
10716: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10717: 331 Guest login ok, send your complete e-mail address as password.
10718: 230-You are user #5 of 500 simultaneous users allowed.
10719: 230-
1.68 rillig 10720: 230- ___ _ _ _
10721: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10722: 230- | _| _| . |_| . | | | . |_| . | _| . |
10723: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10724: 230- |_| |_| |___| |___|
10725: 230-
10726: 230-** Welcome to ftp.plig.org **
10727: 230-
10728: 230-Please note that all transfers from this FTP site are logged. If you
10729: 230-do not like this, please disconnect now.
10730: 230-
1.120 snj 10731: 230-This archive is available via
1.1 grant 10732: 230-
10733: 230-HTTP: http://ftp.plig.org/
10734: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10735: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10736: 230-
10737: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10738: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10739: 230-
10740: 230-
10741: 230 Logged in anonymously.
10742: Remote system type is UNIX.
10743: Using binary mode to transfer files.
10744: 200 Type okay.
10745: 250 "/pub" is new cwd.
10746: 250-"/pub/figlet" is new cwd.
10747: 250-
10748: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10749: 250-
1.75 rillig 10750: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10751: 250-
10752: 250-The official FIGlet web page is:
1.75 rillig 10753: 250- http://www.figlet.org/
1.1 grant 10754: 250-
10755: 250-If you have questions, please mailto:info@figlet.org. If you want to
10756: 250-contribute a font or something else, you can email us.
1.68 rillig 10757: 250
1.1 grant 10758: 250 "/pub/figlet/program" is new cwd.
10759: 250 "/pub/figlet/program/unix" is new cwd.
10760: local: figlet221.tar.gz remote: figlet221.tar.gz
10761: 502 Unimplemented command.
10762: 227 Entering Passive Mode (195,40,6,41,246,104)
10763: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10764: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10765: 226 Transfer completed.
10766: 172219 bytes received in 00:02 (75.99 KB/s)
10767: 221 Goodbye.
10768: => Checksum OK for figlet221.tar.gz.
10769: ===> Extracting for figlet-2.2.1nb2
10770: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10771: ===> Patching for figlet-2.2.1nb2
10772: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10773: ===> Overriding tools for figlet-2.2.1nb2
10774: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10775: ===> Configuring for figlet-2.2.1nb2
10776: ===> Building for figlet-2.2.1nb2
10777: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10778: chmod a+x figlet
10779: gcc -O2 -o chkfont chkfont.c
10780: => Unwrapping files-to-be-installed.
1.14 xtraeme 10781: <code class="prompt">#</code>
1.75 rillig 10782: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10783: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10784: ===> Installing for figlet-2.2.1nb2
10785: install -d -o root -g wheel -m 755 /usr/pkg/bin
10786: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10787: mkdir -p /usr/pkg/share/figlet
10788: cp figlet /usr/pkg/bin
10789: cp chkfont /usr/pkg/bin
10790: chmod 555 figlist showfigfonts
10791: cp figlist /usr/pkg/bin
10792: cp showfigfonts /usr/pkg/bin
10793: cp fonts/*.flf /usr/pkg/share/figlet
10794: cp fonts/*.flc /usr/pkg/share/figlet
10795: cp figlet.6 /usr/pkg/man/man6
10796: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10797: <code class="prompt">#</code></pre>
10798: </div>
1.148 asau 10799: <div class="sect1">
1.75 rillig 10800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10801: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10802: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10803: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10804: ===> Packaging figlet-2.2.1nb2
10805: ===> Building binary package for figlet-2.2.1nb2
10806: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10807: Using SrcDir value of /usr/pkg
1.68 rillig 10808: Registering depends:.
1.75 rillig 10809: <code class="prompt">#</code></pre>
10810: </div>
10811: </div>
1.148 asau 10812: <div class="appendix">
10813: <div class="titlepage"><div><div><h1 class="title">
10814: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10815: <div class="toc">
10816: <p><b>Table of Contents</b></p>
10817: <dl>
1.128 wiz 10818: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10819: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10820: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10821: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10822: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10823: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10824: source packages</a></span></dt>
10825: </dl>
10826: </div>
10827: <p>As in other big projects, the directory layout of pkgsrc
10828: is quite complex for newbies. This chapter explains where you
10829: find things on the FTP server. The base directory on
1.110 hubertf 10830: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89 rillig 10831: On other servers it may be different, but inside this directory,
10832: everything should look the same, no matter on which server you
10833: are. This directory contains some subdirectories, which are
10834: explained below.</p>
1.148 asau 10835: <div class="sect1">
1.76 rillig 10836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10837: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10838: <p>The directory <code class="filename">distfiles</code> contains lots
10839: of archive files from all pkgsrc packages, which are mirrored
10840: here. The subdirectories are called after their package names
10841: and are used when the distributed files have names that don't
10842: explicitly contain a version number or are otherwise too generic
10843: (for example <code class="filename">release.tar.gz</code>).</p>
10844: </div>
1.148 asau 10845: <div class="sect1">
1.76 rillig 10846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10847: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10848: <p>This directory contains things that individual pkgsrc
10849: developers find worth publishing.</p>
10850: </div>
1.148 asau 10851: <div class="sect1">
1.76 rillig 10852: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10853: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10854: <p>This directory contains binary packages for the various
10855: platforms that are supported by pkgsrc.
10856: Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.148 asau 10857: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10858: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10859: operating system for which the packages have been built. The
1.110 hubertf 10860: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10861: command, so it may differ from the one you are used to
10862: hear.</p></li>
1.128 wiz 10863: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10864: architecture of the platform for which the packages have been
1.110 hubertf 10865: built. It also includes the <code class="varname">ABI</code> (Application
10866: Binary Interface) for platforms that have several of
10867: them.</p></li>
1.128 wiz 10868: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10869: the operating system. For version numbers that change often (for
10870: example NetBSD-current), the often-changing part should be
10871: replaced with an <code class="literal">x</code>, for example
10872: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10873: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10874: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10875: for a stable branch, or <code class="literal">head</code> for packages
10876: built from the HEAD branch. The latter should only be used when
10877: the packages are updated on a regular basis. Otherwise the date
10878: from checking out pkgsrc should be appended, for example
10879: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10880: </ul></div>
10881: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10882: can quickly click through the directories on the
10883: server and find the best binary packages for their machines. Since they
10884: usually know the operating system and the hardware architecture, OPSYS
10885: and ARCH are placed first. After these choices, they can select the
10886: best combination of OSVERSION and TAG together, since it is usually the
10887: case that packages stay compatible between different version of the
10888: operating system.</p>
10889: <p>In each of these directories, there is a
10890: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10891: <code class="filename">All</code> which contains all binary packages.
10892: Besides that, there are various category directories that
10893: contain symbolic links to the real binary packages.</p>
10894: </div>
1.148 asau 10895: <div class="sect1">
1.76 rillig 10896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10897: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10898: <p>Here are the reports from bulk builds, for those who want
10899: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10900: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.108 rillig 10901: </div>
1.148 asau 10902: <div class="sect1">
1.108 rillig 10903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10904: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10905: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10906: source packages</h2></div></div></div>
1.128 wiz 10907: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10908: that is the files that define how to create binary packages from
10909: source archives.</p>
10910: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10911: snapshot of the CVS repository, which is updated regularly. The
10912: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10913: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10914: <p>In the directories for the quarterly branches, there is an
10915: additional file called
1.126 jakllsch 10916: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76 rillig 10917: which contains the state of pkgsrc when it was branched.</p>
10918: </div>
1.75 rillig 10919: </div>
1.148 asau 10920: <div class="appendix">
10921: <div class="titlepage"><div><div><h1 class="title">
10922: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 10923: <div class="toc">
10924: <p><b>Table of Contents</b></p>
10925: <dl>
1.79 rillig 10926: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10927: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10928: </dl>
10929: </div>
1.79 rillig 10930: <p>This section contains information on editing the pkgsrc
10931: guide itself.</p>
1.148 asau 10932: <div class="sect1">
1.75 rillig 10933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10934: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10935: <p>The pkgsrc guide's source code is stored in
10936: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10937: are created from it:</p>
1.148 asau 10938: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10939: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10940: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10941: <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>
10942: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79 rillig 10943: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 10944: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79 rillig 10945: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10946: </ul></div>
10947: </div>
1.148 asau 10948: <div class="sect1">
1.75 rillig 10949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10950: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10951: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 10952: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 10953: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 10954: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 10955: documentation) installed. These are automatically installed when
1.189 snj 10956: you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148 asau 10957: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 10958: right directory. All further steps will take place
10959: here.</p></li>
1.148 asau 10960: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 10961: <code class="filename">files/</code>.</p></li>
1.148 asau 10962: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 10963: guide for valid XML and to build the final output files. If you
10964: get any errors at this stage, you can just edit the files, as
10965: there are only symbolic links in the working directory, pointing
10966: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 10967: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 10968: commit)</strong></span></p></li>
1.148 asau 10969: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 10970: regenerate the output files with the proper RCS
10971: Ids.</p></li>
1.148 asau 10972: <li class="step">
1.110 hubertf 10973: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 10974: commit the files in both <code class="filename">pkgsrc/doc</code> and
10975: <code class="filename">htdocs</code>.</p>
1.148 asau 10976: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 10977: <h3 class="title">Note</h3>
10978: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 10979: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10980: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 10981: directory.</p>
10982: </div>
10983: </li>
1.79 rillig 10984: </ol></div>
1.75 rillig 10985: </div>
10986: </div>
10987: </div></body>
1.1 grant 10988: </html>
CVSweb <webmaster@jp.NetBSD.org>