Annotation of pkgsrc/doc/pkgsrc.html, revision 1.117
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.101 rillig 6: <link rel="stylesheet" href="/global.css" type="text/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>
10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
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.104 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.106 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.76 rillig 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>
67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 70: </dl></dd>
71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
72: <dd><dl>
73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
75: </dl></dd>
76: </dl></dd>
77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
78: <dd><dl>
1.82 rillig 79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
82: <dd><dl>
83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 90: </dl></dd>
91: </dl></dd>
92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
93: <dd><dl>
94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
101: <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>
102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 104: </dl></dd>
105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
106: <dd><dl>
107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
110: </dl></dd>
111: </dl></dd>
112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
113: <dd><dl>
114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 118: <dd><dl>
1.103 wiz 119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116 rillig 120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88 wiz 122: </dl></dd>
1.103 wiz 123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 125: </dl></dd>
126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
127: <dd><dl>
128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
129: <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 130: </dl></dd>
131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
132: builds)</a></span></dt>
1.75 rillig 133: <dd><dl>
1.106 rillig 134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
137: <dd><dl>
138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
146: </dl></dd>
147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 148: <dd><dl>
149: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
150: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
151: </dl></dd>
1.106 rillig 152: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
153: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
154: </dl></dd>
155: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
156: <dd><dl>
1.116 rillig 157: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
158: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.106 rillig 159: </dl></dd>
160: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
161: <dd><dl>
162: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
163: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
164: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
165: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
166: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
167: <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>
168: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116 rillig 169: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106 rillig 170: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116 rillig 171: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
172: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
173: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106 rillig 174: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
175: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
176: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116 rillig 177: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106 rillig 178: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.116 rillig 179: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75 rillig 180: </dl></dd>
181: </dl></dd>
182: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
183: <dd><dl>
1.106 rillig 184: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 185: <dd><dl>
1.106 rillig 186: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 187: <dd><dl>
1.106 rillig 188: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
189: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91 rillig 190: </dl></dd>
1.106 rillig 191: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
192: <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>
193: </dl></dd>
194: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
195: <dd><dl>
1.116 rillig 196: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
197: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106 rillig 198: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
199: <dd><dl>
200: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
201: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
202: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
203: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
204: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
205: </dl></dd>
206: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
207: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
208: <dd><dl>
209: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
210: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
211: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
212: </dl></dd>
1.116 rillig 213: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
214: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106 rillig 215: </dl></dd>
1.116 rillig 216: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106 rillig 217: <dd><dl>
218: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116 rillig 219: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106 rillig 220: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
221: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
222: <dd><dl>
223: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
224: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
225: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
226: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
227: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
228: </dl></dd>
229: </dl></dd>
230: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116 rillig 233: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
234: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106 rillig 235: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
236: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116 rillig 237: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106 rillig 238: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
239: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
240: </dl></dd>
241: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
242: <dd><dl>
243: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116 rillig 244: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106 rillig 245: <dd><dl>
246: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116 rillig 247: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.106 rillig 248: </dl></dd>
1.116 rillig 249: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106 rillig 250: <dd><dl>
1.116 rillig 251: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106 rillig 252: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
253: </dl></dd>
254: </dl></dd>
255: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
256: <dd><dl>
257: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
258: <dd><dl>
259: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
260: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
261: </dl></dd>
262: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
263: <dd><dl>
1.116 rillig 264: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106 rillig 265: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
266: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
267: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
268: </dl></dd>
269: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
270: <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>
271: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
272: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
273: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
274: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
275: <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>
276: </dl></dd>
277: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
278: <dd><dl>
279: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116 rillig 280: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106 rillig 281: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 282: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 283: </dl></dd>
284: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
285: <dd><dl>
286: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
287: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
288: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
289: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116 rillig 290: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106 rillig 291: <dd><dl>
292: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
293: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
294: </dl></dd>
1.116 rillig 295: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
299: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
301: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
302: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
303: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
304: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106 rillig 305: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
306: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
307: </dl></dd>
308: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
309: <dd><dl>
310: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
311: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
312: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
313: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
314: </dl></dd>
315: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
316: <dd><dl>
317: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
318: <dd><dl>
319: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116 rillig 320: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106 rillig 321: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
322: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
323: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
324: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
325: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
326: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
327: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
328: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
329: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
330: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
331: </dl></dd>
1.116 rillig 332: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106 rillig 333: <dd><dl>
334: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
335: <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>
336: </dl></dd>
1.116 rillig 337: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106 rillig 338: <dd><dl>
339: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
340: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
341: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
342: </dl></dd>
343: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
344: <dd><dl>
345: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
346: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
347: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
348: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
349: </dl></dd>
1.116 rillig 350: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106 rillig 351: <dd><dl>
352: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
353: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116 rillig 354: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106 rillig 355: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
356: </dl></dd>
1.116 rillig 357: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106 rillig 358: <dd><dl>
359: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
360: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
361: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
362: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
363: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
364: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
365: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
366: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 367: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106 rillig 368: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
369: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
370: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
371: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
372: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
373: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
374: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
375: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
376: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 377: emulation</a></span></dt>
1.106 rillig 378: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
379: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 380: </dl></dd>
1.106 rillig 381: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 382: </dl></dd>
1.106 rillig 383: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
384: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 385: <dd><dl>
1.106 rillig 386: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
387: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
388: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
389: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
390: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
391: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
392: </dl></dd>
393: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
394: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
395: <dd><dl>
396: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
397: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
398: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
399: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 400: </dl></dd>
1.75 rillig 401: </dl></dd>
402: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
403: <dd><dl>
1.106 rillig 404: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 405: <dd><dl>
1.106 rillig 406: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
407: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
408: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 409: <dd><dl>
1.106 rillig 410: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
411: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 412: </dl></dd>
1.106 rillig 413: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
414: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 415: <dd><dl>
1.106 rillig 416: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
417: <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 418: </dl></dd>
1.106 rillig 419: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 420: <dd><dl>
1.116 rillig 421: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
422: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75 rillig 423: </dl></dd>
424: </dl></dd>
1.106 rillig 425: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 426: <dd><dl>
1.106 rillig 427: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
428: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
429: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 430: <dd><dl>
1.106 rillig 431: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
432: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 433: </dl></dd>
434: </dl></dd>
1.106 rillig 435: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 436: <dd><dl>
1.106 rillig 437: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
438: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 439: </dl></dd>
440: </dl></dd>
441: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
442: <dd><dl>
443: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
444: <dd><dl>
445: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
446: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
447: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.116 rillig 448: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 449: </dl></dd>
450: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
451: </dl></dd>
452: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
453: <dd><dl>
454: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
455: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
456: </dl></dd>
1.76 rillig 457: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
458: <dd><dl>
1.116 rillig 459: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
460: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
461: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
462: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
463: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
464: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
465: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
466: pkgsrc-200xQy:
1.76 rillig 467: source packages</a></span></dt>
468: </dl></dd>
1.75 rillig 469: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
470: <dd><dl>
1.79 rillig 471: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 472: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
473: </dl></dd>
474: </dl>
475: </div>
1.82 rillig 476: <div class="list-of-tables">
477: <p><b>List of Tables</b></p>
478: <dl>
479: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
480: </dt>
1.106 rillig 481: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 482: </dt>
1.106 rillig 483: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 484: </dt>
1.82 rillig 485: </dl>
486: </div>
1.75 rillig 487: <div class="chapter" lang="en">
488: <div class="titlepage"><div><div><h2 class="title">
489: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
490: <div class="toc">
491: <p><b>Table of Contents</b></p>
492: <dl>
493: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 494: <dd><dl>
495: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
496: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
497: </dl></dd>
1.75 rillig 498: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
499: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 500: <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 501: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
502: </dl>
503: </div>
504: <div class="sect1" lang="en">
505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
506: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 507: <p>There is a lot of software freely available for Unix-based
508: systems, which is usually available in form of the source code. Before
509: such software can be used, it needs to be configured to the local
510: system, compiled and installed, and this is exactly what The NetBSD
511: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
512: to handle binary packages, so that not every user has to build the
513: packages for himself, which is a time-costly task.</p>
1.75 rillig 514: <p>pkgsrc currently contains several thousand packages,
515: including:</p>
516: <div class="itemizedlist"><ul type="disc">
1.91 rillig 517: <li><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 518: web server</p></li>
1.91 rillig 519: <li><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 520: web browser</p></li>
1.91 rillig 521: <li><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 522: Desktop Environment</p></li>
1.91 rillig 523: <li><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 524: Desktop Environment</p></li>
525: </ul></div>
526: <p>...just to name a few.</p>
527: <p>pkgsrc has built-in support for handling varying dependencies,
528: such as pthreads and X11, and extended features such as IPv6 support on
529: a range of platforms.</p>
1.82 rillig 530: <div class="sect2" lang="en">
531: <div class="titlepage"><div><div><h3 class="title">
532: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
533: <p>
534: pkgsrc provides the following key features:
535: </p>
536: <div class="itemizedlist"><ul type="disc">
537: <li><p>Easy building of software from source as well as the creation
538: and installation of binary packages. The source and latest
539: patches are retrieved from a master or mirror download site, checksum
540: verified, then built on your system. Support for binary-only
541: distributions is available for both native platforms and NetBSD
542: emulated platforms.</p></li>
543: <li><p>All packages are installed in a consistent directory tree,
544: including binaries, libraries, man pages and other
545: documentation.</p></li>
546: <li><p>Package dependencies, including when performing package updates,
547: are handled automatically. The configuration files of various
548: packages are handled automatically during updates, so local changes
549: are preserved.</p></li>
550: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
551: consists of highly portable code. This allows the greatest speed of
552: development when porting to new a platform. This portability also
553: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
554: platforms</em></span>.</p></li>
555: <li><p>The installation prefix, acceptable software licenses,
556: international encryption requirements and build-time options for a
557: large number of packages are all set in a simple, central
558: configuration file.</p></li>
559: <li><p>The entire source (not including the distribution files) is
560: freely available under a BSD license, so you may extend and adapt
561: pkgsrc to your needs. Support for local packages and patches is
562: available right out of the box, so you can configure it specifically
563: for your environment.</p></li>
564: </ul></div>
1.91 rillig 565: <p>The following principles are basic to pkgsrc:</p>
566: <div class="itemizedlist"><ul type="disc">
567: <li><p>“<span class="quote">It should only work if it's right.</span>”
1.114 jmcneill 568: — That means, if a package contains bugs, it's better to find
1.91 rillig 569: them and to complain about them rather than to just install the package
570: and hope that it works. There are numerous checks in pkgsrc that try to
571: 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
572: of shell scripts), and post-installation checks (installed files,
573: references to shared libraries, script interpreters).</p></li>
574: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
1.114 jmcneill 575: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 576: pkgsrc has been ported to many operating systems. Care is taken that
577: packages behave the same on all platforms.</p></li>
578: </ul></div>
1.82 rillig 579: </div>
580: <div class="sect2" lang="en">
581: <div class="titlepage"><div><div><h3 class="title">
582: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
583: <p>pkgsrc consists of both a source distribution and a binary
584: distribution for these operating systems. After retrieving the required
585: source or binaries, you can be up and running with pkgsrc in just
586: minutes!</p>
1.75 rillig 587: <p>pkgsrc was derived from FreeBSD's ports system, and
588: initially developed for NetBSD only. Since then, pkgsrc has
589: grown a lot, and now supports the following platforms:</p>
1.82 rillig 590: <div class="table">
591: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 592: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 593: <colgroup>
594: <col>
595: <col>
596: </colgroup>
597: <thead><tr>
598: <th>Platform</th>
599: <th>Date Support Added</th>
600: </tr></thead>
601: <tbody>
602: <tr>
1.110 hubertf 603: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 604: <td align="center">Aug 1997</td>
605: </tr>
606: <tr>
1.110 hubertf 607: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 608: <td align="center">Mar 1999</td>
609: </tr>
610: <tr>
1.110 hubertf 611: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 612: <td align="center">Jun 1999</td>
613: </tr>
614: <tr>
615: <td>
1.110 hubertf 616: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
617: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 618: </td>
619: <td align="center">Oct 2001</td>
620: </tr>
621: <tr>
1.110 hubertf 622: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 623: <td align="center">Nov 2002</td>
624: </tr>
625: <tr>
1.110 hubertf 626: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 627: <td align="center">Nov 2002</td>
628: </tr>
629: <tr>
1.110 hubertf 630: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 631: <td align="center">Dec 2002</td>
632: </tr>
633: <tr>
634: <td>BSD/OS</td>
635: <td align="center">Dec 2003</td>
636: </tr>
637: <tr>
1.110 hubertf 638: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 639: <td align="center">Dec 2003</td>
640: </tr>
641: <tr>
642: <td>
1.110 hubertf 643: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 644: (Microsoft Windows Services for Unix)
645: </td>
646: <td align="center">Mar 2004</td>
647: </tr>
648: <tr>
1.110 hubertf 649: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 650: <td align="center">Oct 2004</td>
651: </tr>
652: <tr>
1.110 hubertf 653: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 654: <td align="center">Nov 2004</td>
655: </tr>
1.98 wiz 656: <tr>
1.110 hubertf 657: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 658: <td align="center">Apr 2007</td>
659: </tr>
1.82 rillig 660: </tbody>
1.91 rillig 661: </table></div>
1.82 rillig 662: </div>
1.91 rillig 663: <br class="table-break">
1.82 rillig 664: </div>
1.75 rillig 665: </div>
666: <div class="sect1" lang="en">
667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
668: <a name="overview"></a>1.2. Overview</h2></div></div></div>
669: <p>This document is divided into three parts. The first,
1.110 hubertf 670: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 671: describes how one can use one of the packages in the Package
672: Collection, either by installing a precompiled binary package,
1.93 rillig 673: or by building one's own copy using the NetBSD package system.
1.110 hubertf 674: 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 675: package so it can be easily built by other NetBSD users without
676: knowing about the package's building details. The third part,
1.110 hubertf 677: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 678: is intended for those who want to understand how pkgsrc is
679: implemented.</p>
680: <p>This document is available in various formats:
1.110 hubertf 681: <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 682: </div>
683: <div class="sect1" lang="en">
684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
685: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
686: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
687: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
688: terminology used within this document.</p>
689: <div class="variablelist"><dl>
690: <dt><span class="term">Package</span></dt>
691: <dd><p>A set of files and building instructions
692: that describe what's necessary
693: to build a certain piece of software using
694: pkgsrc. Packages are traditionally stored under
1.76 rillig 695: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 696: <dt><span class="term">The NetBSD package system</span></dt>
1.87 wiz 697: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
698: is part of the NetBSD operating system and can be bootstrapped
699: to run on non-NetBSD operating systems as well. It handles
700: building (compiling), installing, and removing of
701: packages.</p></dd>
1.75 rillig 702: <dt><span class="term">Distfile</span></dt>
703: <dd><p>This term describes the file or files that are
704: provided by the author of the piece of software to
705: distribute his work. All the changes necessary to build on
706: NetBSD are reflected in the corresponding package. Usually
707: the distfile is in the form of a compressed tar-archive,
708: but other types are possible, too. Distfiles are usually
709: stored below
1.76 rillig 710: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 711: <dt><span class="term">Port</span></dt>
712: <dd><p>This is the term used by FreeBSD and OpenBSD people
713: for what we call a package.
714: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
715: architecture.</p></dd>
716: <dt><span class="term">Precompiled/binary package</span></dt>
717: <dd>
718: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 719: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 720: file so it can be installed on machines of the same
721: machine architecture without the need to
722: recompile. Packages are usually generated in
1.76 rillig 723: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110 hubertf 724: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.75 rillig 725: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
726: especially in the context of precompiled packages.</p>
727: </dd>
728: <dt><span class="term">Program</span></dt>
1.88 wiz 729: <dd><p>The piece of software to be installed which will be
730: constructed from all the files in the distfile by the
731: actions defined in the corresponding package.</p></dd>
1.75 rillig 732: </dl></div>
733: <div class="sect2" lang="en">
734: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 735: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 736: <div class="variablelist"><dl>
737: <dt><span class="term">pkgsrc users</span></dt>
738: <dd>
739: <p>The
740: pkgsrc users are people who use the packages provided by pkgsrc.
741: Typically they are system administrators. The people using the
742: software that is inside the packages (maybe called “<span class="quote">end
743: users</span>”) are not covered by the pkgsrc guide.</p>
744: <p>There are two kinds of pkgsrc users: Some only want to
745: install pre-built binary packages. Others build the pkgsrc
746: packages from source, either for installing them directly or for
1.110 hubertf 747: 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 748: documentation.</p>
749: </dd>
750: <dt><span class="term">package maintainers</span></dt>
751: <dd><p>A
1.110 hubertf 752: 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 753: <dt><span class="term">infrastructure developers</span></dt>
754: <dd><p>These people are involved in all those files
1.76 rillig 755: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 756: 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 757: too.</p></dd>
758: </dl></div>
759: </div>
760: </div>
761: <div class="sect1" lang="en">
762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
763: <a name="typography"></a>1.4. Typography</h2></div></div></div>
764: <p>When giving examples for commands, shell prompts are used to
765: show if the command should/can be issued as root, or if
766: “<span class="quote">normal</span>” user privileges are sufficient. We use a
767: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
768: shell prompt, assuming they use the C-shell or tcsh.</p>
769: </div>
770: </div>
771: <div class="part" lang="en">
772: <div class="titlepage"><div><div><h1 class="title">
773: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
774: <div class="toc">
775: <p><b>Table of Contents</b></p>
776: <dl>
777: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
778: <dd><dl>
779: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
780: <dd><dl>
781: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
782: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 783: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 784: </dl></dd>
785: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
786: <dd><dl>
787: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
788: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
789: </dl></dd>
790: </dl></dd>
791: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
792: <dd><dl>
1.82 rillig 793: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
794: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
795: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
796: <dd><dl>
797: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
798: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
799: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
800: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
801: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
802: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
803: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 804: </dl></dd>
805: </dl></dd>
806: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
807: <dd><dl>
808: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
811: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 812: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
813: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
814: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
815: <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>
816: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
817: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 818: </dl></dd>
819: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
820: <dd><dl>
821: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
822: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
823: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
824: </dl></dd>
825: </dl></dd>
826: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
827: <dd><dl>
828: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
829: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 830: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 831: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 832: <dd><dl>
1.103 wiz 833: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116 rillig 834: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
835: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88 wiz 836: </dl></dd>
1.103 wiz 837: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
838: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 839: </dl></dd>
840: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
841: <dd><dl>
842: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
843: <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 844: </dl></dd>
845: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
846: builds)</a></span></dt>
1.75 rillig 847: <dd><dl>
1.106 rillig 848: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
849: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
850: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
851: <dd><dl>
852: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
853: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
854: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
855: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
856: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
857: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
858: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
859: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
860: </dl></dd>
861: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 862: <dd><dl>
863: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
864: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
865: </dl></dd>
1.106 rillig 866: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
867: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
868: </dl></dd>
869: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
870: <dd><dl>
1.116 rillig 871: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
872: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.106 rillig 873: </dl></dd>
874: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
875: <dd><dl>
876: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
877: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
878: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
879: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
880: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
881: <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>
882: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116 rillig 883: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106 rillig 884: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116 rillig 885: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
886: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
887: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106 rillig 888: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
889: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
890: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116 rillig 891: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106 rillig 892: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.116 rillig 893: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75 rillig 894: </dl></dd>
895: </dl>
896: </div>
897: <div class="chapter" lang="en">
898: <div class="titlepage"><div><div><h2 class="title">
899: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
900: <div class="toc">
901: <p><b>Table of Contents</b></p>
902: <dl>
903: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
904: <dd><dl>
905: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
906: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 907: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 908: </dl></dd>
909: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
910: <dd><dl>
911: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
912: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
913: </dl></dd>
914: </dl>
915: </div>
1.91 rillig 916: <p>Before you download and extract the files, you need to decide
917: where you want to extract them. When using pkgsrc as root user, pkgsrc
918: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
919: free to install the sources and binary packages wherever you want in
920: your filesystem, provided that the pathname does not contain white-space
921: or other characters that are interpreted specially by the shell and some
922: other programs. A safe bet is to use only letters, digits, underscores
923: and dashes.</p>
1.75 rillig 924: <div class="sect1" lang="en">
925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
926: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
927: <p>Before you download any pkgsrc files, you should decide
928: whether you want the <span class="emphasis"><em>current</em></span> branch or the
929: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
930: quarterly basis from the current branch and only gets modified
931: for security updates. The names of the stable branches are built
932: from the year and the quarter, for example
1.112 weinem 933: <code class="literal">2007Q4</code>.</p>
1.75 rillig 934: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
935: want to download pkgsrc. You can get it as a tar file, via SUP,
936: or via CVS. All three ways are described here.</p>
937: <div class="sect2" lang="en">
938: <div class="titlepage"><div><div><h3 class="title">
939: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
940: <p>The primary download location for all pkgsrc files is
1.110 hubertf 941: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.75 rillig 942: number of subdirectories for different purposes, which are
1.110 hubertf 943: 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>
1.75 rillig 944: <p>The tar file for the current branch is in the directory
1.110 hubertf 945: <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75 rillig 946: It is autogenerated daily.</p>
1.112 weinem 947: <p>The tar file for the stable branch 2007Q4 is in the
948: directory <code class="filename">pkgsrc-2007Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q4/pkgsrc-2007Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q4.tar.gz</code></a>.</p>
949: <p>To download a pkgsrc stable tarball, run:</p>
950: <pre class="screen">
951: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-200xQy</code></em>/<em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz</code></strong></pre>
952: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the
953: stable branch to be downloaded, for example,
954: “<span class="quote">pkgsrc-2007Q4</span>”.</p>
955: <p>Then, extract it with:</p>
956: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz -C /usr</code></strong></pre>
957: <p>This will create the directory <code class="filename">pkgsrc/</code>
958: in <code class="filename">/usr/</code> and all the package source will be
959: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
960: <p>To download pkgsrc-current, run:</p>
961: <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 962: </div>
963: <div class="sect2" lang="en">
964: <div class="titlepage"><div><div><h3 class="title">
965: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
966: <p>As an alternative to the tar file, you can get pkgsrc via
967: the Software Update Protocol, SUP. To do so, make sure your
968: supfile has a line
1.1 grant 969:
1.75 rillig 970: </p>
971: <pre class="programlisting">
1.100 rillig 972: release=pkgsrc
1.1 grant 973: </pre>
1.75 rillig 974: <p>
1.1 grant 975:
1.75 rillig 976: in it, see the examples in
1.76 rillig 977: <code class="filename">/usr/share/examples/supfiles</code>, and that the
978: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.113 weinem 979: run:</p>
980: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>sup -v <em class="replaceable"><code>/path/to/your/supfile</code></em></code></strong>.</pre>
1.75 rillig 981: </div>
982: <div class="sect2" lang="en">
983: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 984: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.112 weinem 985: <p>To do an initial (full) checkout of pkgsrc, you first
1.75 rillig 986: have to set some environment variables. For the C-Shell,
987: type:</p>
1.113 weinem 988: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
989: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
1.75 rillig 990: </pre>
991: <p>Or, the same for the bourne shell:</p>
1.113 weinem 992: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
993: <code class="prompt">$</code> <strong class="userinput"><code>export CVS_RSH="ssh"</code></strong>
1.75 rillig 994: </pre>
1.113 weinem 995: <p>By default, CVS doesn't do things like most people would
1.112 weinem 996: expect it to do. But there is a
1.113 weinem 997: way to convince CVS, by creating a file called
1.101 rillig 998: <code class="filename">.cvsrc</code> in your home directory and saving
999: the following lines to it. This file will save you lots of
1000: headache and some bug reports, so we strongly recommend it. You
1001: can find an explanation of this file in the CVS
1002: documentation.</p>
1003: <pre class="programlisting">
1004: # recommended CVS configuration file from the pkgsrc guide
1005: checkout -P
1.103 wiz 1006: update -dP
1.101 rillig 1007: release -d
1.103 wiz 1008: diff -upN
1.101 rillig 1009: cvs -q -z3
1010: rdiff -u
1011: </pre>
1.112 weinem 1012: <p>To fetch a specific pkgsrc stable branch from scratch, run:</p>
1013: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113 weinem 1014: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r <em class="replaceable"><code>pkgsrc-200xQy</code></em> -P pkgsrc</code></strong></pre>
1.112 weinem 1015: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the stable
1016: branch to be checked out, for example, “<span class="quote">pkgsrc-2007Q4</span>”</p>
1017: <p>This will create the directory <code class="filename">pkgsrc/</code>
1018: in your <code class="filename">/usr/</code> directory and all the package source
1019: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1020: <p>To fetch the pkgsrc current branch, run:</p>
1021: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113 weinem 1022: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -P pkgsrc</code></strong></pre>
1.75 rillig 1023: </div>
1024: </div>
1025: <div class="sect1" lang="en">
1026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1027: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1028: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1029: (which also works if you have first installed it via a tar
1030: file). It saves bandwidth and hard disk activity, compared to
1031: downloading the tar file again.</p>
1032: <div class="sect2" lang="en">
1033: <div class="titlepage"><div><div><h3 class="title">
1034: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1035: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1036: <h3 class="title">Warning</h3>
1.77 rillig 1037: <p>When updating from a tar file, you first need to
1038: completely remove the old pkgsrc directory. Otherwise those
1039: files that have been removed from pkgsrc in the mean time will
1040: not be removed on your local disk, resulting in inconsistencies.
1041: When removing the old files, any changes that you have done to
1042: the pkgsrc files will be lost after updating. Therefore updating
1043: via CVS is strongly recommended.</p>
1.75 rillig 1044: </div>
1.82 rillig 1045: <p>Note that by default the distfiles and the binary packages
1046: are saved in the pkgsrc tree, so don't forget to rescue them
1047: before updating. You can also configure pkgsrc to use other than
1048: the default directories by setting the
1049: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1050: 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 1051: <p>To update pkgsrc from a tar file, download the tar file as
1052: explained above. Then, make sure that you have not made any
1053: changes to the files in the pkgsrc directory. Remove the pkgsrc
1054: directory and extract the new tar file. Done.</p>
1055: </div>
1056: <div class="sect2" lang="en">
1057: <div class="titlepage"><div><div><h3 class="title">
1058: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1059: <p>To update pkgsrc via CVS, make sure the environment
1060: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.113 weinem 1061: change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1062: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
1063: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.75 rillig 1064: <div class="sect3" lang="en">
1065: <div class="titlepage"><div><div><h4 class="title">
1066: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1067: <p>When updating pkgsrc, the CVS program keeps track of the
1068: branch you selected. But if you, for whatever reason, want to
1069: switch from the stable branch to the current one, you can do it
1070: by adding the option “<span class="quote">-A</span>” after the
1071: “<span class="quote">update</span>” keyword. To switch from the current branch
1072: back to the stable branch, add the
1.113 weinem 1073: “<span class="quote">-rpkgsrc-2007Q4</span>” option.</p>
1.75 rillig 1074: </div>
1075: <div class="sect3" lang="en">
1076: <div class="titlepage"><div><div><h4 class="title">
1077: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1078: <p>When you update pkgsrc, the CVS program will only touch
1079: those files that are registered in the CVS repository. That
1080: means that any packages that you created on your own will stay
1081: unmodified. If you change files that are managed by CVS, later
1082: updates will try to merge your changes with those that have been
1083: done by others. See the CVS manual, chapter
1084: “<span class="quote">update</span>” for details.</p>
1085: </div>
1086: </div>
1087: </div>
1088: </div>
1089: <div class="chapter" lang="en">
1090: <div class="titlepage"><div><div><h2 class="title">
1091: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1092: <div class="toc">
1093: <p><b>Table of Contents</b></p>
1094: <dl>
1.82 rillig 1095: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1096: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1097: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1098: <dd><dl>
1099: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1100: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1101: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1102: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1103: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1104: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1105: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1106: </dl></dd>
1107: </dl>
1108: </div>
1109: <div class="sect1" lang="en">
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>
1114: <div class="sect1" lang="en">
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>
1117: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1118: <pre class="screen">
1119: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1120: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1121: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1122: </pre>
1.110 hubertf 1123: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.87 wiz 1124: pkgsrc before bootstrapping. The given
1.110 hubertf 1125: <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87 wiz 1126: <code class="filename">/usr/pkg</code> for the
1127: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1128: and <code class="filename">/var/db/pkg</code> for the package database
1129: directory where pkgsrc will do its internal bookkeeping.
1130: However, these can also be set using command-line
1131: arguments.</p>
1.75 rillig 1132: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1133: <h3 class="title">Note</h3>
1.110 hubertf 1134: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1135: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1136: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.87 wiz 1137: instead of “<span class="quote">make</span>”.</p>
1.75 rillig 1138: </div>
1139: </div>
1140: <div class="sect1" lang="en">
1141: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1142: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1143: <p>Here are some platform-specific notes you should be aware of.</p>
1144: <div class="sect2" lang="en">
1145: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1146: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85 jmmv 1147: <p>Darwin 5.x and up are supported. There are two methods of using
1.110 hubertf 1148: pkgsrc on Mac OS X, by using a <a class="link" href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1149: image</a>, or a <a class="link" href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75 rillig 1150: partition</a>.</p>
1151: <p>Before you start, you will need to download and install the Mac OS X Developer
1.110 hubertf 1152: Tools from Apple's Developer Connection. See <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.87 wiz 1153: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1.110 hubertf 1154: from <a class="ulink" href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1.87 wiz 1155: if you intend to build packages that use the X11 Window System.</p>
1.89 rillig 1156: <p>If you already have a UFS or HFSX partition, or have a spare partition
1157: that you can format as UFS or HFSX, it is recommended to use that instead of
1.87 wiz 1158: the disk image. It'll be somewhat faster and will mount automatically
1159: at boot time, where you must manually mount a disk image.</p>
1.75 rillig 1160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1161: <h3 class="title">Note</h3>
1.85 jmmv 1162: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89 rillig 1163: requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1.75 rillig 1164: </div>
1165: <div class="sect3" lang="en">
1166: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1167: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75 rillig 1168: <p>Create the disk image:</p>
1169: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95 tron 1170: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85 jmmv 1171: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75 rillig 1172: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85 jmmv 1173: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1174: <h3 class="title">Note</h3>
1.109 rillig 1175: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid. In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page. In the case of HFSX, it will disable journaling.</p>
1.85 jmmv 1176: </div>
1.89 rillig 1177: <p>Allow suid:</p>
1178: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.105 weinem 1179: <p>Changing the build directory:</p>
1180: <p>After bootstrapping you need to change the default package build directory to somewhere outside the disk image so it doesn't get filled up in the process of building packages. Add something like that to <code class="filename">mk.conf</code>.</p>
1181: <pre class="programlisting">
1182: WRKOBJDIR?= /tmp/pkgsrc # build here instead of in pkgsrc
1183: </pre>
1.75 rillig 1184: </div>
1185: <div class="sect3" lang="en">
1186: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1187: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1188: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1189: system, normally HFS+. It is possible to use the default
1190: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1191: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1192: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1193: place the package database directory outside the
1194: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1195: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1196: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1197: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1198: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1199: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1200: to ensure that the partition map correctly reflects
1.89 rillig 1201: “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
1.75 rillig 1202: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1203: disk that is booted from. You can unmount the partition, but even if
1204: you newfs it, the partition type will be incorrect and the
1205: automounter won't mount it. It can be mounted manually, but it won't
1206: appear in Finder.</p>
1.75 rillig 1207: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1208: the Installation program starts, go up to the menu and select Disk
1209: Utility. Now, you will be able to select the partition you want
1.89 rillig 1210: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1211: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1212: will appear in Finder.</p>
1.75 rillig 1213: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1214: by root only.</p>
1.75 rillig 1215: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1216: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1217: </div>
1218: </div>
1219: <div class="sect2" lang="en">
1220: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1221: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1222: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1223: other versions may work.</p>
1.75 rillig 1224: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1225: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1226: <div class="orderedlist"><ol type="1">
1227: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1228: <code class="filename">/var/db/pkg</code>. It is therefore
1229: recommended that you choose a different location (e.g.
1230: <code class="filename">/usr/pkgdb</code>) by
1231: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1232: <li>
1233: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1234: good idea to move them out of the way to avoid confusion, e.g.</p>
1235: <pre class="screen">
1236: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1237: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1238: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1239: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1240: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1241: </pre>
1.75 rillig 1242: </li>
1.110 hubertf 1243: <li><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1244: <code class="filename">/etc/mk.conf.example</code> file
1245: when you use the bootstrap script.</p></li>
1.75 rillig 1246: </ol></div>
1247: </div>
1248: <div class="sect2" lang="en">
1249: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1250: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1251: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1252: providing a Unix-like environment with a tighter kernel integration than
1253: available with Cygwin. It is part of the Windows Services for Unix
1254: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1255: (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 1256: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1257: are not officially supported. (The main difference in 3.0/3.1 is lack
1258: of pthreads, but other parts of libc may also be lacking.)</p>
1259: <p>Services for Unix Applications (aka SUA) is an integrated component
1260: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1.95 tron 1261: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75 rillig 1262: <div class="sect3" lang="en">
1263: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1264: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1265: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1266: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1267: <div class="itemizedlist"><ul type="disc">
1268: <li><p>Utilities -> Base Utilities</p></li>
1269: <li><p>Interix GNU Components -> (all)</p></li>
1270: <li><p>Remote Connectivity</p></li>
1271: <li><p>Interix SDK</p></li>
1272: </ul></div>
1273: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1274: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1275: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1276: pkgsrc (or from a binary package).</p>
1.75 rillig 1277: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1278: not need to be installed, but Remote Connectivity itself should be
1279: installed in order to have a working inetd.</p>
1.75 rillig 1280: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1281: behavior for Interix programs, and whether to make pathnames default to
1282: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1283: enabled. (Without case-sensitivity, a large number of packages including
1284: perl will not build.)</p>
1.75 rillig 1285: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1286: works (via the Data Execution Prevention feature). In order to use
1287: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1288: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1289: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1290: support contract; however, Debian Interix Port has made most Interix
1291: 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 1292: <p>In addition to the hotfix noted above, it may be necessary to
1293: disable Data Execution Prevention entirely to make Interix functional.
1294: This may happen only with certain types of CPUs; the cause is not fully
1295: understood at this time. If gcc or other applications still segfault
1296: repeatedly after installing one of the hotfixes note above, the
1297: following option can be added to the appropriate "boot.ini" line on the
1298: Windows boot drive: /NoExecute=AlwaysOff
1299: (WARNING, this will disable DEP completely, which may be a security
1300: risk if applications are often run as a user in the Administrators
1301: group!)</p>
1.75 rillig 1302: </div>
1303: <div class="sect3" lang="en">
1304: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1305: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75 rillig 1306: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1307: with pkgsrc, note the following things.</p>
1.75 rillig 1308: <div class="itemizedlist"><ul type="disc">
1309: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1310: Windows Services for UNIX, then click Change. In the installer, choose
1311: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1312: <li>
1313: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1314: change the following registry key:</p>
1.75 rillig 1315: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1316: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1317: </li>
1318: <li>
1319: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1320: following registry key:</p>
1.75 rillig 1321: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1322: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1323: </li>
1324: </ul></div>
1325: </div>
1326: <div class="sect3" lang="en">
1327: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1328: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1329: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1330: running "pkg_add") must be a member of the local Administrators
1331: group. Such a user must also be used to run the bootstrap. This is
1332: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1333: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1334: automatically complain if this is not the case. This ensures that
1335: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1336: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1337: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1338: NOT be used in conjunction with pkgsrc. If you choose to use them at
1339: the same time as the pkgsrc packages, ensure that you use the proper
1340: pkg_* tools for each type of binary package.</p>
1.75 rillig 1341: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1342: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1343: don't have a termcap/terminfo entry for it, but the following .termcap
1344: entry provides adequate emulation in most cases:</p>
1.75 rillig 1345: <pre class="programlisting">
1.100 rillig 1346: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1347: </pre>
1.75 rillig 1348: </div>
1349: <div class="sect3" lang="en">
1350: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1351: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1352: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1353: for a full Unix-like platform, it has some drawbacks that should
1354: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1355: <div class="itemizedlist"><ul type="disc">
1356: <li>
1357: <p><span class="strong"><strong>X11:</strong></span></p>
1358: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1359: and can run X11 based applications, but it does
1360: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1361: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1362: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1363: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1364: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1365: and the free X11 server included with
1.110 hubertf 1366: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1367: </li>
1368: <li>
1369: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1370: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1371: Win32 applications, it does not currently support various X11
1372: protocol extensions for acceleration (such as MIT-SHM or DGA).
1373: Most interactive applications to a local X server will run
1374: reasonably fast, but full motion video and other graphics
1375: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1376: </li>
1377: <li>
1378: <p><span class="strong"><strong>Audio:</strong></span></p>
1379: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1380: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1381: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1382: <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 1383: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1384: server component. To output audio via an Interix host, the
1.91 rillig 1385: <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 1386: must also be installed.</p>
1.75 rillig 1387: </li>
1388: <li>
1389: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1390: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1391: is not currently possible to access CD/DVD drives, USB devices,
1392: or SCSI devices through non-filesystem means. Among other things,
1393: this makes it impossible to use Interix directly for CD/DVD
1394: burning.</p>
1.75 rillig 1395: </li>
1396: <li>
1397: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1398: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1399: drives are also not directly accessible in Interix. However,
1400: support is in work to make tape drive access possible by using
1401: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1402: esound server).</p>
1.75 rillig 1403: </li>
1404: </ul></div>
1405: </div>
1406: <div class="sect3" lang="en">
1407: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1408: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1409: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1410: Windows system; any member of the local Administrators group will
1411: suffice. However, some packages currently assume that the user
1412: named "root" is the privileged user. To accommodate these, you
1413: may create such a user; make sure it is in the local group
1414: Administrators (or your language equivalent).</p>
1.110 hubertf 1415: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1416: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1417: time being, install packages as the local Administrator (or
1418: your language equivalent), or run the following command after
1419: installing a package to work around the issue:</p>
1.75 rillig 1420: <pre class="screen">
1.87 wiz 1421: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1422: </pre>
1.75 rillig 1423: </div>
1424: </div>
1425: <div class="sect2" lang="en">
1426: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1427: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1428: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1429: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1430: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1431: 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 1432: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110 hubertf 1433: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><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-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87 wiz 1434: etc.</p>
1.86 schwarz 1435: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1436: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1437: you start out using "abi=n32", that's what all your packages will be built
1438: with.</p>
1439: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1440: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1441: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1442: try to link n32 object files with lib64 or vice versa. Check your
1443: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1444: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1445: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1446: as it appears that IRIX linker occasionally runs into issues when trying to
1447: link over a network-mounted file system.</p>
1.75 rillig 1448: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1449: as imake(1), but you may want to set some options depending on your local
1450: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1451: course, your compiler's man pages for details.</p>
1.75 rillig 1452: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1453:
1.87 wiz 1454: </p>
1.75 rillig 1455: <pre class="programlisting">
1.100 rillig 1456: PKGSRC_COMPILER= mipspro
1.87 wiz 1457: </pre>
1.75 rillig 1458: <p>
1.1 grant 1459:
1.110 hubertf 1460: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1461: are using gcc and may end up passing invalid flags to the compiler. Note that
1462: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1463: default.</p>
1.75 rillig 1464: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1465: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1466: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1467: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1468: '--preserve-path' flag.</p>
1.75 rillig 1469: </div>
1470: <div class="sect2" lang="en">
1471: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1472: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1473: <p>Some versions of Linux (for example Debian GNU/Linux) need
1474: either libtermcap or libcurses (libncurses). Installing the
1475: distributions libncurses-dev package (or equivalent) should fix
1476: the problem.</p>
1477: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1478: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1479: i386 have been tested.</p>
1.75 rillig 1480: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1481: directory:</p>
1.75 rillig 1482: <pre class="programlisting">
1.100 rillig 1483: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1484: ac_cv___attribute__=yes ./bootstrap
1.87 wiz 1485: </pre>
1.75 rillig 1486: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1487: <h3 class="title">Note</h3>
1488: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1489: </div>
1490: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1491: function, which icc does not support. #undef'ing __attribute__ has the
1492: unfortunate side-effect of breaking many of the Linux header files, which
1493: cannot be compiled properly without __attribute__. The test must be
1494: overridden so that __attribute__ is assumed supported by the
1495: compiler.</p>
1.75 rillig 1496: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110 hubertf 1497: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1498: <pre class="programlisting">
1.100 rillig 1499: PKGSRC_COMPILER= icc
1.87 wiz 1500: </pre>
1.75 rillig 1501: <p>The default installation directory for icc is
1.87 wiz 1502: <code class="filename">/opt/intel_cc_80</code>, which
1503: is also the pkgsrc default. If you have installed it into a different
1504: directory, set <code class="varname">ICCBASE</code> in
1.110 hubertf 1505: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1506: <pre class="programlisting">
1.100 rillig 1507: ICCBASE= /opt/icc
1.87 wiz 1508: </pre>
1.75 rillig 1509: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1510: provided by icc, so binaries can be run on other systems which do not
1511: have the shared libraries installed.</p>
1512: <p>Libtool, however, extracts a list of libraries from the
1.110 hubertf 1513: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87 wiz 1514: records it, throwing away the -Bstatic and -Bdynamic options
1515: interspersed between the libraries. This means that
1516: libtool-linked C++ shared libraries will have a runtime
1517: dependency on the icc libraries until this is fixed in
1518: libtool.</p>
1.75 rillig 1519: </div>
1520: <div class="sect2" lang="en">
1521: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1522: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1523: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1524: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1525: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1526: <div class="orderedlist"><ol type="1">
1527: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1528: <code class="filename">/var/db/pkg</code>. It is therefore
1529: recommended that you choose a different location (e.g.
1530: <code class="filename">/usr/pkgdb</code>) by
1531: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1532: <li>
1533: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1534: good idea to move them out of the way to avoid confusion, e.g.</p>
1535: <pre class="screen">
1536: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1537: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1538: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1539: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1540: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1541: </pre>
1.75 rillig 1542: </li>
1543: <li>
1.110 hubertf 1544: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1545: <code class="filename">/etc/mk.conf.example</code> file
1546: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1547: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1548: as well. You can work around this by enclosing all the pkgsrc-specific parts
1549: of the file with:</p>
1550: <pre class="programlisting">
1.100 rillig 1551: .ifdef BSD_PKG_MK
1552: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1553: .else
1554: # OpenBSD stuff
1555: .endif
1.87 wiz 1556: </pre>
1.75 rillig 1557: </li>
1558: </ol></div>
1559: </div>
1560: <div class="sect2" lang="en">
1561: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1562: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1563: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1564: You will need a working C compiler. Both gcc 2.95.3 and
1565: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1566: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1567: process and to build packages.</p>
1.75 rillig 1568: <div class="itemizedlist"><ul type="disc">
1569: <li><p>SUNWsprot</p></li>
1570: <li><p>SUNWarc</p></li>
1571: <li><p>SUNWbtool</p></li>
1572: <li><p>SUNWtoo</p></li>
1573: <li><p>SUNWlibm</p></li>
1574: </ul></div>
1.78 rillig 1575: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1576: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1577: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1578: your $prefix are in your <code class="varname">PATH</code>. This includes
1579: <code class="filename">/usr/ccs/{bin,lib}</code>
1580: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1581: <div class="sect3" lang="en">
1582: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1583: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1584: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1585: for building all packages.</p>
1.75 rillig 1586: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1587: then either build gcc from
1.91 rillig 1588: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1.87 wiz 1589: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1590: <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 1591: </div>
1592: <div class="sect3" lang="en">
1593: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1594: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1595: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1596: 5.0)</p>
1.75 rillig 1597: <div class="itemizedlist"><ul type="disc">
1598: <li><p>SPROcc
1.87 wiz 1599: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1600: <li><p>SPROcpl
1.87 wiz 1601: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1602: <li><p>SPROild
1.87 wiz 1603: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1604: <li><p>SPROlang
1.87 wiz 1605: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1606: </ul></div>
1.96 rillig 1607: <p>You should set the following variables in your
1.110 hubertf 1608: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1609: <pre class="programlisting">
1.100 rillig 1610: CC= cc
1611: CXX= CC
1612: CPP= cc -E
1613: CXXCPP= CC -E
1.96 rillig 1614: </pre>
1615: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1616: <h3 class="title">Note</h3>
1617: <p>The <code class="varname">CPP</code> setting might break some
1618: packages that use the C preprocessor for processing things other
1619: than C source code.</p>
1620: </div>
1.75 rillig 1621: </div>
1622: <div class="sect3" lang="en">
1623: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1624: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1625: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1626: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1627: <pre class="programlisting">
1.100 rillig 1628: PKGSRC_COMPILER= sunpro
1629: ABI= 64
1.96 rillig 1630: </pre>
1631: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1632: <h3 class="title">Note</h3>
1633: <p>This setting has been tested for the SPARC
1634: architecture. Intel and AMD machines need some more
1635: work.</p>
1636: </div>
1.75 rillig 1637: </div>
1638: <div class="sect3" lang="en">
1639: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1640: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110 hubertf 1641: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1642: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1643: The workaround is to use another shell for the configure
1.91 rillig 1644: 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 1645: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1646: <pre class="programlisting">
1.100 rillig 1647: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1648: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1649: </pre>
1.91 rillig 1650: <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 1651: </div>
1652: </div>
1653: </div>
1654: </div>
1655: <div class="chapter" lang="en">
1656: <div class="titlepage"><div><div><h2 class="title">
1657: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1658: <div class="toc">
1659: <p><b>Table of Contents</b></p>
1660: <dl>
1661: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1662: <dd><dl>
1663: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1664: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1665: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1666: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1667: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1668: <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>
1669: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1670: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1671: </dl></dd>
1672: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1673: <dd><dl>
1674: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1675: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1676: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1677: </dl></dd>
1678: </dl>
1679: </div>
1680: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1681: is to only install the package tools and to use binary packages
1682: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1683: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1684: of pkgsrc, too. Then you are able to build your own packages,
1685: and you can still use binary packages from someone else.</p>
1.75 rillig 1686: <div class="sect1" lang="en">
1687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1688: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1689: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1690: server and its mirrors, there are collections of binary packages,
1691: ready to be installed. These binary packages have been built using the
1692: default settings for the directories, that is:</p>
1693: <div class="itemizedlist"><ul type="disc">
1694: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1695: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1696: <li><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1697: </ul></div>
1698: <p>If you cannot use these directories for whatever reasons (maybe
1699: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1700: 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.75 rillig 1701: <div class="sect2" lang="en">
1702: <div class="titlepage"><div><div><h3 class="title">
1703: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1704: <p>To install binary packages, you first need to know from where
1705: to get them. The first place where you should look is on the main
1.110 hubertf 1706: 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 1707: <p>This directory contains binary packages for multiple
1708: platforms. First, select your operating system. (Ignore the
1709: directories with version numbers attached to it, they just exist for
1710: legacy reasons.) Then, select your hardware architecture, and in the
1.109 rillig 1711: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.</p>
1712: <p>In this directory, you often find a file called
1713: <code class="filename">bootstrap.tar.gz</code> which contains the package
1714: management tools. If the file is missing, it is likely that your
1715: operating system already provides those tools. Download the file and
1716: extract it in the <code class="filename">/</code> directory. It will create
1717: the directories <code class="filename">/usr/pkg</code> (containing the tools
1718: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1719: (the database of installed packages).</p>
1.75 rillig 1720: </div>
1721: <div class="sect2" lang="en">
1722: <div class="titlepage"><div><div><h3 class="title">
1723: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1724: <p>In the directory from the last section, there is a
1725: subdirectory called <code class="filename">All</code>, which contains all the
1726: binary packages that are available for the platform, excluding those
1727: that may not be distributed via FTP or CDROM (depending on which
1728: medium you are using), and the ones that have vulnerabilities and
1729: therefore are considered insecure to install without thinking
1730: before.</p>
1731: <p>To install packages directly from an FTP or HTTP server, run
1732: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1733: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1734: <pre class="screen">
1735: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1736: <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>
1737: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1738: </pre>
1739: <p>Instead of URLs, you can also use local paths, for example if
1740: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1741: repository. If you want to install packages from multiple sources,
1742: you can separate them by a semicolon in
1743: <code class="varname">PKG_PATH</code>.</p>
1744: <p>After these preparations, installing a package is very
1745: easy:</p>
1746: <pre class="screen">
1747: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1748: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1749: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1750: </pre>
1.75 rillig 1751: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1752: package in question will be installed, too, assuming they are
1753: present where you install from.</p>
1.109 rillig 1754: <p>As mentioned above, packages for which vulnerabilities get
1755: known are not stored in the <code class="filename">All</code> subdirectory.
1756: They don't get deleted since that could be very frustrating if many
1757: other packages depend on it. Instead, they are moved to the
1758: <code class="filename">vulnerable</code> subdirectory. So you may need to add
1759: this directory to the <code class="varname">PKG_PATH</code> variable.
1.114 jmcneill 1760: However, you should run <span class="command"><strong>audit-packages</strong></span>
1761: regularly, especially after installing new packages, and verify
1762: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1763: <p>After you've installed packages, be sure to have
1.88 wiz 1764: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1765: <code class="varname">PATH</code> so you can actually start the just
1766: installed program.</p>
1.75 rillig 1767: </div>
1768: <div class="sect2" lang="en">
1769: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1770: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1771: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1772: installed from source code or from a binary package. The
1.110 hubertf 1773: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1774: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1775: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1776: name can be given with or without version number. Wildcards can
1777: also be used to deinstall a set of packages, for example
1778: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1779: so that the shell does not expand them before
1780: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1781: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1782: removes all the packages that require the package in question
1783: and then removes the package itself. For example:
1.82 rillig 1784:
1.88 wiz 1785: </p>
1.82 rillig 1786: <pre class="screen">
1.88 wiz 1787: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1788: </pre>
1.82 rillig 1789: <p>
1790:
1.88 wiz 1791: will remove jpeg and all the packages that used it; this allows
1792: upgrading the jpeg package.</p>
1.82 rillig 1793: </div>
1794: <div class="sect2" lang="en">
1795: <div class="titlepage"><div><div><h3 class="title">
1796: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1797: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1798: installed packages or binary package files.</p>
1.82 rillig 1799: </div>
1800: <div class="sect2" lang="en">
1801: <div class="titlepage"><div><div><h3 class="title">
1802: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1803: <p>
1.88 wiz 1804: The NetBSD Security-Officer and Packages Groups maintain a list of
1805: known security vulnerabilities to packages which are (or have been)
1806: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1807: 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 1808: </p>
1.82 rillig 1809: <p>
1.93 rillig 1810: Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1.88 wiz 1811: this list can be downloaded
1812: automatically, and a security audit of all packages installed on a system
1813: can take place.
1814: </p>
1.82 rillig 1815: <p>
1.93 rillig 1816: There are two components to
1.91 rillig 1817: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>. The first
1.88 wiz 1818: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
1819: the list of vulnerabilities from the NetBSD FTP site. The second
1820: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
1821: installed packages are vulnerable. If a package is vulnerable, you
1822: will see output similar to the following:
1823: </p>
1.82 rillig 1824: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1825: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1826: <p>
1.91 rillig 1827: One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.110 hubertf 1828: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.88 wiz 1829: file daily, and include a package audit in the daily security script.
1.110 hubertf 1830: Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.91 rillig 1831: file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
1.88 wiz 1832: </p>
1.82 rillig 1833: </div>
1834: <div class="sect2" lang="en">
1835: <div class="titlepage"><div><div><h3 class="title">
1836: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1837: <p>
1.112 weinem 1838: 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.110 hubertf 1839: <span class="command"><strong>lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
1.88 wiz 1840: argument to check if your packages are up-to-date, e.g.
1841: </p>
1842: <pre class="screen">
1843: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1844: ...
1.88 wiz 1845: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1846: </pre>
1.110 hubertf 1847: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1848: package on your system and rebuild any dependencies.
1849: </p>
1.82 rillig 1850: </div>
1851: <div class="sect2" lang="en">
1852: <div class="titlepage"><div><div><h3 class="title">
1853: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1854: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1855: administrative functions on the package system.</p>
1.82 rillig 1856: </div>
1857: <div class="sect2" lang="en">
1858: <div class="titlepage"><div><div><h3 class="title">
1859: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1860: <p>Please pay very careful attention to the warnings
1.110 hubertf 1861: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88 wiz 1862: inherent dangers of installing binary packages which you did
1863: not create yourself, and the security holes that can be
1864: introduced onto your system by indiscriminate adding of such
1865: files.</p>
1.75 rillig 1866: <p>The same warning of course applies to every package you
1.88 wiz 1867: install from source when you haven't completely read and
1868: understood the source code of the package, the compiler that
1869: is used to build the package and all the other tools that are
1870: involved.</p>
1.75 rillig 1871: </div>
1872: </div>
1873: <div class="sect1" lang="en">
1874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1875: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1876: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1877: directory now contains a set of packages, organized into
1878: categories. You can browse the online index of packages, or run
1.110 hubertf 1879: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1880: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1881: 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 1882: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1883: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1884: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1885: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1886: different <code class="varname">LOCALBASE</code> definitions on the same
1887: system (inside a chroot is an exception). </p>
1888: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1889: 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 1890: instructions how to create your own packages.</p>
1.75 rillig 1891: <div class="sect2" lang="en">
1892: <div class="titlepage"><div><div><h3 class="title">
1893: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1894: <p>To build packages from source, you need a working C
1.88 wiz 1895: compiler. On NetBSD, you need to install the
1896: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
1897: sets. If you want to build X11-related packages, the
1898: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
1899: sets are required, too.</p>
1.75 rillig 1900: </div>
1901: <div class="sect2" lang="en">
1902: <div class="titlepage"><div><div><h3 class="title">
1903: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1904: <p>The first step for building a package is downloading the
1.88 wiz 1905: distfiles (i.e. the unmodified source). If they have not yet been
1906: downloaded, pkgsrc will fetch them automatically.</p>
1907: <p>If you have all files that you need in the
1908: <code class="filename">distfiles</code> directory,
1909: you don't need to connect. If the distfiles are on CD-ROM, you can
1910: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1911: </p>
1.82 rillig 1912: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1913: <p>
1.110 hubertf 1914: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1915: <p>By default a list of distribution sites will be randomly
1916: intermixed to prevent huge load on servers which holding popular
1917: packages (for example, SourceForge.net mirrors). Thus, every
1918: time when you need to fetch yet another distfile all the mirrors
1919: will be tried in new (random) order. You can turn this feature
1920: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1921: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1922: <p>You can overwrite some of the major distribution sites to
1923: fit to sites that are close to your own. By setting one or two
1924: variables you can modify the order in which the master sites are
1925: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1926: delimited list of domain suffixes.
1927: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1928: contains a whitespace delimited list of regular expressions. It
1929: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1930: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1931: some examples. This may save some of your bandwidth and
1932: time.</p>
1.75 rillig 1933: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1934: if you want to keep the settings, by editing the
1.110 hubertf 1935: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1936: and adding the definitions there.</p>
1.82 rillig 1937: <p>
1.88 wiz 1938: If a package depends on many other packages (such as
1.93 rillig 1939: <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 1940: alternate between periods of
1941: downloading source, and compiling. To ensure you have all the source
1942: downloaded initially you can run the command:
1943: </p>
1.82 rillig 1944: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1945: <p>
1.88 wiz 1946: which will output and run a set of shell commands to fetch the
1947: necessary files into the <code class="filename">distfiles</code> directory. You can
1948: also choose to download the files manually.
1949: </p>
1.75 rillig 1950: </div>
1951: <div class="sect2" lang="en">
1952: <div class="titlepage"><div><div><h3 class="title">
1953: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1954: <p>
1.88 wiz 1955: Once the software has downloaded, any patches will be applied, then it
1956: will be compiled for you. This may take some time depending on your
1957: computer, and how many other packages the software depends on and their
1958: compile time.
1959: </p>
1.75 rillig 1960: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1961: <h3 class="title">Note</h3>
1962: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1963: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88 wiz 1964: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 1965: </div>
1.87 wiz 1966: <p>For example, type</p>
1.88 wiz 1967: <pre class="screen">
1968: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1969: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1970: </pre>
1.75 rillig 1971: <p>at the shell prompt to build the various components of the
1.88 wiz 1972: package.</p>
1.82 rillig 1973: <p>The next stage is to actually install the newly compiled
1.88 wiz 1974: program onto your system. Do this by entering:
1.82 rillig 1975:
1.88 wiz 1976: </p>
1.82 rillig 1977: <pre class="screen">
1.88 wiz 1978: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1979: </pre>
1.82 rillig 1980: <p>
1981:
1.88 wiz 1982: while you are still in the directory for whatever package you
1983: are installing.</p>
1.82 rillig 1984: <p>Installing the package on your system may require you to
1.88 wiz 1985: be root. However, pkgsrc has a
1986: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1987: to only become root for the actual installation step.</p>
1.82 rillig 1988: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1989: You can now enter:
1.82 rillig 1990:
1.88 wiz 1991: </p>
1.82 rillig 1992: <pre class="screen">
1.88 wiz 1993: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1994: </pre>
1.82 rillig 1995: <p>
1996:
1.88 wiz 1997: to remove the compiled files in the work directory, as you shouldn't need
1998: them any more. If other packages were also added to your system
1999: (dependencies) to allow your program to compile, you can tidy these up
2000: also with the command:</p>
1.82 rillig 2001: <pre class="screen">
1.88 wiz 2002: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2003: </pre>
1.75 rillig 2004: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2005: 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 2006: <p>The program is installed under the default root of the
2007: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2008: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2009: variable in your environment, and it will use that value as the
2010: root of your packages tree. So, to use
2011: <code class="filename">/usr/local</code>, set
2012: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2013: Please note that you should use a directory which is dedicated to
2014: packages and not shared with other programs (i.e., do not try and
2015: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2016: to add any of your own files or directories (such as
2017: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2018: <code class="filename">pkgsrc/</code>) below the
2019: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2020: conflicts between programs and other files installed by the
2021: package system and whatever else may have been installed
2022: there.</p>
1.110 hubertf 2023: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2024: alter some configuration options at build time. Have a look at
2025: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2026: of what will be set there by default. Environment variables such
2027: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2028: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2029: set them each time you want to use pkgsrc.</p>
2030: <p>Occasionally, people want to “<span class="quote">look under the
2031: covers</span>” to see what is going on when a package is building
2032: or being installed. This may be for debugging purposes, or out of
2033: simple curiosity. A number of utility values have been added to
2034: help with this.</p>
1.75 rillig 2035: <div class="orderedlist"><ol type="1">
2036: <li>
1.110 hubertf 2037: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 2038: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2039: information will be displayed. For example,</p>
1.75 rillig 2040: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2041: <p>will show all the commands that are invoked, up to and
2042: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2043: </li>
2044: <li>
1.110 hubertf 2045: <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-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2046: definition, then the <code class="varname">VARNAME</code> definition
2047: should be used, in conjunction with the show-var
1.110 hubertf 2048: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2049: variable <code class="varname">LOCALBASE</code>:</p>
2050: <pre class="screen">
2051: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2052: /usr/pkg
2053: <code class="prompt">%</code>
1.88 wiz 2054: </pre>
1.75 rillig 2055: </li>
2056: </ol></div>
2057: <p>If you want to install a binary package that you've either
1.88 wiz 2058: created yourself (see next section), that you put into
2059: pkgsrc/packages manually or that is located on a remote FTP
2060: server, you can use the "bin-install" target. This target will
1.110 hubertf 2061: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
2062: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2063: sites searched is kept in the variable
2064: <code class="varname">BINPKG_SITES</code>, which defaults to
1.110 hubertf 2065: 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-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 2066: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2067: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2068: details.</p>
2069: <p>A final word of warning: If you set up a system that has a
2070: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2071: set that before any packages are installed, as you cannot use
2072: several directories for the same purpose. Doing so will result in
2073: pkgsrc not being able to properly detect your installed packages,
2074: and fail miserably. Note also that precompiled binary packages are
2075: usually built with the default <code class="varname">LOCALBASE</code> of
2076: <code class="filename">/usr/pkg</code>, and that you should
2077: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2078: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2079: </div>
2080: </div>
2081: </div>
2082: <div class="chapter" lang="en">
2083: <div class="titlepage"><div><div><h2 class="title">
2084: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2085: <div class="toc">
2086: <p><b>Table of Contents</b></p>
2087: <dl>
2088: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2089: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2090: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2091: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2092: <dd><dl>
1.103 wiz 2093: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116 rillig 2094: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
2095: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88 wiz 2096: </dl></dd>
1.103 wiz 2097: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2098: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2099: </dl>
2100: </div>
1.104 rillig 2101: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2102: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2103: that file depends on the installation. On NetBSD, when you use
1.110 hubertf 2104: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 2105: <code class="filename">/etc/</code>. In all other cases the default location is
2106: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2107: bootstrap program to install the binary packages.</p>
2108: <p>During the bootstrap, an example configuration file is created. To
2109: use that, you have to create the directory
2110: <code class="filename">${PREFIX}/etc</code> and copy the example file
2111: there.</p>
2112: <p>The format of the configuration file is that of the usual
2113: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2114: is done by setting variables in this file. Note that you can define all
2115: kinds of variables, and no special error checking (for example for
2116: spelling mistakes) takes place, so you have to try it out to see if it
2117: works.</p>
1.75 rillig 2118: <div class="sect1" lang="en">
2119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2120: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2121: <p>In this section, you can find some variables that apply to all
1.89 rillig 2122: pkgsrc packages. A complete list of the variables that can be
2123: configured by the user is available in
2124: <code class="filename">mk/defaults/mk.conf</code>, together with some
2125: comments that describe each variable's intent.</p>
1.75 rillig 2126: <div class="itemizedlist"><ul type="disc">
2127: <li><p><code class="varname">LOCALBASE</code>: Where
2128: packages will be installed. The default is
1.76 rillig 2129: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2130: with different <code class="varname">LOCALBASE</code>s!</p></li>
2131: <li><p><code class="varname">CROSSBASE</code>: Where
2132: “<span class="quote">cross</span>” category packages will be
2133: installed. The default is
1.76 rillig 2134: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2135: <li><p><code class="varname">X11BASE</code>: Where
2136: X11 is installed on the system. The default is
1.76 rillig 2137: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2138: <li><p><code class="varname">DISTDIR</code>: Where to store the
2139: downloaded copies of the original source distributions used
2140: for building pkgsrc packages. The default is
1.76 rillig 2141: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97 rillig 2142: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2143: database about installed packages is stored. The default is
2144: <code class="filename">/var/db/pkg</code>.</p></li>
1.75 rillig 2145: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2146: If set, override the packages'
2147: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2148: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2149: Backup location(s) for distribution files and patch files
2150: if not found locally or in
1.76 rillig 2151: <code class="filename">${MASTER_SITES}</code> or
2152: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2153: The defaults are
1.76 rillig 2154: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2155: and
1.76 rillig 2156: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2157: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2158: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2159: <em class="replaceable"><code>arch</code></em> are replaced with OS
2160: release (“<span class="quote">2.0</span>”, etc.) and architecture
2161: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2162: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2163: List of acceptable licenses. Whenever you try to build a package
2164: whose license is not in this list, you will get an error message
2165: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2166: </ul></div>
2167: </div>
2168: <div class="sect1" lang="en">
2169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2170: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2171: <p>XXX
2172: </p>
2173: <div class="itemizedlist"><ul type="disc">
2174: <li><p><code class="varname">PACKAGES</code>: The top level
2175: directory for the binary packages. The default is
1.76 rillig 2176: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2177: <li><p><code class="varname">WRKOBJDIR</code>:
2178: The top level directory where, if defined, the separate
2179: working directories will get created, and symbolically
1.76 rillig 2180: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2181: This is useful for building packages on several
1.76 rillig 2182: architectures, then <code class="filename">${PKGSRCDIR}</code>
2183: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2184: is local to every architecture. (It should be noted that
2185: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.114 jmcneill 2186: — it is an internal definition which refers to the
1.75 rillig 2187: root of the pkgsrc tree. It is possible to have many
2188: pkgsrc tree instances.)</p></li>
2189: <li><p><code class="varname">LOCALPATCHES</code>:
2190: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2191: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2192: information.</p></li>
1.75 rillig 2193: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2194: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2195: BSD-style Makefile. If this is not set,
2196: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2197: <code class="filename">/dev/null</code> to avoid picking up
2198: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2199: <li><p><code class="varname">DEPENDS_TARGET</code>:
2200: By default, dependencies are only installed, and no binary
2201: package is created for them. You can set this variable to
2202: <code class="literal">package</code> to automatically create binary
2203: packages after installing dependencies.</p></li>
1.75 rillig 2204: </ul></div>
2205: </div>
2206: <div class="sect1" lang="en">
2207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2208: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103 wiz 2209: <p>A growing number of packages support installation into a
2210: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2211: to be built, before the actual filesystem is touched. DESTDIR
2212: support exists in two variations:</p>
2213: <div class="itemizedlist"><ul type="disc">
2214: <li><p>Basic DESTDIR support means that the package
2215: installation and packaging is still run as
2216: root.</p></li>
2217: <li><p>Full DESTDIR support can run the complete build,
2218: installation and packaging as normal user. Root privileges are
2219: only needed to add packages.</p></li>
2220: </ul></div>
2221: <p>To use the DESTDIR support, set either
2222: <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
2223: packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
2224: get the full support with fallback to basic
2225: support. <code class="varname">USE_DESTDIR=full</code> needs <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> version 20070802 (or
2226: newer). It might become the default DESTDIR support later.</p>
2227: <p>DESTDIR support changes the behaviour of various targets
2228: slightly. To install a package after building it, use
2229: <code class="literal">package-install</code>. <code class="literal">package</code> and
2230: <code class="literal">install</code> don't do that any
2231: longer. <code class="literal">package-install</code> can be used as
2232: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2233: will ask for the root password to install the package and fail,
2234: <code class="literal">package-install</code> will ask again.</p>
2235: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2236: clean</code></strong> needs to be run as root.</p>
2237: </div>
2238: <div class="sect1" lang="en">
2239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2240: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78 rillig 2241: <div class="sect2" lang="en">
2242: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2243: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2244: <p>By default, pkgsrc will use GCC to build packages. This may be
2245: overridden by setting the following variables in /etc/mk.conf:</p>
2246: <div class="variablelist"><dl>
2247: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2248: <dd>
2249: <p>This is a list of values specifying the chain of
2250: compilers to invoke when building packages. Valid values
2251: are:</p>
2252: <div class="itemizedlist"><ul type="disc">
2253: <li><p><code class="varname">distcc</code>:
2254: distributed C/C++ (chainable)</p></li>
2255: <li><p><code class="varname">ccache</code>:
2256: compiler cache (chainable)</p></li>
2257: <li><p><code class="varname">gcc</code>:
2258: GNU C/C++ Compiler</p></li>
2259: <li><p><code class="varname">mipspro</code>:
2260: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2261: <li><p><code class="varname">mipspro</code>:
2262: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2263: <li><p><code class="varname">sunpro</code>:
2264: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2265: </ul></div>
2266: <p>The default is
2267: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2268: <code class="varname">ccache</code> and/or
2269: <code class="varname">distcc</code> with an appropriate
2270: <code class="varname">PKGSRC_COMPILER</code> setting,
2271: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2272: variable should always be terminated with a value for
2273: a real compiler. Note that only one real compiler
2274: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2275: is not allowed).</p>
1.89 rillig 2276: </dd>
2277: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2278: <dd><p>This specifies the minimum version of GCC to use
2279: when building packages. If the system GCC doesn't
2280: satisfy this requirement, then pkgsrc will build and
2281: install one of the GCC packages to use instead.</p></dd>
2282: </dl></div>
2283: </div>
2284: <div class="sect2" lang="en">
2285: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2286: <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 2287: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2288: please make sure to use the <code class="literal">+=</code> operator
2289: instead of the <code class="literal">=</code> operator:</p>
2290: <pre class="programlisting">
1.100 rillig 2291: CFLAGS+= -your -flags
1.78 rillig 2292: </pre>
2293: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.117 ! jnemeth 2294: “<span class="quote">+</span>”) may lead to problems with packages that
! 2295: need to add their own flags. You may want to take a look
! 2296: 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>
! 2297: package if you're interested in optimization for the current
! 2298: CPU. Setting <code class="varname">USE_CPUFLAGS</code> to yes in
! 2299: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use cpuflags.</p>
1.78 rillig 2300: </div>
1.88 wiz 2301: <div class="sect2" lang="en">
2302: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2303: <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 2304: <p>If you want to pass flags to the linker, both in the configure
2305: step and the build step, you can do this in two ways. Either set
2306: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2307: between the two is that <code class="varname">LIBS</code> will be appended to
2308: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2309: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2310: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2311: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2312: <code class="varname">CFLAGS</code>, if you do not wish to override these
2313: settings, use the <code class="literal">+=</code> operator:</p>
2314: <pre class="programlisting">
1.100 rillig 2315: LDFLAGS+= -your -linkerflags
1.88 wiz 2316: </pre>
2317: </div>
1.78 rillig 2318: </div>
2319: <div class="sect1" lang="en">
2320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2321: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2322: <p>XXX
2323: </p>
2324: <div class="itemizedlist"><ul type="disc">
2325: <li>
2326: <p><code class="varname">PKG_DEVELOPER</code>:
2327: Run some sanity checks that package developers want:
2328: </p>
2329: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2330: <li><p>make sure patches apply with zero
2331: fuzz</p></li>
2332: <li><p>run check-shlibs to see that all
2333: binaries will find their shared libs.</p></li>
1.75 rillig 2334: </ul></div>
2335: <p>
1.87 wiz 2336: </p>
1.75 rillig 2337: </li>
1.88 wiz 2338: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2339: of debugging output which is displayed whilst making and
2340: installing the package. The default value for this is 0,
2341: which will not display the commands as they are executed
2342: (normal, default, quiet operation); the value 1 will display
2343: all shell commands before their invocation, and the value 2
2344: will display both the shell commands before their invocation,
1.110 hubertf 2345: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2346: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2347: </ul></div>
2348: <p>
2349: </p>
2350: </div>
2351: <div class="sect1" lang="en">
2352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2353: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2354: <p>Some packages have build time options, usually to select
2355: between different dependencies, enable optional support for big
2356: dependencies or enable experimental features.</p>
1.75 rillig 2357: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2358: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2359: show-options</strong></span>, for example:</p>
1.75 rillig 2360: <pre class="programlisting">
2361: The following options are supported by this package:
2362: ssl Enable SSL support.
2363: Exactly one of the following gecko options is required:
2364: firefox Use firefox as gecko rendering engine.
2365: mozilla Use mozilla as gecko rendering engine.
2366: At most one of the following database options may be selected:
2367: mysql Enable support for MySQL database.
2368: pgsql Enable support for PostgreSQL database.
1.1 grant 2369:
1.75 rillig 2370: These options are enabled by default: firefox
2371: These options are currently enabled: mozilla ssl
1.1 grant 2372: </pre>
1.75 rillig 2373: <p>The following variables can be defined in
1.110 hubertf 2374: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2375: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2376: which can be used to select or disable options for all packages
2377: that support them, and
2378: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2379: which can be used to select or disable options specifically for
2380: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2381: these variables are selected, options preceded by “<span class="quote">-</span>”
2382: are disabled. A few examples:</p>
1.75 rillig 2383: <pre class="screen">
1.110 hubertf 2384: <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 2385: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2386: PKG_OPTIONS.kdebase= debug -sasl
2387: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2388: <p>It is important to note that options that were specifically
2389: suggested by the package maintainer must be explicitely removed if
2390: you do not wish to include the option. If you are unsure you can view
2391: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2392: <p>The following settings are consulted in the order given, and
2393: the last setting that selects or disables an option is
2394: used:</p>
1.75 rillig 2395: <div class="orderedlist"><ol type="1">
2396: <li><p>the default options as suggested by the package
1.88 wiz 2397: maintainer</p></li>
1.75 rillig 2398: <li><p>the options implied by the settings of legacy
1.88 wiz 2399: variables (see below)</p></li>
1.75 rillig 2400: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2401: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2402: </ol></div>
2403: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2404: selected is used, all others are automatically disabled. If an
2405: option of the group is explicitly disabled, the previously
2406: selected option, if any, is used. It is an error if no option
2407: from a required group of options is selected, and building the
2408: package will fail.</p>
2409: <p>Before the options framework was introduced, build options
2410: were selected by setting a variable (often named
2411: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2412: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2413: transition to the options framework for the user, these legacy
2414: variables are converted to the appropriate options setting
2415: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2416: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2417: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2418: directly. Support for the legacy variables will be removed
2419: eventually.</p>
1.75 rillig 2420: </div>
2421: </div>
2422: <div class="chapter" lang="en">
2423: <div class="titlepage"><div><div><h2 class="title">
2424: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2425: <div class="toc">
2426: <p><b>Table of Contents</b></p>
2427: <dl>
2428: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2429: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2430: </dl>
2431: </div>
2432: <div class="sect1" lang="en">
2433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2434: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2435: <p>Once you have built and installed a package, you can create
2436: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110 hubertf 2437: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2438: the same package on a group of hosts and wasting CPU time. It also
2439: provides a simple means for others to install your package, should
2440: you distribute it.</p>
2441: <p>To create a binary package, change into the appropriate
1.110 hubertf 2442: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2443: package</strong></span>:</p>
2444: <pre class="screen">
2445: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2446: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2447: </pre>
2448: <p>This will build and install your package (if not already done),
2449: and then build a binary package from what was installed. You can
1.110 hubertf 2450: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2451: it. Binary packages are created by default in
2452: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2453: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2454: 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 2455: <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 2456: such a binary package.</p>
1.75 rillig 2457: </div>
2458: <div class="sect1" lang="en">
2459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2460: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2461: <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 2462: </div>
2463: </div>
2464: <div class="chapter" lang="en">
2465: <div class="titlepage"><div><div><h2 class="title">
2466: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2467: builds)</h2></div></div></div>
2468: <div class="toc">
2469: <p><b>Table of Contents</b></p>
2470: <dl>
2471: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2472: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2473: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2474: <dd><dl>
2475: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2476: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2477: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2478: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2479: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2480: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2481: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2482: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2483: </dl></dd>
2484: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 2485: <dd><dl>
2486: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2487: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2488: </dl></dd>
1.106 rillig 2489: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2490: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2491: </dl>
2492: </div>
2493: <p>When you have multiple machines that should run the same packages,
2494: it is wasted time if they all build their packages themselves from
2495: source. There are two ways of getting a set of binary packages: The old
2496: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2497: system. This chapter describes how to set them up so that the packages
2498: are most likely to be usable later.</p>
2499: <div class="sect1" lang="en">
2500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2501: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2502: <p>Since a bulk build takes several days or even weeks to finish, you
2503: should think about the setup before you start everything. Pay attention
2504: to at least the following points:</p>
2505: <div class="itemizedlist"><ul type="disc">
2506: <li>
2507: <p>If you want to upload the binary packages to
2508: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2509: packages:</p>
2510: <div class="itemizedlist"><ul type="circle">
2511: <li><p>To end up on ftp.NetBSD.org, the packages must be built
2512: by a NetBSD developer on a trusted machine (that is, where you and only
2513: you have root access).</p></li>
2514: <li><p>Packages on ftp.NetBSD.org should only be created from
2515: the stable branches (like 2007Q1), so that users browsing the available
2516: collections can see at a glance how old the packages
2517: are.</p></li>
2518: <li><p>The packages must be built as root, since some packages
2519: require set-uid binaries at runtime, and creating those packages as
2520: unprivileged user doesn't work well at the moment.</p></li>
2521: </ul></div>
2522: </li>
2523: <li><p>Make sure that the bulk build cannot break anything in
2524: your system. Most bulk builds run as root, so they should be run at least
2525: in a chroot environment or something even more restrictive, depending on
2526: what the operating system provides. There have been numerous cases where
2527: certain packages tried to install files outside the
2528: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2529: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2530: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2531: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2532: that you don't need any package during the build.</p></li>
2533: </ul></div>
2534: </div>
2535: <div class="sect1" lang="en">
2536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2537: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2538: <p>A complete bulk build requires lots of disk space. Some of the
2539: disk space can be read-only, some other must be writable. Some can be on
2540: remote filesystems (such as NFS) and some should be local. Some can be
2541: temporary filesystems, others must survive a sudden reboot.</p>
2542: <div class="itemizedlist"><ul type="disc">
2543: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2544: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2545: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2546: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2547: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2548: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2549: </ul></div>
1.75 rillig 2550: </div>
2551: <div class="sect1" lang="en">
2552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2553: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.116 rillig 2554: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2555: <h3 class="title">Note</h3>
2556: <p>There are two ways of doing a bulk build. The old-style
2557: one and the new-style “<span class="quote">pbulk</span>”. The latter is the recommended
2558: way.</p>
1.106 rillig 2559: </div>
1.75 rillig 2560: <div class="sect2" lang="en">
2561: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2562: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75 rillig 2563: <div class="sect3" lang="en">
2564: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2565: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93 rillig 2566: </h4></div></div></div>
1.76 rillig 2567: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2568: configuration file for bulk builds. You can configure how your
2569: copy of pkgsrc is kept up to date, how the distfiles are
2570: downloaded, how the packages are built and how the report is
2571: generated. You can find an annotated example file in
2572: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2573: it, copy <code class="filename">build.conf-example</code> to
2574: <code class="filename">build.conf</code> and edit it, following the
2575: comments in that file.</p>
1.75 rillig 2576: </div>
2577: <div class="sect3" lang="en">
2578: <div class="titlepage"><div><div><h4 class="title">
1.110 hubertf 2579: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.104 rillig 2580: </h4></div></div></div>
1.110 hubertf 2581: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2582: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2583: details of the default settings. You will want to ensure that
2584: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2585: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.104 rillig 2586: completely bypasses the license check.</p>
1.87 wiz 2587: <pre class="programlisting">
1.100 rillig 2588: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2589: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2590: BSDSRCDIR= /usr/src
2591: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2592: OBJHOSTNAME?= yes # use work.`hostname`
2593: FAILOVER_FETCH= yes # insist on the correct checksum
2594: PKG_DEVELOPER?= yes
2595: _ACCEPTABLE= yes
2596: </pre>
1.75 rillig 2597: <p>Some options that are especially useful for bulk builds
2598: can be found at the top lines of the file
1.76 rillig 2599: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2600: options of these are briefly described here.</p>
2601: <div class="itemizedlist"><ul type="disc">
2602: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2603: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2604: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2605: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2606: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2607: to the directory where all log files are created. Otherwise the
2608: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2609: <li><p>Another important variable is
1.87 wiz 2610: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2611: should be always available while building other
2612: packages.</p></li>
1.75 rillig 2613: </ul></div>
2614: <p>Some other options are scattered in the pkgsrc
2615: infrastructure:</p>
2616: <div class="itemizedlist"><ul type="disc">
2617: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2618: should be set to <code class="literal">yes</code>. The purpose of the bulk
2619: builds is creating binary packages, no matter if they are
2620: vulnerable or not. When uploading the packages to a public
2621: server, the vulnerable packages will be put into a directory of
2622: their own. Leaving this variable unset would prevent the bulk
2623: build system from even trying to build them, so possible
2624: building errors would not show up.</p></li>
1.75 rillig 2625: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2626: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2627: “<span class="quote">yes</span>” to check that the installed set of files
2628: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2629: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2630: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2631: “<span class="quote">yes</span>” to check that the installed
2632: “<span class="quote">#!</span>”-scripts will find their
2633: interpreter.</p></li>
1.91 rillig 2634: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2635: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2636: package's self-test before installing it. Note that some
2637: packages make heavy use of “<span class="quote">good</span>” random
2638: numbers, so you need to assure that the machine on which you
2639: are doing the bulk builds is not completely idle. Otherwise
2640: some test programs will seem to hang, while they are just
2641: waiting for new random data to be
2642: available.</p></li>
1.75 rillig 2643: </ul></div>
2644: </div>
2645: <div class="sect3" lang="en">
2646: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2647: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93 rillig 2648: </h4></div></div></div>
1.75 rillig 2649: <p>It is possible to configure the bulk build to perform
1.87 wiz 2650: certain site-specific tasks at the end of the pre-build
2651: stage. If the file
2652: <code class="filename">pre-build.local</code> exists in
2653: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110 hubertf 2654: (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.87 wiz 2655: stage. An example use of
2656: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2657: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2658: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2659: <p>to prevent the system from trying to build a particular package
1.87 wiz 2660: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2661: </div>
2662: </div>
2663: <div class="sect2" lang="en">
2664: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2665: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2666: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2667: deleted at the start of bulk builds, make sure your login
2668: shell is placed somewhere else. Either drop it into
2669: <code class="filename">/usr/local/bin</code> (and adjust your login
2670: shell in the passwd file), or (re-)install it via
1.110 hubertf 2671: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.87 wiz 2672: you can login after a reboot (remember that your current
2673: process won't die if the package is removed, you just can't
2674: start any new instances of the shell any more). Also, if you
2675: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2676: version of ssh for some reason, be sure to install ssh before
2677: starting it from <code class="filename">rc.local</code>:</p>
2678: <pre class="programlisting">
1.100 rillig 2679: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2680: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2681: /usr/pkg/etc/rc.d/sshd
2682: fi
2683: </pre>
1.75 rillig 2684: <p>Not doing so will result in you being not able to log in
1.87 wiz 2685: via ssh after the bulk build is finished or if the machine
2686: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2687: </div>
2688: <div class="sect2" lang="en">
2689: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2690: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75 rillig 2691: <p>Make sure you don't need any of the packages still
1.87 wiz 2692: installed.</p>
1.75 rillig 2693: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2694: <h3 class="title">Warning</h3>
1.99 rillig 2695: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2696: configuration files and some more files from
2697: <code class="filename">/var</code>, <code class="filename">/home</code> and
2698: possibly other locations will be removed! So don't run a bulk
2699: build with privileges that might harm your
2700: system.</em></span></p>
1.75 rillig 2701: </div>
2702: <p>Be sure to remove all other things that might
1.87 wiz 2703: interfere with builds, like some libs installed in
2704: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2705: <pre class="screen">
2706: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2707: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2708: </pre>
1.75 rillig 2709: <p>If for some reason your last build didn't complete (power
1.87 wiz 2710: failure, system panic, ...), you can continue it by
2711: running:</p>
1.75 rillig 2712: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2713: <p>At the end of the bulk build, you will get a summary via mail,
2714: and find build logs in the directory specified by
2715: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2716: file.</p>
1.75 rillig 2717: </div>
2718: <div class="sect2" lang="en">
2719: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2720: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75 rillig 2721: <p>The bulk builds consist of three steps:</p>
2722: <div class="variablelist"><dl>
2723: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2724: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2725: cleans out any broken distfiles, and removes all
2726: packages installed.</p></dd>
1.75 rillig 2727: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2728: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2729: an optimised order in which packages will be
2730: built. Packages that don't require other packages will
2731: be built first, and packages with many dependencies will
2732: be built later.</p></dd>
1.75 rillig 2733: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2734: <dd><p>Generates a report that's placed in the directory
2735: specified in the <code class="filename">build.conf</code> file
2736: named <code class="filename">broken.html</code>, a short version
2737: of that report will also be mailed to the build's
2738: admin.</p></dd>
1.75 rillig 2739: </dl></div>
1.87 wiz 2740: <p>During the build, a list of broken packages will be compiled
2741: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2742: <code class="filename">.../.broken.${MACHINE}</code> if
2743: <code class="varname">OBJMACHINE</code> is set), individual build logs
2744: of broken builds can be found in the package's
2745: directory. These files are used by the bulk-targets to mark
2746: broken builds to not waste time trying to rebuild them, and
2747: they can be used to debug these broken package builds
2748: later.</p>
1.75 rillig 2749: </div>
2750: <div class="sect2" lang="en">
2751: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2752: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75 rillig 2753: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2754: NetBSD 2.0/i386:</p>
1.75 rillig 2755: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2756: <li><p>10 GB - distfiles (NFS ok)</p></li>
2757: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2758: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2759: </ul></div>
2760: <p>Note that all pkgs will be de-installed as soon as they are
2761: turned into a binary package, and that sources are removed,
2762: so there is no excessively huge demand to disk
2763: space. Afterwards, if the package is needed again, it will
1.110 hubertf 2764: be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.87 wiz 2765: there are no cycles wasted by recompiling.</p>
1.75 rillig 2766: </div>
2767: <div class="sect2" lang="en">
2768: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2769: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2770: <p>If you don't want all the packages nuked from a machine
2771: (rendering it useless for anything but pkg compiling), there
2772: is the possibility of doing the package bulk build inside a
2773: chroot environment.</p>
2774: <p>The first step is to set up a chroot sandbox,
2775: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2776: using null mounts, or manually.</p>
2777: <p>There is a shell script called
2778: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2779: up the sandbox environment using null mounts. It will also
2780: create a script called <code class="filename">sandbox</code> in the
2781: root of the sandbox environment, which will allow the null
1.110 hubertf 2782: mounts to be activated using the <span class="command"><strong>sandbox
1.87 wiz 2783: mount</strong></span> command and deactivated using the
1.110 hubertf 2784: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87 wiz 2785: <p>To set up a sandbox environment by hand, after extracting all
1.110 hubertf 2786: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87 wiz 2787: distribution DESTDIR=/usr/sandbox</strong></span> in
2788: <code class="filename">/usr/src/etc</code>, be sure the following items
2789: are present and properly configured:</p>
1.75 rillig 2790: <div class="procedure"><ol type="1">
2791: <li>
2792: <p>Kernel</p>
2793: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2794: </li>
2795: <li>
1.76 rillig 2796: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2797: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2798: </li>
2799: <li>
1.91 rillig 2800: <p><code class="filename">/etc/resolv.conf</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a> and mail):</p>
1.75 rillig 2801: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2802: </li>
2803: <li>
2804: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2805: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2806: </li>
2807: <li>
1.91 rillig 2808: <p><code class="filename">/etc/localtime</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a>):</p>
1.75 rillig 2809: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2810: </li>
2811: <li>
1.76 rillig 2812: <p><code class="filename">/usr/src</code> (system sources,
1.114 jmcneill 2813: e. g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.75 rillig 2814: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2815: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2816: </li>
2817: <li>
1.76 rillig 2818: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2819: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2820: </li>
2821: <li>
1.76 rillig 2822: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2823: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2824: </li>
2825: <li>
2826: <p>Checkout pkgsrc via cvs into
1.87 wiz 2827: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2828: <pre class="screen">
2829: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2830: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2831: </pre>
1.75 rillig 2832: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2833: you do development in, as this will likely cause problems!</p>
1.75 rillig 2834: </li>
2835: <li><p>Make
1.87 wiz 2836: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2837: <code class="filename">.../distfiles</code> point somewhere
2838: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.116 rillig 2839: <li><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. ???">Section 7.3.1.2, “???”</a>.</p></li>
1.76 rillig 2840: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2841: </ol></div>
2842: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2843: the build with the following steps:</p>
2844: <pre class="screen">
2845: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2846: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2847: </pre>
2848: <p>This will just jump inside the sandbox and start building. At
2849: the end of the build, mail will be sent with the results of
2850: the build. Created binary pkgs will be in
2851: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2852: (wherever that points/mounts to/from).</p>
1.75 rillig 2853: </div>
2854: <div class="sect2" lang="en">
2855: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2856: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2857: <p>In addition to building a complete set of all packages in
2858: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2859: may be used to build a subset of the packages contained in
2860: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.110 hubertf 2861: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75 rillig 2862: <div class="itemizedlist"><ul type="disc">
2863: <li><p>SITE_SPECIFIC_PKGS</p></li>
2864: <li><p>HOST_SPECIFIC_PKGS</p></li>
2865: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2866: <li><p>USER_SPECIFIC_PKGS</p></li>
2867: </ul></div>
1.87 wiz 2868: <p>will define the set of packages which should be built.
2869: The bulk build code will also include any packages which are
2870: needed as dependencies for the explicitly listed packages.</p>
2871: <p>One use of this is to do a bulk build with
2872: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2873: periodically to have a complete set of the binary packages
2874: needed for your site available without the overhead of
2875: building extra packages that are not needed.</p>
1.75 rillig 2876: </div>
2877: <div class="sect2" lang="en">
2878: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2879: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2880: <p>This section describes how pkgsrc developers can upload binary
2881: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2882: <p>If you would like to automatically create checksum files for the
2883: binary packages you intend to upload, remember to set
2884: <code class="varname">MKSUMS=yes</code> in your
2885: <code class="filename">mk/bulk/build.conf</code>.</p>
2886: <p>If you would like to PGP sign the checksum files (highly
2887: recommended!), remember to set
2888: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2889: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2890: your GPG password to sign the files before uploading everything.</p>
2891: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2892: set properly in your <code class="filename">mk/bulk/build.conf</code>
2893: file, i.e. adjust it to something like one of the following:</p>
1.93 rillig 2894: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
2895: <p>Please use appropriate values for "packages-200xQy",
1.87 wiz 2896: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2897: is different from your local login, write your login directly
2898: into the variable, e.g. my local account is "feyrer", but for my
2899: login "hubertf", I use:</p>
1.93 rillig 2900: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2901: <p>A separate <code class="filename">upload</code> directory is used
2902: here to allow "closing" the directory during upload. To do
2903: so, run the following command on ftp.NetBSD.org next:</p>
1.93 rillig 2904: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87 wiz 2905: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2906: only appropriate for packages for the NetBSD operating
2907: system. Binary packages for other operating systems should go
2908: into <code class="filename">/pub/pkgsrc</code>.</p>
2909: <p>Before uploading the binary pkgs, ssh authentication needs
2910: to be set up. This example shows how to set up temporary keys
2911: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2912: (assuming that no keys should be present there usually):</p>
2913: <pre class="screen">
2914: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2915: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2916: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 2917: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2918: </pre>
2919: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2920: append it to your <code class="filename">~/.ssh/authorized_keys</code>
2921: file on ftp.NetBSD.org. You can remove the key after the
2922: upload is done!</p>
2923: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 2924: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 2925: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2926: <p>Now after all this works, you can exit the sandbox and start
2927: the upload:</p>
2928: <pre class="screen">
2929: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 2930: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 2931: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2932: </pre>
1.110 hubertf 2933: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
2934: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.87 wiz 2935: upload. The upload script will take care of not uploading
2936: restricted packages and putting vulnerable packages into the
2937: <code class="filename">vulnerable</code> subdirectory.</p>
2938: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 2939: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 2940: Gdd:x! </pre>
2941: <p>Use whatever is needed to remove the key you've entered
2942: before! Last, move the uploaded packages out of the
2943: <code class="filename">upload</code> directory to have them accessible
2944: to everyone:</p>
2945: <pre class="screen">
1.93 rillig 2946: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 2947: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2948: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 2949: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
2950: </pre>
1.75 rillig 2951: </div>
2952: </div>
2953: <div class="sect1" lang="en">
2954: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2955: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2956: <p>Running a pbulk-style bulk build works roughly as follows:</p>
2957: <div class="itemizedlist"><ul type="disc">
2958: <li><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2959: <li><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
2960: </ul></div>
2961: <div class="sect2" lang="en">
2962: <div class="titlepage"><div><div><h3 class="title">
2963: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117 ! jnemeth 2964: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
1.116 rillig 2965: <pre class="screen">
2966: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2967: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2968: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2969: </pre>
2970: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
2971: <div class="itemizedlist"><ul type="disc">
2972: <li><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2973: <li><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
2974: <li><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
2975: <li><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
2976: <li><p><code class="literal"><code class="varname">_ACCEPTABLE</code>=yes</code>, to accept all licenses, no matter how restrictive they are.</p></li>
2977: </ul></div>
2978: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2979: <pre class="screen">
2980: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2981: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2982: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2983: </pre>
2984: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
2985: </div>
1.106 rillig 2986: <div class="sect2" lang="en">
2987: <div class="titlepage"><div><div><h3 class="title">
1.116 rillig 2988: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114 jmcneill 2989: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116 rillig 2990: <p>TODO: continue writing</p>
1.106 rillig 2991: </div>
2992: </div>
2993: <div class="sect1" lang="en">
2994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2995: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2996: <p>After your pkgsrc bulk-build has completed, you may wish to
2997: create a CD-ROM set of the resulting binary packages to assist
2998: in installing packages on other machines. The
1.91 rillig 2999: <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 3000: a simple tool for creating the ISO 9660 images.
1.110 hubertf 3001: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 3002: way that keeps all the dependencies for a given package on the same
3003: CD as that package.</p>
1.75 rillig 3004: <div class="sect2" lang="en">
3005: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3006: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3007: <p>Complete documentation for cdpack is found in the cdpack(1)
3008: man page. The following short example assumes that the binary
3009: packages are left in
3010: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3011: sufficient disk space exists in <code class="filename">/u2</code> to
3012: hold the ISO 9660 images.</p>
3013: <pre class="screen">
3014: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3015: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3016: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3017: </pre>
3018: <p>If you wish to include a common set of files
3019: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3020: etc.) on each CD in the collection, then you need to create a
3021: directory which contains these files. e.g.</p>
3022: <pre class="screen">
3023: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3024: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3025: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3026: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3027: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3028: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3029: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3030: </pre>
1.75 rillig 3031: <p>Now create the images:</p>
3032: <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 3033: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3034: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3035: in their root directories.</p>
1.75 rillig 3036: </div>
3037: </div>
3038: </div>
3039: <div class="chapter" lang="en">
3040: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3041: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 3042: <div class="toc">
3043: <p><b>Table of Contents</b></p>
3044: <dl>
1.116 rillig 3045: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
3046: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.90 rillig 3047: </dl>
3048: </div>
3049: <p>The files that are installed by pkgsrc are organized in a way that
3050: is similar to what you find in the <code class="filename">/usr</code> directory
3051: of the base system. But some details are different. This is because
3052: pkgsrc initially came from FreeBSD and had adopted its file system
3053: hierarchy. Later it was largely influenced by NetBSD. But no matter
3054: which operating system you are using pkgsrc with, you can expect the
3055: same layout for pkgsrc.</p>
1.91 rillig 3056: <p>There are mainly four root directories for pkgsrc, which are all
3057: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3058: When pkgsrc has been installed as root, the default locations
3059: are:</p>
3060: <pre class="programlisting">
1.100 rillig 3061: LOCALBASE= /usr/pkg
3062: PKG_SYSCONFBASE= /usr/pkg/etc
3063: VARBASE= /var
3064: PKG_DBDIR= /var/db/pkg
1.91 rillig 3065: </pre>
3066: <p>In unprivileged mode (when pkgsrc has been installed as any other
3067: user), the default locations are:</p>
3068: <pre class="programlisting">
1.100 rillig 3069: LOCALBASE= ${HOME}/pkg
3070: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3071: VARBASE= ${HOME}/pkg/var
3072: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3073: </pre>
3074: <p>What these four directories are for, and what they look like is
3075: explained below.</p>
1.90 rillig 3076: <div class="itemizedlist"><ul type="disc">
3077: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3078: <code class="filename">/usr</code> directory in the base system. It is the
3079: “<span class="quote">main</span>” directory where the files are installed and contains
3080: the well-known subdirectories like <code class="filename">bin</code>,
3081: <code class="filename">include</code>, <code class="filename">lib</code>,
3082: <code class="filename">share</code> and
3083: <code class="filename">sbin</code>.</p></li>
3084: <li><p><code class="varname">VARBASE</code> corresponds to
3085: <code class="filename">/var</code> in the base system. Some programs (especially
3086: games, network daemons) need write access to it during normal
3087: operation.</p></li>
3088: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3089: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 3090: 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 3091: itself.</p></li>
3092: </ul></div>
3093: <div class="sect1" lang="en">
3094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3095: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 3096: </h2></div></div></div>
1.90 rillig 3097: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3098: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3099: <div class="variablelist"><dl>
3100: <dt><span class="term"><code class="filename">bin</code></span></dt>
3101: <dd><p>Contains executable programs that are intended to be
3102: directly used by the end user.</p></dd>
3103: <dt><span class="term"><code class="filename">emul</code></span></dt>
3104: <dd><p>Contains files for the emulation layers of various other
3105: operating systems, especially for
3106: NetBSD.</p></dd>
3107: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3108: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3109: <dd><p>Contains
3110: the configuration files.</p></dd>
3111: <dt><span class="term"><code class="filename">include</code></span></dt>
3112: <dd><p>Contains headers for the C and C++ programming
3113: languages.</p></dd>
3114: <dt><span class="term"><code class="filename">info</code></span></dt>
3115: <dd><p>Contains GNU info files of various
3116: packages.</p></dd>
3117: <dt><span class="term"><code class="filename">lib</code></span></dt>
3118: <dd><p>Contains shared and static
3119: libraries.</p></dd>
3120: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3121: <dd><p>Contains data files that don't change after
3122: installation. Other data files belong into
3123: <code class="filename">${VARBASE}</code>.</p></dd>
3124: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3125: <dd><p>Contains programs that are not intended to be used by
3126: end users, such as helper programs or network
3127: daemons.</p></dd>
3128: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3129: <dd><p>Contains programs that are intended to be executed as
3130: CGI scripts by a web server.</p></dd>
3131: <dt><span class="term"><code class="filename">man</code> (the usual value of
3132: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3133: <dd><p>Contains brief
3134: documentation in form of manual pages.</p></dd>
3135: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3136: <dd><p>Contains programs that are intended to be used only by
3137: the super-user.</p></dd>
3138: <dt><span class="term"><code class="filename">share</code></span></dt>
3139: <dd><p>Contains platform-independent data files that don't
3140: change after installation.</p></dd>
3141: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3142: <dd><p>Contains documentation files provided by the
3143: packages.</p></dd>
3144: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3145: <dd><p>Contains example files provided by the packages. Among
3146: others, the original configuration files are saved here and copied to
3147: <code class="filename">${PKG_SYSCONFDIR}</code> during
3148: installation.</p></dd>
3149: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3150: <dd><p>Contains the original files for rc.d
3151: scripts.</p></dd>
3152: <dt><span class="term"><code class="filename">var</code> (the usual location of
3153: <code class="filename">${VARBASE}</code>)</span></dt>
3154: <dd><p>Contains files
3155: that may be modified after
3156: installation.</p></dd>
3157: </dl></div>
3158: </div>
3159: <div class="sect1" lang="en">
3160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3161: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 3162: </h2></div></div></div>
1.90 rillig 3163: <div class="variablelist"><dl>
3164: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3165: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3166: <dd><p>Contains
3167: information about the currently installed
3168: packages.</p></dd>
3169: <dt><span class="term"><code class="filename">games</code></span></dt>
3170: <dd><p>Contains highscore
3171: files.</p></dd>
3172: <dt><span class="term"><code class="filename">log</code></span></dt>
3173: <dd><p>Contains log files.</p></dd>
3174: <dt><span class="term"><code class="filename">run</code></span></dt>
3175: <dd><p>Contains informational files about daemons that are
3176: currently running.</p></dd>
3177: </dl></div>
3178: </div>
3179: </div>
3180: <div class="chapter" lang="en">
3181: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3182: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3183: <div class="toc">
3184: <p><b>Table of Contents</b></p>
3185: <dl>
1.106 rillig 3186: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3187: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3188: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3189: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3190: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3191: <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>
3192: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116 rillig 3193: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106 rillig 3194: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116 rillig 3195: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
3196: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
3197: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106 rillig 3198: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3199: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3200: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116 rillig 3201: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106 rillig 3202: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.116 rillig 3203: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75 rillig 3204: </dl>
3205: </div>
3206: <p>This section contains hints, tips & tricks on special things in
3207: pkgsrc that we didn't find a better place for in the previous chapters, and
3208: it contains items for both pkgsrc users and developers.</p>
3209: <div class="sect1" lang="en">
3210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3211: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3212: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3213: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 3214: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 3215: This is a general purpose list for most issues regarding
3216: pkgsrc, regardless of platform, e.g. soliciting user help
3217: for pkgsrc configuration, unexpected build failures, using
3218: particular packages, upgrading pkgsrc installations,
3219: questions regarding the pkgsrc release branches, etc. General announcements or
3220: proposals for changes that impact the pkgsrc user community,
3221: e.g. major infrastructure changes, new features, package
3222: removals, etc., may also be posted.</p></li>
1.110 hubertf 3223: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 3224: A list where the results of pkgsrc bulk builds are sent and
3225: discussed.</p></li>
1.110 hubertf 3226: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 3227: This list is for those who are interested in getting a
3228: commit message for every change committed to pkgsrc. It is
3229: also available in digest form, meaning one daily message
3230: containing all commit messages for changes to the package
3231: source tree in that 24 hour period.</p></li>
3232: </ul></div>
3233: <p>To subscribe, do:</p>
3234: <pre class="programlisting">
1.100 rillig 3235: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3236: </pre>
3237: <p>Archives for all these mailing lists are available from
1.110 hubertf 3238: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 3239: </div>
3240: <div class="sect1" lang="en">
3241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3242: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3243: <p>Pkgviews is tightly integrated with buildlink. You can find a
3244: pkgviews User's guide in
1.76 rillig 3245: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3246: </div>
3247: <div class="sect1" lang="en">
3248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3249: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3250: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3251: a number of useful utilities for both users and developers of pkgsrc. This
3252: section attempts only to make the reader aware of the utilities and when
3253: they might be useful, and not to duplicate the documentation that comes
3254: with each package.</p>
3255: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3256: <div class="itemizedlist"><ul type="disc"><li><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 3257: Symlinks for use by buildlink.</p></li></ul></div>
3258: <p>OS tool augmentation (automatically installed when needed):</p>
3259: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3260: <li><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 3261: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3262: <li><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 3263: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3264: <li><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 3265: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3266: <li><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 3267: Up-to-date replacement for
1.76 rillig 3268: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3269: systems where pkg_install is not present.</p></li>
3270: </ul></div>
3271: <p>Utilities used by pkgsrc (not automatically installed):</p>
3272: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3273: <li><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 3274: Create a binary package from an
1.110 hubertf 3275: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 3276: save the old package.</p></li>
1.91 rillig 3277: <li><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 3278: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3279: from multiple locations. It currently supports the following
3280: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3281: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
1.75 rillig 3282: packages someplace else (enabled by default).</p></li>
1.117 ! jnemeth 3283: <li><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
! 3284: the best compiler flags to optimise code for your current
! 3285: CPU and compiler. Setting <code class="varname">USE_CPUFLAGS</code> to
! 3286: yes in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use
! 3287: cpuflags. </p></li>
1.75 rillig 3288: </ul></div>
3289: <p>Utilities for keeping track of installed packages, being up to date,
3290: etc:</p>
3291: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3292: <li><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 3293: packages whose installed versions do not match the latest pkgsrc
3294: entries.</p></li>
1.91 rillig 3295: <li><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 3296: dependency graphs of packages, to aid in choosing a strategy for
3297: updating.</p></li>
1.91 rillig 3298: <li><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
3299: 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>
3300: <li><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 3301: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
3302: <li><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 3303: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3304: <li><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 3305: packages you have installed.</p></li>
3306: </ul></div>
3307: <p>Utilities for people maintaining or creating individual packages:</p>
3308: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3309: <li><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 3310: making and maintaining patches for a package (includes pkgdiff,
3311: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3312: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
3313: <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 3314: converting to pkgsrc.</p></li>
1.91 rillig 3315: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
1.75 rillig 3316: pkgsrc to a Solaris package.</p></li>
3317: </ul></div>
3318: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3319: utilities)</p>
3320: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3321: <li><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 3322: packages in a chrooted area.</p></li>
1.91 rillig 3323: <li><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 3324: kernel version for chrooted cross builds.</p></li>
3325: </ul></div>
3326: </div>
3327: <div class="sect1" lang="en">
3328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3329: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3330: <p>If you want to use pkgsrc as non-root user, you can set some
3331: variables to make pkgsrc work under these conditions. At the very least,
3332: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3333: will turn on unprivileged mode and set multiple related variables to allow
3334: installation of packages as non-root.</p>
3335: <p>In case the defaults are not enough, you may want to tune some other
3336: variables used. For example, if the automatic user/group detection leads
3337: to incorrect values (or not the ones you would like to use), you can change
3338: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3339: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3340: <p>As regards bootstrapping, please note that the
1.110 hubertf 3341: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75 rillig 3342: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3343: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3344: installation targets. These directories can be overridden by the
1.75 rillig 3345: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3346: that allow finer tuning of the tree layout.</p>
3347: </div>
3348: <div class="sect1" lang="en">
3349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3350: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3351: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3352: enable this feature by adding the option
3353: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3354: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3355: distfile is found, pkgsrc will try to resume it.</p>
3356: <p>You can also
1.110 hubertf 3357: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.117 ! jnemeth 3358: <code class="varname">FETCH_USING</code> variable. You can specify the program by
! 3359: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
! 3360: by using the value manual. A value of custom disables the system defaults
! 3361: and dependency tracking for the fetch program. In that case you have to
! 3362: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
! 3363: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
! 3364: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3365: <p>For example, if you want to use
1.117 ! jnemeth 3366: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3367: like:</p>
3368: <pre class="programlisting">
1.117 ! jnemeth 3369: FETCH_USING= wget
1.1 grant 3370: </pre>
1.75 rillig 3371: </div>
3372: <div class="sect1" lang="en">
3373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3374: <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 3375: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3376: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3377: you will have to add the following line into
1.110 hubertf 3378: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3379: <pre class="programlisting">
1.103 wiz 3380: X11_TYPE=modular
1.1 grant 3381: </pre>
1.75 rillig 3382: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3383: <h3 class="title">Note</h3>
1.103 wiz 3384: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3385: </p>
1.75 rillig 3386: </div>
3387: </div>
3388: <div class="sect1" lang="en">
3389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3390: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3391: <p>If you are sitting behind a firewall which does not allow direct
3392: connections to Internet hosts (i.e. non-NAT), you may specify the
3393: relevant proxy hosts. This is done using an environment variable in the
3394: form of a URL, e.g. in Amdahl, the machine
3395: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3396: port 80 as the proxy port number. So the proxy environment variables
3397: are:</p>
3398: <pre class="programlisting">
1.100 rillig 3399: ftp_proxy=ftp://orpheus.amdahl.com:80/
3400: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3401: </pre>
1.75 rillig 3402: </div>
3403: <div class="sect1" lang="en">
3404: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 3405: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3406: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3407: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3408: the first available command from the following list:</p>
3409: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3410: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3411: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3412: </ul></div>
3413: <p>On a default NetBSD installation, this will be
1.76 rillig 3414: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3415: connections first, and falls back to active connections if the server
3416: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3417: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3418: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3419: <p>Having that option present will prevent
1.76 rillig 3420: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3421: transfers.</p>
3422: </div>
3423: <div class="sect1" lang="en">
3424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3425: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3426: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3427: from work or university, where you can't run a <span class="command"><strong>make
3428: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 3429: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3430: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3431: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3432: resulting list to your machine at work/school and use it there. If you
1.110 hubertf 3433: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 3434: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3435: URL:</p>
3436: <p>At home:</p>
3437: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3438: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3439: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3440: <p>At work:</p>
3441: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3442: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3443: home.</p>
3444: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3445: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3446: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3447: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3448: directly by running:</p>
1.75 rillig 3449: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3450: <p>If you even decide to ignore
3451: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3452: by running:</p>
3453: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3454: </div>
3455: <div class="sect1" lang="en">
3456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3457: <a name="tmac.andoc-missing"></a>9.10. What does “<span class="quote">Don't know how to make
1.75 rillig 3458: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3459: <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 3460: package, you get the error from make that it doesn't know how to make
1.76 rillig 3461: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3462: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3463: the NetBSD base distribution on your machine. It is recommended to do
3464: that to format man pages.</p>
1.91 rillig 3465: <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 3466: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3467: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3468: </div>
3469: <div class="sect1" lang="en">
3470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3471: <a name="bsd.own.mk-missing"></a>9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</h2></div></div></div>
1.87 wiz 3472: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3473: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3474: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3475: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3476: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3477: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3478: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3479: -r</strong></span>).</p>
3480: </div>
3481: <div class="sect1" lang="en">
3482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3483: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3484: <p>When installing packages as non-root user and using the just-in-time
1.110 hubertf 3485: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><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 3486: password for each required package installed. To avoid this, the sudo
3487: package can be used, which does password caching over a limited time. To
3488: use it, install sudo (either as binary package or from
1.98 wiz 3489: <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 3490: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3491: <span class="emphasis"><em>after</em></span> the definition of the
3492: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3493: <pre class="programlisting">
1.100 rillig 3494: .if exists(${LOCALBASE}/bin/sudo)
3495: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3496: .endif
1.1 grant 3497: </pre>
1.75 rillig 3498: </div>
3499: <div class="sect1" lang="en">
3500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3501: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3502: <p>As the system administrator, you can choose where configuration files
3503: are installed. The default settings make all these files go into
1.76 rillig 3504: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3505: be suboptimal depending on your expectations (e.g., a read-only,
3506: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3507: configuration of the provided packages).</p>
3508: <p>In order to change the defaults, you can modify the
3509: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3510: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3511: directory; some common examples include <code class="filename">/etc</code> or
3512: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3513: <p>Furthermore, you can change this value on a per-package basis by
3514: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3515: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3516: package you would like to modify, that is, the contents of
3517: <code class="varname">PKGBASE</code>.</p>
3518: <p>Note that after changing these settings, you must rebuild and
3519: reinstall any affected packages.</p>
3520: </div>
3521: <div class="sect1" lang="en">
3522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3523: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3524: <p>Please be aware that there can often be bugs in third-party software,
3525: and some of these bugs can leave a machine vulnerable to exploitation by
3526: attackers. In an effort to lessen the exposure, the NetBSD packages team
3527: maintains a database of known-exploits to packages which have at one time
3528: been included in pkgsrc. The database can be downloaded automatically, and
3529: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3530: do this, refer to the following two tools (installed as part of the
3531: <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.75 rillig 3532: <div class="orderedlist"><ol type="1">
3533: <li>
1.110 hubertf 3534: <p><span class="command"><strong>download-vulnerability-list</strong></span>, an easy way to
1.75 rillig 3535: download a list of the security vulnerabilities information. This list
3536: is kept up to date by the NetBSD security officer and the NetBSD
3537: packages team, and is distributed from the NetBSD ftp server:</p>
1.110 hubertf 3538: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.75 rillig 3539: </li>
1.110 hubertf 3540: <li><p><span class="command"><strong>audit-packages</strong></span>, an easy way to audit the
1.75 rillig 3541: current machine, checking each vulnerability which is known. If a
3542: vulnerable package is installed, it will be shown by output to stdout,
3543: including a description of the type of vulnerability, and a URL
3544: containing more information.</p></li>
3545: </ol></div>
1.114 jmcneill 3546: <p>Use of these tools is strongly recommended! After
3547: “<span class="quote">pkg_install</span>” is installed, please read
1.75 rillig 3548: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3549: pkg_install</code></strong>.</p>
1.87 wiz 3550: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3551: 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 3552: check.</p>
1.75 rillig 3553: </div>
3554: <div class="sect1" lang="en">
3555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3556: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3557: <p>When you add your own preferences to the
3558: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3559: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3560: environment variables to the <code class="filename">./configure</code>
1.110 hubertf 3561: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3562: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3563: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3564: package.</p>
3565: <p>Currently there is no solution to this problem. If you
3566: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3567: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3568: directory and then inspect any <code class="filename">Makefile</code> and
3569: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3570: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3571: these lines. But be aware that some “<span class="quote">smart</span>”
3572: programmers write so bad code that it only works for the
3573: specific combination of <code class="varname">CFLAGS</code> they have
3574: chosen.</p>
3575: </div>
1.80 rillig 3576: <div class="sect1" lang="en">
3577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3578: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3579: <div class="procedure"><ol type="1">
3580: <li><p>Make sure that your copy of pkgsrc is consistent. A
3581: case that occurs often is that people only update pkgsrc in
3582: parts, because of performance reasons. Since pkgsrc is one large
3583: system, not a collection of many small systems, there are
3584: sometimes changes that only work when the whole pkgsrc tree is
3585: updated.</p></li>
3586: <li><p>Make sure that you don't have any CVS conflicts.
3587: Search for “<span class="quote"><<<<<<</span>” or
3588: “<span class="quote">>>>>>></span>” in all your pkgsrc
3589: files.</p></li>
3590: <li><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3591: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3592: verify this.</p></li>
3593: <li><p>If the problem still exists, write a mail to the
3594: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3595: </ol></div>
3596: </div>
1.88 wiz 3597: <div class="sect1" lang="en">
3598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3599: <a name="faq.rcs-conflicts"></a>9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</h2></div></div></div>
1.89 rillig 3600: <p>You have modified a file from pkgsrc, and someone else has
3601: modified that same file afterwards in the CVS repository. Both changes
3602: are in the same region of the file, so when you updated pkgsrc, the
3603: <code class="literal">cvs</code> command marked the conflicting changes in the
3604: file. Because of these markers, the file is no longer a valid
3605: <code class="filename">Makefile</code>.</p>
3606: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3607: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3608: -dP</strong></span> in that directory to download the current version.</p>
3609: </div>
1.75 rillig 3610: </div>
3611: </div>
3612: <div class="part" lang="en">
3613: <div class="titlepage"><div><div><h1 class="title">
3614: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3615: <div class="partintro" lang="en">
3616: <div></div>
3617: <p>This part of the book deals with creating and
3618: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3619: guide on creating a new package. The remaining chapters are more
3620: like a reference manual for pkgsrc.</p>
1.75 rillig 3621: <div class="toc">
3622: <p><b>Table of Contents</b></p>
3623: <dl>
1.106 rillig 3624: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3625: <dd><dl>
1.106 rillig 3626: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3627: <dd><dl>
1.106 rillig 3628: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3629: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91 rillig 3630: </dl></dd>
1.106 rillig 3631: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3632: <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>
3633: </dl></dd>
3634: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3635: <dd><dl>
1.116 rillig 3636: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
3637: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106 rillig 3638: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3639: <dd><dl>
3640: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3641: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3642: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3643: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3644: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3645: </dl></dd>
3646: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3647: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3648: <dd><dl>
3649: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3650: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3651: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3652: </dl></dd>
1.116 rillig 3653: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
3654: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106 rillig 3655: </dl></dd>
1.116 rillig 3656: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106 rillig 3657: <dd><dl>
3658: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116 rillig 3659: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106 rillig 3660: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3661: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3662: <dd><dl>
3663: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3664: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3665: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3666: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3667: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3668: </dl></dd>
3669: </dl></dd>
3670: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3671: <dd><dl>
3672: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116 rillig 3673: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
3674: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106 rillig 3675: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3676: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116 rillig 3677: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106 rillig 3678: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3679: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3680: </dl></dd>
3681: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3682: <dd><dl>
3683: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116 rillig 3684: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106 rillig 3685: <dd><dl>
3686: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116 rillig 3687: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.106 rillig 3688: </dl></dd>
1.116 rillig 3689: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106 rillig 3690: <dd><dl>
1.116 rillig 3691: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106 rillig 3692: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3693: </dl></dd>
3694: </dl></dd>
3695: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3696: <dd><dl>
3697: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3698: <dd><dl>
3699: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3700: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3701: </dl></dd>
3702: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3703: <dd><dl>
1.116 rillig 3704: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106 rillig 3705: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3706: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3707: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3708: </dl></dd>
3709: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3710: <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>
3711: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3712: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3713: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3714: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3715: <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>
3716: </dl></dd>
3717: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3718: <dd><dl>
3719: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116 rillig 3720: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106 rillig 3721: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3722: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3723: </dl></dd>
3724: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3725: <dd><dl>
3726: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3727: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3728: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3729: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116 rillig 3730: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106 rillig 3731: <dd><dl>
3732: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3733: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3734: </dl></dd>
1.116 rillig 3735: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
3736: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
3737: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
3738: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
3739: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
3740: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
3741: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
3742: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
3743: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
3744: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106 rillig 3745: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3746: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3747: </dl></dd>
3748: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3749: <dd><dl>
3750: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3751: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3752: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3753: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3754: </dl></dd>
3755: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3756: <dd><dl>
3757: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3758: <dd><dl>
3759: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116 rillig 3760: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106 rillig 3761: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3762: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3763: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3764: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3765: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3766: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3767: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3768: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3769: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3770: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3771: </dl></dd>
1.116 rillig 3772: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106 rillig 3773: <dd><dl>
3774: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3775: <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>
3776: </dl></dd>
1.116 rillig 3777: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106 rillig 3778: <dd><dl>
3779: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3780: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3781: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3782: </dl></dd>
3783: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3784: <dd><dl>
3785: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3786: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3787: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3788: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3789: </dl></dd>
1.116 rillig 3790: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106 rillig 3791: <dd><dl>
3792: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3793: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116 rillig 3794: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106 rillig 3795: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3796: </dl></dd>
1.116 rillig 3797: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106 rillig 3798: <dd><dl>
3799: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3800: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3801: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3802: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3803: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3804: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3805: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3806: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3807: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106 rillig 3808: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
3809: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3810: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3811: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3812: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3813: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3814: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3815: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3816: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3817: emulation</a></span></dt>
1.106 rillig 3818: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3819: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3820: </dl></dd>
1.106 rillig 3821: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3822: </dl></dd>
1.106 rillig 3823: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3824: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3825: <dd><dl>
1.106 rillig 3826: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3827: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3828: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3829: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3830: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
3831: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
3832: </dl></dd>
3833: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3834: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3835: <dd><dl>
3836: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3837: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3838: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3839: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3840: </dl></dd>
1.75 rillig 3841: </dl>
3842: </div>
1.77 rillig 3843: </div>
3844: <div class="chapter" lang="en">
3845: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3846: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3847: <div class="toc">
3848: <p><b>Table of Contents</b></p>
3849: <dl>
1.106 rillig 3850: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3851: <dd><dl>
1.106 rillig 3852: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3853: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91 rillig 3854: </dl></dd>
1.106 rillig 3855: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3856: <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 3857: </dl>
3858: </div>
1.77 rillig 3859: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3860: most likely have a URL from where you can download the source
3861: code. Starting with this URL, creating a package involves only a
3862: few steps.</p>
1.77 rillig 3863: <div class="procedure"><ol type="1">
1.91 rillig 3864: <li><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.77 rillig 3865: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3866: category in which you want to place your package. You can also create a
3867: directory of your own (maybe called <code class="filename">local</code>). In that
3868: category directory, create another directory for your package and change
3869: into it.</p></li>
1.110 hubertf 3870: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3871: you for a URL. Enter the URL of the distribution file (in most cases a
3872: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3873: of your package are created automatically. The distribution file is
3874: extracted automatically to fill in some details in the
3875: <code class="filename">Makefile</code> that would otherwise have to be done
3876: manually.</p></li>
3877: <li>
3878: <p>Examine the extracted files to determine the dependencies of
3879: your package. Ideally, this is mentioned in some
3880: <code class="filename">README</code> file, but things may differ. For each of
3881: these dependencies, look where it exists in pkgsrc, and if there is a
3882: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3883: line to your package <code class="filename">Makefile</code> which includes that
3884: file just before the last line. If the
3885: <code class="filename">buildlink3.mk</code> file does not exist, add a
3886: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3887: version of the dependency and where it can be found in pkgsrc. This line
3888: should be placed in the third paragraph. If the dependency is only
3889: needed for building the package, but not when using it, use
3890: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3891: Your package may then look like this:</p>
1.77 rillig 3892: <pre class="programlisting">
1.100 rillig 3893: [...]
1.77 rillig 3894:
1.100 rillig 3895: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3896: DEPENDS+= screen-[0-9]*:../../misc/screen
3897: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3898:
1.100 rillig 3899: [...]
1.77 rillig 3900:
1.100 rillig 3901: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3902: .include "../../devel/glib2/buildlink3.mk"
3903: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3904: </pre>
3905: </li>
1.110 hubertf 3906: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91 rillig 3907: to be done to make your package a “<span class="quote">good</span>” one. If you don't
1.110 hubertf 3908: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3909: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3910: -e</strong></span>, which outputs additional
3911: explanations.</p></li>
3912: <li><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3913: 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 3914: over there, you can hopefully continue here.</p></li>
1.110 hubertf 3915: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3916: directory from the extracted files. Besides these files, a lot of cache
3917: files and other system information has been saved in the working
3918: directory, which may become wrong after you edited the
3919: <code class="filename">Makefile</code>.</p></li>
1.110 hubertf 3920: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
3921: 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.91 rillig 3922: <li><p>When the package builds fine, the next step is to install
1.110 hubertf 3923: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3924: everything works.</p></li>
3925: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3926: contains a list of the files that are installed by the package, is
1.110 hubertf 3927: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3928: >PLIST</strong></span> to generate a probably correct list. Check
3929: the file using your preferred text editor to see if the list of
3930: files looks plausible.</p></li>
1.110 hubertf 3931: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3932: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110 hubertf 3933: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3934: has been registered in the database of installed files, but with an
1.110 hubertf 3935: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3936: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3937: registered with the list of files from
3938: <code class="filename">PLIST</code>.</p></li>
1.110 hubertf 3939: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3940: package from the set of installed files.</p></li>
1.77 rillig 3941: </ol></div>
1.91 rillig 3942: <div class="sect1" lang="en">
3943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3944: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91 rillig 3945: <div class="sect2" lang="en">
3946: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3947: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3948: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3949: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3950: </div>
3951: <div class="sect2" lang="en">
3952: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3953: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91 rillig 3954: <p>KDE applications should always include
3955: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3956: settings that are typical of KDE packages.</p>
3957: </div>
3958: </div>
3959: <div class="sect1" lang="en">
3960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3961: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91 rillig 3962: <div class="sect2" lang="en">
3963: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3964: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91 rillig 3965: <div class="sect3" lang="en">
3966: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3967: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3968: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
3969: that the “<span class="quote">nvu</span>” package has not yet been imported into
3970: pkgsrc. As the description says it has to do with the web, the obvious
3971: choice for the category is “<span class="quote">www</span>”.</p>
3972: <pre class="programlisting">
1.100 rillig 3973: <code class="prompt">$</code> mkdir www/nvu
3974: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3975: </pre>
3976: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3977: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3978: <pre class="programlisting">
1.100 rillig 3979: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3980: </pre>
3981: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3982: below the <code class="varname">DISTNAME</code> line, as the package name should
3983: not have the word “<span class="quote">sources</span>” in it. I also filled in the
3984: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3985: <code class="varname">COMMENT</code> fields. Then the package
3986: <code class="filename">Makefile</code> looked like that:</p>
3987: <pre class="programlisting">
1.100 rillig 3988: # $NetBSD$
3989: #
1.91 rillig 3990:
1.100 rillig 3991: DISTNAME= nvu-1.0-sources
3992: PKGNAME= nvu-1.0
3993: CATEGORIES= www
3994: MASTER_SITES= http://cvs.nvu.com/download/
3995: EXTRACT_SUFX= .tar.bz2
3996:
3997: MAINTAINER= rillig@NetBSD.org
3998: HOMEPAGE= http://cvs.nvu.com/
3999: COMMENT= Web Authoring System
1.91 rillig 4000:
1.100 rillig 4001: # url2pkg-marker (please do not remove this line.)
4002: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4003: </pre>
4004: <p>Then, I quit the editor and watched pkgsrc downloading a large
4005: source archive:</p>
4006: <pre class="programlisting">
1.100 rillig 4007: url2pkg> Running "make makesum" ...
4008: => Required installed package digest>=20010302: digest-20060826 found
4009: => Fetching nvu-1.0-sources.tar.bz2
4010: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4011: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4012: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4013: url2pkg> Running "make extract" ...
4014: => Required installed package digest>=20010302: digest-20060826 found
4015: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4016: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4017: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4018: ===> Installing dependencies for nvu-1.0
4019: ===> Overriding tools for nvu-1.0
4020: ===> Extracting for nvu-1.0
4021: url2pkg> Adjusting the Makefile.
1.91 rillig 4022:
1.100 rillig 4023: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4024:
1.100 rillig 4025: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4026: </pre>
4027: </div>
4028: <div class="sect3" lang="en">
4029: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4030: <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 4031: <p>Now that the package has been extracted, let's see what's inside
4032: it. The package has a <code class="filename">README.txt</code>, but that only
4033: says something about mozilla, so it's probably useless for seeing what
4034: dependencies this package has. But since there is a GNU configure script
4035: in the package, let's hope that it will complain about everything it
4036: needs.</p>
4037: <pre class="programlisting">
1.100 rillig 4038: <code class="prompt">$</code> bmake
4039: => Required installed package digest>=20010302: digest-20060826 found
4040: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4041: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4042: ===> Patching for nvu-1.0
4043: ===> Creating toolchain wrappers for nvu-1.0
4044: ===> Configuring for nvu-1.0
4045: [...]
4046: configure: error: Perl 5.004 or higher is required.
4047: [...]
4048: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4049: [...]
1.91 rillig 4050: </pre>
4051: <p>That worked quite well. So I opened the package Makefile in my
4052: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4053: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4054: package have changed now, and since a perl wrapper is automatically
4055: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4056: from scratch.</p>
4057: <pre class="programlisting">
1.100 rillig 4058: <code class="prompt">$</code> bmake clean
4059: ===> Cleaning for nvu-1.0
4060: <code class="prompt">$</code> bmake
4061: [...]
4062: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4063: GNU Make. You will not be able to build Mozilla without GNU Make.
4064: [...]
1.91 rillig 4065: </pre>
4066: <p>So I added “<span class="quote">gmake</span>” to the
4067: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4068: <pre class="programlisting">
1.100 rillig 4069: [...]
4070: checking for GTK - version >= 1.2.0... no
4071: *** Could not run GTK test program, checking why...
4072: [...]
1.91 rillig 4073: </pre>
4074: <p>Now to the other dependencies. The first question is: Where is the
4075: GTK package hidden in pkgsrc?</p>
4076: <pre class="programlisting">
1.100 rillig 4077: <code class="prompt">$</code> echo ../../*/gtk*
4078: [many packages ...]
4079: <code class="prompt">$</code> echo ../../*/gtk
4080: ../../x11/gtk
4081: <code class="prompt">$</code> echo ../../*/gtk2
4082: ../../x11/gtk2
4083: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4084: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4085: </pre>
4086: <p>The first try was definitely too broad. The second one had exactly
4087: one result, which is very good. But there is one pitfall with GNOME
4088: packages. Before GNOME 2 had been released, there were already many
4089: GNOME 1 packages in pkgsrc. To be able to continue to use these
4090: packages, the GNOME 2 packages were imported as separate packages, and
4091: their names usually have a “<span class="quote">2</span>” appended. So I checked
4092: whether this was the case here, and indeed it was.</p>
4093: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4094: file, adding the dependency is very easy. I just inserted an
4095: <code class="literal">.include</code> line before the last line of the package
4096: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4097: <pre class="programlisting">
1.100 rillig 4098: [...]
4099: .include "../../x11/gtk2/buildlink3.mk"
4100: .include "../../mk/bsd.pkg.mk
1.91 rillig 4101: </pre>
1.110 hubertf 4102: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 4103: was:</p>
4104: <pre class="programlisting">
1.100 rillig 4105: [...]
4106: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4107: checking for GTK - version >= 1.2.0... no
4108: *** Could not run GTK test program, checking why...
4109: *** The test program failed to compile or link. See the file config.log for the
4110: *** exact error that occured. This usually means GTK was incorrectly installed
4111: *** or that you have moved GTK since it was installed. In the latter case, you
4112: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4113: configure: error: Test for GTK failed.
4114: [...]
1.91 rillig 4115: </pre>
4116: <p>In this particular case, the assumption that “<span class="quote">every package
4117: prefers GNOME 2</span>” had been wrong. The first of the lines above
4118: told me that this package really wanted to have the GNOME 1 version of
4119: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 4120: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 4121: So I changed the <code class="literal">x11/gtk2</code> to
4122: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4123: and tried again.</p>
4124: <pre class="programlisting">
1.100 rillig 4125: [...]
4126: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0 -I/home/roland/pkg/include -I/usr/include -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
4127: In file included from xpidl.c:42:
4128: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4129: In file included from xpidl.c:42:
4130: xpidl.h:132: error: parse error before "IDL_ns"
4131: [...]
1.91 rillig 4132: </pre>
4133: <p>The package still does not find all of its dependencies. Now the
4134: question is: Which package provides the
4135: <code class="filename">libIDL/IDL.h</code> header file?</p>
4136: <pre class="programlisting">
1.100 rillig 4137: <code class="prompt">$</code> echo ../../*/*idl*
4138: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4139: <code class="prompt">$</code> echo ../../*/*IDL*
4140: ../../net/libIDL
1.91 rillig 4141: </pre>
4142: <p>Let's take the one from the second try. So I included the
4143: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4144: again. But the error didn't change. After digging through some of the
4145: code, I concluded that the build process of the package was broken and
4146: couldn't have ever worked, but since the Mozilla source tree is quite
4147: large, I didn't want to fix it. So I added the following to the package
4148: <code class="filename">Makefile</code> and tried again:</p>
4149: <pre class="programlisting">
1.100 rillig 4150: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4151: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4152: </pre>
4153: <p>The latter line is needed because the package expects the library
4154: <code class="filename">libIDL.so</code>, but only
4155: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4156: wrapper to rewrite that on the fly.</p>
4157: <p>The next problem was related to a recent change of the FreeType
4158: 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>
4159: which patch files were relevant for this issue and copied them to the
4160: <code class="filename">patches</code> directory. Then I retried, fixed the
4161: patches so that they applied cleanly and retried again. This time,
4162: everything worked.</p>
4163: </div>
4164: <div class="sect3" lang="en">
4165: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4166: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 4167: <pre class="programlisting">
1.100 rillig 4168: <code class="prompt">$</code> bmake CHECK_FILES=no install
4169: [...]
4170: <code class="prompt">$</code> bmake print-PLIST >PLIST
4171: <code class="prompt">$</code> bmake deinstall
4172: <code class="prompt">$</code> bmake install
1.91 rillig 4173: </pre>
4174: </div>
4175: </div>
4176: </div>
1.77 rillig 4177: </div>
1.75 rillig 4178: <div class="chapter" lang="en">
4179: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4180: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4181: <div class="toc">
4182: <p><b>Table of Contents</b></p>
4183: <dl>
1.116 rillig 4184: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
4185: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106 rillig 4186: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4187: <dd><dl>
4188: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4189: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4190: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4191: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4192: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4193: </dl></dd>
4194: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4195: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4196: <dd><dl>
4197: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4198: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4199: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4200: </dl></dd>
1.116 rillig 4201: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
4202: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.75 rillig 4203: </dl>
4204: </div>
1.87 wiz 4205: <p>Whenever you're preparing a package, there are a number of
4206: files involved which are described in the following
4207: sections.</p>
1.75 rillig 4208: <div class="sect1" lang="en">
4209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4210: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4211: </h2></div></div></div>
1.75 rillig 4212: <p>Building, installation and creation of a binary package are all
1.87 wiz 4213: controlled by the package's <code class="filename">Makefile</code>.
4214: The <code class="filename">Makefile</code> describes various things about
4215: a package, for example from where to get it, how to configure,
4216: build, and install it.</p>
1.76 rillig 4217: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4218: sections that describe the package.</p>
1.75 rillig 4219: <p>In the first section there are the following variables, which
1.87 wiz 4220: should appear exactly in the order given here. The order and
4221: grouping of the variables is mostly historical and has no further
4222: meaning.</p>
1.75 rillig 4223: <div class="itemizedlist"><ul type="disc">
4224: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4225: distribution file to be downloaded from the package's
4226: website.</p></li>
1.75 rillig 4227: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4228: package, as used by pkgsrc. You only need to provide it if
4229: <code class="varname">DISTNAME</code> (which is the default) is not a good
4230: name for the package in pkgsrc. Usually it is the pkgsrc
4231: directory name together with the version number. It must match the
4232: regular expression
4233: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4234: starts with a letter or digit, and contains only letters, digits,
4235: dashes, underscores, dots and plus signs.</p></li>
4236: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4237: the package file to create if the <code class="varname">PKGNAME</code>
4238: isn't unique on a SVR4 system. The default is
4239: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4240: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
1.87 wiz 4241: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4242: does not produce an unique package name on a SVR4 system.
4243: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4244: characters.</p></li>
1.75 rillig 4245: <li>
4246: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4247: which the package fits in. You can choose any of the top-level
4248: directories of pkgsrc for it.</p>
1.75 rillig 4249: <p>Currently the following values are available for
1.87 wiz 4250: <code class="varname">CATEGORIES</code>. If more than
4251: one is used, they need to be separated by spaces:</p>
1.75 rillig 4252: <pre class="programlisting">
1.100 rillig 4253: archivers cross geography meta-pkgs security
4254: audio databases graphics misc shells
4255: benchmarks devel ham multimedia sysutils
4256: biology editors inputmethod net textproc
4257: cad emulators lang news time
4258: chat finance mail parallel wm
4259: comms fonts math pkgtools www
4260: converters games mbone print x11
4261: </pre>
1.75 rillig 4262: </li>
1.81 rillig 4263: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4264: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4265: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4266: and <code class="varname">DISTFILES</code> are discussed in detail in
1.116 rillig 4267: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The fetch phase”</a>.</p></li>
1.75 rillig 4268: </ul></div>
4269: <p>The second section contains information about separately
1.87 wiz 4270: downloaded patches, if any.
4271: </p>
1.75 rillig 4272: <div class="itemizedlist"><ul type="disc">
4273: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4274: Name(s) of additional files that contain distribution patches.
4275: There is no default. pkgsrc will look for them at
4276: <code class="varname">PATCH_SITES</code>.
4277: They will automatically be uncompressed before patching if
4278: the names end with <code class="filename">.gz</code> or
4279: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4280: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4281: Primary location(s) for distribution patch files (see
4282: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4283: </ul></div>
4284: <p>The third section contains the following variables.
1.87 wiz 4285: </p>
1.75 rillig 4286: <div class="itemizedlist"><ul type="disc">
1.114 jmcneill 4287: <li><p><code class="varname">MAINTAINER</code> is the email
4288: address of the person who feels responsible for this package,
4289: and who is most likely to look at problems or questions regarding
4290: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
4291: Other developers may contact the <code class="varname">MAINTAINER</code>
4292: before making changes to the package, but are not required to
4293: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4294: to yourself. If you really can't maintain the package for future
4295: updates, set it to
1.110 hubertf 4296: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.114 jmcneill 4297: <li><p><code class="varname">OWNER</code> should be used instead
4298: of <code class="varname">MAINTAINER</code> when you do not want other
4299: developers to update or change the package without contacting
4300: you first. A package Makefile should contain one of
4301: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4302: not both. </p></li>
1.75 rillig 4303: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4304: find more information about the package.</p></li>
1.75 rillig 4305: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4306: description of the package (should not include the package
4307: name).</p></li>
1.75 rillig 4308: </ul></div>
4309: <p>Other variables that affect the build:
1.87 wiz 4310: </p>
1.75 rillig 4311: <div class="itemizedlist"><ul type="disc"><li>
4312: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4313: interesting distribution files of the package are found. The
4314: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4315: works for most packages.</p>
1.75 rillig 4316: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4317: (most GNU software does, for instance), but extracts itself in
4318: the current directory, you should set
4319: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4320: <p>If a package doesn't create a subdirectory with the
4321: name of <code class="varname">DISTNAME</code> but some different name,
4322: set <code class="varname">WRKSRC</code> to point to the proper name in
4323: <code class="filename">${WRKDIR}</code>, for example
4324: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4325: <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 4326: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4327: taken from the <code class="varname">WRKDIR_BASENAME</code>
4328: variable. By default, its value is
4329: <code class="filename">work</code>. If you want to use the same
4330: pkgsrc tree for building different kinds of binary packages,
4331: you can change the variable according to your needs. Two
4332: other variables handle common cases of setting
4333: <code class="varname">WRKDIR_BASENAME</code> individually. If
4334: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4335: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4336: the host's name is attached to the directory name. If
4337: <code class="varname">OBJMACHINE</code> is defined, the platform name
4338: is attached, which might look like
4339: <code class="filename">work.i386</code> or
4340: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4341: </li></ul></div>
4342: <p>Please pay attention to the following gotchas:</p>
4343: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4344: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4345: installed in compressed form by the package. For packages using
4346: BSD-style makefiles which honor MANZ, there is
4347: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4348: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4349: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4350: below).</p></li>
1.110 hubertf 4351: <li><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 4352: </ul></div>
4353: </div>
4354: <div class="sect1" lang="en">
4355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4356: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4357: </h2></div></div></div>
1.76 rillig 4358: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4359: digest, or checksum, of each distfile needed for the package. This
4360: ensures that the distfiles retrieved from the Internet have not been
4361: corrupted during transfer or altered by a malign force to introduce
4362: a security hole. Due to recent rumor about weaknesses of digest
4363: algorithms, all distfiles are protected using both SHA1 and RMD160
4364: message digests, as well as the file size.</p>
1.76 rillig 4365: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4366: checksums for all the patches found in the
1.110 hubertf 4367: <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 4368: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4369: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4370: command.</p>
1.75 rillig 4371: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4372: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
1.87 wiz 4373: <code class="filename">distinfo</code> file and care should be taken when
4374: upgrading such a package to ensure distfile information is not
4375: lost.</p>
1.75 rillig 4376: </div>
4377: <div class="sect1" lang="en">
4378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4379: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4380: <p>Many packages still don't work out-of-the box on the various
4381: platforms that are supported by pkgsrc. Therefore, a number of custom
4382: patch files are needed to make the package work. These patch files are
4383: found in the <code class="filename">patches/</code> directory.</p>
4384: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4385: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4386: 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.93 rillig 4387: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4388: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4389: <div class="sect2" lang="en">
4390: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4391: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4392: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4393: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4394: problems. (To force patches to apply with fuzz you can set
4395: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4396: should contain only changes for a single file, and no file should be
1.93 rillig 4397: patched by more than one patch file. This helps to keep future
4398: modifications simple.</p>
4399: <p>Each patch file is structured as follows: In the first line,
4400: there is the RCS Id of the patch itself. The second line should be
4401: empty for aesthetic reasons. After that, there should be a comment for
4402: each change that the patch does. There are a number of standard
4403: cases:</p>
4404: <div class="itemizedlist"><ul type="disc">
4405: <li><p>Patches that replace the <code class="literal">==</code>
1.110 hubertf 4406: operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.111 rillig 4407: are so common that they don't need a comment at all.</p></li>
1.93 rillig 4408: <li><p>Patches for commonly known vulnerabilities should
4409: mention the vulnerability ID (CAN, CVE).</p></li>
4410: <li><p>Patches that change source code should mention the
4411: platform and other environment (for example, the compiler) that the
4412: patch is needed for.</p></li>
4413: </ul></div>
4414: <p>In all other cases, the patch should be commented so that any
4415: developer who knows the code of the application can make some use of
4416: the patch. Special care should be taken for the upstream developers,
4417: since we generally want that they accept our patches, so we have less
4418: work in the future.</p>
4419: </div>
4420: <div class="sect2" lang="en">
4421: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4422: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4423: <p>One important thing to mention is to pay attention that no RCS
4424: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4425: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4426: <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 4427: problems.</p>
1.87 wiz 4428: <p>For even more automation, we recommend using
1.110 hubertf 4429: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4430: whole set of patches. You just have to backup files before you
4431: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4432: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4433: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4434: you upgrade a package this way, you can easily compare the new
4435: set of patches with the previously existing one with
1.110 hubertf 4436: <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87 wiz 4437: or update from the <code class="filename">work/.newpatches</code>
4438: directory to <code class="filename">patches/</code>.</p>
4439: <p>When you have finished a package, remember to generate
1.110 hubertf 4440: the checksums for the patch files by using the <span class="command"><strong>make
1.116 rillig 4441: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “distinfo”</a>.</p>
1.87 wiz 4442: <p>When adding a patch that corrects a problem in the
4443: distfile (rather than e.g. enforcing pkgsrc's view of where
4444: man pages should go), send the patch as a bug report to the
4445: maintainer. This benefits non-pkgsrc users of the package,
4446: and usually makes it possible to remove the patch in future
4447: version.</p>
1.101 rillig 4448: <p>The file names of the patch files are usually of the form
4449: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4450: </div>
4451: <div class="sect2" lang="en">
4452: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4453: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4454: <p>If you want to share patches between multiple packages
4455: in pkgsrc, e.g. because they use the same distfiles, set
4456: <code class="varname">PATCHDIR</code> to the path where the patch files
4457: can be found, e.g.:</p>
4458: <pre class="programlisting">
1.100 rillig 4459: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4460: </pre>
1.75 rillig 4461: <p>Patch files that are distributed by the author or other
1.87 wiz 4462: maintainers can be listed in
4463: <code class="varname">PATCHFILES</code>.</p>
4464: <p>If it is desired to store any patches that should not be
4465: committed into pkgsrc, they can be kept outside the pkgsrc
4466: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4467: directory tree there is expected to have the same
4468: “<span class="quote">category/package</span>” structure as pkgsrc, and
4469: patches are expected to be stored inside these dirs (also
4470: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4471: example, if you want to keep a private patch for
4472: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4473: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4474: files in the named directory are expected to be patch files,
4475: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4476: applied</em></span>.</p>
1.93 rillig 4477: </div>
1.85 jmmv 4478: <div class="sect2" lang="en">
4479: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4480: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4481: <p>When fixing a portability issue in the code do not use
4482: preprocessor magic to check for the current operating system nor
4483: platform. Doing so hurts portability to other platforms because
4484: the OS-specific details are not abstracted appropriately.</p>
4485: <p>The general rule to follow is: instead of checking for the
4486: operating system the application is being built on, check for the
4487: specific <span class="emphasis"><em>features</em></span> you need. For example,
4488: instead of assuming that kqueue is available under NetBSD and
4489: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.114 jmcneill 4490: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4491: yes, this generally involves patching the
1.110 hubertf 4492: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4493: that prevents some OSes from adopting interfaces from other OSes
4494: (e.g. Linux implementing kqueue), something that the above checks
4495: cannot take into account.</p>
4496: <p>Of course, checking for features generally involves more
4497: work on the developer's side, but the resulting changes are
1.87 wiz 4498: cleaner and there are chances they will work on many other
1.85 jmmv 4499: platforms. Not to mention that there are higher chances of being
4500: later integrated into the mainstream sources. Remember:
4501: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4502: <p>Some typical examples:</p>
4503: <div class="table">
1.106 rillig 4504: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4505: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4506: <colgroup>
4507: <col>
4508: <col>
4509: <col>
4510: </colgroup>
4511: <thead><tr>
4512: <th>Where</th>
4513: <th>Incorrect</th>
4514: <th>Correct</th>
4515: </tr></thead>
4516: <tbody>
4517: <tr>
4518: <td>configure script</td>
4519: <td>
1.100 rillig 4520: <pre class="programlisting">
4521: case ${target_os} in
4522: netbsd*) have_kvm=yes ;;
4523: *) have_kvm=no ;;
4524: esac
4525: </pre>
1.85 jmmv 4526: </td>
4527: <td>
1.100 rillig 4528: <pre class="programlisting">
4529: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4530: </pre>
1.85 jmmv 4531: </td>
4532: </tr>
4533: <tr>
4534: <td>C source file</td>
4535: <td>
1.100 rillig 4536: <pre class="programlisting">
4537: #if defined(__NetBSD__)
4538: # include <sys/event.h>
4539: #endif
4540: </pre>
1.85 jmmv 4541: </td>
4542: <td>
1.100 rillig 4543: <pre class="programlisting">
4544: #if defined(HAVE_SYS_EVENT_H)
4545: # include <sys/event.h>
4546: #endif
4547: </pre>
1.85 jmmv 4548: </td>
4549: </tr>
4550: <tr>
4551: <td>C source file</td>
4552: <td>
1.100 rillig 4553: <pre class="programlisting">
4554: int
4555: monitor_file(...)
4556: {
4557: #if defined(__NetBSD__)
4558: int fd = kqueue();
4559: ...
4560: #else
4561: ...
4562: #endif
4563: }
4564: </pre>
1.85 jmmv 4565: </td>
4566: <td>
1.100 rillig 4567: <pre class="programlisting">
4568: int
4569: monitor_file(...)
4570: {
4571: #if defined(HAVE_KQUEUE)
4572: int fd = kqueue();
4573: ...
4574: #else
4575: ...
4576: #endif
4577: }
4578: </pre>
1.85 jmmv 4579: </td>
4580: </tr>
4581: </tbody>
1.91 rillig 4582: </table></div>
1.85 jmmv 4583: </div>
1.91 rillig 4584: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4585: 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
4586: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4587: 2</a>). It summarizes multiple details on how to make
4588: software easier to package; all the suggestions in it were
4589: collected from our experience in pkgsrc work, so they are possibly
4590: helpful when creating patches too.</p>
4591: </div>
4592: <div class="sect2" lang="en">
4593: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4594: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4595: <p>Always, always, <span class="strong"><strong>always</strong></span>
4596: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4597: improvements you do to a package to the mainstream developers.
4598: This is the only way to get their attention on portability issues
4599: and to ensure that future versions can be built out-of-the box on
4600: NetBSD. Furthermore, any user that gets newer distfiles will get
4601: the fixes straight from the packaged code.</p>
1.93 rillig 4602: <p>This generally involves cleaning up the patches
4603: (because sometimes the patches that are
1.85 jmmv 4604: added to pkgsrc are quick hacks), filling bug reports in the
4605: appropriate trackers for the projects and working with the
4606: mainstream authors to accept your changes. It is
4607: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4608: the packages in pkgsrc are kept simple and thus further changes
4609: can be done without much hassle.</p>
4610: <p>Support the idea of free software!</p>
4611: </div>
1.75 rillig 4612: </div>
4613: <div class="sect1" lang="en">
4614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4615: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4616: <div class="variablelist"><dl>
1.76 rillig 4617: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4618: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4619: any credits where they are due. Please bear in mind that others do not
4620: share your sense of humour (or spelling idiosyncrasies), and that others
4621: will read everything that you write here.</p></dd>
1.76 rillig 4622: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4623: <dd><p>This file governs the files that are installed on your
4624: system: all the binaries, manual pages, etc. There are other
4625: directives which may be entered in this file, to control the
4626: creation and deletion of directories, and the location of
1.110 hubertf 4627: 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 4628: information.</p></dd>
1.75 rillig 4629: </dl></div>
4630: </div>
4631: <div class="sect1" lang="en">
4632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4633: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78 rillig 4634: <div class="sect2" lang="en">
4635: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4636: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4637: <div class="variablelist"><dl>
1.76 rillig 4638: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110 hubertf 4639: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 4640: First time after package extraction and before files are
4641: moved in place, the second time after the files to install
4642: are moved in place. This can be used to do any custom
4643: procedures not possible with @exec commands in
1.110 hubertf 4644: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4645: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><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>.</p></dd>
1.76 rillig 4646: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4647: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4648: this script's responsibility to clean up any additional messy details
4649: around the package's installation, since all pkg_delete knows is how to
4650: delete the files created in the original distribution.
1.110 hubertf 4651: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4652: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.76 rillig 4653: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4654: <dd>
4655: <p>This file is displayed after installation of the package.
1.87 wiz 4656: Useful for things like legal notices on almost-free
4657: software and hints for updating config files after
4658: installing modules for apache, PHP etc.
4659: Please note that you can modify variables in it easily by using
4660: <code class="varname">MESSAGE_SUBST</code> in the package's
4661: <code class="filename">Makefile</code>:</p>
1.75 rillig 4662: <pre class="programlisting">
1.100 rillig 4663: MESSAGE_SUBST+= SOMEVAR="somevalue"
4664: </pre>
1.75 rillig 4665: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4666: <code class="filename">MESSAGE</code>. By default, substitution is
4667: performed for <code class="varname">PKGNAME</code>,
4668: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4669: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4670: <code class="varname">X11BASE</code>,
4671: <code class="varname">PKG_SYSCONFDIR</code>,
4672: <code class="varname">ROOT_GROUP</code>, and
1.117 ! jnemeth 4673: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4674: <p>You can display a different or additional files by
4675: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4676: default is <code class="filename">MESSAGE</code>, if the file
4677: exists.</p>
1.75 rillig 4678: </dd>
1.78 rillig 4679: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4680: <dd><p>FIXME: There is no documentation on the
4681: alternatives framework.</p></dd>
4682: </dl></div>
4683: </div>
4684: <div class="sect2" lang="en">
4685: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4686: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4687: <div class="variablelist"><dl>
4688: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4689: <dd><p>This file contains arbitrary things that could
4690: also go into a <code class="filename">Makefile</code>, but its purpose is
4691: to be used by more than one package. This file should only be
4692: used when the packages that will use the file are known in
4693: advance. For other purposes it is often better to write a
4694: <code class="filename">*.mk</code> file and give it a good name that
4695: describes what it does.</p></dd>
4696: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4697: <dd><p>This file contains the dependency information
1.110 hubertf 4698: 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 4699: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4700: <dd><p>This file contains workarounds for compiler bugs
4701: and similar things. It is included automatically by the pkgsrc
4702: infrastructure, so you don't need an extra
4703: <code class="literal">.include</code> line for
4704: it.</p></dd>
4705: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4706: <dd><p>This file contains the code for the
1.110 hubertf 4707: 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 4708: selected by the user. If a package has only one or two options,
4709: it is equally acceptable to put the code directly into the
4710: <code class="filename">Makefile</code>.</p></dd>
4711: </dl></div>
4712: </div>
4713: <div class="sect2" lang="en">
4714: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4715: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4716: <div class="variablelist"><dl>
4717: <dt><span class="term"><code class="filename">README*</code></span></dt>
4718: <dd><p>These files do not take place in the creation of
4719: a package and thus are purely informative to the package
4720: developer.</p></dd>
4721: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4722: <dd><p>This file contains things that need to be done
4723: to make the package even
4724: better.</p></dd>
1.75 rillig 4725: </dl></div>
4726: </div>
1.78 rillig 4727: </div>
1.75 rillig 4728: <div class="sect1" lang="en">
4729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4730: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4731: </h2></div></div></div>
1.110 hubertf 4732: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4733: unpacked into the directory denoted by
4734: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4735: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4736: directory is also used to keep various timestamp files.
4737: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4738: The default is <code class="filename">${.CURDIR}/work</code>
4739: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4740: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4741: </div>
4742: <div class="sect1" lang="en">
4743: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4744: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4745: </h2></div></div></div>
1.75 rillig 4746: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4747: to configuration or building, you could place these files here and use
1.110 hubertf 4748: a <span class="command"><strong>${CP}</strong></span> command in the
1.87 wiz 4749: “<span class="quote">pre-configure</span>” target to achieve
4750: this. Alternatively, you could simply diff the file against
4751: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4752: the creation of this file.</p>
4753: <p>If you want to share files in this way with other
4754: packages, set the <code class="varname">FILESDIR</code> variable to point
4755: to the other package's <code class="filename">files</code> directory,
4756: e.g.:</p>
4757: <pre class="programlisting">
1.100 rillig 4758: FILESDIR=${.CURDIR}/../xemacs/files
4759: </pre>
1.75 rillig 4760: </div>
4761: </div>
4762: <div class="chapter" lang="en">
4763: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4764: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4765: <div class="toc">
4766: <p><b>Table of Contents</b></p>
4767: <dl>
1.106 rillig 4768: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116 rillig 4769: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106 rillig 4770: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4771: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4772: <dd><dl>
4773: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4774: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4775: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4776: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4777: <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 4778: </dl></dd>
4779: </dl>
4780: </div>
1.76 rillig 4781: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4782: each of which forms a well-defined part of the pkgsrc system. Using
1.110 hubertf 4783: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75 rillig 4784: like pkgsrc requires some discipline to keep the code correct and
4785: understandable.</p>
1.76 rillig 4786: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4787: programming are variables (which are actually macros) and shell
4788: commands. Among these shell commands may even be more complex ones
1.110 hubertf 4789: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75 rillig 4790: as intended it is necessary to quote all variables correctly when they
4791: are used.</p>
4792: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4793: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4794: with them.</p>
4795: <div class="sect1" lang="en">
4796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4797: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97 rillig 4798: <div class="itemizedlist"><ul type="disc"><li>
4799: <p>When you are creating a file as a
4800: target of a rule, always write the data to a temporary file first
4801: and finally rename that file. Otherwise there might occur an error
4802: in the middle of generating the file, and when the user runs
1.110 hubertf 4803: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><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 4804: regenerated properly. Example:</p>
4805: <pre class="programlisting">
1.100 rillig 4806: wrong:
4807: @echo "line 1" > ${.TARGET}
4808: @echo "line 2" >> ${.TARGET}
4809: @false
4810:
4811: correct:
4812: @echo "line 1" > ${.TARGET}.tmp
4813: @echo "line 2" >> ${.TARGET}.tmp
4814: @false
4815: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4816: </pre>
1.110 hubertf 4817: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4818: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4819: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4820: correct</strong></span> gives an error message twice, as expected.</p>
1.110 hubertf 4821: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4822: <code class="literal">${.TARGET}</code> in case of error, but this only
4823: happens when it is interrupted, for example by pressing
4824: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110 hubertf 4825: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4826: </li></ul></div>
4827: </div>
4828: <div class="sect1" lang="en">
4829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4830: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4831: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4832: can be processed using the five operators ``='', ``+='', ``?='',
1.110 hubertf 4833: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4834: page.</p>
4835: <p>When a variable's value is parsed from a
1.76 rillig 4836: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4837: backslash character ``\'' are handled specially. If a backslash is
4838: followed by a newline, any whitespace immediately in front of the
4839: backslash, the backslash, the newline, and any whitespace
4840: immediately behind the newline are replaced with a single space. A
4841: backslash character and an immediately following hash character are
4842: replaced with a single hash character. Otherwise, the backslash is
4843: passed as is. In a variable assignment, any hash character that is
4844: not preceded by a backslash starts a comment that continues upto the
4845: end of the logical line.</p>
4846: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4847: the only way to create a variable consisting of a single backslash
4848: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4849: <p>So far for defining variables. The other thing you can do with
4850: variables is evaluating them. A variable is evaluated when it is
4851: part of the right side of the ``:='' or the ``!='' operator, or
4852: directly before executing a shell command which the variable is part
1.110 hubertf 4853: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75 rillig 4854: is, variables are not evaluated until there's no other way. The
4855: ``modifiers'' mentioned in the man page also evaluate the
4856: variable.</p>
4857: <p>Some of the modifiers split the string into words and then
4858: operate on the words, others operate on the string as a whole. When
4859: a string is split into words, it is split as you would expect
1.110 hubertf 4860: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.114 jmcneill 4861: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4862: loop does not follow the shell quoting rules but splits at sequences
4863: of whitespace.</p>
4864: <p>There are several types of variables that should be handled
4865: differently. Strings and two types of lists.</p>
4866: <div class="itemizedlist"><ul type="disc">
4867: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4868: characters. Nevertheless, you should restrict yourself to only
4869: using printable characters. Examples are
4870: <code class="varname">PREFIX</code> and
4871: <code class="varname">COMMENT</code>.</p></li>
4872: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4873: are never exported to any shell command. Their elements are
4874: separated by whitespace. Therefore, the elements themselves cannot
4875: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4876: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4877: Examples are <code class="varname">DEPENDS</code> and
4878: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4879: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4880: may be exported to a shell command. Their elements can contain any
4881: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4882: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4883: <code class="varname">DISTFILES</code> and
4884: <code class="varname">MASTER_SITES</code>.</p></li>
4885: </ul></div>
4886: <div class="sect2" lang="en">
4887: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4888: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75 rillig 4889: <div class="itemizedlist"><ul type="disc">
4890: <li><p>All variable names starting with an underscore
4891: are reserved for use by the pkgsrc infrastructure. They shall
4892: not be used by package
1.76 rillig 4893: <code class="filename">Makefile</code>s.</p></li>
1.110 hubertf 4894: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4895: lowercase variable names for the iteration
4896: variables.</p></li>
4897: <li><p>All list variables should have a ``plural''
4898: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4899: <code class="varname">DISTFILES</code>.</p></li>
4900: </ul></div>
4901: </div>
4902: </div>
4903: <div class="sect1" lang="en">
4904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4905: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4906: <p>This section presents you with some code snippets you should
4907: use in your own code. If you don't find anything appropriate here,
4908: you should test your code and add it here.</p>
4909: <div class="sect2" lang="en">
4910: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4911: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4912: <pre class="programlisting">
1.100 rillig 4913: STRING= foo * bar `date`
4914: INT_LIST= # empty
4915: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4916: EXT_LIST= # empty
4917: ANOTHER_EXT_LIST= a=b c=d
4918:
4919: INT_LIST+= ${STRING} # 1
4920: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4921: EXT_LIST+= ${STRING:Q} # 3
4922: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4923: </pre>
1.75 rillig 4924: <p>When you add a string to an external list (example 3), it
4925: must be quoted. In all other cases, you must not add a quoting
4926: level. You must not merge internal and external lists, unless you
4927: are sure that all entries are correctly interpreted in both
4928: lists.</p>
4929: </div>
4930: <div class="sect2" lang="en">
4931: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4932: <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 4933: <pre class="programlisting">
1.100 rillig 4934: EXT_LIST= # empty
4935: .for i in ${INT_LIST}
4936: EXT_LIST+= ${i:Q}""
4937: .endfor
1.1 grant 4938: </pre>
1.75 rillig 4939: <p>This code converts the internal list
4940: <code class="varname">INT_LIST</code> into the external list
4941: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4942: are unquoted they must be quoted here. The reason for appending
4943: <code class="varname">""</code> is explained below.</p>
4944: </div>
4945: <div class="sect2" lang="en">
4946: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4947: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4948: <p>Sometimes you may want to print an arbitrary string. There
4949: are many ways to get it wrong and only few that can handle every
4950: nastiness.</p>
1.75 rillig 4951: <pre class="programlisting">
1.100 rillig 4952: STRING= foo bar < > * `date` $$HOME ' "
4953: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4954:
1.100 rillig 4955: all:
4956: echo ${STRING} # 1
4957: echo "${STRING}" # 2
4958: echo "${STRING:Q}" # 3
4959: echo ${STRING:Q} # 4
4960: echo x${STRING:Q} | sed 1s,.,, # 5
4961: printf "%s\\n" ${STRING:Q}"" # 6
4962: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4963: </pre>
1.75 rillig 4964: <p>Example 1 leads to a syntax error in the shell, as the
4965: characters are just copied.</p>
4966: <p>Example 2 leads to a syntax error too, and if you leave out
4967: the last " character from <code class="varname">${STRING}</code>,
1.110 hubertf 4968: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75 rillig 4969: variable would be evaluated, too.</p>
4970: <p>Example 3 outputs each space character preceded by a
4971: backslash (or not), depending on the implementation of the
1.110 hubertf 4972: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75 rillig 4973: <p>Example 4 handles correctly every string that does not start
4974: with a dash. In that case, the result depends on the
1.110 hubertf 4975: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75 rillig 4976: guarantee that your input does not start with a dash, this form is
4977: appropriate.</p>
4978: <p>Example 5 handles even the case of a leading dash
4979: correctly.</p>
1.79 rillig 4980: <p>Example 6 also works with every string and is the
4981: light-weight solution, since it does not involve a pipe, which has
4982: its own problems.</p>
1.75 rillig 4983: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4984: because the quoting has already been done when adding elements to
4985: the list.</p>
4986: <p>As internal lists shall not be passed to the shell, there is
4987: no example for it.</p>
4988: </div>
4989: <div class="sect2" lang="en">
4990: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4991: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4992: <p>There are many possible sources of wrongly quoted variables.
4993: This section lists some of the commonly known ones.</p>
4994: <div class="itemizedlist"><ul type="disc">
4995: <li>
4996: <p>Whenever you use the value of a list, think
4997: about what happens to leading or trailing whitespace. If the
4998: list is a well-formed shell expression, you can apply the
4999: <code class="varname">:M*</code> modifier to strip leading and trailing
5000: whitespace from each word. The <code class="varname">:M</code> operator
5001: first splits its argument according to the rules of the shell,
5002: and then creates a new list consisting of all words that match
5003: the shell glob expression <code class="varname">*</code>, that is: all.
5004: One class of situations where this is needed is when adding a
5005: variable like <code class="varname">CPPFLAGS</code> to
5006: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5007: invokes other configure scripts, it strips the leading and
5008: trailing whitespace from the variable and then passes it to the
5009: other configure scripts. But these configure scripts expect the
5010: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5011: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5012: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5013: here is how we do it:</p>
5014: <pre class="programlisting">
1.100 rillig 5015: CPPFLAGS= # empty
5016: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5017: CPPFLAGS+= ${MY_CPPFLAGS}
5018:
5019: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5020:
5021: all:
5022: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5023: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5024: </pre>
1.75 rillig 5025: </li>
5026: <li><p>The example above contains one bug: The
5027: <code class="varname">${PREFIX}</code> is a properly quoted shell
5028: expression, but there is the C compiler after it, which also
5029: expects a properly quoted string (this time in C syntax). The
5030: version above is therefore only correct if
5031: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5032: or double quotes. If you want to allow these, you have to add
5033: another layer of quoting to each variable that is used as a C
5034: string literal. You cannot use the <code class="varname">:Q</code>
5035: operator for it, as this operator only works for the
5036: shell.</p></li>
5037: <li>
5038: <p>Whenever a variable can be empty, the
5039: <code class="varname">:Q</code> operator can have surprising results. Here
5040: are two completely different cases which can be solved with the
5041: same trick.</p>
5042: <pre class="programlisting">
1.100 rillig 5043: EMPTY= # empty
5044: empty_test:
5045: for i in a ${EMPTY:Q} c; do \
5046: echo "$$i"; \
5047: done
5048:
5049: for_test:
5050: .for i in a:\ a:\test.txt
5051: echo ${i:Q}
5052: echo "foo"
5053: .endfor
1.1 grant 5054: </pre>
1.75 rillig 5055: <p>The first example will only print two of the three lines
5056: we might have expected. This is because
5057: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5058: the shell cannot see. The workaround is to write
5059: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5060: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5061: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5062: <p>The second example will only print three lines instead of
5063: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5064: This is because the backslash of the value
5065: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110 hubertf 5066: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
5067: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75 rillig 5068: <code class="varname">${i:Q}""</code>.</p>
5069: </li>
5070: </ul></div>
5071: </div>
5072: <div class="sect2" lang="en">
5073: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5074: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5075: <p>The pkgsrc bmake program does not handle the following
5076: assignment correctly. In case <code class="varname">_othervar_</code>
5077: contains a ``-'' character, one of the closing braces is included
5078: in <code class="varname">${VAR}</code> after this code executes.</p>
5079: <pre class="programlisting">
1.100 rillig 5080: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5081: </pre>
1.75 rillig 5082: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5083: 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 5084: <code class="varname">bug1</code>.</p>
5085: </div>
5086: </div>
5087: </div>
5088: <div class="chapter" lang="en">
5089: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5090: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 5091: <div class="toc">
5092: <p><b>Table of Contents</b></p>
5093: <dl>
1.106 rillig 5094: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116 rillig 5095: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
5096: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106 rillig 5097: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5098: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116 rillig 5099: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106 rillig 5100: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5101: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5102: </dl>
5103: </div>
1.87 wiz 5104: <p>The <code class="filename">PLIST</code> file contains a package's
5105: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5106: the package (relative to the <code class="filename">${PREFIX}</code>
5107: directory it's been installed in) plus some additional statements
1.110 hubertf 5108: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 5109: This chapter addresses some issues that need attention when
5110: dealing with the <code class="filename">PLIST</code> file (or files, see
5111: below!).</p>
1.75 rillig 5112: <div class="sect1" lang="en">
5113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5114: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 5115: <p>Be sure to add a RCS ID line as the first thing in any
5116: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5117: <pre class="programlisting">
1.100 rillig 5118: @comment $NetBSD$
1.87 wiz 5119: </pre>
1.75 rillig 5120: </div>
5121: <div class="sect1" lang="en">
5122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5123: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 5124: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 5125: to output a PLIST that matches any new files since the package
1.110 hubertf 5126: 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 5127: more information on this target.</p>
1.75 rillig 5128: </div>
5129: <div class="sect1" lang="en">
5130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 5131: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 5132: </h2></div></div></div>
1.87 wiz 5133: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 5134: <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
5135: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 5136: <code class="varname">@comment</code>s instead of real
5137: <code class="varname">@dirrm</code> lines. You can also do this for
5138: specific directories and files, so that the results of that
5139: command are very close to reality. This helps <span class="emphasis"><em>a
5140: lot</em></span> during the update of packages.</p>
5141: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5142: of AWK patterns and actions that are used to filter the output of
5143: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5144: scripting you like to it, but be careful with quoting.</p>
5145: <p>For example, to get all files inside the
5146: <code class="filename">libdata/foo</code> directory removed from the
5147: resulting PLIST:</p>
5148: <pre class="programlisting">
1.100 rillig 5149: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5150: </pre>
5151: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5152: to a specific (shared) directory converted to
5153: <code class="varname">@comment</code>s:</p>
1.75 rillig 5154: <pre class="programlisting">
1.100 rillig 5155: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5156: </pre>
1.75 rillig 5157: </div>
5158: <div class="sect1" lang="en">
5159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5160: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5161: <p>A number of variables are substituted automatically in
5162: PLISTs when a package is installed on a system. This includes the
5163: following variables:</p>
1.75 rillig 5164: <div class="variablelist"><dl>
5165: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5166: <dd>
5167: <p>Some packages like emacs and perl embed information
1.87 wiz 5168: about which architecture they were built on into the
5169: pathnames where they install their files. To handle this
5170: case, PLIST will be preprocessed before actually used, and
5171: the symbol
5172: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
1.110 hubertf 5173: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5174: same is done if the string
5175: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5176: PLIST somewhere - use this on packages that have GNU
5177: autoconf-created configure scripts.</p>
1.75 rillig 5178: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5179: <h3 class="title">Legacy note</h3>
5180: <p>There used to be a symbol
1.87 wiz 5181: “<span class="quote"><code class="varname">$ARCH</code></span>” that
1.110 hubertf 5182: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5183: -m</strong></span>, but that's no longer supported and has
5184: been removed.</p>
1.75 rillig 5185: </div>
5186: </dd>
5187: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5188: <dd>
5189: <p>Some packages want to embed the OS name and version
1.87 wiz 5190: into some paths. To do this, use these variables in the
5191: <code class="filename">PLIST</code>:
5192: </p>
1.75 rillig 5193: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 5194: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</p></li>
1.75 rillig 5195: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
1.110 hubertf 5196: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</p></li>
1.75 rillig 5197: </ul></div>
5198: </dd>
5199: </dl></div>
1.87 wiz 5200: <p>For a complete list of values which are replaced by
5201: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5202: search for <code class="varname">PLIST_SUBST</code>).</p>
5203: <p>If you want to change other variables not listed above, you
5204: can add variables and their expansions to this variable in the
1.110 hubertf 5205: 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 5206: <pre class="programlisting">
1.100 rillig 5207: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5208: </pre>
1.75 rillig 5209: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5210: in the <code class="filename">PLIST</code> with
5211: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5212: </div>
5213: <div class="sect1" lang="en">
5214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5215: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5216: <p>Man pages should be installed in compressed form if
1.87 wiz 5217: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5218: and uncompressed otherwise. To handle this in the
5219: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5220: appended/removed automatically for man pages according to
5221: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5222: or not, see above for details. This modification of the
5223: <code class="filename">PLIST</code> file is done on a copy of it, not
5224: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5225: </div>
5226: <div class="sect1" lang="en">
5227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5228: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5229: </h2></div></div></div>
1.76 rillig 5230: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5231: in generating the binary package, set the variable
5232: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110 hubertf 5233: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 5234: important. The default for <code class="varname">PLIST_SRC</code> is
5235: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5236: </div>
5237: <div class="sect1" lang="en">
5238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5239: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5240: <p>Some packages decide to install a different set of files based on
1.87 wiz 5241: the operating system being used. These differences can be
5242: automatically handled by using the following files:</p>
1.75 rillig 5243: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5244: <li><p><code class="filename">PLIST.common</code></p></li>
5245: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5246: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5247: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5248: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5249: </ul></div>
5250: </div>
5251: <div class="sect1" lang="en">
5252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5253: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5254: <p>A “<span class="quote">shared directory</span>” is a directory where
5255: multiple (and unrelated) packages install files. These
5256: directories are problematic because you have to add special tricks
5257: in the PLIST to conditionally remove them, or have some
5258: centralized package handle them.</p>
5259: <p>Within pkgsrc, you'll find both approaches. If a directory
5260: is shared by a few unrelated packages, it's often not worth to add
5261: an extra package to remove it. Therefore, one simply does:</p>
5262: <pre class="programlisting">
1.100 rillig 5263: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
1.87 wiz 5264: </pre>
5265: <p>in the PLISTs of all affected packages, instead of the
5266: regular "@dirrm" line.</p>
5267: <p>However, if the directory is shared across many packages, two
5268: different solutions are available:</p>
1.75 rillig 5269: <div class="orderedlist"><ol type="1">
1.87 wiz 5270: <li><p>If the packages have a common dependency, the directory
5271: can be removed in that. For example, see
1.91 rillig 5272: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
1.87 wiz 5273: removes the shared directory
5274: <code class="filename">share/omf</code>.</p></li>
5275: <li><p>If the packages using the directory are not related at
5276: all (they have no common dependencies), a *-dirs package is
5277: used.</p></li>
1.75 rillig 5278: </ol></div>
1.87 wiz 5279: <p>From now on, we'll discuss the second solution. To get an
5280: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5281: <pre class="programlisting">
1.100 rillig 5282: <code class="prompt">%</code> cd .../pkgsrc
5283: <code class="prompt">%</code> ls -d */*-dirs
1.87 wiz 5284: </pre>
5285: <p>Their use from other packages is very simple. The
5286: <code class="varname">USE_DIRS</code> variable takes a list of package names
5287: (without the “<span class="quote">-dirs</span>” part) together with the required
5288: version number (always pick the latest one when writing new
5289: packages).</p>
5290: <p>For example, if a package installs files under
5291: <code class="filename">share/applications</code>, it should have the
5292: following line in it:</p>
5293: <pre class="programlisting">
1.100 rillig 5294: USE_DIRS+= xdg-1.1
1.87 wiz 5295: </pre>
1.110 hubertf 5296: <p>After regenerating the PLIST using <span class="command"><strong>make
1.87 wiz 5297: print-PLIST</strong></span>, you should get the right (commented out)
5298: lines.</p>
5299: <p>Note that even if your package is using
5300: <code class="filename">$X11BASE</code>, it must not depend on the
5301: *-x11-dirs packages. Just specify the name without that part and
5302: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5303: care of it.</p>
1.75 rillig 5304: </div>
5305: </div>
5306: <div class="chapter" lang="en">
5307: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5308: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5309: <div class="toc">
5310: <p><b>Table of Contents</b></p>
5311: <dl>
1.106 rillig 5312: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116 rillig 5313: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.75 rillig 5314: <dd><dl>
1.106 rillig 5315: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116 rillig 5316: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.75 rillig 5317: </dl></dd>
1.116 rillig 5318: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.75 rillig 5319: <dd><dl>
1.116 rillig 5320: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106 rillig 5321: <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 5322: </dl></dd>
5323: </dl>
5324: </div>
5325: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5326: are seen by a package's configure and build processes. This is implemented
5327: in a two step process:</p>
1.75 rillig 5328: <div class="orderedlist"><ol type="1">
5329: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5330: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5331: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5332: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5333: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5334: <code class="option">-L${LOCALBASE}/lib</code> into references to
5335: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5336: native compiler on some operating systems look like GCC, so that
5337: packages that expect GCC won't require modifications to build with
5338: those native compilers.</p></li>
1.75 rillig 5339: </ol></div>
5340: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5341: package may be built consistently despite what other software may be
5342: installed. Please note that the normal system header and library paths,
5343: e.g. <code class="filename">/usr/include</code>,
5344: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5345: designed to insulate the package build from non-system-supplied
5346: software.</p>
1.75 rillig 5347: <div class="sect1" lang="en">
5348: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5349: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5350: <p>The process of converting packages to use the buildlink3
1.87 wiz 5351: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5352: The things to keep in mind are:</p>
1.75 rillig 5353: <div class="orderedlist"><ol type="1">
1.87 wiz 5354: <li><p>Ensure that the build always calls the wrapper scripts
5355: instead of the actual toolchain. Some packages are tricky,
5356: and the only way to know for sure is the check
5357: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5358: wrappers are being invoked.</p></li>
5359: <li><p>Don't override <code class="varname">PREFIX</code> from within
5360: the package Makefile, e.g. Java VMs, standalone shells,
5361: etc., because the code to symlink files into
5362: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5363: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5364: </p></li>
5365: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5366: <code class="filename">buildlink3.mk</code> files that you list in a
5367: package's Makefile are added as dependencies for that package.
5368: </p></li>
1.75 rillig 5369: </ol></div>
1.87 wiz 5370: <p>If a dependency on a particular package is required for its libraries and
5371: headers, then we replace:</p>
1.75 rillig 5372: <pre class="programlisting">
1.100 rillig 5373: DEPENDS+= foo>=1.1.0:../../category/foo
5374: </pre>
1.75 rillig 5375: <p>with</p>
5376: <pre class="programlisting">
1.100 rillig 5377: .include "../../category/foo/buildlink3.mk"
5378: </pre>
1.75 rillig 5379: <p>The buildlink3.mk files usually define the required dependencies.
5380: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5381: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5382: <pre class="programlisting">
1.100 rillig 5383: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5384: .include "../../category/foo/buildlink3.mk"
5385: </pre>
1.76 rillig 5386: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5387: files in <code class="filename">pkgsrc/mk</code>
5388: that handle special package issues:</p>
1.75 rillig 5389: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5390: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5391: the native or a pkgsrc Berkeley DB implementation based on
5392: the values of <code class="varname">BDB_ACCEPTED</code> and
5393: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5394: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5395: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5396: 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.76 rillig 5397: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5398: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5399: adding a dependency on Heimdal or MIT-krb5 for packages that
5400: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5401: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5402: system-provided Motif installation or adds a dependency on
1.91 rillig 5403: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</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.88 wiz 5404: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5405: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5406: which Motif version will be used.</p></li>
1.76 rillig 5407: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5408: variables that may be used by packages that use the
5409: Open Sound System (OSS) API.</p></li>
1.76 rillig 5410: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5411: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5412: the file for more information.</p></li>
1.76 rillig 5413: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5414: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5415: 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.76 rillig 5416: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5417: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5418: library.</p></li>
1.75 rillig 5419: </ul></div>
1.76 rillig 5420: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5421: files provide a more complete
5422: description of how to use them properly.</p>
1.75 rillig 5423: </div>
5424: <div class="sect1" lang="en">
5425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5426: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5427: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5428: included by Makefiles to indicate the need to compile and link
5429: against header files and libraries provided by the package. A
5430: <code class="filename">buildlink3.mk</code> file should always provide
5431: enough information to add the correct type of dependency
5432: relationship and include any other
5433: <code class="filename">buildlink3.mk</code> files that it needs to find
5434: headers and libraries that it needs in turn.</p>
5435: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5436: 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 5437: package is highly recommended. For most packages, the following
5438: command will generate a good starting point for
5439: <code class="filename">buildlink3.mk</code> files:</p>
5440: <pre class="screen">
5441: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5442: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5443: </pre>
1.75 rillig 5444: <div class="sect2" lang="en">
5445: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5446: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5447: <p>The following real-life example
1.87 wiz 5448: <code class="filename">buildlink3.mk</code> is taken
5449: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5450: <pre class="programlisting">
1.100 rillig 5451: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5452:
1.100 rillig 5453: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5454: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5455:
1.100 rillig 5456: .if ${BUILDLINK_DEPTH} == "+"
5457: BUILDLINK_DEPENDS+= tiff
5458: .endif
1.87 wiz 5459:
1.100 rillig 5460: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5461: BUILDLINK_PACKAGES+= tiff
1.87 wiz 5462:
1.100 rillig 5463: .if ${TIFF_BUILDLINK3_MK} == "+"
5464: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5465: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5466: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5467:
1.100 rillig 5468: .include "../../devel/zlib/buildlink3.mk"
5469: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 5470:
1.100 rillig 5471: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5472: </pre>
1.87 wiz 5473: <p>The header and footer manipulate
5474: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5475: <code class="filename">buildlink3.mk</code> files and is used to track
5476: at what depth we are including
5477: <code class="filename">buildlink3.mk</code> files.</p>
5478: <p>The first section controls if the dependency on
5479: <em class="replaceable"><code>pkg</code></em> is added.
5480: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5481: packages for which dependencies are added by
5482: buildlink3.</p>
5483: <p>The second section advises pkgsrc that the
5484: <code class="filename">buildlink3.mk</code> file for
5485: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5486: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5487: packages for which <code class="filename">buildlink3.mk</code> files
5488: have been included. It must <span class="emphasis"><em>always</em></span> be
5489: appended to within a <code class="filename">buildlink3.mk</code>
5490: file.</p>
5491: <p>The third section is protected from multiple inclusion
5492: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5493: added. Several important variables are set in the section:</p>
5494: <div class="itemizedlist"><ul type="disc">
5495: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5496: is the actual dependency recorded in the installed
5497: package; this should always be set using
1.110 hubertf 5498: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5499: we're appending to any pre-existing list of values. This
5500: variable should be set to the first version of the
5501: package that had an API change.
5502: </p></li>
5503: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5504: is the location of the <em class="replaceable"><code>pkg</code></em>
5505: pkgsrc directory.</p></li>
5506: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5507: (not shown above) controls whether we use
5508: <code class="varname">BUILD_DEPENDS</code> or
5509: <code class="varname">DEPENDS</code> to add the dependency on
5510: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5511: selected by setting
5512: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5513: to “<span class="quote">build</span>”. By default, the full dependency is
5514: used.</p></li>
5515: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5516: and
5517: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5518: (not shown above) are lists of subdirectories of
1.76 rillig 5519: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5520: to add to the header and library search paths. These
5521: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5522: respectively.</p></li>
5523: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5524: (not shown above) is the list of preprocessor flags to add
5525: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5526: configure and build phases. The “<span class="quote">-I</span>” option
5527: should be avoided and instead be handled using
5528: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5529: above.</p></li>
1.75 rillig 5530: </ul></div>
1.87 wiz 5531: <p>The following variables are all optionally defined within
5532: this second section (protected against multiple inclusion) and
5533: control which package files are symlinked into
5534: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5535: transformed during the symlinking:</p>
1.75 rillig 5536: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5537: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5538: (not shown above) is a shell glob pattern relative to
1.76 rillig 5539: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5540: to be symlinked into
1.76 rillig 5541: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5542: e.g. <code class="filename">include/*.h</code>.</p></li>
5543: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5544: (not shown above) is a shell pipeline that
5545: outputs to stdout a list of files relative to
5546: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5547: The resulting files are to be symlinked
5548: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5549: this takes the <code class="filename">+CONTENTS</code> of a
5550: <em class="replaceable"><code>pkg</code></em> and filters it through
5551: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5552: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5553: (not shown above) is a filter command that filters
1.76 rillig 5554: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5555: relative to
1.76 rillig 5556: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5557: on stdout. By default for overwrite packages,
5558: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5559: outputs the contents of the <code class="filename">include</code>
5560: and <code class="filename">lib</code> directories in the package
5561: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5562: it outputs any libtool archives in
1.87 wiz 5563: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5564: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5565: (not shown above) is a list of sed arguments used to
5566: transform the name of the source filename into a
1.110 hubertf 5567: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5568: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5569: </ul></div>
1.87 wiz 5570: <p>The last section includes any
5571: <code class="filename">buildlink3.mk</code> needed for
5572: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5573: Including these <code class="filename">buildlink3.mk</code> files
5574: means that the headers and libraries for these
5575: dependencies are also symlinked into
5576: <code class="filename">${BUILDLINK_DIR}</code>
5577: whenever the <em class="replaceable"><code>pkg</code></em>
5578: <code class="filename">buildlink3.mk</code>
5579: file is included.</p>
1.75 rillig 5580: </div>
5581: <div class="sect2" lang="en">
5582: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5583: <a name="updating-buildlink-depends"></a>14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.87 wiz 5584: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5585: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5586: after a package update is when the API or interface to the
1.87 wiz 5587: header files change.</p>
5588: <p>In this case,
5589: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5590: should be adjusted to require at least the new package
5591: version. In some cases, the packages that depend on this new
5592: version may need their <code class="varname">PKGREVISION</code>s
5593: increased and, if they have <code class="filename">buildlink3.mk</code>
5594: files, their
5595: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5596: adjusted, too. This is needed so pkgsrc will require the
5597: correct package dependency and not settle for an older one
5598: when building the source.</p>
5599: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5600: should be increased when the binary interface or sonames
5601: (major number of the library version) of any installed
5602: shared libraries change. This is needed so that binary
5603: packages made using it will require the correct package
5604: dependency and not settle for an older one which will not
1.87 wiz 5605: contain the necessary shared libraries.</p>
1.110 hubertf 5606: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.75 rillig 5607: more information about dependencies on other packages,
5608: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5609: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5610: <p>Please take careful consideration before adjusting
5611: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5612: or
5613: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5614: as we don't want to cause unneeded package deletions and
5615: rebuilds. In many cases, new versions of packages work just
5616: fine with older dependencies.</p>
5617: <p>Also it is not needed to set
1.75 rillig 5618: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5619: when it is identical to
1.87 wiz 5620: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5621: </div>
5622: </div>
5623: <div class="sect1" lang="en">
5624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5625: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5626: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5627: coincide with headers and libraries present in the base system.
1.76 rillig 5628: Aside from a <code class="filename">buildlink3.mk</code> file, these
5629: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5630: file that includes the necessary checks to decide whether using
5631: the built-in software or the pkgsrc software is
1.87 wiz 5632: appropriate.</p>
5633: <p>The only requirements of a builtin.mk file for
5634: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5635: <div class="orderedlist"><ol type="1">
1.87 wiz 5636: <li><p>It should set
5637: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5638: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5639: after it is included.</p></li>
5640: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5641: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5642: which is already set before the
5643: <code class="filename">builtin.mk</code> file is included.</p></li>
5644: <li><p>It should be written to allow multiple inclusion. This
5645: is <span class="emphasis"><em>very</em></span> important and takes careful
5646: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5647: </ol></div>
5648: <div class="sect2" lang="en">
5649: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5650: <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 5651: <p>The following is the recommended template for builtin.mk
1.87 wiz 5652: files:</p>
1.75 rillig 5653: <pre class="programlisting">
1.100 rillig 5654: .if !defined(IS_BUILTIN.foo)
5655: #
5656: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5657: # genuinely exists in the system or not.
5658: #
5659: IS_BUILTIN.foo?= no
5660:
5661: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5662: # version can be determined.
5663: #
5664: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5665: BUILTIN_PKG.foo?= foo-1.0
5666: . endif
5667: .endif # IS_BUILTIN.foo
5668:
5669: .if !defined(USE_BUILTIN.foo)
5670: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5671: . if defined(BUILTIN_PKG.foo)
5672: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5673: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5674: USE_BUILTIN.foo!= \
5675: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5676: && ${ECHO} "yes" || ${ECHO} "no"
5677: . endif
5678: . endfor
5679: . endif
5680: .endif # USE_BUILTIN.foo
5681:
5682: CHECK_BUILTIN.foo?= no
5683: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5684: #
5685: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5686: # "yes" or "no".
5687: #
5688: .endif # CHECK_BUILTIN.foo
5689: </pre>
1.87 wiz 5690: <p>The first section sets
5691: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5692: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5693: in the base system. This should not be a base system software
5694: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5695: it should only be “<span class="quote">yes</span>” if the actual package is
5696: included as part of the base system. This variable is only
5697: used internally within the <code class="filename">builtin.mk</code>
5698: file.</p>
5699: <p>The second section sets
5700: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5701: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5702: system if it exists (if
5703: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5704: is “<span class="quote">yes</span>”). This variable is only used internally
5705: within the <code class="filename">builtin.mk</code> file.</p>
5706: <p>The third section sets
5707: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5708: and is <span class="emphasis"><em>required</em></span> in all
5709: <code class="filename">builtin.mk</code> files. The code in this
5710: section must make the determination whether the built-in
5711: software is adequate to satisfy the dependencies listed in
5712: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5713: This is typically done by comparing
5714: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5715: against each of the dependencies in
5716: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5717: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5718: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5719: end of the <code class="filename">builtin.mk</code> file. Note that
5720: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5721: may be “<span class="quote">yes</span>” even if
5722: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5723: is “<span class="quote">no</span>” because we may make the determination
5724: that the built-in version of the software is similar enough to
5725: be used as a replacement.</p>
5726: <p>The last section is guarded by
5727: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5728: and includes code that uses the value of
5729: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5730: set in the previous section. This typically includes, e.g.,
5731: adding additional dependency restrictions and listing additional
5732: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5733: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5734: </div>
5735: <div class="sect2" lang="en">
5736: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5737: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5738: <p>When building packages, it's possible to choose whether to set
5739: a global preference for using either the built-in (native)
5740: version or the pkgsrc version of software to satisfy a
5741: dependency. This is controlled by setting
5742: <code class="varname">PREFER_PKGSRC</code> and
5743: <code class="varname">PREFER_NATIVE</code>. These variables take values
5744: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5745: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5746: use the pkgsrc versions of software, while
5747: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5748: built-in versions. Preferences are determined by the most
5749: specific instance of the package in either
5750: <code class="varname">PREFER_PKGSRC</code> or
5751: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5752: in neither or in both variables, then
5753: <code class="varname">PREFER_PKGSRC</code> has precedence over
5754: <code class="varname">PREFER_NATIVE</code>. For example, to require
5755: using pkgsrc versions of software for all but the most basic
5756: bits on a NetBSD system, you can set:</p>
5757: <pre class="programlisting">
1.100 rillig 5758: PREFER_PKGSRC= yes
5759: PREFER_NATIVE= getopt skey tcp_wrappers
5760: </pre>
1.87 wiz 5761: <p>A package <span class="emphasis"><em>must</em></span> have a
5762: <code class="filename">builtin.mk</code>
5763: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5764: otherwise it is simply ignored in that list.</p>
1.75 rillig 5765: </div>
5766: </div>
5767: </div>
5768: <div class="chapter" lang="en">
5769: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5770: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5771: <div class="toc">
5772: <p><b>Table of Contents</b></p>
5773: <dl>
1.106 rillig 5774: <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 5775: <dd><dl>
1.106 rillig 5776: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5777: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5778: </dl></dd>
1.106 rillig 5779: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5780: <dd><dl>
1.116 rillig 5781: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106 rillig 5782: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5783: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5784: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5785: </dl></dd>
5786: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5787: <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>
5788: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5789: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5790: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5791: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5792: <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 5793: </dl>
5794: </div>
5795: <p>This chapter describes the framework known as
5796: <code class="literal">pkginstall</code>, whose key features are:</p>
5797: <div class="itemizedlist"><ul type="disc">
5798: <li><p>Generic installation and manipulation of directories and files
5799: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5800: <li><p>Automatic handling of configuration files during installation,
5801: provided that packages are correctly designed.</p></li>
5802: <li><p>Generation and installation of system startup scripts.</p></li>
5803: <li><p>Registration of system users and groups.</p></li>
5804: <li><p>Registration of system shells.</p></li>
5805: <li><p>Automatic updating of fonts databases.</p></li>
5806: </ul></div>
5807: <p>The following sections inspect each of the above points in detail.</p>
5808: <p>You may be thinking that many of the things described here could be
5809: easily done with simple code in the package's post-installation target
5810: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5811: as the code in them is only executed when building from source. Machines
5812: using binary packages could not benefit from it at all (as the code itself
5813: could be unavailable). Therefore, the only way to achieve any of the items
5814: described above is by means of the installation scripts, which are
5815: automatically generated by pkginstall.</p>
5816: <div class="sect1" lang="en">
5817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5818: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5819: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5820: of files and directories that belong to a package. The names used in it
1.76 rillig 5821: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5822: which means that it cannot register files outside this directory (absolute
5823: path names are not allowed). Despite this restriction, some packages need
5824: to install files outside this location; e.g., under
1.76 rillig 5825: <code class="filename">${VARBASE}</code> or
1.87 wiz 5826: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5827: is to create such files during installation time by using
5828: installation scripts.</p>
5829: <p>The generic installation scripts are shell scripts that can
5830: contain arbitrary code. The list of scripts to execute is taken from
5831: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5832: <code class="filename">INSTALL</code>. A similar variable exists for package
5833: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5834: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5835: commands, so they have the potential to create and manage files
5836: anywhere in the file system.</p>
5837: <p>Using these general installation files is not recommended, but
5838: may be needed in some special cases. One reason for avoiding them is
5839: that the user has to trust the packager that there is no unwanted or
5840: simply erroneous code included in the installation script. Also,
5841: previously there were many similar scripts for the same functionality,
5842: and fixing a common error involved finding and changing all of
5843: them.</p>
5844: <p>The pkginstall framework offers another, standardized way. It
5845: provides generic scripts to abstract the manipulation of such files
5846: and directories based on variables set in the package's
5847: <code class="filename">Makefile</code>. The rest of this section describes
5848: these variables.</p>
1.75 rillig 5849: <div class="sect2" lang="en">
5850: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5851: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5852: <p>The following variables can be set to request the creation of
5853: directories anywhere in the file system:</p>
5854: <div class="itemizedlist"><ul type="disc">
5855: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5856: contain a list of directories that should be created and should attempt
5857: to be destroyed by the installation scripts. The difference between
5858: the two is that the latter prompts the administrator to remove any
5859: directories that may be left after deinstallation (because they were
5860: not empty), while the former does not.</p></li>
5861: <li>
5862: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5863: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5864: which directories should be created and should attempt to be destroyed
5865: by the installation scripts. Each tuple holds the following values,
5866: separated by spaces: the directory name, its owner, its group and its
5867: numerical mode. For example:</p>
5868: <pre class="programlisting">
1.100 rillig 5869: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5870: </pre>
1.75 rillig 5871: <p>The difference between the two is exactly the same as their
5872: non-<code class="varname">PERMS</code> counterparts.</p>
5873: </li>
5874: </ul></div>
5875: </div>
5876: <div class="sect2" lang="en">
5877: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5878: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5879: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5880: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5881: To overcome this problem, the only solution is to extract the file in the
5882: known place (i.e., inside the installation prefix) and copy it to the
5883: appropriate location during installation (done by the installation scripts
5884: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5885: file</em></span> in the following paragraphs, which describe the variables
5886: that can be used to automatically and consistently handle files outside the
5887: installation prefix:</p>
5888: <div class="itemizedlist"><ul type="disc">
5889: <li>
5890: <p><code class="varname">CONF_FILES</code> and
5891: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5892: During installation time, the master file is copied to the target one
5893: if and only if the latter does not exist. Upon deinstallation, the
5894: target file is removed provided that it was not modified by the
5895: installation.</p>
5896: <p>The difference between the two is that the latter prompts the
5897: administrator to remove any files that may be left after
5898: deinstallation (because they were not empty), while the former does
5899: not.</p>
5900: </li>
5901: <li>
5902: <p><code class="varname">CONF_FILES_PERMS</code> and
5903: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5904: files as well as their target locations. For each of them, it also
5905: specifies their owner, their group and their numeric permissions, in
5906: this order. For example:</p>
5907: <pre class="programlisting">
1.100 rillig 5908: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5909: </pre>
1.75 rillig 5910: <p>The difference between the two is exactly the same as their
5911: non-<code class="varname">PERMS</code> counterparts.</p>
5912: </li>
5913: </ul></div>
5914: </div>
5915: </div>
5916: <div class="sect1" lang="en">
5917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5918: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5919: <p>Configuration files are special in the sense that they are installed
5920: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5921: need special treatment during installation (most of which is automated by
5922: pkginstall). The main concept you must bear in mind is that files marked
5923: as configuration files are automatically copied to the right place (somewhere
5924: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5925: and only if</em></span> they didn't exist before. Similarly, they will not
5926: be removed if they have local modifications. This ensures that
5927: administrators never lose any custom changes they may have made.</p>
5928: <div class="sect2" lang="en">
5929: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5930: <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 5931: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5932: specifies where configuration files shall be installed. Its contents are
5933: set based upon the following variables:</p>
5934: <div class="itemizedlist"><ul type="disc">
5935: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5936: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5937: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5938: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5939: Packages must not use it directly.</p></li>
5940: <li>
5941: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5942: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5943: for the package being built shall be installed. The definition of this
5944: variable only makes sense in the package's
1.76 rillig 5945: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5946: <p>As an example, consider the Apache package,
1.91 rillig 5947: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
1.75 rillig 5948: configuration files under the
1.76 rillig 5949: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5950: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5951: Makefile.</p>
5952: </li>
5953: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5954: variable that holds this package's configuration directory (if
5955: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5956: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5957: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5958: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5959: directory where the configuration files for the package identified by
5960: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5961: </ul></div>
5962: <p>Based on the above variables, pkginstall determines the value of
5963: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5964: variable that can be used within a package to refer to its configuration
5965: directory. The algorithm used to set its value is basically the
5966: following:</p>
5967: <div class="orderedlist"><ol type="1">
5968: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5969: its value is used.</p></li>
5970: <li><p>If the previous variable is not defined but
5971: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5972: <code class="filename">Makefile</code>, the resulting value is
5973: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 5974: <li><p>Otherwise, it is set to
1.76 rillig 5975: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5976: </ol></div>
1.76 rillig 5977: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 ! jnemeth 5978: 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
! 5979: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
! 5980: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5981: </div>
5982: <div class="sect2" lang="en">
5983: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5984: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5985: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5986: known place, you need to teach each package where it shall install its
5987: files. In some cases you will have to patch the package Makefiles to
5988: achieve it. If you are lucky, though, it may be as easy as passing an
5989: extra flag to the configuration script; this is the case of GNU Autoconf-
5990: generated files:</p>
5991: <pre class="programlisting">
1.100 rillig 5992: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5993: </pre>
1.75 rillig 5994: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5995: for</em></span> its configuration files, not where they will be originally
5996: installed (although the difference is never explicit,
5997: unfortunately).</p>
5998: </div>
5999: <div class="sect2" lang="en">
6000: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6001: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6002: <p>As said before, pkginstall automatically handles configuration files.
6003: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6004: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6005: directly</strong></span>. Bad news is that many software installation scripts
6006: will, out of the box, mess with the contents of that directory. So what is
6007: the correct procedure to fix this issue?</p>
6008: <p>You must teach the package (usually by manually patching it) to
6009: install any configuration files under the examples hierarchy,
1.76 rillig 6010: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6011: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6012: has the original copies available.</p>
6013: <p>Once the required configuration files are in place (i.e., under the
6014: examples hierarchy), the pkginstall framework can use them as master copies
6015: during the package installation to update what is in
1.76 rillig 6016: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6017: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 6018: 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 6019: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6020: <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 6021: <pre class="programlisting">
1.100 rillig 6022: EGDIR= ${PREFIX}/share/doc/mutt/samples
6023: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6024: </pre>
1.75 rillig 6025: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6026: package and has no meaning outside it.</p>
6027: </div>
6028: <div class="sect2" lang="en">
6029: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6030: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6031: <p>The automatic copying of config files can be toggled by setting the
6032: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6033: installation.</p>
6034: </div>
6035: </div>
6036: <div class="sect1" lang="en">
6037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6038: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 6039: <p>System startup scripts are special files because they must be
6040: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 6041: 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 6042: can be used. However, pkginstall provides a special mechanism to handle
6043: these files.</p>
6044: <p>In order to provide system startup scripts, the package has
6045: to:</p>
6046: <div class="orderedlist"><ol type="1">
1.76 rillig 6047: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6048: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6049: <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 6050: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6051: <li>
6052: <p>Tell pkginstall to handle it, appending the name of the script,
6053: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6054: Continuing the previous example:</p>
6055: <pre class="programlisting">
1.100 rillig 6056: RCD_SCRIPTS+= cupsd
1.1 grant 6057: </pre>
1.75 rillig 6058: </li>
6059: </ol></div>
6060: <p>Once this is done, pkginstall will do the following steps for each
6061: script in an automated fashion:</p>
6062: <div class="orderedlist"><ol type="1">
6063: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6064: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6065: variable.</p></li>
6066: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6067: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6068: that this master file must be explicitly registered in the
1.76 rillig 6069: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6070: <li><p>Add code to the installation scripts to copy the startup script
6071: from the examples hierarchy into the system-wide startup scripts
6072: directory.</p></li>
6073: </ol></div>
6074: <div class="sect2" lang="en">
6075: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6076: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6077: <p>The automatic copying of config files can be toggled by setting the
6078: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6079: installation. Note that the scripts will be always copied inside the
1.76 rillig 6080: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6081: matter what the value of this variable is.</p>
6082: </div>
6083: </div>
6084: <div class="sect1" lang="en">
6085: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6086: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 6087: <p>If a package needs to create special users and/or groups during
6088: installation, it can do so by using the pkginstall framework.</p>
6089: <p>Users can be created by adding entries to the
6090: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6091: syntax:</p>
6092: <pre class="programlisting">
1.100 rillig 6093: user:group
1.1 grant 6094: </pre>
1.87 wiz 6095: <p>Further specification of user details may be done by setting
6096: per-user variables.
6097: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6098: numeric UID for the user.
6099: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6100: user's description or comment.
6101: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6102: user's home directory, and defaults to
6103: <code class="filename">/nonexistent</code> if not specified.
6104: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6105: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6106: not specified.</p>
1.75 rillig 6107: <p>Similarly, groups can be created by adding entries to the
6108: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6109: <pre class="programlisting">
1.100 rillig 6110: group
1.1 grant 6111: </pre>
1.93 rillig 6112: <p>The numeric GID of the group may be set by defining
1.75 rillig 6113: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6114: <p>If a package needs to create the users and groups at an earlier
6115: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6116: either <code class="literal">configure</code> or <code class="literal">build</code> to
6117: indicate the phase before which the users and groups are created. In
6118: this case, the numeric UIDs and GIDs of the created users and groups
6119: are automatically hardcoded into the final installation scripts.</p>
6120: </div>
6121: <div class="sect1" lang="en">
6122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6123: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 6124: <p>Packages that install system shells should register them in the shell
1.76 rillig 6125: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6126: administrator. This must be done from the installation scripts to keep
6127: binary packages working on any system. pkginstall provides an easy way to
6128: accomplish this task.</p>
6129: <p>When a package provides a shell interpreter, it has to set the
6130: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6131: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6132: 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 6133: <pre class="programlisting">
1.100 rillig 6134: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6135: </pre>
1.75 rillig 6136: <div class="sect2" lang="en">
6137: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6138: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6139: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6140: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6141: environment variable to <code class="literal">NO</code>.</p>
6142: </div>
6143: </div>
6144: <div class="sect1" lang="en">
6145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6146: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 6147: <p>Packages that install X11 fonts should update the database files
6148: that index the fonts within each fonts directory. This can easily be
6149: accomplished within the pkginstall framework.</p>
6150: <p>When a package installs X11 fonts, it must list the directories in
6151: which fonts are installed in the
6152: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6153: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6154: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6155: installation scripts to run the appropriate commands to update the fonts
6156: database files within each of those directories. For convenience, if the
6157: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6158: 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 6159: <pre class="programlisting">
1.100 rillig 6160: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6161: </pre>
1.75 rillig 6162: <div class="sect2" lang="en">
6163: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6164: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6165: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6166: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6167: environment variable to <code class="literal">NO</code>.</p>
6168: </div>
6169: </div>
6170: </div>
6171: <div class="chapter" lang="en">
6172: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6173: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6174: <div class="toc">
6175: <p><b>Table of Contents</b></p>
6176: <dl>
1.106 rillig 6177: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116 rillig 6178: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106 rillig 6179: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6180: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6181: </dl>
6182: </div>
6183: <p>Many packages have the ability to be built to support different
1.76 rillig 6184: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6185: in pkgsrc that provides generic handling of those options that
6186: determine different ways in which the packages can be built. It's
6187: possible for the user to specify exactly which sets of options will be
6188: built into a package or to allow a set of global default options
6189: apply.</p>
1.107 rillig 6190: <p>There are two broad classes of behaviors that one might want to
6191: control via options. One is whether some particular feature is
6192: enabled in a program that will be built anyway, often by including or
6193: not including a dependency on some other package. The other is
6194: whether or not an additional program will be built as part of the
6195: package. Generally, it is better to make a split package for such
6196: additional programs instead of using options, because it enables
6197: binary packages to be built which can then be added separately. For
6198: example, the foo package might have minimal dependencies (those
6199: packages without which foo doesn't make sense), and then the foo-gfoo
6200: package might include the GTK frontend program gfoo. This is better
6201: than including a gtk option to foo that adds gfoo, because either that
6202: option is default, in which case binary users can't get foo without
6203: gfoo, or not default, in which case they can't get gfoo. With split
6204: packages, they can install foo without having GTK, and later decide to
6205: install gfoo (pulling in GTK at that time). This is an advantage to
6206: source users too, avoiding the need for rebuilds.</p>
6207: <p>Plugins with widely varying dependencies should usually be split
6208: instead of options.</p>
6209: <p>It is often more work to maintain split packages, especially if
6210: the upstream package does not support this. The decision of split
6211: vs. option should be made based on the likelihood that users will want
6212: or object to the various pieces, the size of the dependencies that are
6213: included, and the amount of work.</p>
6214: <p>A further consideration is licensing. Non-free parts, or parts
6215: that depend on non-free dependencies (especially plugins) should
6216: almost always be split if feasible.</p>
1.75 rillig 6217: <div class="sect1" lang="en">
6218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6219: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6220: <p>Global default options are listed in
6221: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6222: that should be built into every package if that option is supported.
1.110 hubertf 6223: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6224: </div>
6225: <div class="sect1" lang="en">
6226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6227: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6228: </h2></div></div></div>
1.75 rillig 6229: <p>The following example shows how
1.76 rillig 6230: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6231: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6232: <code class="filename">Makefile</code>, or in a file,
6233: e.g. <code class="filename">options.mk</code>, that is included by the
6234: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6235: <pre class="programlisting">
1.100 rillig 6236: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6237: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6238: PKG_OPTIONS_OPTIONAL_GROUPS= database
6239: PKG_OPTIONS_GROUP.database= mysql pgsql
6240: PKG_SUGGESTED_OPTIONS= wibble-foo
6241: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6242: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6243:
6244: .include "../../mk/bsd.prefs.mk"
6245:
6246: # this package was previously named wibble2
6247: .if defined(PKG_OPTIONS.wibble2)
6248: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6249: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6250: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6251: .endif
6252:
6253: .include "../../mk/bsd.options.mk"
6254:
6255: # Package-specific option-handling
6256:
6257: ###
6258: ### FOO support
6259: ###
6260: .if !empty(PKG_OPTIONS:Mwibble-foo)
6261: CONFIGURE_ARGS+= --enable-foo
6262: .endif
6263:
6264: ###
6265: ### LDAP support
6266: ###
6267: .if !empty(PKG_OPTIONS:Mldap)
6268: . include "../../databases/openldap-client/buildlink3.mk"
6269: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6270: .endif
6271:
6272: ###
6273: ### database support
6274: ###
6275: .if !empty(PKG_OPTIONS:Mmysql)
6276: . include "../../mk/mysql.buildlink3.mk"
6277: .endif
6278: .if !empty(PKG_OPTIONS:Mpgsql)
6279: . include "../../mk/pgsql.buildlink3.mk"
6280: .endif
1.75 rillig 6281: </pre>
6282: <p>The first section contains the information about which build
6283: options are supported by the package, and any default options settings
6284: if needed.</p>
6285: <div class="orderedlist"><ol type="1">
6286: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110 hubertf 6287: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75 rillig 6288: options. It should be set to
1.78 rillig 6289: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6290: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6291: at the point where the options are processed.</p></li>
1.75 rillig 6292: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6293: build options supported by the package.</p></li>
6294: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6295: list of names of groups of mutually exclusive options. The options in
6296: each group are listed in
6297: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6298: The most specific setting of any option from the group takes
6299: precedence over all other options in the group. Options from the
6300: groups will be automatically added to
6301: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6302: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6303: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6304: packages will fail if no option from the group is
6305: selected.</p></li>
6306: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6307: of names of sets of options. At least one option from each set must
6308: be selected. The options in each set are listed in
6309: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6310: Options from the sets will be automatically added to
6311: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6312: fail if no option from the set is selected.</p></li>
6313: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6314: build options which are enabled by default.</p></li>
6315: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6316: of
6317: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.110 hubertf 6318: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6319: their option counterparts. Pairs should be added with
6320: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6321: warning will be issued if the user uses a legacy
6322: variable.</p></li>
6323: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6324: of
6325: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6326: pairs that map options that have been renamed to their new
6327: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6328: the listing of global legacy options. A warning will be issued if
6329: the user uses a legacy option.</p></li>
6330: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6331: options implied by deprecated variables used. This can be used for
6332: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6333: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6334: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6335: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6336: a list of warnings about deprecated variables or options used, and
6337: what to use instead.</p></li>
6338: </ol></div>
6339: <p>A package should never modify
6340: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6341: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6342: To suggest a default set of options, use
6343: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6344: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6345: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6346: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6347: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6348: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6349: happen with platform-specific options if none of them is supported on
6350: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6351: empty list and the package is otherwise treated as not using the
6352: options framework.</p>
1.76 rillig 6353: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6354: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6355: build options, properly filtered to remove unsupported and duplicate
6356: options.</p>
6357: <p>The remaining sections contain the logic that is specific to
6358: each option. The correct way to check for an option is to check
6359: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6360: <pre class="programlisting">
1.100 rillig 6361: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6362: </pre>
6363: </div>
6364: <div class="sect1" lang="en">
6365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6366: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6367: <p>Options that enable similar features in different packages (like
6368: optional support for a library) should use a common name in all
6369: packages that support it (like the name of the library). If another
6370: package already has an option with the same meaning, use the same
6371: name.</p>
6372: <p>Options that enable features specific to one package, where it's
6373: unlikely that another (unrelated) package has the same (or a similar)
6374: optional feature, should use a name prefixed with
6375: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6376: <p>If a group of related packages share an optional feature
6377: specific to that group, prefix it with the name of the
6378: “<span class="quote">main</span>” package
6379: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6380: <p>For new options, add a line to
1.76 rillig 6381: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6382: fields, separated by tab. The first field is the option name, the
6383: second its description. The description should be a whole sentence
6384: (starting with an uppercase letter and ending with a period) that
6385: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6386: support.</span>” The file is sorted by option names.</p>
6387: </div>
1.107 rillig 6388: <div class="sect1" lang="en">
6389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6390: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6391: <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 6392: different dependencies based on the options with which the package was
6393: built. For querying these options, the file
6394: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6395: typical example looks like this:</p>
6396: <pre class="programlisting">
6397: pkgbase := libpurple
6398: .include "../../mk/pkg-build-options.mk"
6399:
6400: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6401: ...
6402: .endif
6403: </pre>
6404: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6405: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6406: options of the libpurple package, which can then be queried like
6407: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6408: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6409: details.</p>
6410: </div>
1.75 rillig 6411: </div>
6412: <div class="chapter" lang="en">
6413: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6414: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6415: <div class="toc">
6416: <p><b>Table of Contents</b></p>
6417: <dl>
1.106 rillig 6418: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6419: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6420: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6421: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116 rillig 6422: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106 rillig 6423: <dd><dl>
6424: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6425: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6426: </dl></dd>
1.116 rillig 6427: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
6428: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
6429: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
6430: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
6431: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
6432: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
6433: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
6434: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
6435: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
6436: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106 rillig 6437: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6438: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6439: </dl>
6440: </div>
6441: <div class="sect1" lang="en">
6442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6443: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6444: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6445: built. Building a package is separated into different
6446: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6447: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6448: described in the following sections. Each phase is splitted into
6449: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6450: containing phase, prefixed by one of <code class="varname">pre-</code>,
6451: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6452: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6453: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6454: <p>Never override the regular targets (like
6455: <code class="varname">fetch</code>), if you have to, override the
6456: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6457: <p>The basic steps for building a program are always the same. First
1.87 wiz 6458: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6459: the local system and then extracted. After any pkgsrc-specific patches
6460: to compile properly are applied, the software can be configured, then
6461: built (usually by compiling), and finally the generated binaries, etc.
6462: can be put into place on the system.</p>
1.97 rillig 6463: <p>To get more details about what is happening at each step,
6464: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6465: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6466: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6467: </div>
6468: <div class="sect1" lang="en">
6469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6470: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6471: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6472: the next section, here's a brief discussion on where programs are
6473: installed, and which variables influence this.</p>
1.75 rillig 6474: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6475: where all files of the final program shall be installed. It is
6476: usually set to <code class="varname">LOCALBASE</code>
6477: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6478: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6479: <code class="varname">PREFIX</code> needs to be put
6480: into the various places in the program's source where paths to
1.110 hubertf 6481: 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 6482: <p>When choosing which of these variables to use,
1.87 wiz 6483: follow the following rules:</p>
1.75 rillig 6484: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6485: <li><p><code class="varname">PREFIX</code> always points to the location
6486: where the current pkg will be installed. When referring to a
6487: pkg's own installation path, use
6488: “<span class="quote">${PREFIX}</span>”.</p></li>
6489: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6490: are installed. If you need to construct a -I or -L argument
6491: to the compiler to find includes and libraries installed by
6492: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6493: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6494: installed all packages in <code class="filename">/usr/local</code>. As
6495: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6496: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6497: <li><p><code class="varname">X11BASE</code> is where the actual X11
6498: distribution (from xsrc, etc.) is installed. When looking for
6499: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6500: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6501: <li>
6502: <p>X11-based packages are special in that they may be
6503: installed in either <code class="varname">X11BASE</code> or
6504: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6505: <p>Usually, X11 packages should be installed under
1.88 wiz 6506: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6507: will need to include
6508: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6509: request the presence of X11 and to get the right compilation
6510: flags.</p>
1.75 rillig 6511: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6512: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6513: files. These packages are special and they must be placed under
6514: <code class="varname">X11BASE</code>. To accomplish this, set either
6515: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6516: your package.</p>
1.75 rillig 6517: <p>Some notes: If you need
1.87 wiz 6518: to find includes or libraries installed by a pkg that has
6519: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6520: its pkg <code class="filename">Makefile</code>, you need to look in
6521: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6522: <code class="filename">${LOCALBASE}</code>. To force installation of
6523: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6524: <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 6525: is enabled by default.</p>
1.75 rillig 6526: </li>
1.88 wiz 6527: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6528: the installed location of an X11
6529: package. <code class="varname">X11PREFIX</code> will be set to
6530: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6531: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6532: installed.</p></li>
6533: <li>
6534: <p>If xpkgwedge is installed, it is possible to have some
6535: packages installed in <code class="varname">X11BASE</code> and some in
6536: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6537: installed package, the <code class="varname">EVAL_PREFIX</code>
6538: definition can be used. It takes pairs in the format
1.110 hubertf 6539: “<span class="quote">DIRNAME=<package></span>”, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 6540: variable <code class="varname">DIRNAME</code> will be set to the prefix
6541: of the installed package <package>, or
6542: “<span class="quote">${X11PREFIX}</span>” if the package is not
6543: installed.</p>
1.75 rillig 6544: <p>This is best illustrated by example.</p>
6545: <p>The following lines are taken from
1.87 wiz 6546: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6547: <pre class="programlisting">
1.100 rillig 6548: EVAL_PREFIX+= GTKDIR=gtk+
6549: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6550: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6551: CONFIGURE_ARGS+= --enable-multibyte
6552: </pre>
1.88 wiz 6553: <p>Specific defaults can be defined for the packages
6554: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6555: definition of the form:</p>
1.75 rillig 6556: <pre class="programlisting">
1.100 rillig 6557: GTKDIR_DEFAULT= ${LOCALBASE}
6558: </pre>
1.75 rillig 6559: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6560: to the first definition in
6561: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6562: </li>
1.76 rillig 6563: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110 hubertf 6564: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 6565: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6566: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6567: </ul></div>
6568: </div>
6569: <div class="sect1" lang="en">
6570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6571: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6572: <p>When building a package, various directories are used to store
1.87 wiz 6573: source files, temporary files, pkgsrc-internal files, and so on. These
6574: directories are explained here.</p>
1.75 rillig 6575: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6576: are two common base directories for these relative directories:
6577: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6578: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6579: inside the package itself.</p>
1.75 rillig 6580: <div class="variablelist"><dl>
6581: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6582: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6583: root directory. Generally, you don't need
6584: it.</p></dd>
1.97 rillig 6585: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6586: <dd><p>This is an absolute pathname that points to the
6587: current package.</p></dd>
1.75 rillig 6588: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6589: <dd><p>This is a pathname relative to
1.87 wiz 6590: <code class="varname">PKGSRCDIR</code> that points to the current
6591: package.</p></dd>
1.75 rillig 6592: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6593: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6594: where all work takes place. The distfiles are extracted to this
1.87 wiz 6595: directory. It also contains temporary directories and log files used by
6596: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6597: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6598: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6599: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6600: where the distfiles are extracted. It is usually a direct subdirectory
6601: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6602: that isn't hidden. This variable may be changed by a package
6603: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6604: </dl></div>
1.114 jmcneill 6605: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6606: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6607: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6608: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6609: If users would like to have their pkgsrc trees behave in a
6610: read-only manner, then the value of
6611: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6612: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6613: </div>
6614: <div class="sect1" lang="en">
6615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6616: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6617: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6618: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6619: phase. This will automatically run all phases that are required for this
6620: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6621: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6622: the package will be built, but not installed.</p>
1.75 rillig 6623: </div>
6624: <div class="sect1" lang="en">
6625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6626: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6627: <p>The first step in building a package is to fetch the
1.88 wiz 6628: distribution files (distfiles) from the sites that are providing
6629: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6630: phase.</p>
1.81 rillig 6631: <div class="sect2" lang="en">
6632: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6633: <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 6634: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6635: defines all URLs from where the distfile, whose name is
6636: derived from the <code class="varname">DISTNAME</code> variable, is
6637: fetched. The more complicated cases are described
6638: below.</p>
6639: <p>The variable <code class="varname">DISTFILES</code> specifies
6640: the list of distfiles that have to be fetched. Its value
6641: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6642: so that most packages don't need to define it at all.
6643: <code class="varname">EXTRACT_SUFX</code> is
6644: <code class="literal">.tar.gz</code> by default, but can be changed
6645: freely. Note that if your package requires additional
6646: distfiles to the default one, you cannot just append the
6647: additional filenames using the <code class="literal">+=</code>
6648: operator, but you have write for example:</p>
1.81 rillig 6649: <pre class="programlisting">
1.100 rillig 6650: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6651: </pre>
1.88 wiz 6652: <p>Each distfile is fetched from a list of sites, usually
6653: <code class="varname">MASTER_SITES</code>. If the package has multiple
6654: <code class="varname">DISTFILES</code> or multiple
6655: <code class="varname">PATCHFILES</code> from different sites, you can
6656: set
6657: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6658: to the list of URLs where the file
6659: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6660: (including the suffix) can be found.</p>
6661: <pre class="programlisting">
1.100 rillig 6662: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6663: DISTFILES+= foo-file.tar.gz
6664: SITES.foo-file.tar.gz= \
6665: http://www.somewhere.com/somehow/ \
6666: http://www.somewhereelse.com/mirror/somehow/
6667: </pre>
1.81 rillig 6668: <p>When actually fetching the distfiles, each item from
1.88 wiz 6669: <code class="varname">MASTER_SITES</code> or
6670: <code class="varname">SITES.*</code> gets the name of each distfile
6671: appended to it, without an intermediate slash. Therefore,
6672: all site values have to end with a slash or other separator
6673: character. This allows for example to set
6674: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6675: that gets the name of the distfile as a parameter. In this
6676: case, the definition would look like:</p>
1.81 rillig 6677: <pre class="programlisting">
1.100 rillig 6678: MASTER_SITES= http://www.example.com/download.cgi?file=
6679: </pre>
1.81 rillig 6680: <p>There are some predefined values for
1.88 wiz 6681: <code class="varname">MASTER_SITES</code>, which can be used in
6682: packages. The names of the variables should speak for
6683: themselves.</p>
6684: <pre class="programlisting">
1.100 rillig 6685: ${MASTER_SITE_APACHE}
6686: ${MASTER_SITE_BACKUP}
6687: ${MASTER_SITE_CYGWIN}
6688: ${MASTER_SITE_DEBIAN}
6689: ${MASTER_SITE_FREEBSD}
6690: ${MASTER_SITE_FREEBSD_LOCAL}
6691: ${MASTER_SITE_GENTOO}
6692: ${MASTER_SITE_GNOME}
6693: ${MASTER_SITE_GNU}
6694: ${MASTER_SITE_GNUSTEP}
6695: ${MASTER_SITE_IFARCHIVE}
6696: ${MASTER_SITE_KDE}
6697: ${MASTER_SITE_MOZILLA}
6698: ${MASTER_SITE_MYSQL}
6699: ${MASTER_SITE_OPENOFFICE}
6700: ${MASTER_SITE_PERL_CPAN}
6701: ${MASTER_SITE_PGSQL}
6702: ${MASTER_SITE_R_CRAN}
6703: ${MASTER_SITE_SOURCEFORGE}
6704: ${MASTER_SITE_SOURCEFORGE_JP}
6705: ${MASTER_SITE_SUNSITE}
6706: ${MASTER_SITE_SUSE}
6707: ${MASTER_SITE_TEX_CTAN}
6708: ${MASTER_SITE_XCONTRIB}
6709: ${MASTER_SITE_XEMACS}
6710: </pre>
1.88 wiz 6711: <p>Some explanations for the less self-explaining ones:
6712: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110 hubertf 6713: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
6714: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88 wiz 6715: <p>If you choose one of these predefined sites, you may
6716: want to specify a subdirectory of that site. Since these
6717: macros may expand to more than one actual site, you
6718: <span class="emphasis"><em>must</em></span> use the following construct to
6719: specify a subdirectory:</p>
1.81 rillig 6720: <pre class="programlisting">
1.100 rillig 6721: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6722: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6723: </pre>
1.81 rillig 6724: <p>Note the trailing slash after the subdirectory
1.88 wiz 6725: name.</p>
1.81 rillig 6726: </div>
6727: <div class="sect2" lang="en">
6728: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6729: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6730: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6731: all the distfiles exist in a local directory
1.93 rillig 6732: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6733: user). If the files do not exist, they are fetched using
6734: commands of the form</p>
1.75 rillig 6735: <pre class="programlisting">
1.100 rillig 6736: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6737: </pre>
1.88 wiz 6738: <p>where <code class="literal">${site}</code> varies through
6739: several possibilities in turn: first,
6740: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6741: sites specified in either <code class="varname">SITES.file</code> if
6742: defined, else <code class="varname">MASTER_SITES</code> or
6743: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6744: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6745: all except the first and the last can be optionally sorted
6746: by the user, via setting either
6747: <code class="varname">MASTER_SORT_RANDOM</code>, and
6748: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6749: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 ! jnemeth 6750: <p> The specific command and arguments used depend on the
! 6751: <code class="varname">FETCH_USING</code> parameter. The example above is
! 6752: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6753: <p>The distfiles mirror run by the NetBSD Foundation uses the
6754: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6755: distfiles, if they are freely distributable. Packages setting
6756: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6757: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6758: mirrored.</p>
1.81 rillig 6759: </div>
1.75 rillig 6760: </div>
6761: <div class="sect1" lang="en">
6762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6763: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6764: <p>After the distfile(s) are fetched, their checksum is
6765: generated and compared with the checksums stored in the
6766: distinfo file. If the checksums don't match, the build is
6767: aborted. This is to ensure the same distfile is used for
6768: building, and that the distfile wasn't changed, e.g. by some
6769: malign force, deliberately changed distfiles on the master
6770: distribution site or network lossage.</p>
1.75 rillig 6771: </div>
6772: <div class="sect1" lang="en">
6773: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6774: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6775: <p>When the distfiles are present on the local system, they
1.88 wiz 6776: need to be extracted, as they usually come in the form of some
6777: compressed archive format.</p>
1.75 rillig 6778: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6779: extracted. If you only need some of them, you can set the
6780: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6781: files.</p>
6782: <p>Extracting the files is usually done by a little
1.93 rillig 6783: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6784: already knows how to extract various archive formats, so most
6785: likely you will not need to change anything here. But if you
6786: need, the following variables may help you:</p>
1.75 rillig 6787: <div class="variablelist"><dl>
6788: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6789: <dd><p>Use these variables to override the default
1.88 wiz 6790: options for an extract command, which are defined in
1.93 rillig 6791: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6792: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6793: <dd><p>This variable can be set to
1.114 jmcneill 6794: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6795: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6796: absolute pathname pointing to the command with which tar
1.114 jmcneill 6797: archives should be extracted. It is preferred to choose bsdtar over gtar
6798: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6799: </dl></div>
1.88 wiz 6800: <p>If the <code class="filename">extract</code> program doesn't
6801: serve your needs, you can also override the
6802: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6803: command used for extracting the files. This command is
6804: executed in the <code class="filename">${WRKSRC}</code>
6805: directory. During execution of this command, the shell
6806: variable <code class="varname">extract_file</code> holds the absolute
6807: pathname of the file that is going to be extracted.</p>
1.75 rillig 6808: <p>And if that still does not suffice, you can override the
1.88 wiz 6809: <code class="varname">do-extract</code> target in the package
6810: Makefile.</p>
1.75 rillig 6811: </div>
6812: <div class="sect1" lang="en">
6813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6814: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6815: <p>After extraction, all the patches named by the
1.88 wiz 6816: <code class="varname">PATCHFILES</code>, those present in the patches
6817: subdirectory of the package as well as in
6818: $LOCALPATCHES/$PKGPATH (e.g.
6819: <code class="filename">/usr/local/patches/graphics/png</code>) are
6820: applied. Patchfiles ending in <code class="filename">.Z</code> or
6821: <code class="filename">.gz</code> are uncompressed before they are
6822: applied, files ending in <code class="filename">.orig</code> or
6823: <code class="filename">.rej</code> are ignored. Any special options to
1.110 hubertf 6824: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
6825: <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>
6826: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 6827: it fail if the patches apply with some lines of fuzz. Please
6828: fix (regen) the patches so that they apply cleanly. The
6829: rationale behind this is that patches that don't apply cleanly
6830: may end up being applied in the wrong place, and cause severe
6831: harm there.</p>
1.75 rillig 6832: </div>
6833: <div class="sect1" lang="en">
6834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6835: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6836: <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 6837: </p>
1.75 rillig 6838: </div>
6839: <div class="sect1" lang="en">
6840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6841: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6842: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6843: linkers. The following variables can be used to tweak the
6844: wrappers.</p>
1.75 rillig 6845: <div class="variablelist"><dl>
6846: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6847: <dd><p>The command used to print progress
1.88 wiz 6848: messages. Does nothing by default. Set to
6849: <code class="literal">${ECHO}</code> to see the progress
6850: messages.</p></dd>
1.75 rillig 6851: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6852: <dd><p>This variable can be set to
1.88 wiz 6853: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6854: depending on whether you want additional information in the
6855: wrapper log file.</p></dd>
1.75 rillig 6856: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6857: <dd><p>This variable can be set to
1.88 wiz 6858: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6859: on whether the wrapper should use its cache, which will
6860: improve the speed. The default value is
6861: <code class="literal">yes</code>, but is forced to
6862: <code class="literal">no</code> if the platform does not support
6863: it.</p></dd>
1.75 rillig 6864: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6865: <dd><p>A list of reordering commands. A reordering
6866: command has the form
6867: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6868: It ensures that that
6869: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6870: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6871: </p></dd>
1.75 rillig 6872: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6873: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6874: investigate further]</p></dd>
1.75 rillig 6875: </dl></div>
6876: </div>
6877: <div class="sect1" lang="en">
6878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6879: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6880: <p>Most pieces of software need information on the header
6881: files, system calls, and library routines which are available
6882: on the platform they run on. The process of determining this
6883: information is known as configuration, and is usually
6884: automated. In most cases, a script is supplied with the
6885: distfiles, and its invocation results in generation of header
6886: files, Makefiles, etc.</p>
6887: <p>If the package contains a configure script, this can be
6888: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6889: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6890: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6891: “<span class="quote">yes</span>” instead. What happens in the
6892: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6893: <pre class="programlisting">
1.100 rillig 6894: .for d in ${CONFIGURE_DIRS}
6895: cd ${WRKSRC} \
6896: && cd ${d} \
6897: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6898: .endfor
6899: </pre>
1.88 wiz 6900: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6901: “<span class="quote">.</span>”) is a list of pathnames relative to
6902: <code class="varname">WRKSRC</code>. In each of these directories, the
6903: configure script is run with the environment
6904: <code class="varname">CONFIGURE_ENV</code> and arguments
6905: <code class="varname">CONFIGURE_ARGS</code>. The variables
6906: <code class="varname">CONFIGURE_ENV</code>,
6907: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6908: “<span class="quote">./configure</span>”) and
6909: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6910: package.</p>
6911: <p>If the program uses an <code class="filename">Imakefile</code>
6912: for configuration, the appropriate steps can be invoked by
6913: setting <code class="varname">USE_IMAKE</code> to
6914: “<span class="quote">yes</span>”. (If you only want the package installed in
6915: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6916: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6917: xmkmf's environment by adding them to the
6918: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6919: <p>If the program uses <code class="filename">cmake</code>
6920: for configuration, the appropriate steps can be invoked by
6921: setting <code class="varname">USE_CMAKE</code> to “<span class="quote">yes</span>”.
6922: You can add variables to cmake's environment by adding them to the
6923: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6924: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6925: The top directory argument is given by the
6926: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
6927: “<span class="quote">.</span>” (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6928: <p>If there is no configure step at all, set
6929: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6930: </div>
6931: <div class="sect1" lang="en">
6932: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6933: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6934: <p>For building a package, a rough equivalent of the
6935: following code is executed.</p>
1.75 rillig 6936: <pre class="programlisting">
1.100 rillig 6937: .for d in ${BUILD_DIRS}
6938: cd ${WRKSRC} \
6939: && cd ${d} \
6940: && env ${MAKE_ENV} \
6941: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6942: -f ${MAKE_FILE} \
6943: ${BUILD_TARGET}
6944: .endfor
6945: </pre>
1.88 wiz 6946: <p><code class="varname">BUILD_DIRS</code> (default:
6947: “<span class="quote">.</span>”) is a list of pathnames relative to
6948: <code class="varname">WRKSRC</code>. In each of these directories,
6949: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6950: <code class="varname">MAKE_ENV</code> and arguments
6951: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6952: <code class="varname">MAKE_ENV</code>,
6953: <code class="varname">BUILD_MAKE_FLAGS</code>,
6954: <code class="varname">MAKE_FILE</code> and
6955: <code class="varname">BUILD_TARGET</code> may all be changed by the
6956: package.</p>
1.75 rillig 6957: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6958: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6959: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6960: default value of <code class="varname">MAKE_FILE</code> is
6961: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6962: defaults to “<span class="quote">all</span>”.</p>
1.97 rillig 6963: <p>If there is no build step at all, set
6964: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6965: </div>
6966: <div class="sect1" lang="en">
6967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6968: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6969: <p>[TODO]</p>
6970: </div>
6971: <div class="sect1" lang="en">
6972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6973: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6974: <p>Once the build stage has completed, the final step is to
1.88 wiz 6975: install the software in public directories, so users can
6976: access the programs and files.</p>
1.75 rillig 6977: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6978: equivalent of the following code is executed. Additionally,
6979: before and after this code, much magic is performed to do
6980: consistency checks, registering the package, and so on.</p>
6981: <pre class="programlisting">
1.100 rillig 6982: .for d in ${INSTALL_DIRS}
6983: cd ${WRKSRC} \
6984: && cd ${d} \
6985: && env ${MAKE_ENV} \
6986: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6987: -f ${MAKE_FILE} \
6988: ${INSTALL_TARGET}
6989: .endfor
6990: </pre>
1.75 rillig 6991: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6992: <span class="emphasis"><em>build</em></span> phase.
6993: <code class="varname">INSTALL_DIRS</code> defaults to
6994: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6995: is “<span class="quote">install</span>” by default, plus
6996: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6997: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6998: defined.</p>
1.75 rillig 6999: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 7000: variables are useful. They are all variations of the
1.110 hubertf 7001: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 7002: permissions preset. <code class="varname">INSTALL</code> is the plain
7003: install command. The specialized variants, together with their
7004: intended use, are:</p>
1.75 rillig 7005: <div class="variablelist"><dl>
7006: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7007: <dd><p>directories that contain
7008: binaries</p></dd>
1.75 rillig 7009: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7010: <dd><p>directories that contain
7011: scripts</p></dd>
1.75 rillig 7012: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7013: <dd><p>directories that contain shared and static
7014: libraries</p></dd>
1.75 rillig 7015: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7016: <dd><p>directories that contain data
7017: files</p></dd>
1.75 rillig 7018: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7019: <dd><p>directories that contain man
7020: pages</p></dd>
1.75 rillig 7021: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7022: <dd><p>binaries that can be stripped from debugging
7023: symbols</p></dd>
1.75 rillig 7024: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7025: <dd><p>binaries that cannot be
7026: stripped</p></dd>
1.75 rillig 7027: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7028: <dd><p>game
7029: binaries</p></dd>
1.75 rillig 7030: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7031: <dd><p>shared and static
7032: libraries</p></dd>
1.75 rillig 7033: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7034: <dd><p>data files</p></dd>
7035: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7036: <dd><p>data files for
7037: games</p></dd>
1.75 rillig 7038: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7039: <dd><p>man pages</p></dd>
7040: </dl></div>
7041: <p>Some other variables are:</p>
7042: <div class="variablelist"><dl>
7043: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7044: <dd><p>A list of directories relative to
1.88 wiz 7045: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7046: beginning of the <span class="emphasis"><em>install</em></span> phase.
7047: The package is supposed to create all needed directories itself
7048: before installing files to it and list all other directories here.
7049: </p></dd>
1.75 rillig 7050: </dl></div>
1.97 rillig 7051: <p>In the rare cases that a package shouldn't install anything,
7052: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7053: mostly relevant for packages in the <code class="filename">regress</code>
7054: category.</p>
1.75 rillig 7055: </div>
7056: <div class="sect1" lang="en">
7057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7058: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7059: <p>Once the install stage has completed, a binary package of
7060: the installed files can be built. These binary packages can be
7061: used for quick installation without previous compilation, e.g. by
1.110 hubertf 7062: the <span class="command"><strong>make bin-install</strong></span> or by using
7063: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 7064: <p>By default, the binary packages are created in
7065: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7066: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7067: one for each category in the <code class="varname">CATEGORIES</code>
7068: variable. <code class="varname">PACKAGES</code> defaults to
7069: <code class="filename">pkgsrc/packages</code>.</p>
1.97 rillig 7070: <p>If there should be no binary package, set
7071: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7072: This should only be used in rare cases, like when a package
7073: definitely is only usable on the machine where it is built and even
7074: then, a binary package can be useful.</p>
1.88 wiz 7075: </div>
7076: <div class="sect1" lang="en">
7077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7078: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 7079: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 7080: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 7081: to clean the work directories of all dependencies too, use
1.110 hubertf 7082: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 7083: </div>
7084: <div class="sect1" lang="en">
7085: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7086: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7087: <div class="variablelist"><dl>
7088: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7089: <dd><p>For any of the main targets described in the
7090: previous section, two auxiliary targets exist with
1.87 wiz 7091: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7092: prefix for the main target's name. These targets are
1.88 wiz 7093: invoked before and after the main target is called,
7094: allowing extra configuration or installation steps be
7095: performed from a package's Makefile, for example, which
7096: a program's configure script or install target
7097: omitted.</p></dd>
1.75 rillig 7098: <dt><span class="term">do-*</span></dt>
1.88 wiz 7099: <dd><p>Should one of the main targets do the wrong thing,
7100: and should there be no variable to fix this, you can
7101: redefine it with the do-* target. (Note that redefining
7102: the target itself instead of the do-* target is a bad
7103: idea, as the pre-* and post-* targets won't be called
7104: anymore, etc.) You will not usually need to do
7105: this.</p></dd>
1.75 rillig 7106: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7107: <dd>
1.110 hubertf 7108: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 7109: you noticed some file was not installed properly, you
7110: can repeat the installation with this target, which will
7111: ignore the “<span class="quote">already installed</span>” flag.</p>
7112: <p>This is the default value of
7113: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 7114: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 7115: package</strong></span>, where the defaults are
7116: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7117: respectively.</p>
7118: </dd>
1.75 rillig 7119: <dt><span class="term">deinstall</span></dt>
7120: <dd>
1.110 hubertf 7121: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 7122: current directory, effectively de-installing the
7123: package. The following variables can be used to tune the
7124: behaviour:</p>
1.75 rillig 7125: <div class="variablelist"><dl>
7126: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110 hubertf 7127: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 7128: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7129: <dd><p>Remove all packages that require (depend on)
7130: the given package. This can be used to remove any
7131: packages that may have been pulled in by a given
1.110 hubertf 7132: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7133: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7134: <code class="filename">pkgsrc/x11/kde</code>, this is
7135: likely to remove whole KDE. Works by adding
1.110 hubertf 7136: “<span class="quote">-R</span>” to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 7137: command line.</p></dd>
1.75 rillig 7138: </dl></div>
7139: </dd>
1.88 wiz 7140: <dt><span class="term">bin-install</span></dt>
7141: <dd><p>Install a binary package from local disk and via FTP
7142: from a list of sites (see the
7143: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7144: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7145: available anywhere. The arguments given to
1.110 hubertf 7146: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7147: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7148: operation, etc.</p></dd>
1.75 rillig 7149: <dt><span class="term">update</span></dt>
7150: <dd>
1.88 wiz 7151: <p>This target causes the current package to be
7152: updated to the latest version. The package and all
7153: depending packages first get de-installed, then current
7154: versions of the corresponding packages get compiled and
7155: installed. This is similar to manually noting which
7156: packages are currently installed, then performing a
1.110 hubertf 7157: series of <span class="command"><strong>make deinstall</strong></span> and
7158: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7159: <code class="varname">UPDATE_TARGET</code> is set to) for these
7160: packages.</p>
7161: <p>You can use the “<span class="quote">update</span>” target to
1.110 hubertf 7162: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7163: update</strong></span> was interrupted for some reason.
7164: However, in this case, make sure you don't call
1.110 hubertf 7165: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7166: list of dependent packages in <code class="varname">WRKDIR</code>.
7167: Otherwise, you lose the ability to automatically update
7168: the current package along with the dependent packages
7169: you have installed.</p>
1.110 hubertf 7170: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7171: update</strong></span> will only work as long as the package
7172: tree remains unchanged. If the source code for one of
7173: the packages to be updated has been changed, resuming
1.110 hubertf 7174: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7175: fail!</p>
7176: <p>The following variables can be used either on the
1.110 hubertf 7177: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7178: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7179: update</strong></span>:</p>
1.75 rillig 7180: <div class="variablelist"><dl>
7181: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7182: <dd><p>Install target to recursively use for the
7183: updated package and the dependent packages.
7184: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7185: set, “<span class="quote">install</span>” otherwise for
1.110 hubertf 7186: <span class="command"><strong>make update</strong></span>. Other good
1.88 wiz 7187: targets are “<span class="quote">package</span>” or
7188: “<span class="quote">bin-install</span>”. Do not set this to
7189: “<span class="quote">update</span>” or you will get stuck in an
7190: endless loop!</p></dd>
1.75 rillig 7191: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7192: <dd><p>Don't clean up after updating. Useful if
7193: you want to leave the work sources of the updated
7194: packages around for inspection or other purposes.
7195: Be sure you eventually clean up the source tree
7196: (see the “<span class="quote">clean-update</span>” target below)
7197: or you may run into troubles with old source code
7198: still lying around on your next
1.110 hubertf 7199: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7200: update</strong></span>.</p></dd>
1.75 rillig 7201: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7202: <dd><p>Deinstall each package before installing
7203: (making <code class="varname">DEPENDS_TARGET</code>). This
7204: may be necessary if the
7205: “<span class="quote">clean-update</span>” target (see below) was
1.110 hubertf 7206: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7207: update</strong></span>.</p></dd>
1.75 rillig 7208: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7209: <dd><p>Allows you to disable recursion and hardcode
7210: the target for packages. The default is
7211: “<span class="quote">update</span>” for the update target,
7212: facilitating a recursive update of prerequisite
7213: packages. Only set
7214: <code class="varname">DEPENDS_TARGET</code> if you want to
7215: disable recursive updates. Use
7216: <code class="varname">UPDATE_TARGET</code> instead to just
7217: set a specific target for each package to be
1.110 hubertf 7218: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7219: (see above).</p></dd>
1.75 rillig 7220: </dl></div>
7221: </dd>
7222: <dt><span class="term">clean-update</span></dt>
7223: <dd>
1.88 wiz 7224: <p>Clean the source tree for all packages that would
1.110 hubertf 7225: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7226: from the current directory. This target should not be
7227: used if the current package (or any of its depending
7228: packages) have already been de-installed (e.g., after
1.110 hubertf 7229: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7230: some packages you intended to update. As a rule of
7231: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7232: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7233: and only if you have a dirty package tree (e.g., if you
7234: used <code class="varname">NOCLEAN</code>).</p>
7235: <p>If you are unsure about whether your tree is
1.110 hubertf 7236: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7237: clean</strong></span> at the top of the tree, or use the
7238: following sequence of commands from the directory of the
7239: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7240: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7241: time, otherwise you lose all the packages you wanted to
7242: update!):</p>
1.87 wiz 7243: <pre class="screen">
7244: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7245: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7246: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7247: </pre>
1.88 wiz 7248: <p>The following variables can be used either on the
1.110 hubertf 7249: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7250: <span class="command"><strong>make clean-update</strong></span>:</p>
1.75 rillig 7251: <div class="variablelist"><dl>
7252: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7253: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7254: reconstruct the list of directories to update for
1.110 hubertf 7255: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7256: update</strong></span> successfully installed all
7257: packages you wanted to update. Normally, this is
1.110 hubertf 7258: done automatically on <span class="command"><strong>make
1.88 wiz 7259: update</strong></span>, but may have been suppressed by
7260: the <code class="varname">NOCLEAN</code> variable (see
7261: above).</p></dd>
1.75 rillig 7262: </dl></div>
7263: </dd>
1.88 wiz 7264: <dt><span class="term">replace</span></dt>
7265: <dd>
7266: <p>Update the installation of the current package. This
7267: differs from update in that it does not replace dependent
1.93 rillig 7268: 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 7269: target to work.</p>
7270: <p><span class="emphasis"><em>Be careful when using this
7271: target!</em></span> There are no guarantees that dependent
7272: packages will still work, in particular they will most
1.110 hubertf 7273: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7274: library package whose shared library major version changed
7275: between your installed version and the new one. For this
7276: reason, this target is not officially supported and only
7277: recommended for advanced users.</p>
7278: </dd>
1.75 rillig 7279: <dt><span class="term">info</span></dt>
1.110 hubertf 7280: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 7281: package. You can use this to check which version of a
7282: package is installed.</p></dd>
7283: <dt><span class="term">index</span></dt>
7284: <dd>
7285: <p>This is a top-level command, i.e. it should be used in
7286: the <code class="filename">pkgsrc</code> directory. It creates a
7287: database of all packages in the local pkgsrc tree, including
7288: dependencies, comment, maintainer, and some other useful
7289: information. Individual entries are created by running
1.110 hubertf 7290: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7291: directories. This index file is saved as
7292: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7293: verbose format by running <span class="command"><strong>make
1.88 wiz 7294: print-index</strong></span>. You can search in it with
1.110 hubertf 7295: <span class="command"><strong>make search
1.88 wiz 7296: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7297: extract a list of all packages that depend on a particular
1.110 hubertf 7298: one by running <span class="command"><strong>make show-deps
1.88 wiz 7299: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7300: <p>Running this command takes a very long time, some
7301: hours even on fast machines!</p>
7302: </dd>
1.75 rillig 7303: <dt><span class="term">readme</span></dt>
1.88 wiz 7304: <dd>
7305: <p>This target generates a
7306: <code class="filename">README.html</code> file, which can be
1.91 rillig 7307: 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 7308: contain references to any packages which are in the
7309: <code class="varname">PACKAGES</code> directory on the local
7310: host. The generated files can be made to refer to URLs
7311: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7312: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7313: wanted to generate <code class="filename">README.html</code>
7314: files which pointed to binary packages on the local
7315: machine, in the directory
7316: <code class="filename">/usr/packages</code>, set
7317: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7318: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7319: <code class="varname">${PACKAGES}</code> directory and its
7320: subdirectories will be searched for all the binary
7321: packages.</p>
7322: <p>The target can be run at the toplevel or in category
7323: directories, in which case it descends recursively.</p>
7324: </dd>
1.75 rillig 7325: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7326: <dd><p>This is a top-level command, run it in
7327: <code class="filename">pkgsrc</code>. Use this target to create a
7328: file <code class="filename">README-all.html</code> which contains a
7329: list of all packages currently available in the NetBSD
7330: Packages Collection, together with the category they belong
7331: to and a short description. This file is compiled from the
7332: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7333: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7334: readme</strong></span>.</p></dd>
1.75 rillig 7335: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7336: <dd><p>This is very much the same as the
7337: “<span class="quote">readme</span>” target (see above), but is to be
7338: used when generating a pkgsrc tree to be written to a
7339: CD-ROM. This target also produces
7340: <code class="filename">README.html</code> files, and can be made
7341: to refer to URLs based on
7342: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7343: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7344: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7345: <dd><p>This target shows which distfiles and patchfiles
7346: are needed to build the package
7347: (<code class="varname">ALLFILES</code>, which contains all
7348: <code class="varname">DISTFILES</code> and
1.87 wiz 7349: <code class="varname">PATCHFILES</code>, but not
7350: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7351: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7352: <dd><p>This target shows nothing if the package is not
7353: installed. If a version of this package is installed,
7354: but is not the version provided in this version of
7355: pkgsrc, then a warning message is displayed. This target
7356: can be used to show which of your installed packages are
7357: downlevel, and so the old versions can be deleted, and
7358: the current ones added.</p></dd>
1.75 rillig 7359: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7360: <dd><p>This target shows the directory in the pkgsrc
7361: hierarchy from which the package can be built and
7362: installed. This may not be the same directory as the one
7363: from which the package was installed. This target is
7364: intended to be used by people who may wish to upgrade
7365: many packages on a single host, and can be invoked from
7366: the top-level pkgsrc Makefile by using the
1.87 wiz 7367: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7368: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7369: <dd><p>This target shows which installed packages match
7370: the current package's <code class="varname">DEPENDS</code>. Useful
7371: if out of date dependencies are causing build
7372: problems.</p></dd>
1.75 rillig 7373: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7374: <dd><p>After a package is installed, check all its
7375: binaries and (on ELF platforms) shared libraries to see
7376: if they find the shared libs they need. Run by default
1.110 hubertf 7377: 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 7378: <dt><span class="term">print-PLIST</span></dt>
7379: <dd>
7380: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7381: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7382: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7383: -newer work/.extract_done</strong></span>. An attempt is made
7384: to care for shared libs etc., but it is
1.87 wiz 7385: <span class="emphasis"><em>strongly</em></span> recommended to review the
7386: result before putting it into
7387: <code class="filename">PLIST</code>. On upgrades, it's useful to
7388: diff the output of this command against an already
7389: existing <code class="filename">PLIST</code> file.</p>
1.110 hubertf 7390: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 7391: other methods that don't update file access times, be
7392: sure to add these files manually to your
1.87 wiz 7393: <code class="filename">PLIST</code>, as the “<span class="quote">find
7394: -newer</span>” command used by this target won't catch
7395: them!</p>
1.116 rillig 7396: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of make print-PLIST”</a> for more
1.87 wiz 7397: information on this target.</p>
1.75 rillig 7398: </dd>
7399: <dt><span class="term">bulk-package</span></dt>
7400: <dd>
1.88 wiz 7401: <p>Used to do bulk builds. If an appropriate binary
7402: package already exists, no action is taken. If not, this
7403: target will compile, install and package it (and its
7404: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110 hubertf 7405: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.88 wiz 7406: After creating the binary package, the sources, the
7407: just-installed package and its required packages are
7408: removed, preserving free disk space.</p>
7409: <p><span class="emphasis"><em>Beware that this target may deinstall
7410: all packages installed on a system!</em></span></p>
1.75 rillig 7411: </dd>
7412: <dt><span class="term">bulk-install</span></dt>
7413: <dd>
1.88 wiz 7414: <p>Used during bulk-installs to install required
7415: packages. If an up-to-date binary package is available,
1.110 hubertf 7416: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
7417: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7418: but the installed binary won't be removed.</p>
1.88 wiz 7419: <p>A binary package is considered
7420: “<span class="quote">up-to-date</span>” to be installed via
1.110 hubertf 7421: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.88 wiz 7422: <div class="itemizedlist"><ul type="disc">
7423: <li><p>None of the package's files
7424: (<code class="filename">Makefile</code>, ...) were modified
7425: since it was built.</p></li>
7426: <li><p>None of the package's required (binary)
7427: packages were modified since it was built.</p></li>
1.75 rillig 7428: </ul></div>
1.88 wiz 7429: <p><span class="emphasis"><em>Beware that this target may deinstall
7430: all packages installed on a system!</em></span></p>
1.75 rillig 7431: </dd>
7432: </dl></div>
7433: </div>
7434: </div>
7435: <div class="chapter" lang="en">
7436: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7437: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7438: <div class="toc">
7439: <p><b>Table of Contents</b></p>
7440: <dl>
1.106 rillig 7441: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7442: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7443: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7444: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7445: </dl>
7446: </div>
1.87 wiz 7447: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7448: by pkgsrc and also for individual packages to define what commands
7449: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7450: or for later run-time of an installed packaged (such as
7451: <code class="varname">DEPENDS</code>).
7452: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7453: package will not be used.</p>
7454: <p>When building a package, the replacement tools are
1.75 rillig 7455: made available in a directory (as symlinks or wrapper scripts)
7456: that is early in the executable search path. Just like the buildlink
1.87 wiz 7457: system, this helps with consistent builds.</p>
7458: <p>A tool may be needed to help build a specific package. For example,
7459: perl, GNU make (gmake) or yacc may be needed.</p>
7460: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7461: tool may be inefficient for building a package with pkgsrc.
7462: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7463: yacc) or a better sed.</p>
7464: <p>The tools used by a package can be listed by running
1.110 hubertf 7465: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75 rillig 7466: <div class="sect1" lang="en">
7467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7468: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7469: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7470: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7471: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7472: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7473: These can be seen by running:
1.110 hubertf 7474: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7475: <p>If a package needs a specific program to build
1.75 rillig 7476: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7477: to define the tools needed.</p>
1.75 rillig 7478: </div>
7479: <div class="sect1" lang="en">
7480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7481: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7482: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7483: and not the native version for a build dependency.
7484: And the :run means that it is used for a
7485: run-time dependencies also (and becomes a DEPENDS).
7486: The default is a build dependency which can be set with
7487: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7488: and pkg-config:build.)</p>
1.75 rillig 7489: <pre class="programlisting">
7490: USE_TOOLS+= mktemp:pkgsrc
7491: USE_TOOLS+= gmake perl:run pkg-config
7492: </pre>
1.87 wiz 7493: <p>When using the tools framework, a
1.75 rillig 7494: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7495: which contains the full path to the appropriate tool. For example,
7496: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7497: on Linux systems.</p>
7498: <p>If you always need a pkgsrc version of the
1.75 rillig 7499: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7500: </p>
7501: </div>
7502: <div class="sect1" lang="en">
7503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7504: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7505: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7506: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7507: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7508: the name of the common tools. For example:</p>
7509: <pre class="programlisting">
7510: .if exists(/usr/bin/bzcat)
7511: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7512: .elif exists(/usr/bin/bzip2)
7513: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7514: .endif
1.69 rillig 7515:
1.75 rillig 7516: TOOLS_PLATFORM.true?= true # shell builtin
7517: </pre>
7518: </div>
1.97 rillig 7519: <div class="sect1" lang="en">
7520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7521: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97 rillig 7522: <div class="qandaset">
7523: <dl>
1.106 rillig 7524: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7525: </dt>
1.106 rillig 7526: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7527: tools?</a>
7528: </dt>
1.106 rillig 7529: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7530: package is using while being built? I want to know whether it
7531: uses sed or not.</a>
7532: </dt>
7533: </dl>
7534: <table border="0" summary="Q and A Set">
7535: <col align="left" width="1%">
7536: <tbody>
7537: <tr class="question">
7538: <td align="left" valign="top">
1.117 ! jnemeth 7539: <a name="tools.new"></a><a name="id9503691"></a><p><b>18.4.1.</b></p>
1.97 rillig 7540: </td>
7541: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7542: </tr>
7543: <tr class="answer">
7544: <td align="left" valign="top"></td>
7545: <td align="left" valign="top"><p>TODO</p></td>
7546: </tr>
7547: <tr class="question">
7548: <td align="left" valign="top">
1.117 ! jnemeth 7549: <a name="tools.listall"></a><a name="id9503700"></a><p><b>18.4.2.</b></p>
1.97 rillig 7550: </td>
7551: <td align="left" valign="top"><p>How do I get a list of all available
7552: tools?</p></td>
7553: </tr>
7554: <tr class="answer">
7555: <td align="left" valign="top"></td>
7556: <td align="left" valign="top"><p>TODO</p></td>
7557: </tr>
7558: <tr class="question">
7559: <td align="left" valign="top">
1.117 ! jnemeth 7560: <a name="tools.used"></a><a name="id9503708"></a><p><b>18.4.3.</b></p>
1.97 rillig 7561: </td>
7562: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7563: package is using while being built? I want to know whether it
7564: uses sed or not.</p></td>
7565: </tr>
7566: <tr class="answer">
7567: <td align="left" valign="top"></td>
7568: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7569: to do it.)</p></td>
7570: </tr>
7571: </tbody>
7572: </table>
7573: </div>
7574: </div>
1.75 rillig 7575: </div>
7576: <div class="chapter" lang="en">
7577: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7578: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7579: <div class="toc">
7580: <p><b>Table of Contents</b></p>
7581: <dl>
1.106 rillig 7582: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7583: <dd><dl>
1.106 rillig 7584: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116 rillig 7585: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106 rillig 7586: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7587: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7588: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7589: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7590: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7591: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7592: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7593: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7594: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7595: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7596: </dl></dd>
1.116 rillig 7597: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106 rillig 7598: <dd><dl>
7599: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7600: <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>
7601: </dl></dd>
1.116 rillig 7602: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106 rillig 7603: <dd><dl>
7604: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7605: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7606: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7607: </dl></dd>
7608: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7609: <dd><dl>
7610: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7611: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7612: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7613: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7614: </dl></dd>
1.116 rillig 7615: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106 rillig 7616: <dd><dl>
7617: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7618: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116 rillig 7619: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106 rillig 7620: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7621: </dl></dd>
1.116 rillig 7622: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106 rillig 7623: <dd><dl>
7624: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7625: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7626: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7627: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7628: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7629: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7630: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7631: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7632: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106 rillig 7633: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
7634: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7635: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7636: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7637: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7638: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7639: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7640: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7641: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7642: emulation</a></span></dt>
1.106 rillig 7643: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7644: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7645: </dl></dd>
1.106 rillig 7646: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7647: </dl>
7648: </div>
7649: <div class="sect1" lang="en">
7650: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7651: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75 rillig 7652: <div class="sect2" lang="en">
7653: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7654: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7655: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7656: different platforms. As a result, it is important to ensure,
7657: where possible, that packages in pkgsrc are portable. This
7658: chapter mentions some particular details you should pay
7659: attention to while working on pkgsrc.</p>
1.78 rillig 7660: </div>
7661: <div class="sect2" lang="en">
7662: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7663: <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 7664: </h3></div></div></div>
1.78 rillig 7665: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7666: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7667: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7668: want to use those variables in the preprocessor directives of
1.110 hubertf 7669: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7670: <code class="literal">.for</code>), you need to include the file
7671: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7672: loads the user preferences.</p>
1.78 rillig 7673: <p>But note that some variables may not be completely defined
1.87 wiz 7674: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7675: included, as they may contain references to variables that are
7676: not yet defined. In shell commands this is no problem, since
7677: variables are actually macros, which are only expanded when they
7678: are used. But in the preprocessor directives mentioned above and
7679: in dependency lines (of the form <code class="literal">target:
7680: dependencies</code>) the variables are expanded at load
7681: time.</p>
1.78 rillig 7682: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7683: <h3 class="title">Note</h3>
7684: <p>Currently there is no exhaustive list of all
1.87 wiz 7685: variables that tells you whether they can be used at load time
7686: or only at run time, but it is in preparation.</p>
1.78 rillig 7687: </div>
7688: </div>
7689: <div class="sect2" lang="en">
7690: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7691: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7692: <p>Occasionally, packages require interaction from the user,
7693: and this can be in a number of ways:</p>
1.78 rillig 7694: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7695: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7696: interaction such as entering username/password or accepting a
7697: license on a web page.</p></li>
1.88 wiz 7698: <li><p>When extracting the distfiles, some packages may ask for
7699: passwords.</p></li>
1.78 rillig 7700: <li><p>help to configure the package before it is built</p></li>
7701: <li><p>help during the build process</p></li>
7702: <li><p>help during the installation of a package</p></li>
7703: </ul></div>
1.88 wiz 7704: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7705: provided to notify the pkgsrc mechanism of an interactive stage
7706: which will be needed, and this should be set in the package's
7707: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7708: <pre class="programlisting">
1.100 rillig 7709: INTERACTIVE_STAGE= build
1.87 wiz 7710: </pre>
1.78 rillig 7711: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7712: <pre class="programlisting">
1.100 rillig 7713: INTERACTIVE_STAGE= configure install
1.87 wiz 7714: </pre>
1.88 wiz 7715: <p>The user can then decide to skip this package by setting the
7716: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7717: </div>
7718: <div class="sect2" lang="en">
7719: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7720: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7721: <p>Authors of software can choose the licence under which
7722: software can be copied. This is due to copyright law, and reasons
7723: for license choices are outside the scope of pkgsrc. The pkgsrc
7724: system recognizes that there are a number of licenses which some
7725: users may find objectionable or difficult or impossible to comply
7726: with. The Free Software Foundation has declared some licenses
7727: "Free", and the Open Source Initiative has a definition of "Open
7728: Source". The pkgsrc system, as a policy choice, does not label
7729: packages which have licenses that are Free or Open Source.
7730: However, packages without a license meeting either of those tests
7731: are labeled with a license tag denoting the license. Note that a
7732: package with no license to copy trivially does not meet either the
7733: Free or Open Source test.</p>
7734: <p>For packages which are not Free or Open Source, pkgsrc will
7735: not build the package unless the user has indicated to pkgsrc that
7736: packages with that particular license may be built. Note that
7737: this documentation avoids the term "accepted the license". The
7738: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7739: accidentally building a package with a non-free license;
1.98 wiz 7740: judgement and responsibility remain with the user. (Installation
7741: of binary packages are not currently subject to this mechanism;
7742: this is a bug.)</p>
7743: <p>One might want to only install packages with a BSD license,
7744: or the GPL, and not the other. The pkgsrc license tag mechanism
7745: does not provide a way to do this. It might be possible to put in
7746: tags for free licenses, and have a default
7747: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7748: widely viewed as having a very poor ratio of benefit to
7749: work.</p>
1.78 rillig 7750: <p>The license tag mechanism is intended to address
1.87 wiz 7751: copyright-related issues surrounding building, installing and
7752: using a package, and not to address redistribution issues (see
7753: <code class="varname">RESTRICTED</code> and
7754: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7755: definition of licenses for which tags are not needed implies
7756: that packages with redistribution restrictions should have
1.98 wiz 7757: tags, because Free or Open Source programs do not have
7758: redistribution restrictions.</p>
7759: <p>Denoting that a package may be copied according to a
7760: particular license is done by placing the license in
1.87 wiz 7761: <code class="filename">pkgsrc/licenses</code> and setting the
7762: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7763: 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 7764: <pre class="programlisting">
1.100 rillig 7765: LICENSE= xv-license
1.87 wiz 7766: </pre>
7767: <p>When trying to build, the user will get a notice that the
1.98 wiz 7768: package is covered by a license which has not been placed in the
7769: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7770: <pre class="programlisting">
1.100 rillig 7771: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7772: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7773: ===> To view the license, enter "/usr/bin/make show-license".
7774: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7775: ===> ACCEPTABLE_LICENSES+=xv-license
7776: *** Error code 1
1.87 wiz 7777: </pre>
1.110 hubertf 7778: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7779: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7780: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7781: convey to pkgsrc that it should not in the future fail because of
7782: that license:</p>
1.78 rillig 7783: <pre class="programlisting">
1.100 rillig 7784: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7785: </pre>
1.98 wiz 7786: <p>When adding a package with a new license, the license text
7787: should be added to <code class="filename">pkgsrc/licenses</code> for
7788: displaying. A list of known licenses can be seen in this
1.91 rillig 7789: directory.</p>
1.98 wiz 7790: <p>When the license changes (in a way other than formatting),
7791: please make sure that the new license has a different name (e.g.,
7792: append the version number if it exists, or the date). Just
7793: because a user told pkgsrc to build programs under a previous
7794: version of a license does not mean that pkgsrc should build
1.99 rillig 7795: programs under the new licenses. The higher-level point is that
1.98 wiz 7796: pkgsrc does not evaluate licenses for reasonableness; the only
7797: test is a mechanistic test of whether a particular text has been
7798: approved by either of two bodies.</p>
1.78 rillig 7799: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7800: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7801: is deprecated because it does not crisply refer to a particular
7802: license text. Another problem with such usage is that it does not
7803: enable a user to tell pkgsrc to proceed for a single package
7804: without also telling pkgsrc to proceed for all packages with that
7805: tag.</p>
1.75 rillig 7806: </div>
7807: <div class="sect2" lang="en">
7808: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7809: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7810: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7811: Because a license tag is required unless the package is Free or
7812: Open Source, all packages with restrictions should have license
7813: tags. By declaring the restrictions, package tools can
7814: automatically refrain from e.g. placing binary packages on FTP
7815: sites.</p>
7816: <p>There are four restrictions that may be encoded, which are
7817: the cross product of sources (distfiles) and binaries not being
7818: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7819: language in any license, and because non-Free licenses tend to be
7820: different from each other, pkgsrc adopts a definition of FTP and
7821: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7822: should not be made available over the Internet at no charge.
7823: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7824: made available on some kind of media, together with other source
7825: and binary packages, and which is sold for a distribution charge.
7826: </p>
7827: <p>In order to encode these restrictions, the package system
1.87 wiz 7828: defines five make variables that can be set to note these
7829: restrictions:</p>
1.75 rillig 7830: <div class="itemizedlist"><ul type="disc">
7831: <li>
7832: <p><code class="varname">RESTRICTED</code></p>
7833: <p>This variable should be set whenever a restriction
1.87 wiz 7834: exists (regardless of its kind). Set this variable to a
1.98 wiz 7835: string containing the reason for the restriction. It should
7836: be understood that those wanting to understand the restriction
7837: will have to read the license, and perhaps seek advice of
7838: counsel.</p>
1.75 rillig 7839: </li>
7840: <li>
7841: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7842: <p>Binaries may not be placed on CD-ROM containing other
7843: binary packages, for which a distribution charge may be made.
7844: In this case, set this variable to
7845: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7846: </li>
7847: <li>
7848: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7849: <p>Binaries may not made available on the Internet without
7850: charge. In this case, set this variable to
7851: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7852: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7853: </li>
7854: <li>
7855: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7856: <p>Distfiles may not be placed on CD-ROM, together with
7857: other distfiles, for which a fee may be charged. In this
7858: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7859: </p>
1.75 rillig 7860: </li>
7861: <li>
7862: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7863: <p>Distfiles may not made available via FTP at no charge.
7864: In this case, set this variable to
7865: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7866: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7867: </li>
7868: </ul></div>
7869: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7870: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7871: generic make variables to denote restrictions is deprecated,
7872: because they unconditionally prevent users from generating
7873: binary packages!</p>
1.75 rillig 7874: </div>
7875: <div class="sect2" lang="en">
7876: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7877: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7878: <p>Your package may depend on some other package being present
1.88 wiz 7879: - and there are various ways of expressing this dependency.
7880: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7881: <code class="varname">DEPENDS</code> definitions, the
7882: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7883: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7884: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7885: 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 7886: <p>The basic difference between the two variables is as
1.87 wiz 7887: follows: The <code class="varname">DEPENDS</code> definition registers
7888: that pre-requisite in the binary package so it will be pulled in
7889: when the binary package is later installed, whilst the
7890: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7891: dependency that is only needed for building the package.</p>
1.75 rillig 7892: <p>This means that if you only need a package present whilst
1.87 wiz 7893: you are building, it should be noted as a
7894: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7895: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7896: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7897: <pre class="programlisting">
1.100 rillig 7898: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7899: </pre>
1.75 rillig 7900: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7901: may include any of the wildcard version numbers recognized by
1.110 hubertf 7902: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.75 rillig 7903: <div class="orderedlist"><ol type="1">
7904: <li>
7905: <p>If your package needs another package's binaries or
1.87 wiz 7906: libraries to build or run, and if that package has a
7907: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7908: <pre class="programlisting">
1.100 rillig 7909: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7910: </pre>
1.75 rillig 7911: </li>
7912: <li>
7913: <p>If your package needs to use another package to build
1.87 wiz 7914: itself and there is no <code class="filename">buildlink3.mk</code>
7915: file available, use the <code class="varname">BUILD_DEPENDS</code>
7916: definition:</p>
1.75 rillig 7917: <pre class="programlisting">
1.100 rillig 7918: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7919: </pre>
1.75 rillig 7920: </li>
7921: <li>
7922: <p>If your package needs a library with which to link and
1.76 rillig 7923: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7924: available, this is specified using the
7925: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7926: <pre class="programlisting">
1.100 rillig 7927: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7928: </pre>
1.109 rillig 7929: <p>You can also use wildcards in package dependencies:</p>
1.75 rillig 7930: <pre class="programlisting">
1.100 rillig 7931: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7932: </pre>
1.75 rillig 7933: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7934: creating binary packages. The dependency is checked when
7935: installing the binary package and any package which matches
7936: the pattern will be used. Wildcard dependencies should be
7937: used with care.</p>
1.75 rillig 7938: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7939: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7940: such as “<span class="quote">tk-postgresql</span>” matching a
7941: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7942: <p>Wildcards can also be used to specify that a package
1.87 wiz 7943: will only build against a certain minimum version of a
7944: pre-requisite:</p>
1.75 rillig 7945: <pre class="programlisting">
1.100 rillig 7946: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7947: </pre>
1.75 rillig 7948: <p>This means that the package will build against version
1.87 wiz 7949: 3.5.4 of the tiff library or newer. Such a dependency may
7950: be warranted if, for example, the API of the library has
7951: changed with version 3.5.4 and a package would not compile
7952: against an earlier version of tiff.</p>
1.75 rillig 7953: <p>Please note that such dependencies should only be
1.87 wiz 7954: updated if a package requires a newer pre-requisite, but
1.93 rillig 7955: not to denote recommendations such as
1.87 wiz 7956: ABI changes that do not prevent a package from building
7957: correctly. Such recommendations can be expressed using
7958: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7959: <pre class="programlisting">
1.100 rillig 7960: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7961: </pre>
1.75 rillig 7962: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7963: line, this denotes that while a package will build against
7964: tiff>=3.5.4, at least version 3.6.1 is recommended.
7965: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7966: dependencies unless explicitly ignored (in which case a
7967: warning will be printed).</p>
1.75 rillig 7968: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7969: use the required <code class="varname">DEPENDS</code>, set
7970: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7971: it easier and faster to update packages built using pkgsrc,
7972: since older compatible dependencies can continue to be
7973: used. This is useful for people who watch their rebuilds
7974: very carefully; it is not very good as a general-purpose
7975: hammer. If you use it, you need to be mindful of possible
7976: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7977: <p>Packages that are built with recommendations ignored
1.87 wiz 7978: may not be uploaded to ftp.NetBSD.org by developers and
7979: should not be used across different systems that may have
7980: different versions of binary packages installed.</p>
1.75 rillig 7981: <p>For security fixes, please update the package
1.110 hubertf 7982: 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 7983: information.</p>
1.75 rillig 7984: </li>
7985: <li>
7986: <p>If your package needs some executable to be able to run
1.87 wiz 7987: correctly and if there's no
7988: <code class="filename">buildlink3.mk</code> file, this is specified
7989: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7990: <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.87 wiz 7991: be able to execute the latex binary from the teTeX package
7992: when it runs, and that is specified:</p>
1.75 rillig 7993: <pre class="programlisting">
1.100 rillig 7994: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7995: </pre>
1.75 rillig 7996: <p>The comment about wildcard dependencies from previous
1.87 wiz 7997: paragraph applies here, too.</p>
1.75 rillig 7998: </li>
7999: </ol></div>
8000: <p>If your package needs files from another package to build,
1.87 wiz 8001: add the relevant distribution files to
8002: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8003: 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 8004: (It relies on the jpeg sources being present in source form
8005: during the build.)</p>
1.75 rillig 8006: </div>
8007: <div class="sect2" lang="en">
8008: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8009: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8010: <p>Your package may conflict with other packages a user might
1.87 wiz 8011: already have installed on his system, e.g. if your package
1.88 wiz 8012: installs the same set of files as another package in the pkgsrc
8013: tree.</p>
1.75 rillig 8014: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8015: space-separated list of packages (including version string) your
8016: package conflicts with.</p>
1.91 rillig 8017: <p>For example, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw3d/README.html" target="_top"><code class="filename">x11/Xaw3d</code></a>
8018: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.87 wiz 8019: install the same shared library, thus you set in
8020: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8021: <pre class="programlisting">
1.100 rillig 8022: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8023: </pre>
8024: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8025: <pre class="programlisting">
1.100 rillig 8026: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8027: </pre>
1.75 rillig 8028: <p>Packages will automatically conflict with other packages
1.87 wiz 8029: with the name prefix and a different version
8030: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8031: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 8032: </div>
8033: <div class="sect2" lang="en">
8034: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8035: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8036: <p>There are several reasons why a package might be
1.88 wiz 8037: instructed to not build under certain circumstances. If the
1.87 wiz 8038: package builds and runs on most platforms, the exceptions
8039: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8040: the package builds and runs on a small handful of platforms,
8041: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8042: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8043: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8044: (OS-version-platform) that can use glob-style
8045: wildcards.</p>
1.88 wiz 8046: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8047: 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 8048: backwards compatible with other versions of the OS, and should be
8049: uploaded to a version specific directory on the FTP server. Mark
8050: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8051: “<span class="quote">yes</span>”. This variable is not currently used by any of
8052: the package system internals, but may be used in the
8053: future.</p>
1.75 rillig 8054: <p>If the package should be skipped (for example, because it
1.87 wiz 8055: provides functionality already provided by the system), set
1.88 wiz 8056: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8057: the package should fail because some preconditions are not met,
8058: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8059: message.</p>
1.75 rillig 8060: </div>
8061: <div class="sect2" lang="en">
8062: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8063: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8064: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8065: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8066: be set in the package Makefile. This will be carried into any
8067: binary package that is made from this pkgsrc entry. A
8068: “<span class="quote">preserved</span>” package will
1.110 hubertf 8069: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.87 wiz 8070: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 8071: </div>
8072: <div class="sect2" lang="en">
8073: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8074: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8075: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8076: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110 hubertf 8077: and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87 wiz 8078: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8079: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8080: <code class="varname">PKGREVISION</code> should be increased (this
8081: is of course not necessary if the problem is fixed by using
8082: a newer release of the software).</p>
1.75 rillig 8083: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8084: branch, be sure to submit a pullup request!</p>
1.75 rillig 8085: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8086: semi-automatically by a weekly cron job.</p>
1.75 rillig 8087: </div>
8088: <div class="sect2" lang="en">
8089: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8090: <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 8091: <p>When making fixes to an existing package it can be useful
1.87 wiz 8092: to change the version number in <code class="varname">PKGNAME</code>. To
8093: avoid conflicting with future versions by the original author, a
8094: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8095: on package versions by setting <code class="varname">PKGREVISION=1</code>
8096: (2, ...). The “<span class="quote">nb</span>” is treated like a
8097: “<span class="quote">.</span>” by the package tools. e.g.</p>
8098: <pre class="programlisting">
1.100 rillig 8099: DISTNAME= foo-17.42
8100: PKGREVISION= 9
1.87 wiz 8101: </pre>
1.75 rillig 8102: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 8103: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8104: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8105: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8106: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8107: <p>When a new release of the package is released, the
1.87 wiz 8108: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8109: minor release of the above package, things should be like:</p>
1.75 rillig 8110: <pre class="programlisting">
1.100 rillig 8111: DISTNAME= foo-17.43
1.87 wiz 8112: </pre>
8113: <p><code class="varname">PKGREVISION</code> should be incremented for any
8114: non-trivial change in the resulting binary package. Without a
8115: <code class="varname">PKGREVISION</code> bump, someone with the previous
8116: version installed has no way of knowing that their package is out
8117: of date. Thus, changes without increasing
8118: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8119: trivial that no reasonable person would want to upgrade", and this
8120: is the rough test for when increasing
8121: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8122: changes that do not merit increasing
8123: <code class="varname">PKGREVISION</code> are:</p>
1.100 rillig 8124: <div class="itemizedlist"><ul type="disc">
1.114 jmcneill 8125: <li><p>Changing <code class="varname">HOMEPAGE</code>,
8126: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8127: or comments in Makefile.</p></li>
8128: <li><p>
8129: Changing build variables if the resulting binary package is the same.</p></li>
8130: <li><p>
8131: Changing <code class="filename">DESCR</code>.</p></li>
8132: <li><p>
8133: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8134: </ul></div>
1.87 wiz 8135: <p>Examples of changes that do merit an increase to
8136: <code class="varname">PKGREVISION</code> include:</p>
1.100 rillig 8137: <div class="itemizedlist"><ul type="disc">
8138: <li><p>
8139: Security fixes</p></li>
8140: <li><p>
8141: Changes or additions to a patch file</p></li>
8142: <li><p>
8143: Changes to the <code class="filename">PLIST</code></p></li>
1.112 weinem 8144: <li><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8145: </ul></div>
1.78 rillig 8146: <p>PKGREVISION must also be incremented when dependencies have ABI
8147: changes.</p>
1.75 rillig 8148: </div>
1.79 rillig 8149: <div class="sect2" lang="en">
8150: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8151: <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 8152: <p>When you want to replace the same text in multiple files
1.87 wiz 8153: or when the replacement text varies, patches alone cannot help.
8154: This is where the SUBST framework comes in. It provides an
8155: easy-to-use interface for replacing text in files.
8156: Example:</p>
8157: <pre class="programlisting">
1.100 rillig 8158: SUBST_CLASSES+= fix-paths
8159: SUBST_STAGE.fix-paths= pre-configure
8160: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8161: SUBST_FILES.fix-paths= src/*.c
8162: SUBST_FILES.fix-paths+= scripts/*.sh
8163: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8164: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8165: </pre>
1.79 rillig 8166: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8167: that are used to identify the different SUBST blocks that are
8168: defined. The SUBST framework is heavily used by pkgsrc, so it is
8169: important to always use the <code class="literal">+=</code> operator with
8170: this variable. Otherwise some substitutions may be
8171: skipped.</p>
1.79 rillig 8172: <p>The remaining variables of each SUBST block are
1.87 wiz 8173: parameterized with the identifier from the first line
8174: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8175: parameters to a function call.</p>
1.79 rillig 8176: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8177: which the replacement will take place. All combinations of
8178: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8179: <code class="literal">post-</code> together with a phase name are
8180: possible, though only few are actually used. Most commonly used
8181: are <code class="literal">post-patch</code> and
8182: <code class="literal">pre-configure</code>. Of these two,
8183: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8184: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8185: have the state after applying the patches but before making any
8186: other changes. This is especially useful when you are debugging
8187: a package in order to create new patches for it. Similarly,
8188: <code class="literal">post-build</code> is preferred over
8189: <code class="literal">pre-install</code>, because the install phase should
8190: generally be kept as simple as possible. When you use
8191: <code class="literal">post-build</code>, you have the same files in the
8192: working directory that will be installed later, so you can check
8193: if the substitution has succeeded.</p>
1.79 rillig 8194: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8195: that is printed just before the substitution is done.</p>
1.79 rillig 8196: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8197: globbing patterns that specifies the files in which the
8198: substitution will take place. The patterns are interpreted
8199: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8200: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110 hubertf 8201: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87 wiz 8202: command should be prefixed with <code class="literal">-e</code>, so that
8203: all SUBST blocks look uniform.</p>
1.79 rillig 8204: <p>There are some more variables, but they are so seldomly
1.87 wiz 8205: used that they are only documented in the
8206: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8207: </div>
1.75 rillig 8208: </div>
8209: <div class="sect1" lang="en">
8210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8211: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75 rillig 8212: <div class="sect2" lang="en">
8213: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8214: <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 8215: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8216: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8217: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8218: with the name of each file to download as an argument, expecting
8219: it to output the URL of the directory from which to download
1.91 rillig 8220: 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 8221: example of this usage.</p>
1.75 rillig 8222: <p>If the download can't be automated, because the user must
1.87 wiz 8223: submit personal information to apply for a password, or must pay
8224: for the source, or whatever, you can set
8225: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8226: displayed to the user before aborting the build. Example:</p>
8227: <pre class="programlisting">
1.100 rillig 8228: FETCH_MESSAGE= "Please download the files"
8229: FETCH_MESSAGE+= " "${DISTFILES:Q}
8230: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8231: </pre>
1.75 rillig 8232: </div>
8233: <div class="sect2" lang="en">
8234: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8235: <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 8236: <p>Sometimes authors of a software package make some
1.87 wiz 8237: modifications after the software was released, and they put up a
8238: new distfile without changing the package's version number. If a
8239: package is already in pkgsrc at that time, the checksum will
8240: no longer match. The contents of the new distfile should be
8241: compared against the old one before changing anything, to make
8242: sure the distfile was really updated on purpose, and that
8243: no trojan horse or so crept in.
1.97 rillig 8244: Please mention that the distfiles were compared and what was found
8245: in your commit message.
1.87 wiz 8246: Then, the correct way to work around this is to
8247: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8248: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8249: <code class="varname">DISTFILES</code> and
1.93 rillig 8250: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8251: subdirectory of the local distfiles directory.
1.110 hubertf 8252: (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 8253: In case this
1.87 wiz 8254: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8255: including the <code class="filename">nbX</code> suffix) or a date stamp
8256: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8257: Do not forget regenerating the <code class="filename">distinfo</code> file
8258: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8259: path in the filenames.
1.97 rillig 8260: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8261: Furthermore, a mail to the package's authors seems appropriate
8262: telling them that changing distfiles after releases without
8263: changing the file names is not good practice.</p>
1.75 rillig 8264: </div>
8265: </div>
8266: <div class="sect1" lang="en">
8267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8268: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75 rillig 8269: <div class="sect2" lang="en">
8270: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8271: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8272: <p>pkgsrc supports many different machines, with different
1.87 wiz 8273: object formats like a.out and ELF, and varying abilities to do
8274: shared library and dynamic loading at all. To accompany this,
8275: varying commands and options have to be passed to the
8276: compiler, linker, etc. to get the Right Thing, which can be
8277: pretty annoying especially if you don't have all the machines
8278: at your hand to test things. The
1.91 rillig 8279: <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.87 wiz 8280: can help here, as it just “<span class="quote">knows</span>” how to build
8281: both static and dynamic libraries from a set of source files,
8282: thus being platform-independent.</p>
8283: <p>Here's how to use libtool in a package in seven simple
8284: steps:</p>
1.75 rillig 8285: <div class="orderedlist"><ol type="1">
8286: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8287: Makefile.</p></li>
1.75 rillig 8288: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8289: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8290: add it to the definition of <code class="varname">CC</code>, if only
8291: libraries are being built in a given Makefile. This one command
8292: will build both PIC and non-PIC library objects, so you need not
8293: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8294: <li>
8295: <p>For the linking of the library, remove any
1.87 wiz 8296: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8297: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8298: <pre class="programlisting">
1.100 rillig 8299: ${LIBTOOL} --mode=link \
8300: ${CC} -o ${.TARGET:.a=.la} \
8301: ${OBJS:.o=.lo} \
8302: -rpath ${PREFIX}/lib \
8303: -version-info major:minor
1.87 wiz 8304: </pre>
1.75 rillig 8305: <p>Note that the library is changed to have a
1.87 wiz 8306: <code class="filename">.la</code> extension, and the objects are
8307: changed to have a <code class="filename">.lo</code>
8308: extension. Change <code class="varname">OBJS</code> as
8309: necessary. This automatically creates all of the
8310: <code class="filename">.a</code>,
8311: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8312: necessary) in the build directory. Be sure to include
8313: “<span class="quote">-version-info</span>”, especially when major and
8314: minor are zero, as libtool will otherwise strip off the
8315: shared library version.</p>
1.75 rillig 8316: <p>From the libtool manual:</p>
8317: <pre class="programlisting">
1.100 rillig 8318: So, libtool library versions are described by three integers:
1.69 rillig 8319:
1.100 rillig 8320: CURRENT
8321: The most recent interface number that this library implements.
1.69 rillig 8322:
1.100 rillig 8323: REVISION
8324: The implementation number of the CURRENT interface.
1.69 rillig 8325:
1.100 rillig 8326: AGE
8327: The difference between the newest and oldest interfaces that
8328: this library implements. In other words, the library implements
8329: all the interface numbers in the range from number `CURRENT -
8330: AGE' to `CURRENT'.
1.1 grant 8331:
1.100 rillig 8332: If two libraries have identical CURRENT and AGE numbers, then the
8333: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8334: </pre>
1.75 rillig 8335: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8336: different results for a.out and ELF (excluding symlinks)
8337: in only one case. An ELF library of the form
8338: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8339: will have a symlink of
8340: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8341: on an a.out platform. This is handled
8342: automatically.</p>
1.75 rillig 8343: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8344: directory of the library being built.</p>
1.76 rillig 8345: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8346: <code class="filename">.la</code> file, the other files will be
8347: added automatically.</p>
1.75 rillig 8348: </li>
8349: <li>
1.76 rillig 8350: <p>When linking shared object (<code class="filename">.so</code>)
1.110 hubertf 8351: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.87 wiz 8352: shared libraries, use “<span class="quote">-module
8353: -avoid-version</span>” to prevent them getting version
8354: tacked on.</p>
1.76 rillig 8355: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8356: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8357: </li>
8358: <li>
8359: <p>When linking programs that depend on these libraries
1.87 wiz 8360: <span class="emphasis"><em>before</em></span> they are installed, preface
1.110 hubertf 8361: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><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-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with “<span class="quote">${LIBTOOL}
1.87 wiz 8362: --mode=link</span>”, and it will find the correct
8363: libraries (static or shared), but please be aware that
8364: libtool will not allow you to specify a relative path in
8365: -L (such as “<span class="quote">-L../somelib</span>”), because it
8366: expects you to change that argument to be the
8367: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8368: <pre class="programlisting">
1.100 rillig 8369: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8370: </pre>
1.75 rillig 8371: <p>should be changed to:</p>
8372: <pre class="programlisting">
1.100 rillig 8373: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8374: </pre>
1.75 rillig 8375: <p>and it will do the right thing with the libraries.</p>
8376: </li>
8377: <li>
1.110 hubertf 8378: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8379: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with “<span class="quote">${LIBTOOL}
1.87 wiz 8380: --mode=install</span>”, and change the library name to
8381: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8382: <pre class="programlisting">
1.100 rillig 8383: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8384: </pre>
1.76 rillig 8385: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8386: shared library, any needed symlinks, and run
1.110 hubertf 8387: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8388: </li>
1.76 rillig 8389: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8390: the <code class="filename">.la</code>
8391: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8392: </ol></div>
8393: </div>
8394: <div class="sect2" lang="en">
8395: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8396: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8397: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8398: package Makefile. This will override the package's own libtool
8399: in most cases. For older libtool using packages, libtool is
8400: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8401: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8402: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8403: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8404: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8405: default, it is set to “<span class="quote">libtool */libtool
8406: */*/libtool</span>”. If this does not match the location of the
8407: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8408: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8409: libraries built and installed, then use
8410: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8411: <p>If your package makes use of the platform-independent library
1.87 wiz 8412: for loading dynamic shared objects, that comes with libtool
8413: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8414: <p>Some packages use libtool incorrectly so that the package
8415: may not work or build in some circumstances. Some of the more
8416: common errors are:</p>
1.75 rillig 8417: <div class="itemizedlist"><ul type="disc">
8418: <li>
8419: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8420: executable or library. This in itself isn't a problem if one of two things
8421: has been done:</p>
1.75 rillig 8422: <div class="orderedlist"><ol type="1">
8423: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8424: <code class="filename">libfoo.la</code>, not
8425: <code class="filename">foo.la</code></p></li>
1.75 rillig 8426: <li><p>The -dlopen option is used when linking an executable.</p></li>
8427: </ol></div>
8428: </li>
8429: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8430: The function lt_dlinit() should be called and the macro
8431: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8432: executables.</p></li>
1.75 rillig 8433: </ul></div>
8434: </div>
8435: <div class="sect2" lang="en">
8436: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8437: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8438: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8439: to regenerate the configure script and Makefile.in makefile
8440: templates, then they should be executed in a pre-configure
8441: target.</p>
1.75 rillig 8442: <p>For packages that need only autoconf:</p>
8443: <pre class="programlisting">
1.100 rillig 8444: AUTOCONF_REQD= 2.50 # if default version is not good enough
8445: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8446: ...
1.1 grant 8447:
1.100 rillig 8448: pre-configure:
8449: cd ${WRKSRC} && autoconf
1.1 grant 8450:
1.100 rillig 8451: ...
1.87 wiz 8452: </pre>
1.75 rillig 8453: <p>and for packages that need automake and autoconf:</p>
8454: <pre class="programlisting">
1.100 rillig 8455: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8456: USE_TOOLS+= automake # use "automake14" for automake-1.4
8457: ...
8458:
8459: pre-configure:
8460: set -e; cd ${WRKSRC}; \
8461: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8462:
1.100 rillig 8463: ...
1.87 wiz 8464: </pre>
1.75 rillig 8465: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8466: require GNU Make.</p>
1.75 rillig 8467: <p>There are times when the configure process makes
1.87 wiz 8468: additional changes to the generated files, which then causes
8469: the build process to try to re-execute the automake sequence.
8470: This is prevented by touching various files in the configure
8471: stage. If this causes problems with your package you can set
8472: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8473: Makefile.</p>
1.75 rillig 8474: </div>
8475: </div>
8476: <div class="sect1" lang="en">
8477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8478: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87 wiz 8479: <div class="sect2" lang="en">
8480: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8481: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8482: <p>Compilers for the C, C++, and Fortran languages comes with
8483: the NetBSD base system. By default, pkgsrc assumes that a package
8484: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8485: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8486: <p>To declare which language's compiler a package needs, set
8487: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8488: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8489: “<span class="quote">fortran</span>” (and any combination). The default is
8490: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8491: written in C++, usually need a C compiler for the configure
8492: phase.</p>
8493: </div>
8494: <div class="sect2" lang="en">
8495: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8496: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8497: <p>If a program is written in Java, use the Java framework in
8498: pkgsrc. The package must include
8499: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8500: provides the following variables:</p>
8501: <div class="itemizedlist"><ul type="disc">
8502: <li><p><code class="varname">USE_JAVA</code> defines if a build
8503: dependency on the JDK is added. If
8504: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8505: there is only a runtime dependency on the JDK. The default is
8506: “<span class="quote">yes</span>”, which also adds a build dependency on the
8507: JDK.</p></li>
8508: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8509: a package needs a Java2 implementation. The supported values
8510: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8511: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8512: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8513: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8514: above. This variable is not set by default.</p></li>
8515: </ul></div>
8516: </div>
8517: <div class="sect2" lang="en">
8518: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8519: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8520: <p>If your package contains interpreted perl scripts, add
8521: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8522: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8523: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8524: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8525: that you want adjusted. Every occurrence of
8526: <code class="filename">*/bin/perl</code> will be replaced with the full
8527: path to the perl executable.</p>
8528: <p>If a particular version of perl is needed, set the
8529: <code class="varname">PERL5_REQD</code> variable to the version number. The
8530: default is “<span class="quote">5.0</span>”.</p>
1.110 hubertf 8531: <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 8532: about handling perl modules.</p>
8533: </div>
8534: <div class="sect2" lang="en">
8535: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8536: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8537: <p>Currently, there is no special handling for other languages
8538: in pkgsrc. If a compiler package provides a
8539: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8540: just add a (build) dependency on the appropriate compiler
8541: package.</p>
8542: </div>
8543: </div>
8544: <div class="sect1" lang="en">
8545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8546: <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 8547: <p>The most common failures when building a package are that
8548: some platforms do not provide certain header files, functions or
8549: libraries, or they provide the functions in a library that the
8550: original package author didn't know. To work around this, you
8551: can rewrite the source code in most cases so that it does not
8552: use the missing functions or provides a replacement function.</p>
8553: <div class="sect2" lang="en">
8554: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8555: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8556: <p>If a package already comes with a GNU configure script, the
8557: preferred way to fix the build failure is to change the
8558: configure script, not the code. In the other cases, you can
8559: utilize the C preprocessor, which defines certain macros
8560: depending on the operating system and hardware architecture it
8561: compiles for. These macros can be queried using for example
8562: <code class="varname">#if defined(__i386)</code>. Almost every operating
8563: system, hardware architecture and compiler has its own macro.
8564: For example, if the macros <code class="varname">__GNUC__</code>,
8565: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8566: are all defined, you know that you are using NetBSD on an i386
8567: compatible CPU, and your compiler is GCC.</p>
8568: <p>The list of the following macros for hardware and
8569: operating system depends on the compiler that is used. For
8570: example, if you want to conditionally compile code on Solaris,
8571: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8572: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8573: <div class="sect3" lang="en">
8574: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8575: <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 8576: <p>To distinguish between 4.4 BSD-derived systems and the
8577: rest of the world, you should use the following code.</p>
8578: <pre class="programlisting">
1.100 rillig 8579: #include <sys/param.h>
8580: #if (defined(BSD) && BSD >= 199306)
8581: /* BSD-specific code goes here */
8582: #else
8583: /* non-BSD-specific code goes here */
8584: #endif
1.75 rillig 8585: </pre>
1.77 rillig 8586: <p>If this distinction is not fine enough, you can also test
8587: for the following macros.</p>
1.75 rillig 8588: <pre class="programlisting">
1.100 rillig 8589: FreeBSD __FreeBSD__
8590: DragonFly __DragonFly__
8591: Interix __INTERIX
8592: IRIX __sgi (TODO: get a definite source for this)
8593: Linux linux, __linux, __linux__
8594: NetBSD __NetBSD__
8595: OpenBSD __OpenBSD__
8596: Solaris sun, __sun
1.75 rillig 8597: </pre>
8598: </div>
8599: <div class="sect3" lang="en">
8600: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8601: <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 8602: <pre class="programlisting">
1.100 rillig 8603: i386 i386, __i386, __i386__
8604: MIPS __mips
8605: SPARC sparc, __sparc
1.75 rillig 8606: </pre>
8607: </div>
8608: <div class="sect3" lang="en">
8609: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8610: <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 8611: <pre class="programlisting">
1.100 rillig 8612: GCC __GNUC__ (major version), __GNUC_MINOR__
8613: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8614: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8615: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8616: </pre>
8617: </div>
8618: </div>
1.78 rillig 8619: <div class="sect2" lang="en">
8620: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8621: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8622: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8623: combinations of compiler version and architecture and almost
8624: always relation to optimisation being enabled. Common symptoms
8625: are gcc internal errors or never finishing compiling a
1.78 rillig 8626: file.</p>
8627: <p>Typically, a workaround involves testing the
8628: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8629: optimisation for that combination of file,
8630: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8631: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8632: number of examples.</p>
8633: </div>
8634: <div class="sect2" lang="en">
8635: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8636: <a name="undefined-reference"></a>19.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8637: <p>This error message often means that a package did not
1.78 rillig 8638: link to a shared library it needs. The following functions are
8639: known to cause this error message over and over.</p>
8640: <div class="informaltable">
8641: <a name="undefined-reference-functions"></a><table border="1">
8642: <colgroup>
8643: <col>
8644: <col>
8645: <col>
8646: </colgroup>
8647: <thead><tr>
8648: <th>Function</th>
8649: <th>Library</th>
8650: <th>Affected platforms</th>
8651: </tr></thead>
8652: <tbody>
8653: <tr>
8654: <td>accept, bind, connect</td>
8655: <td>-lsocket</td>
8656: <td>Solaris</td>
8657: </tr>
8658: <tr>
8659: <td>crypt</td>
8660: <td>-lcrypt</td>
8661: <td>DragonFly, NetBSD</td>
8662: </tr>
8663: <tr>
8664: <td>dlopen, dlsym</td>
8665: <td>-ldl</td>
8666: <td>Linux</td>
8667: </tr>
8668: <tr>
8669: <td>gethost*</td>
8670: <td>-lnsl</td>
8671: <td>Solaris</td>
8672: </tr>
8673: <tr>
8674: <td>inet_aton</td>
8675: <td>-lresolv</td>
8676: <td>Solaris</td>
8677: </tr>
8678: <tr>
8679: <td>nanosleep, sem_*, timer_*</td>
8680: <td>-lrt</td>
8681: <td>Solaris</td>
8682: </tr>
8683: <tr>
8684: <td>openpty</td>
8685: <td>-lutil</td>
8686: <td>Linux</td>
8687: </tr>
8688: </tbody>
8689: </table>
8690: </div>
8691: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8692: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8693: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8694: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8695: bmake</strong></span>.</p>
1.92 rillig 8696: <div class="sect3" lang="en">
8697: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8698: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8699: <p>When you are using the SunPro compiler, there is another
8700: possibility. That compiler cannot handle the following code:</p>
8701: <pre class="programlisting">
1.100 rillig 8702: extern int extern_func(int);
1.93 rillig 8703:
1.100 rillig 8704: static inline int
8705: inline_func(int x)
8706: {
1.92 rillig 8707: return extern_func(x);
1.100 rillig 8708: }
1.93 rillig 8709:
1.100 rillig 8710: int main(void)
8711: {
1.92 rillig 8712: return 0;
1.100 rillig 8713: }
1.92 rillig 8714: </pre>
8715: <p>It generates the code for <code class="function">inline_func</code> even if
8716: that function is never used. This code then refers to
8717: <code class="function">extern_func</code>, which can usually not be resolved. To
8718: solve this problem you can try to tell the package to disable inlining
8719: of functions.</p>
8720: </div>
1.87 wiz 8721: </div>
8722: <div class="sect2" lang="en">
8723: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8724: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8725: <p>Sometimes packages fail to build because the compiler runs
8726: into an operating system specific soft limit. With the
8727: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8728: to unlimit the resources. Currently, the allowed values are
8729: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8730: Setting this variable is similar to running the shell builtin
1.110 hubertf 8731: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8732: segment size or maximum stack size of a process, respectively, to
8733: their hard limits.</p>
1.78 rillig 8734: </div>
1.75 rillig 8735: </div>
8736: <div class="sect1" lang="en">
8737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8738: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 8739: <div class="sect2" lang="en">
8740: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8741: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8742: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8743: with some operating systems cannot create more than one
8744: directory at a time. As such, you should call
8745: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8746: <pre class="programlisting">
1.100 rillig 8747: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8748: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8749: </pre>
1.78 rillig 8750: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8751: dir2</code></span>” to the
8752: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8753: automatically do the right thing.</p>
1.75 rillig 8754: </div>
8755: <div class="sect2" lang="en">
8756: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8757: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8758: <p>In general, documentation should be installed into
1.87 wiz 8759: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8760: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8761: includes the version number of the package).</p>
1.84 wiz 8762: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8763: directory where HTML documentation is installed with the
8764: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8765: is needed because otherwise the documentation ends up in
8766: <code class="filename">${PREFIX}/share/doc/html</code> or other
8767: places.</p>
8768: <p>An exception to the above is that library API documentation
1.91 rillig 8769: 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 8770: browsers (devhelp) should be left at their default location, which
8771: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8772: documentation can be recognized from files ending in
8773: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8774: (It is also acceptable to install such files in
8775: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8776: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8777: <code class="filename">.devhelp*</code> file must be directly in that
8778: directory then, no additional subdirectory level is allowed in
8779: this case. This is usually achieved by using
8780: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8781: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8782: though.)</p>
1.75 rillig 8783: </div>
8784: <div class="sect2" lang="en">
8785: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8786: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8787: <p>Certain packages, most of them in the games category, install
1.87 wiz 8788: a score file that allows all users on the system to record their
8789: highscores. In order for this to work, the binaries need to be
8790: installed setgid and the score files owned by the appropriate
8791: group and/or owner (traditionally the "games" user/group). The
8792: following variables, documented in more detail in
8793: <code class="filename">mk/defaults/mk.conf</code>, control this
8794: behaviour: <code class="varname">SETGIDGAME</code>,
8795: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8796: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8797: <p>Note that per default, setgid installation of games is
1.87 wiz 8798: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8799: the other variables accordingly.</p>
1.114 jmcneill 8800: <p>A package should therefore never hard code file ownership or
1.87 wiz 8801: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8802: <code class="varname">INSTALL_GAME_DATA</code> to set these
8803: correctly.</p>
1.75 rillig 8804: </div>
8805: <div class="sect2" lang="en">
8806: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8807: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8808: <p><code class="varname">DESTDIR</code> support means that a package
8809: installs into a staging directory, not the final location of the
8810: files. Then a binary package is created which can be used for
8811: installation as usual. There are two ways: Either the package must
8812: install as root (“<span class="quote">destdir</span>”) or the package can
8813: install as non-root user (“<span class="quote">user-destdir</span>”).</p>
8814: <div class="itemizedlist"><ul type="disc">
8815: <li><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
8816: set to “<span class="quote">destdir</span>” or “<span class="quote">user-destdir</span>”. If
8817: bsd.prefs.mk is included in the Makefile,
8818: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8819: the inclusion.</p></li>
1.103 wiz 8820: <li><p>All installation operations have to be prefixed with
8821: <code class="filename">${DESTDIR}</code>.</p></li>
8822: <li><p>automake gets this DESTDIR mostly right
8823: automatically. Many manual rules and pre/post-install often are
8824: incorrect; fix them.</p></li>
8825: <li><p>If files are installed with special owner/group
8826: either use @owner/@group in the <code class="filename">PLIST</code>
8827: (preferred) or use <code class="varname">SPECIAL_PERMS</code>
8828: (discouraged). Note that @owner/@group are sticky during
8829: install, keep this in mind.</p></li>
8830: <li><p>In general, packages should support
8831: <code class="varname">UNPRIVILEGED</code> to be able to use
8832: DESTDIR.</p></li>
8833: </ul></div>
8834: </div>
8835: <div class="sect2" lang="en">
8836: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8837: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8838: <p>Your package may also contain scripts with hardcoded paths to
8839: other interpreters besides (or as well as) perl. To correct the
8840: full pathname to the script interpreter, you need to set the
8841: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8842: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8843: <pre class="programlisting">
1.100 rillig 8844: REPLACE_INTERPRETER+= tcl
8845: REPLACE.tcl.old= .*/bin/tclsh
8846: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8847: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8848: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8849: </pre>
1.75 rillig 8850: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8851: <h3 class="title">Note</h3>
8852: <p>Before March 2006, these variables were called
1.87 wiz 8853: <code class="varname">_REPLACE.*</code> and
8854: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8855: </div>
8856: </div>
8857: <div class="sect2" lang="en">
8858: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8859: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8860: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8861: the Makefile fragment
8862: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8863: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8864: configuration for such modules as well as various hooks to tune
8865: this configuration. See comments in this file for
8866: details.</p>
1.75 rillig 8867: <p>Perl5 modules will install into different places depending
1.87 wiz 8868: on the version of perl used during the build process. To
8869: address this, pkgsrc will append lines to the
8870: <code class="filename">PLIST</code> corresponding to the files listed in
8871: the installed <code class="filename">.packlist</code> file generated by
8872: most perl5 modules. This is invoked by defining
8873: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8874: paths to packlist files, e.g.:</p>
1.75 rillig 8875: <pre class="programlisting">
1.100 rillig 8876: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8877: </pre>
1.75 rillig 8878: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8879: <code class="varname">PERL5_SITEARCH</code>, and
8880: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8881: in which perl5 modules may be installed, and may be used by
8882: perl5 packages that don't have a packlist. These three
8883: variables are also substituted for in the
8884: <code class="filename">PLIST</code>.</p>
1.75 rillig 8885: </div>
8886: <div class="sect2" lang="en">
8887: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8888: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8889: <p>Some packages install info files or use the
1.87 wiz 8890: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8891: commands. <code class="varname">INFO_FILES</code> should be defined in
8892: the package Makefile so that <code class="filename">INSTALL</code> and
8893: <code class="filename">DEINSTALL</code> scripts will be generated to
8894: handle registration of the info files in the Info directory
8895: file. The “<span class="quote">install-info</span>” command used for the info
8896: files registration is either provided by the system, or by a
8897: special purpose package automatically added as dependency if
8898: needed.</p>
1.75 rillig 8899: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8900: <code class="filename">${PREFIX}</code> where info files are primarily
8901: located. <code class="varname">PKGINFODIR</code> defaults to
8902: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8903: <p>The info files for the package should be listed in the
1.87 wiz 8904: package <code class="filename">PLIST</code>; however any split info files
8905: need not be listed.</p>
1.75 rillig 8906: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8907: at build time must add “<span class="quote">makeinfo</span>” to
8908: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8909: version of the “<span class="quote">makeinfo</span>” command is needed it
8910: should be noted with the <code class="varname">TEXINFO_REQD</code>
8911: variable in the package <code class="filename">Makefile</code>. By
8912: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8913: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8914: does not match the required minimum, a build dependency on the
1.91 rillig 8915: <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 8916: be added automatically.</p>
1.75 rillig 8917: <p>The build and installation process of the software provided
1.87 wiz 8918: by the package should not use the
1.110 hubertf 8919: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8920: info files is the task of the package
8921: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8922: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8923: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8924: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8925: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8926: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8927: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8928: no effect except the logging of a message. The script overriding
1.110 hubertf 8929: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8930: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8931: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8932: </div>
8933: <div class="sect2" lang="en">
8934: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8935: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8936: <p>All packages that install manual pages should install them
1.87 wiz 8937: into the same directory, so that there is one common place to look
8938: for them. In pkgsrc, this place is
8939: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8940: should be used in packages. The default for
8941: <code class="varname">PKGMANDIR</code> is
8942: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8943: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8944: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8945: <h3 class="title">Note</h3>
1.87 wiz 8946: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8947: is far from complete.</p>
1.75 rillig 8948: </div>
1.81 rillig 8949: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8950: <code class="filename">man/</code> as the top level directory for the man
8951: page file entries, and the pkgsrc framework will convert as
8952: needed. In all other places, the correct
8953: <code class="varname">PKGMANDIR</code> must be used.</p>
8954: <p>Packages that are
8955: configured with <code class="varname">GNU_CONFIGURE</code> set as
8956: “<span class="quote">yes</span>”, by default will use the
8957: <code class="filename">./configure</code>
8958: --mandir switch to set where the man pages should be installed.
8959: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8960: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8961: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8962: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8963: to “<span class="quote">no</span>”.
8964: Or if the <code class="filename">./configure</code> script uses
8965: a non-standard use of --mandir, you can set
8966: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8967: <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 8968: information on installation of compressed manual pages.</p>
1.75 rillig 8969: </div>
8970: <div class="sect2" lang="en">
8971: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8972: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8973: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8974: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8975: you need to take some extra steps to make sure they get registered
8976: in the database:</p>
1.75 rillig 8977: <div class="orderedlist"><ol type="1">
1.107 rillig 8978: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8979: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8980: takes care of rebuilding the GConf database at installation and
1.87 wiz 8981: deinstallation time, and tells the package where to install
1.107 rillig 8982: GConf data files using some standard configure arguments. It
1.87 wiz 8983: also disallows any access to the database directly from the
8984: package.</p></li>
1.75 rillig 8985: <li><p>Ensure that the package installs its
1.87 wiz 8986: <code class="filename">.schemas</code> files under
8987: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8988: installed under <code class="filename">${PREFIX}/etc</code>, you will
8989: need to manually patch the package.</p></li>
1.75 rillig 8990: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8991: directory, as they will be handled automatically. See
1.110 hubertf 8992: <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.107 rillig 8993: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8994: your <code class="filename">Makefile</code> with a list of all
8995: <code class="filename">.schemas</code> files installed by the package, if
8996: any. Names must not contain any directories in them.</p></li>
1.107 rillig 8997: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8998: your <code class="filename">Makefile</code> with a
8999: list of all <code class="filename">.entries</code> files installed by the
9000: package, if any. Names must not contain any directories in
9001: them.</p></li>
1.75 rillig 9002: </ol></div>
9003: </div>
9004: <div class="sect2" lang="en">
9005: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9006: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 9007: <p>If a package installs <code class="filename">.omf</code> files, used by
9008: scrollkeeper, you need to take some extra steps to make sure they
9009: get registered in the database:</p>
1.75 rillig 9010: <div class="orderedlist"><ol type="1">
9011: <li><p>Include
1.117 ! jnemeth 9012: <code class="filename">../../textproc/rarian/omf.mk</code>
1.87 wiz 9013: instead of its <code class="filename">buildlink3.mk</code> file. This
9014: takes care of rebuilding the scrollkeeper database at
9015: installation and deinstallation time, and disallows any access
9016: to it directly from the package.</p></li>
1.75 rillig 9017: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9018: <code class="filename">libdata/scrollkeeper</code> directory, as they
9019: will be handled automatically.</p></li>
1.76 rillig 9020: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 9021: the PLIST. It will be handled by scrollkeeper.</p></li>
1.75 rillig 9022: </ol></div>
9023: </div>
9024: <div class="sect2" lang="en">
9025: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9026: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9027: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9028: the fonts database in the directory where they get installed at
9029: installation and deinstallation time. This can be automatically
9030: done by using the pkginstall framework.</p>
1.75 rillig 9031: <p>You can list the directories where fonts are installed in the
1.87 wiz 9032: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9033: variables, where <em class="replaceable"><code>type</code></em> can be one of
9034: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
9035: Also make sure that the database file
9036: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9037: <p>Note that you should not create new directories for fonts;
1.87 wiz 9038: instead use the standard ones to avoid that the user needs to
9039: manually configure his X server to find them.</p>
1.75 rillig 9040: </div>
9041: <div class="sect2" lang="en">
9042: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9043: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9044: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9045: take some extra steps to get them registered in the GTK2 database
9046: properly:</p>
1.75 rillig 9047: <div class="orderedlist"><ol type="1">
9048: <li><p>Include
1.87 wiz 9049: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9050: <code class="filename">buildlink3.mk</code> file. This takes care of
9051: rebuilding the database at installation and deinstallation time.</p></li>
9052: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9053: your package installs GTK2 immodules.</p></li>
9054: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9055: GTK2 loaders.</p></li>
1.75 rillig 9056: <li>
1.87 wiz 9057: <p>Patch the package to not touch any of the GTK2
9058: databases directly. These are:</p>
1.75 rillig 9059: <div class="itemizedlist"><ul type="disc">
1.76 rillig 9060: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9061: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9062: </ul></div>
9063: </li>
1.87 wiz 9064: <li><p>Check the <code class="filename">PLIST</code> and remove
9065: any entries under the <code class="filename">libdata/gtk-2.0</code>
9066: directory, as they will be handled automatically.</p></li>
1.75 rillig 9067: </ol></div>
9068: </div>
9069: <div class="sect2" lang="en">
9070: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9071: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9072: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9073: registered in system-wide catalogs (like DTDs, sub-catalogs,
9074: etc.), you need to take some extra steps:</p>
1.75 rillig 9075: <div class="orderedlist"><ol type="1">
9076: <li><p>Include
1.87 wiz 9077: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9078: your <code class="filename">Makefile</code>, which takes care of
9079: registering those files in system-wide catalogs at
9080: installation and deinstallation time.</p></li>
1.75 rillig 9081: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9082: any SGML catalogs installed by the package.</p></li>
1.75 rillig 9083: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9084: any XML catalogs installed by the package.</p></li>
1.75 rillig 9085: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9086: to be added to the SGML catalog. These come in groups of
9087: three strings; see xmlcatmgr(1) for more information
9088: (specifically, arguments recognized by the 'add' action).
9089: Note that you will normally not use this variable.</p></li>
1.75 rillig 9090: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9091: to be added to the XML catalog. These come in groups of three
9092: strings; see xmlcatmgr(1) for more information (specifically,
9093: arguments recognized by the 'add' action). Note that you will
9094: normally not use this variable.</p></li>
1.75 rillig 9095: </ol></div>
9096: </div>
9097: <div class="sect2" lang="en">
9098: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9099: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9100: <p>If a package provides extensions to the MIME database by
1.87 wiz 9101: installing <code class="filename">.xml</code> files inside
9102: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9103: need to take some extra steps to ensure that the database is kept
9104: consistent with respect to these new files:</p>
1.75 rillig 9105: <div class="orderedlist"><ol type="1">
9106: <li><p>Include
1.87 wiz 9107: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9108: (avoid using the <code class="filename">buildlink3.mk</code> file from
9109: this same directory, which is reserved for inclusion from
9110: other <code class="filename">buildlink3.mk</code> files). It takes
9111: care of rebuilding the MIME database at installation and
9112: deinstallation time, and disallows any access to it directly
9113: from the package.</p></li>
1.75 rillig 9114: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9115: <code class="filename">share/mime</code> directory,
9116: <span class="emphasis"><em>except</em></span> for files saved under
9117: <code class="filename">share/mime/packages</code>. The former are
9118: handled automatically by
9119: the update-mime-database program, but the latter are
9120: package-dependent and must be removed by the package that
9121: installed them in the first place.</p></li>
1.76 rillig 9122: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9123: from the PLIST. They will be handled by the shared-mime-info
9124: package.</p></li>
1.75 rillig 9125: </ol></div>
9126: </div>
9127: <div class="sect2" lang="en">
9128: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9129: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9130: <p>If a package uses intltool during its build, add
9131: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9132: which forces it to use the intltool package provided by pkgsrc,
9133: instead of the one bundled with the distribution file.</p>
1.75 rillig 9134: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9135: latest available version; this way, the package benefits of any
9136: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9137: </div>
9138: <div class="sect2" lang="en">
9139: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9140: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9141: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9142: the startup directory by default, but you can enable it, by adding
9143: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9144: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9145: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9146: it will automatically remove the scripts when the package is
9147: deinstalled.</p>
1.75 rillig 9148: </div>
9149: <div class="sect2" lang="en">
9150: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9151: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9152: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9153: the <code class="filename">ls-R</code> database of the tree needs to be
9154: updated.</p>
1.75 rillig 9155: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9156: <h3 class="title">Note</h3>
9157: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 9158: packages should install files
9159: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9160: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 9161: </div>
9162: <div class="orderedlist"><ol type="1">
9163: <li><p>Include
1.87 wiz 9164: <code class="filename">../../print/teTeX/module.mk</code> instead
9165: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9166: takes care of rebuilding the <code class="filename">ls-R</code>
9167: database at installation and deinstallation time.</p></li>
1.75 rillig 9168: <li>
9169: <p>If your package installs files into a texmf
1.87 wiz 9170: tree other than the one
9171: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9172: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9173: trees that need database update.</p>
1.75 rillig 9174: <p>If your package also installs font map files that need
1.110 hubertf 9175: to be registered using <span class="command"><strong>updmap</strong></span>,
1.87 wiz 9176: set <code class="varname">TEX_FONTMAPS</code> to the list of all
1.110 hubertf 9177: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9178: be run automatically at installation/deinstallation to
9179: enable/disable font map files for TeX output
9180: drivers.</p>
1.75 rillig 9181: </li>
1.76 rillig 9182: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9183: databases are included in <code class="filename">PLIST</code>, as
9184: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9185: </ol></div>
9186: </div>
1.85 jmmv 9187: <div class="sect2" lang="en">
9188: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9189: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9190: emulation</h3></div></div></div>
9191: <p>There are some packages that provide libraries and
9192: executables for running binaries from a one operating system
9193: on a different one (if the latter supports it). One example
9194: is running Linux binaries on NetBSD.</p>
1.91 rillig 9195: <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 9196: helps in extracting and packaging Linux rpm packages.</p>
9197: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9198: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9199: if all libraries for each installed executable can be found by
9200: the dynamic linker. Since the standard dynamic linker is run,
9201: this fails for emulation packages, because the libraries used
9202: by the emulation are not in the standard directories.</p>
9203: </div>
9204: <div class="sect2" lang="en">
9205: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9206: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9207: <p>If a package installs images under the
1.87 wiz 9208: <code class="filename">share/icons/hicolor</code> and/or updates the
9209: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9210: database, you need to take some extra steps to make sure that the
9211: shared theme directory is handled appropriately and that the cache
9212: database is rebuilt:</p>
1.85 jmmv 9213: <div class="orderedlist"><ol type="1">
9214: <li><p>Include
1.87 wiz 9215: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9216: <li><p>Check the <code class="filename">PLIST</code> and remove the
9217: entry that refers to the theme cache.</p></li>
1.85 jmmv 9218: <li><p>Ensure that the PLIST does not remove the shared icon
9219: directories from the <code class="filename">share/icons/hicolor</code>
9220: hierarchy because they will be handled automatically.</p></li>
9221: </ol></div>
9222: <p>The best way to verify that the PLIST is correct with
9223: respect to the last two points is to regenerate it using
1.110 hubertf 9224: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9225: </div>
9226: <div class="sect2" lang="en">
9227: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9228: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9229: <p>If a package installs <code class="filename">.desktop</code> files
9230: under <code class="filename">share/applications</code> and these include
9231: MIME information, you need to take extra steps to ensure that they
9232: are registered into the MIME database:</p>
9233: <div class="orderedlist"><ol type="1">
9234: <li><p>Include
9235: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9236: <li><p>Check the PLIST and remove the entry that refers to the
9237: <code class="filename">share/applications/mimeinfo.cache</code> file.
9238: It will be handled automatically.</p></li>
9239: </ol></div>
9240: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9241: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9242: print-PLIST</strong></span>.</p>
1.75 rillig 9243: </div>
9244: </div>
1.87 wiz 9245: <div class="sect1" lang="en">
9246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9247: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9248: <p>In some cases one does not have the time to solve a problem
9249: immediately. There are currently two ways to declare that one knows
9250: that a package has problems.</p>
9251: <div class="itemizedlist"><ul type="disc">
9252: <li><p>The first way is to plainly mark it as broken. For
9253: this, one just sets the variable <code class="varname">BROKEN</code> to the
9254: reason why the package is broken (similar to the
9255: <code class="varname">RESTRICTED</code> variable). A user trying to build
9256: the package will immediately be shown this message, and the build
9257: will not be even tried.</p></li>
9258: <li><p>After each pkgsrc freeze period (a time when the
9259: tree is stabilized and a new pkgsrc branch is cut), the packages
9260: that were not building in the official branch build on the latest
9261: NetBSD release will be marked as broken on that branch. This is
9262: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9263: branch name (or appending the branch name to it). If a user tries
9264: to build such a package and the build fails, the user gets a
9265: message that says that the package was broken on the respective
9266: branch(es).</p></li>
9267: </ul></div>
9268: <p>Both types of packages are removed from pkgsrc in irregular
9269: intervals.</p>
9270: </div>
1.75 rillig 9271: </div>
9272: <div class="chapter" lang="en">
9273: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9274: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9275: <p>To check out all the gotchas when building a package, here are
9276: the steps that I do in order to get a package working. Please note
9277: this is basically the same as what was explained in the previous
9278: sections, only with some debugging aids.</p>
1.75 rillig 9279: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 9280: <li><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>
1.75 rillig 9281: <li>
1.91 rillig 9282: <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 9283: create a directory for a new package, change into it, then run
1.110 hubertf 9284: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9285: <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>
9286: <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>
9287: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9288: </li>
1.76 rillig 9289: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9290: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110 hubertf 9291: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75 rillig 9292: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9293: configure step to the package's
9294: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9295: <li>
9296: <p>Make the package compile, doing multiple rounds of</p>
9297: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9298: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9299: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9300: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9301: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9302: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9303: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9304: <p>Doing this step as non-root user will ensure that no files
9305: are modified that shouldn't be, especially during the build
1.110 hubertf 9306: phase. <span class="command"><strong>mkpatches</strong></span>,
9307: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9308: 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 9309: package.</p>
1.75 rillig 9310: </li>
1.88 wiz 9311: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.116 rillig 9312: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “Makefile”</a>.</p></li>
1.75 rillig 9313: <li>
1.76 rillig 9314: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9315: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9316: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9317: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9318: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9319: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9320: <p>You usually need to be <code class="username">root</code> to do
9321: this. Look if there are any files left:</p>
1.75 rillig 9322: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9323: <p>If this reveals any files that are missing in
1.88 wiz 9324: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9325: </li>
9326: <li>
1.88 wiz 9327: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9328: package again and make a binary package:</p>
1.75 rillig 9329: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9330: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9331: </li>
9332: <li>
9333: <p>Delete the installed package:</p>
1.88 wiz 9334: <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 9335: </li>
9336: <li>
1.110 hubertf 9337: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9338: command, which shouldn't find anything now:</p>
1.75 rillig 9339: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9340: </li>
9341: <li>
9342: <p>Reinstall the binary package:</p>
1.93 rillig 9343: <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 9344: </li>
1.88 wiz 9345: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9346: <li>
1.110 hubertf 9347: <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 9348: reports:</p>
1.75 rillig 9349: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9350: </li>
1.110 hubertf 9351: <li><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 9352: </ul></div>
9353: </div>
9354: <div class="chapter" lang="en">
9355: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9356: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9357: <div class="toc">
9358: <p><b>Table of Contents</b></p>
9359: <dl>
1.106 rillig 9360: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9361: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9362: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9363: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9364: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
9365: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9366: </dl>
9367: </div>
9368: <div class="sect1" lang="en">
9369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9370: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9371: <p>Our policy is that we accept binaries only from pkgsrc
9372: developers to guarantee that the packages don't contain any
9373: trojan horses etc. This is not to annoy anyone but rather to
9374: protect our users! You're still free to put up your home-made
9375: binary packages and tell the world where to get them. NetBSD
9376: developers doing bulk builds and wanting to upload them please
1.110 hubertf 9377: see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, “Uploading results of a bulk build”</a>.</p>
1.75 rillig 9378: </div>
9379: <div class="sect1" lang="en">
9380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9381: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9382: <p>First, check that your package is complete, compiles and
1.110 hubertf 9383: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9384: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9385: archive that contains all files that make up the package.
1.87 wiz 9386: Finally, send this package to the pkgsrc bug tracking system,
1.110 hubertf 9387: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9388: that, go to the web page
1.110 hubertf 9389: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87 wiz 9390: which contains some instructions and a link to a form, where you
9391: can submit packages.</p>
9392: <p>In the form of the problem report, the category should be
9393: “<span class="quote">pkg</span>”, the synopsis should include the package name
9394: and version number, and the description field should contain a
9395: short description of your package (contents of the COMMENT
9396: variable or DESCR file are OK). The uuencoded package data should
9397: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9398: <p>If you want to submit several packages, please send a
9399: separate PR for each one, it's easier for us to track things
9400: that way.</p>
9401: <p>Alternatively, you can also import new packages into
9402: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
1.110 hubertf 9403: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9404: for details.</p>
9405: </div>
9406: <div class="sect1" lang="en">
9407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9408: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9409: <p>Please note all package additions, updates, moves, and
1.93 rillig 9410: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9411: important to keep this file up to date and conforming to the
9412: existing format, because it will be used by scripts to
1.110 hubertf 9413: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9414: sites. Additionally, check the
1.76 rillig 9415: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9416: for the package you updated or removed, in case it was mentioned
9417: there.</p>
9418: <p>When the <code class="varname">PKGREVISION</code> of a package is
9419: bumped, the change should appear in
1.93 rillig 9420: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9421: related or otherwise relevant. Mass bumps that result from a
9422: dependency being updated should not be mentioned. In all other
9423: cases it's the developer's decision.</p>
9424: <p>There is a make target that helps in creating proper
1.110 hubertf 9425: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9426: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9427: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9428: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9429: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9430: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9431: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9432: For new packages, or package moves or removals, set the
9433: <code class="varname">CTYPE</code> variable on the command line to "Added",
9434: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9435: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.75 rillig 9436: not the same as your NetBSD login name. Don't forget to commit
1.93 rillig 9437: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75 rillig 9438: </div>
9439: <div class="sect1" lang="en">
9440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9441: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9442: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9443: access to the pkgsrc repository. Please remember that cvs
9444: imports files relative to the current working directory, and that
9445: the pathname that you
1.110 hubertf 9446: give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75 rillig 9447: to place the files in the repository. Newly created packages should be
9448: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9449: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9450: <pre class="programlisting">
1.100 rillig 9451: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9452: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9453: </pre>
1.87 wiz 9454: <p>Remember to move the directory from which you imported out of
1.75 rillig 9455: the way, or cvs will complain the next time you “<span class="quote">cvs
9456: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9457: package to the category's <code class="filename">Makefile</code>.</p>
9458: <p>The commit message of the initial import should include part of the
1.76 rillig 9459: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9460: what the package is/does.</p>
9461: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9462: add</span>” because the former gets everything with a single command,
1.87 wiz 9463: and provides a consistent tag.</p>
1.75 rillig 9464: </div>
9465: <div class="sect1" lang="en">
9466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9467: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9468: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9469: changes between old and new versions into the commit log when updating
1.87 wiz 9470: a package. There are various reasons for this:</p>
1.75 rillig 9471: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9472: <li><p>A URL is volatile, and can change over time. It may go away completely
9473: or its information may be overwritten by newer information.</p></li>
9474: <li><p>Having the change information between old and new versions in our CVS
9475: repository is very useful for people who use either cvs or anoncvs.</p></li>
9476: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9477: repository is very useful for people who read the pkgsrc-changes mailing
9478: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9479: the package.</p></li>
1.75 rillig 9480: </ul></div>
1.87 wiz 9481: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9482: has been released, it should not automatically be upgraded in the CVS
9483: repository. We prefer to be conservative in the packages that are
9484: included in pkgsrc - development or beta packages are not really the
9485: best thing for most places in which pkgsrc is used. Please use your
9486: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9487: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9488: </div>
9489: <div class="sect1" lang="en">
9490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9491: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9492: <div class="orderedlist"><ol type="1">
9493: <li><p>Make a copy of the directory somewhere else.</p></li>
9494: <li>
9495: <p>Remove all CVS dirs.</p>
1.87 wiz 9496: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9497: <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 9498: <p>and use that for further work.</p>
1.75 rillig 9499: </li>
9500: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9501: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9502: instead of “<span class="quote">../../category/package</span>”.</p></li>
1.110 hubertf 9503: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9504: place.</p></li>
9505: <li>
9506: <p>Check if any package depends on it:
9507: </p>
9508: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9509: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9510: </li>
9511: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110 hubertf 9512: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9513: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9514: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9515: <li>
9516: <p>Commit the changed and removed files:</p>
9517: <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 9518: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9519: </li>
9520: </ol></div>
9521: </div>
9522: </div>
9523: <div class="chapter" lang="en">
9524: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9525: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9526: <p>This section contains the answers to questions that may
9527: arise when you are writing a package. If you don't find your
9528: question answered here, first have a look in the other chapters,
9529: and if you still don't have the answer, ask on the
9530: <code class="literal">pkgsrc-users</code> mailing list.</p>
9531: <div class="qandaset">
9532: <dl>
1.106 rillig 9533: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9534: MAKEFLAGS, .MAKEFLAGS and
9535: MAKE_FLAGS?</a>
9536: </dt>
1.106 rillig 9537: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9538: MAKE, GMAKE and
9539: MAKE_PROGRAM?</a>
9540: </dt>
1.106 rillig 9541: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9542: CC, PKG_CC and
9543: PKGSRC_COMPILER?</a>
9544: </dt>
1.106 rillig 9545: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9546: BUILDLINK_LDFLAGS,
9547: BUILDLINK_LDADD and
9548: BUILDLINK_LIBS?</a>
9549: </dt>
1.106 rillig 9550: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9551: VARNAME=BUILDLINK_PREFIX.foo
9552: say it's empty?</a>
9553: </dt>
1.106 rillig 9554: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9555: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9556: don't understand the := inside
9557: it.</a>
9558: </dt>
1.106 rillig 9559: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9560: developers?</a>
9561: </dt>
1.106 rillig 9562: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9563: documentation?</a>
9564: </dt>
1.106 rillig 9565: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9566: do?</a>
9567: </dt>
1.75 rillig 9568: </dl>
9569: <table border="0" summary="Q and A Set">
9570: <col align="left" width="1%">
9571: <tbody>
9572: <tr class="question">
9573: <td align="left" valign="top">
1.117 ! jnemeth 9574: <a name="devfaq.makeflags"></a><a name="id9508238"></a><p><b>22.1.</b></p>
1.75 rillig 9575: </td>
9576: <td align="left" valign="top"><p>What is the difference between
9577: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9578: <code class="varname">MAKE_FLAGS</code>?</p></td>
9579: </tr>
9580: <tr class="answer">
1.91 rillig 9581: <td align="left" valign="top"></td>
1.75 rillig 9582: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110 hubertf 9583: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 9584: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9585: the <code class="varname">MAKE_PROGRAM</code> when building the
9586: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9587: </tr>
9588: <tr class="question">
9589: <td align="left" valign="top">
1.117 ! jnemeth 9590: <a name="devfaq.make"></a><a name="id9508273"></a><p><b>22.2.</b></p>
1.75 rillig 9591: </td>
9592: <td align="left" valign="top"><p>What is the difference between
9593: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9594: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9595: </tr>
9596: <tr class="answer">
1.91 rillig 9597: <td align="left" valign="top"></td>
1.75 rillig 9598: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110 hubertf 9599: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 9600: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9601: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9602: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9603: Make program that is used for building the
9604: package.</p></td>
9605: </tr>
9606: <tr class="question">
9607: <td align="left" valign="top">
1.117 ! jnemeth 9608: <a name="devfaq.cc"></a><a name="id9508309"></a><p><b>22.3.</b></p>
1.75 rillig 9609: </td>
9610: <td align="left" valign="top"><p>What is the difference between
9611: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9612: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9613: </tr>
9614: <tr class="answer">
1.91 rillig 9615: <td align="left" valign="top"></td>
1.75 rillig 9616: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9617: compiler, which can be configured by the pkgsrc user.
9618: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9619: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9620: path to a compiler, but the type of compiler that should be
1.76 rillig 9621: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9622: information about the latter variable.</p></td>
9623: </tr>
9624: <tr class="question">
9625: <td align="left" valign="top">
1.117 ! jnemeth 9626: <a name="devfaq.bl3flags"></a><a name="id9508344"></a><p><b>22.4.</b></p>
1.75 rillig 9627: </td>
9628: <td align="left" valign="top"><p>What is the difference between
9629: <code class="varname">BUILDLINK_LDFLAGS</code>,
9630: <code class="varname">BUILDLINK_LDADD</code> and
9631: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9632: </tr>
9633: <tr class="answer">
1.91 rillig 9634: <td align="left" valign="top"></td>
1.75 rillig 9635: <td align="left" valign="top"><p>[FIXME]</p></td>
9636: </tr>
9637: <tr class="question">
9638: <td align="left" valign="top">
1.117 ! jnemeth 9639: <a name="devfaq.bl3prefix"></a><a name="id9508362"></a><p><b>22.5.</b></p>
1.75 rillig 9640: </td>
1.110 hubertf 9641: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9642: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9643: say it's empty?</p></td>
9644: </tr>
9645: <tr class="answer">
1.91 rillig 9646: <td align="left" valign="top"></td>
1.75 rillig 9647: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9648: available in the “<span class="quote">wrapper</span>” phase and later. To
9649: “<span class="quote">simulate</span>” the wrapper phase, append
1.110 hubertf 9650: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9651: command.</p></td>
9652: </tr>
1.78 rillig 9653: <tr class="question">
9654: <td align="left" valign="top">
1.117 ! jnemeth 9655: <a name="devfaq.master_sites"></a><a name="id9508389"></a><p><b>22.6.</b></p>
1.78 rillig 9656: </td>
9657: <td align="left" valign="top"><p>What does
9658: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9659: don't understand the <code class="literal">:=</code> inside
9660: it.</p></td>
9661: </tr>
9662: <tr class="answer">
1.91 rillig 9663: <td align="left" valign="top"></td>
1.78 rillig 9664: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9665: assignment operator, like you might expect at first sight.
9666: Instead, it is a degenerate form of
9667: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110 hubertf 9668: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78 rillig 9669: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9670: case of <code class="varname">MASTER_SITE_*</code>,
9671: <em class="replaceable"><code>old_string</code></em> is the empty string and
9672: <em class="replaceable"><code>new_string</code></em> is
9673: <code class="literal">package/</code>. That's where the
9674: <code class="literal">:</code> and the <code class="literal">=</code> fall
9675: together.</p></td>
9676: </tr>
9677: <tr class="question">
9678: <td align="left" valign="top">
1.117 ! jnemeth 9679: <a name="devfaq.mailinglists"></a><a name="id9508456"></a><p><b>22.7.</b></p>
1.78 rillig 9680: </td>
9681: <td align="left" valign="top"><p>Which mailing lists are there for package
9682: developers?</p></td>
9683: </tr>
9684: <tr class="answer">
1.91 rillig 9685: <td align="left" valign="top"></td>
1.78 rillig 9686: <td align="left" valign="top"><div class="variablelist"><dl>
1.110 hubertf 9687: <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 9688: <dd><p>This is a list for technical discussions related
9689: to pkgsrc development, e.g. soliciting feedback for changes to
9690: pkgsrc infrastructure, proposed new features, questions related
9691: to porting pkgsrc to a new platform, advice for maintaining a
9692: package, patches that affect many packages, help requests moved
9693: from pkgsrc-users when an infrastructure bug is found,
9694: etc.</p></dd>
1.110 hubertf 9695: <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 9696: <dd><p>All bug reports in category "pkg" sent with
1.110 hubertf 9697: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 9698: directly; use one of the other mailing
9699: lists.</p></dd>
9700: </dl></div></td>
9701: </tr>
1.80 rillig 9702: <tr class="question">
9703: <td align="left" valign="top">
1.117 ! jnemeth 9704: <a name="devfaq.documentation"></a><a name="id9508487"></a><p><b>22.8.</b></p>
1.80 rillig 9705: </td>
9706: <td align="left" valign="top"><p>Where is the pkgsrc
9707: documentation?</p></td>
9708: </tr>
9709: <tr class="answer">
1.91 rillig 9710: <td align="left" valign="top"></td>
1.80 rillig 9711: <td align="left" valign="top">
9712: <p>There are many places where you can find
9713: documentation about pkgsrc:</p>
9714: <div class="itemizedlist"><ul type="disc">
9715: <li><p>The pkgsrc guide (this document) is a collection
9716: of chapters that explain large parts of pkgsrc, but some
9717: chapters tend to be outdated. Which ones they are is hard to
9718: say.</p></li>
1.110 hubertf 9719: <li><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 9720: about certain features, announcements of new parts of the pkgsrc
9721: infrastructure and sometimes even announcements that a certain
9722: feature has been marked as obsolete. The benefit here is that
9723: each message has a date appended to it.</p></li>
9724: <li><p>Many of the files in the
9725: <code class="filename">mk/</code> directory start with a comment that
9726: describes the purpose of the file and how it can be used by the
1.92 rillig 9727: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9728: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9729: help</strong></span>.</p></li>
1.80 rillig 9730: <li><p>The CVS log messages are a rich source of
9731: information, but they tend to be highly abbreviated, especially
9732: for actions that occur often. Some contain a detailed
9733: description of what has changed, but they are geared towards the
9734: other pkgsrc developers, not towards an average pkgsrc user.
9735: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9736: don't know what has been before, these messages may not be worth
9737: too much to you.</p></li>
9738: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9739: documented</span>”, that is the documentation exists only in the
9740: mind of the developer who wrote the code. To get this
1.110 hubertf 9741: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9742: to see who has written it and ask on the
9743: <code class="literal">tech-pkg</code> mailing list, so that others can
9744: find your questions later (see above). To be sure that the
9745: developer in charge reads the mail, you may CC him or
9746: her.</p></li>
9747: </ul></div>
9748: </td>
9749: </tr>
1.92 rillig 9750: <tr class="question">
9751: <td align="left" valign="top">
1.117 ! jnemeth 9752: <a name="devfaq.too-much-time"></a><a name="id9508541"></a><p><b>22.9.</b></p>
1.92 rillig 9753: </td>
9754: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9755: do?</p></td>
9756: </tr>
9757: <tr class="answer">
9758: <td align="left" valign="top"></td>
9759: <td align="left" valign="top">
1.93 rillig 9760: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9761: anyway.</p>
9762: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 9763: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9764: <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
9765: will tell you about newer versions of installed packages that are
9766: available, but not yet updated in pkgsrc.</p></li>
9767: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.114 jmcneill 9768: — it contains a list of suggested new packages and a list of
1.92 rillig 9769: cleanups and enhancements for pkgsrc that would be nice to
9770: have.</p></li>
9771: <li><p>Review packages for which review was requested on
1.110 hubertf 9772: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 9773: mailing list.</p></li>
9774: </ul></div>
9775: </td>
9776: </tr>
1.75 rillig 9777: </tbody>
9778: </table>
9779: </div>
9780: </div>
1.85 jmmv 9781: <div class="chapter" lang="en">
9782: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9783: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9784: <div class="toc">
9785: <p><b>Table of Contents</b></p>
9786: <dl>
1.106 rillig 9787: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9788: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9789: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9790: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9791: </dl>
9792: </div>
1.110 hubertf 9793: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9794: site</a>:</p>
9795: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9796: environment, an intuitive and attractive desktop for users, and the
9797: GNOME development platform, an extensive framework for building
9798: applications that integrate into the rest of the desktop.</p></blockquote></div>
9799: <p>pkgsrc provides a seamless way to automatically build and install
9800: a complete GNOME environment <span class="emphasis"><em>under many different
9801: platforms</em></span>. We can say with confidence that pkgsrc is one of
9802: the most advanced build and packaging systems for GNOME due to its
9803: included technologies buildlink3, the wrappers and tools framework and
9804: automatic configuration file management. Lots of efforts are put into
9805: achieving a completely clean deinstallation of installed software
9806: components.</p>
1.110 hubertf 9807: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9808: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9809: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9810: pkgsrc as its preferred packaging system, contributing lots of
9811: portability fixes to make GNOME build and install under it.</p>
9812: <p>This chapter is aimed at pkgsrc developers and other people
9813: interested in helping our GNOME porting and packaging efforts. It
9814: provides instructions on how to manage the existing packages and some
9815: important information regarding their internals.</p>
9816: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9817: <h3 class="title">We need your help!</h3>
9818: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9819: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9820: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9821: work</a> list! There is still a long way to go to get a
9822: fully-functional GNOME desktop under NetBSD and we need your help to
9823: achieve it!</p>
9824: </div>
9825: <div class="sect1" lang="en">
9826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9827: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9828: <p>pkgsrc includes three GNOME-related meta packages:</p>
9829: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9830: <li><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 9831: the core GNOME desktop environment. It only includes the necessary
9832: bits to get it to boot correctly, although it may lack important
9833: functionality for daily operation. The idea behind this package is
9834: to let end users build their own configurations on top of this one,
9835: first installing this meta package to achieve a functional setup and
9836: then adding individual applications.</p></li>
1.91 rillig 9837: <li><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 9838: complete installation of the GNOME platform and desktop as defined
9839: by the GNOME project; this is based on the components distributed in
9840: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9841: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9842: official FTP server. Developer-only tools found in those
9843: directories are not installed unless required by some other
9844: component to work properly. Similarly, packages from the bindings
9845: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9846: in unless required as a dependency for an end-user component. This
1.91 rillig 9847: 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>
9848: <li><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 9849: Installs all the tools required to build a GNOME component when
9850: fetched from the CVS repository. These are required to let the
1.110 hubertf 9851: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9852: </ul></div>
9853: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9854: sorted in a way that eases updates: a package may depend on other
9855: packages listed before it but not on any listed after it. It is very
9856: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9857: change it to alphabetical sorting!</em></span></p>
9858: </div>
9859: <div class="sect1" lang="en">
9860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9861: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9862: <p>Almost all GNOME applications are written in C and use a common
9863: set of tools as their build system. Things get different with the new
9864: bindings to other languages (such as Python), but the following will
9865: give you a general idea on the minimum required tools:</p>
9866: <div class="itemizedlist"><ul type="disc">
9867: <li>
9868: <p>Almost all GNOME applications use the GNU Autotools as their
9869: build system. As a general rule you will need to tell this to your
9870: package:</p>
1.100 rillig 9871: <pre class="programlisting">
9872: GNU_CONFIGURE=yes
1.85 jmmv 9873: USE_LIBTOOL=yes
1.100 rillig 9874: USE_TOOLS+=gmake
9875: </pre>
1.85 jmmv 9876: </li>
9877: <li>
9878: <p>If the package uses pkg-config to detect dependencies, add this
9879: tool to the list of required utilities:</p>
9880: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9881: <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 9882: the end of the build process to ensure that you did not miss to
9883: specify any dependency in your package and that the version
9884: requirements are all correct.</p>
9885: </li>
1.93 rillig 9886: <li><p>If the package uses intltool, be sure to add
9887: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9888: to handle dependencies and to force the package to use the latest
9889: available version.</p></li>
9890: <li>
9891: <p>If the package uses gtk-doc (a documentation generation
9892: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9893: tool is rather big and the distfile should come with pregenerated
9894: documentation anyway; if it does not, it is a bug that you ought to
9895: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9896: the default):</p>
9897: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9898: <p>The default location of installed HTML files
9899: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9900: and should not be changed unless the package insists on installing
9901: them somewhere else. Otherwise programs as
1.110 hubertf 9902: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9903: do that with an entry similar to:</p>
9904: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9905: </li>
9906: </ul></div>
9907: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9908: files under the installation prefix to maintain databases. In this
9909: context, shared means that those exact same directories and files are
9910: used among several different packages, leading to conflicts in the
9911: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9912: handle the most common cases, so you have to forget about using
9913: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9914: omitting shared files from them. If you find yourself doing those,
9915: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9916: <p>The following table lists the common situations that result in
9917: using shared directories or files. For each of them, the appropriate
9918: solution is given. After applying the solution be sure to
9919: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9920: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9921: <div class="table">
1.106 rillig 9922: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9923: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9924: <colgroup>
9925: <col>
9926: <col>
9927: </colgroup>
9928: <thead><tr>
9929: <th>If the package...</th>
9930: <th>Then...</th>
9931: </tr></thead>
9932: <tbody>
9933: <tr>
9934: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.110 hubertf 9935: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper data files">Section 19.6.10, “Packages installing scrollkeeper data files”</a>.</td>
1.85 jmmv 9936: </tr>
9937: <tr>
9938: <td>Installs icons under the
9939: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9940: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9941: <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 9942: </tr>
9943: <tr>
9944: <td>Installs files under
9945: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9946: <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 9947: </tr>
9948: <tr>
9949: <td>Installs <code class="filename">.desktop</code> files under
9950: <code class="filename">share/applications</code> and these include MIME
9951: information.</td>
1.110 hubertf 9952: <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 9953: </tr>
9954: </tbody>
1.91 rillig 9955: </table></div>
1.85 jmmv 9956: </div>
1.91 rillig 9957: <br class="table-break">
1.85 jmmv 9958: </div>
9959: <div class="sect1" lang="en">
9960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9961: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9962: <p>When seeing GNOME as a whole, there are two kinds of
9963: updates:</p>
9964: <div class="variablelist"><dl>
9965: <dt><span class="term">Major update</span></dt>
9966: <dd>
9967: <p>Given that there is still a very long way for GNOME 3 (if it
9968: ever appears), we consider a major update one that goes from a
9969: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9970: where <code class="literal">Y</code> is even and greater than
9971: <code class="literal">X</code>. These are hard to achieve because they
9972: introduce lots of changes in the components' code and almost all
9973: GNOME distfiles are updated to newer versions. Some of them can
9974: even break API and ABI compatibility with the previous major
9975: version series. As a result, the update needs to be done all at
9976: once to minimize breakage.</p>
9977: <p>A major update typically consists of around 80 package
9978: updates and the addition of some new ones.</p>
9979: </dd>
9980: <dt><span class="term">Minor update</span></dt>
9981: <dd>
9982: <p>We consider a minor update one that goes from a
9983: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9984: one where <code class="literal">Y</code> is greater than
9985: <code class="literal">X</code>. These are easy to achieve because they do
9986: not update all GNOME components, can be done in an incremental way
9987: and do not break API nor ABI compatibility.</p>
9988: <p>A minor update typically consists of around 50 package
9989: updates, although the numbers here may vary a lot.</p>
9990: </dd>
9991: </dl></div>
9992: <p>In order to update the GNOME components in pkgsrc to a new stable
9993: release (either major or minor), the following steps should be
9994: followed:</p>
9995: <div class="orderedlist"><ol type="1">
9996: <li>
9997: <p>Get a list of all the tarballs that form the new release by
9998: using the following commands. These will leave the full list of the
9999: components's distfiles into the <code class="filename">list.txt</code>
10000: file:</p>
1.88 wiz 10001: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10002: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10003: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10004: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10005: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10006: awk '{ print $9 }' >>list.txt</code></strong></pre>
10007: </li>
10008: <li><p>Open each meta package's <code class="filename">Makefile</code> and
10009: bump their version to the release you are updating them to. The
10010: three meta packages should be always consistent with versioning.
10011: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10012: in them.</p></li>
10013: <li>
10014: <p>For each meta package, update all its
10015: <code class="varname">DEPENDS</code> lines to match the latest versions as
10016: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10017: newer version (even if found in the FTP) because the meta packages
10018: are supposed to list the exact versions that form a specific GNOME
10019: release. Exceptions are permitted here if a newer version solves a
10020: serious issue in the overall desktop experience; these typically
10021: come in the form of a revision bump in pkgsrc, not in newer versions
10022: from the developers.</p>
10023: <p>Packages not listed in the <code class="filename">list.txt</code> file
10024: should be updated to the latest version available (if found in
10025: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10026: 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 10027: </li>
10028: <li>
10029: <p>Generate a patch from the modified meta packages and extract the
10030: list of "new" lines. This will provide you an outline on what
10031: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10032: <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 10033: </li>
10034: <li><p>For major desktop updates it is recommended to zap all your
10035: installed packages and start over from scratch at this point.</p></li>
10036: <li><p>Now comes the longest step by far: iterate over the contents
10037: of <code class="filename">todo.txt</code> and update the packages listed in
10038: it in order. For major desktop updates none of these should be
1.93 rillig 10039: committed until the entire set is completed because there are chances
1.85 jmmv 10040: of breaking not-yet-updated packages.</p></li>
10041: <li><p>Once the packages are up to date and working, commit them to
10042: the tree one by one with appropriate log messages. At the end,
10043: commit the three meta package updates and all the corresponding
10044: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10045: <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>
10046: </ol></div>
10047: </div>
10048: <div class="sect1" lang="en">
10049: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10050: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10051: <p>GNOME is a very big component in pkgsrc which approaches 100
10052: packages. Please, it is very important that you always, always,
10053: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10054: 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 10055: their attention on portability issues and to ensure that future versions
10056: can be built out-of-the box on NetBSD. The less custom patches in
10057: pkgsrc, the easier further updates are. Those developers in charge of
10058: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10059: <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 10060: Bugzilla</a>. Not all components use these to track bugs, but most
10061: of them do. Do not be short on your reports: always provide detailed
10062: explanations of the current failure, how it can be improved to achieve
10063: maximum portability and, if at all possible, provide a patch against CVS
10064: head. The more verbose you are, the higher chances of your patch being
10065: accepted.</p>
10066: <p>Also, please avoid using preprocessor magic to fix portability
10067: issues. While the FreeBSD GNOME people are doing a great job in porting
10068: GNOME to their operating system, the official GNOME sources are now
10069: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10070: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10071: 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 10072: details.</p>
10073: </div>
10074: </div>
1.75 rillig 10075: </div>
10076: <div class="part" lang="en">
10077: <div class="titlepage"><div><div><h1 class="title">
10078: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10079: <div class="partintro" lang="en">
10080: <div></div>
10081: <p>This part of the guide deals with everything
10082: from the infrastructure that is behind the interfaces described
10083: in the developer's guide. A casual package maintainer should not
10084: need anything from this part.</p>
10085: <div class="toc">
10086: <p><b>Table of Contents</b></p>
10087: <dl>
1.106 rillig 10088: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10089: <dd><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.75 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.75 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.81 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.81 rillig 10104: <dd><dl>
1.116 rillig 10105: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
10106: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75 rillig 10107: </dl></dd>
10108: </dl></dd>
1.106 rillig 10109: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10110: <dd><dl>
1.106 rillig 10111: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10112: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10113: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10114: <dd><dl>
1.106 rillig 10115: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10116: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10117: </dl></dd>
10118: </dl></dd>
1.106 rillig 10119: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10120: <dd><dl>
1.106 rillig 10121: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10122: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10123: </dl></dd>
10124: </dl>
10125: </div>
10126: </div>
10127: <div class="chapter" lang="en">
10128: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10129: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10130: <div class="toc">
10131: <p><b>Table of Contents</b></p>
10132: <dl>
1.106 rillig 10133: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10134: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10135: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10136: <dd><dl>
1.106 rillig 10137: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10138: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10139: </dl></dd>
1.106 rillig 10140: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10141: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10142: <dd><dl>
1.106 rillig 10143: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10144: <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 10145: </dl></dd>
1.106 rillig 10146: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10147: <dd><dl>
1.116 rillig 10148: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
10149: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75 rillig 10150: </dl></dd>
10151: </dl>
10152: </div>
10153: <p>The pkgsrc infrastructure consists of many small Makefile
10154: fragments. Each such fragment needs a properly specified
10155: interface. This chapter explains how such an interface looks
10156: like.</p>
10157: <div class="sect1" lang="en">
10158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10159: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10160: <p>Whenever a variable is defined in the pkgsrc
10161: infrastructure, the location and the way of definition provide
10162: much information about the intended use of that variable.
10163: Additionally, more documentation may be found in a header
10164: comment or in this pkgsrc guide.</p>
10165: <p>A special file is
10166: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10167: variables that are intended to be user-defined. They are either
10168: defined using the <code class="literal">?=</code> operator or they are
10169: left undefined because defining them to anything would
10170: effectively mean “<span class="quote">yes</span>”. All these variables may be
10171: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10172: file.</p>
10173: <p>Outside this file, the following conventions apply:
10174: Variables that are defined using the <code class="literal">?=</code>
10175: operator may be overridden by a package.</p>
10176: <p>Variables that are defined using the <code class="literal">=</code>
10177: operator may be used read-only at run-time.</p>
10178: <p>Variables whose name starts with an underscore must not be
10179: accessed outside the pkgsrc infrastructure at all. They may
10180: change without further notice.</p>
10181: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10182: <h3 class="title">Note</h3>
10183: <p>These conventions are currently not applied
10184: consistently to the complete pkgsrc
10185: infrastructure.</p>
10186: </div>
10187: </div>
10188: <div class="sect1" lang="en">
10189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10190: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10191: <p>All variables that contain lists of things should default
10192: to being empty. Two examples that do not follow this rule are
10193: <code class="varname">USE_LANGUAGES</code> and
10194: <code class="varname">DISTFILES</code>. These variables cannot simply be
10195: modified using the <code class="literal">+=</code> operator in package
10196: <code class="filename">Makefile</code>s (or other files included by
10197: them), since there is no guarantee whether the variable is
10198: already set or not, and what its value is. In the case of
10199: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10200: the default value and just define it as in the following
10201: example.</p>
10202: <pre class="programlisting">
1.100 rillig 10203: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10204: </pre>
10205: <p>Because of the selection of this default value, the same
10206: value appears in many package Makefiles. Similarly for
10207: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10208: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10209: doesn't stand out. Nevertheless it is mentioned in many
10210: files.</p>
10211: </div>
10212: <div class="sect1" lang="en">
10213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10214: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75 rillig 10215: <div class="sect2" lang="en">
10216: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10217: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10218: <p>Variable evaluation takes place either at load time or at
10219: runtime, depending on the context in which they occur. The
10220: contexts where variables are evaluated at load time are:</p>
10221: <div class="itemizedlist"><ul type="disc">
10222: <li><p>The right hand side of the <code class="literal">:=</code>
10223: and <code class="literal">!=</code> operators,</p></li>
10224: <li><p>Make directives like <code class="literal">.if</code> or
10225: <code class="literal">.for</code>,</p></li>
10226: <li><p>Dependency lines.</p></li>
10227: </ul></div>
10228: <p>A special exception are references to the iteration
10229: variables of <code class="literal">.for</code> loops, which are expanded
10230: inline, no matter in which context they appear.</p>
10231: <p>As the values of variables may change during load time,
10232: care must be taken not to evaluate them by accident. Typical
10233: examples for variables that should not be evaluated at load time
10234: are <code class="varname">DEPENDS</code> and
10235: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10236: clear, here is an example:</p>
10237: <pre class="programlisting">
1.100 rillig 10238: CONFIGURE_ARGS= # none
10239: CFLAGS= -O
10240: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10241:
1.100 rillig 10242: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10243:
1.100 rillig 10244: CFLAGS+= -Wall
1.75 rillig 10245: </pre>
10246: <p>This code shows how the use of the <code class="literal">:=</code>
10247: operator can quickly lead to unexpected results. The first
10248: paragraph is fairly common code. The second paragraph evaluates
10249: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10250: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10251: <code class="literal">-Wall</code> is appended to the
10252: <code class="varname">CFLAGS</code>, but this addition will not appear in
10253: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10254: paragraphs from above typically occur in completely unrelated
10255: files.</p>
10256: </div>
10257: <div class="sect2" lang="en">
10258: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10259: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10260: <p>After all the files have been loaded, the values of the
10261: variables cannot be changed anymore. Variables that are used in
10262: the shell commands are expanded at this point.</p>
10263: </div>
10264: </div>
10265: <div class="sect1" lang="en">
10266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10267: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10268: <p>There are many ways in which the definition and use of a
10269: variable can be restricted in order to detect bugs and
10270: violations of the (mostly unwritten) policies. See the
10271: <code class="literal">pkglint</code> developer's documentation for further
10272: details.</p>
10273: </div>
10274: <div class="sect1" lang="en">
10275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10276: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10277: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10278: of the following classes. Cases where a file falls into more
10279: than one class should be avoided as it often leads to subtle
10280: bugs.</p>
10281: <div class="sect2" lang="en">
10282: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10283: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10284: <p>In a traditional imperative programming language some of
1.76 rillig 10285: the <code class="filename">.mk</code> files could be described as
1.114 jmcneill 10286: procedures. They take some input parameters and—after
10287: inclusion—provide a result in output parameters. Since all
1.76 rillig 10288: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10289: care must be taken not to use parameter names that have already
10290: another meaning. For example, <code class="varname">PKGNAME</code> is a
10291: bad choice for a parameter name.</p>
10292: <p>Procedures are completely evaluated at preprocessing time.
10293: That is, when calling a procedure all input parameters must be
10294: completely resolvable. For example,
10295: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10296: parameter since it is very likely that further text will be
10297: added after calling the procedure, which would effectively apply
10298: the procedure to only a part of the variable. Also, references
10299: to other variables wit will be modified after calling the
10300: procedure.</p>
10301: <p>A procedure can declare its output parameters either as
10302: suitable for use in preprocessing directives or as only
10303: available at runtime. The latter alternative is for variables
10304: that contain references to other runtime variables.</p>
10305: <p>Procedures shall be written such that it is possible to
10306: call the procedure more than once. That is, the file must not
10307: contain multiple-inclusion guards.</p>
10308: <p>Examples for procedures are
1.76 rillig 10309: <code class="filename">mk/bsd.options.mk</code> and
10310: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10311: that the parameters are evaluated at load time, they should be
10312: assigned using the <code class="literal">:=</code> operator, which should
10313: be used only for this purpose.</p>
10314: </div>
10315: <div class="sect2" lang="en">
10316: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10317: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10318: <p>Action files take some input parameters and may define
10319: runtime variables. They shall not define loadtime variables.
10320: There are action files that are included implicitly by the
10321: pkgsrc infrastructure, while other must be included
10322: explicitly.</p>
10323: <p>An example for action files is
1.76 rillig 10324: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10325: </div>
10326: </div>
1.81 rillig 10327: <div class="sect1" lang="en">
10328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10329: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10330: <p>Package <code class="filename">Makefile</code>s usually consist of
10331: a set of variable definitions, and include the file
10332: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10333: Before that, they may also include various other
10334: <code class="filename">*.mk</code> files if they need to query the
10335: availability of certain features like the type of compiler or
10336: the X11 implementation. Due to the heavy use of preprocessor
10337: directives like <code class="literal">.if</code> and
10338: <code class="literal">.for</code>, the order in which the files are loaded
10339: matters.</p>
10340: <p>This section describes at which point the various files
10341: are loaded and gives reasons for that order.</p>
10342: <div class="sect2" lang="en">
10343: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10344: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10345: </h3></div></div></div>
10346: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10347: is to define some essential variables like
10348: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10349: <code class="varname">MACHINE_ARCH</code>.</p>
10350: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10351: 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 10352: After that, those variables
1.81 rillig 10353: that have not been overridden by the user are loaded from
10354: <code class="filename">mk/defaults/mk.conf</code>.</p>
10355: <p>After the user settings, the system settings and platform
10356: settings are loaded, which may override the user
10357: settings.</p>
10358: <p>Then, the tool definitions are loaded. The tool wrappers
10359: are not yet in effect. This only happens when building a
10360: package, so the proper variables must be used instead of the
10361: direct tool names.</p>
10362: <p>As the last steps, some essential variables from the
10363: wrapper and the package system flavor are loaded, as well as the
10364: variables that have been cached in earlier phases of a package
10365: build.</p>
10366: </div>
10367: <div class="sect2" lang="en">
10368: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10369: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10370: </h3></div></div></div>
1.81 rillig 10371: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10372: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10373: loaded, which fill default values for those variables that have
1.93 rillig 10374: not been defined by the package. These variables may later
1.81 rillig 10375: be used even in unrelated files.</p>
10376: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10377: provides the target <code class="literal">error-check</code> that is added
10378: as a special dependency to all other targets that use
10379: <code class="varname">DELAYED_ERROR_MSG</code> or
10380: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10381: <p>Then, the package-specific hacks from
10382: <code class="filename">hacks.mk</code> are included.</p>
10383: <p>Then, various other files follow. Most of them don't have
10384: any dependencies on what they need to have included before or
10385: after them, though some do.</p>
10386: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10387: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10388: restricts the use of these variables to all the files that have
10389: been included before. Appearances in later files will be
10390: silently ignored.</p>
10391: <p>Then, the files for the main targets are included, in the
10392: order of later execution, though the actual order should not
10393: matter.</p>
10394: <p>At last, some more files are included that don't set any
10395: interesting variables but rather just define make targets to be
10396: executed.</p>
10397: </div>
10398: </div>
1.75 rillig 10399: </div>
10400: <div class="chapter" lang="en">
10401: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10402: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10403: <div class="toc">
10404: <p><b>Table of Contents</b></p>
10405: <dl>
1.106 rillig 10406: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10407: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10408: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10409: <dd><dl>
1.106 rillig 10410: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10411: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10412: </dl></dd>
10413: </dl>
10414: </div>
10415: <p>The pkgsrc infrastructure consists of a large codebase,
10416: and there are many corners where every little bit of a file is
10417: well thought out, making pkgsrc likely to fail as soon as
10418: anything is changed near those parts. To prevent most changes
10419: from breaking anything, a suite of regression tests should go
10420: along with every important part of the pkgsrc infrastructure.
10421: This chapter describes how regression tests work in pkgsrc and
10422: how you can add new tests.</p>
10423: <div class="sect1" lang="en">
10424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10425: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10426: <p></p>
10427: </div>
10428: <div class="sect1" lang="en">
10429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10430: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10431: <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 10432: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10433: can simply run that command, which will run all tests in the
1.76 rillig 10434: <code class="filename">regress</code> category.</p>
1.75 rillig 10435: </div>
10436: <div class="sect1" lang="en">
10437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10438: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10439: <p>Every directory in the <code class="filename">regress</code>
10440: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10441: is considered a regression test. This file is a shell program
1.110 hubertf 10442: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10443: The following functions can be overridden to suit your
10444: needs.</p>
10445: <div class="sect2" lang="en">
10446: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10447: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10448: <p>These functions do not take any parameters. They are all
10449: called in “<span class="quote">set -e</span>” mode, so you should be careful
10450: to check the exitcodes of any commands you run in the
10451: test.</p>
10452: <div class="variablelist"><dl>
10453: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10454: <dd><p>This function prepares the environment for the
10455: test. By default it does nothing.</p></dd>
10456: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10457: <dd><p>This function runs the actual test. By default,
10458: it calls <code class="varname">TEST_MAKE</code> with the arguments
10459: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10460: error messages into the file
10461: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10462: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10463: <dd><p>This function is run after the test and is
10464: typically used to compare the actual output from the one that is
10465: expected. It can make use of the various helper functions from
10466: the next section.</p></dd>
10467: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10468: <dd><p>This function cleans everything up after the
10469: test has been run. By default it does nothing.</p></dd>
10470: </dl></div>
10471: </div>
10472: <div class="sect2" lang="en">
10473: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10474: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10475: <div class="variablelist"><dl>
10476: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10477: <dd><p>This function compares the exitcode of the
1.110 hubertf 10478: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10479: If they differ, the test will fail.</p></dd>
10480: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10481: <dd><p>This function checks for each of its parameters
1.110 hubertf 10482: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10483: extended regular expression. If it does not, the test will
10484: fail.</p></dd>
10485: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10486: <dd><p>This function checks for each of its parameters
1.110 hubertf 10487: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10488: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10489: If any of the regular expressions matches, the test will
10490: fail.</p></dd>
10491: </dl></div>
10492: </div>
10493: </div>
10494: </div>
10495: <div class="chapter" lang="en">
10496: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10497: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10498: <div class="toc">
10499: <p><b>Table of Contents</b></p>
10500: <dl>
1.106 rillig 10501: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10502: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10503: </dl>
10504: </div>
10505: <p>The pkgsrc system has already been ported to many
10506: operating systems, hardware architectures and compilers. This
10507: chapter explains the necessary steps to make pkgsrc even more
10508: portable.</p>
10509: <div class="sect1" lang="en">
10510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10511: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10512: <p>To port pkgsrc to a new operating system (called
10513: <code class="literal">MyOS</code> in this example), you need to touch the
10514: following files:</p>
10515: <div class="variablelist"><dl>
1.93 rillig 10516: <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 10517: <dd><p>This file contains some basic definitions, for
10518: example the name of the C
10519: compiler.</p></dd>
1.76 rillig 10520: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10521: <dd><p>Insert code that defines the variables
10522: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10523: <code class="varname">LOWER_OS_VERSION</code>,
10524: <code class="varname">LOWER_VENDOR</code>,
10525: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10526: <code class="varname">APPEND_ELF</code>, and the other variables that
10527: appear in this file.</p></dd>
1.93 rillig 10528: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10529: <dd><p>This file contains the platform-specific
10530: definitions that are used by pkgsrc. Start by copying one of the
10531: other files and edit it to your
10532: needs.</p></dd>
1.93 rillig 10533: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10534: <dd><p>This file contains a list of directories,
10535: together with their permission bits and ownership. These
10536: directories will be created automatically with every package
1.98 wiz 10537: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10538: be removed.</p></dd>
1.93 rillig 10539: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10540: <dd><p>Just copy one of the pre-existing x11.dist files
10541: to your
1.76 rillig 10542: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10543: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10544: <dd><p>On some operating systems, the tools that are
10545: provided with the base system are not good enough for pkgsrc.
1.110 hubertf 10546: For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.75 rillig 10547: narrow limit on the line length they can process. Therefore
10548: pkgsrc brings its own tools, which can be enabled
10549: here.</p></dd>
1.93 rillig 10550: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10551: <dd><p>This file defines the paths to all the tools
10552: that are needed by one or the other package in pkgsrc, as well
10553: as by pkgsrc itself. Find out where these tools are on your
10554: platform and add them.</p></dd>
10555: </dl></div>
10556: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10557: <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 10558: </div>
10559: <div class="sect1" lang="en">
10560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10561: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10562: <p>TODO</p>
10563: </div>
10564: </div>
10565: </div>
10566: <div class="appendix" lang="en">
10567: <div class="titlepage"><div><div><h2 class="title">
10568: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10569: <div class="toc">
10570: <p><b>Table of Contents</b></p>
10571: <dl>
10572: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10573: <dd><dl>
10574: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10575: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10576: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.116 rillig 10577: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10578: </dl></dd>
10579: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10580: </dl>
10581: </div>
10582: <p>We checked to find a piece of software that wasn't in the packages
10583: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10584: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10585: present in the tree is beyond us, but it's useful for the purposes of
10586: this exercise.</p>
10587: <div class="sect1" lang="en">
10588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10589: <a name="example-files"></a>A.1. files</h2></div></div></div>
10590: <div class="sect2" lang="en">
10591: <div class="titlepage"><div><div><h3 class="title">
10592: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10593: <pre class="programlisting">
1.100 rillig 10594: # $NetBSD$
10595: #
1.1 grant 10596:
1.100 rillig 10597: DISTNAME= bison-1.25
10598: CATEGORIES= devel
10599: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10600:
1.100 rillig 10601: MAINTAINER= thorpej@NetBSD.org
10602: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10603: COMMENT= GNU yacc clone
1.1 grant 10604:
1.100 rillig 10605: GNU_CONFIGURE= yes
10606: INFO_FILES= bison.info
1.1 grant 10607:
1.100 rillig 10608: .include "../../mk/bsd.pkg.mk"
1.1 grant 10609: </pre>
1.75 rillig 10610: </div>
10611: <div class="sect2" lang="en">
10612: <div class="titlepage"><div><div><h3 class="title">
10613: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10614: <pre class="programlisting">
1.100 rillig 10615: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.110 hubertf 10616: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10617: of the NetBSD source tree is beyond me.
1.1 grant 10618: </pre>
1.75 rillig 10619: </div>
10620: <div class="sect2" lang="en">
10621: <div class="titlepage"><div><div><h3 class="title">
10622: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10623: <pre class="programlisting">
1.100 rillig 10624: @comment $NetBSD$
10625: bin/bison
10626: man/man1/bison.1.gz
10627: share/bison.simple
10628: share/bison.hairy
1.1 grant 10629: </pre>
1.75 rillig 10630: </div>
10631: <div class="sect2" lang="en">
10632: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10633: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10634: </h3></div></div></div>
1.75 rillig 10635: <p>The NetBSD package system comes with
1.91 rillig 10636: <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 10637: which helps to check the contents of these
10638: files. After installation it is quite easy to use, just change to the
10639: directory of the package you wish to examine and execute
1.110 hubertf 10640: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10641: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10642: looks fine.</pre>
10643: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10644: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10645: -Wall</strong></span> for a very thorough check.</p>
10646: </div>
10647: </div>
10648: <div class="sect1" lang="en">
10649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10650: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10651: <p>Create the directory where the package lives,
10652: plus any auxiliary directories:</p>
10653: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10654: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10655: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10656: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10657: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10658: <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 10659: then continue with fetching the distfile:</p>
10660: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10661: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10662: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10663: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10664: ftp: Error retrieving file: 500 Internal error
10665:
10666: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10667: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10668: ftp: Error retrieving file: 500 Internal error
10669:
10670: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10671: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10672: Successfully retrieved file.</pre>
10673: <p>Generate the checksum of the distfile into
1.76 rillig 10674: <code class="filename">distinfo</code>:</p>
1.88 wiz 10675: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10676: <p>Now compile:</p>
10677: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10678: >> Checksum OK for bison-1.25.tar.gz.
10679: ===> Extracting for bison-1.25
10680: ===> Patching for bison-1.25
10681: ===> Ignoring empty patch directory
10682: ===> Configuring for bison-1.25
10683: creating cache ./config.cache
10684: checking for gcc... cc
10685: checking whether we are using GNU C... yes
10686: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10687: checking how to run the C preprocessor... cc -E
10688: checking for minix/config.h... no
10689: checking for POSIXized ISC... no
10690: checking whether cross-compiling... no
10691: checking for ANSI C header files... yes
10692: checking for string.h... yes
10693: checking for stdlib.h... yes
10694: checking for memory.h... yes
10695: checking for working const... yes
10696: checking for working alloca.h... no
10697: checking for alloca... yes
10698: checking for strerror... yes
10699: updating cache ./config.cache
10700: creating ./config.status
10701: creating Makefile
10702: ===> Building for bison-1.25
10703: 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
10704: 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
10705: 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
10706: 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
10707: 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 10708: 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 10709: 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
10710: 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
10711: 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
10712: 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
10713: 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
10714: 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
10715: 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
10716: 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
10717: 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
10718: 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
10719: 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
10720: 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
10721: 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
10722: 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
10723: 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
10724: 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
10725: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10726: rm -f bison.s1
1.75 rillig 10727: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10728: <p>Everything seems OK, so install the files:</p>
10729: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10730: >> Checksum OK for bison-1.25.tar.gz.
10731: ===> Installing for bison-1.25
10732: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10733: rm -f /usr/pkg/bin/bison
10734: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10735: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10736: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10737: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10738: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10739: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10740: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10741: ===> Registering installation for bison-1.25</pre>
10742: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10743: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10744: binary package, do this now:</p>
10745: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10746: >> Checksum OK for bison-1.25.tar.gz.
10747: ===> Building package for bison-1.25
10748: Creating package bison-1.25.tgz
10749: Registering depends:.
1.75 rillig 10750: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10751: <p>Now that you don't need the source and object files
10752: any more, clean up:</p>
10753: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10754: ===> Cleaning for bison-1.25</pre>
10755: </div>
10756: </div>
10757: <div class="appendix" lang="en">
10758: <div class="titlepage"><div><div><h2 class="title">
10759: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10760: <div class="toc">
10761: <p><b>Table of Contents</b></p>
10762: <dl>
10763: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10764: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10765: </dl>
10766: </div>
10767: <div class="sect1" lang="en">
10768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10769: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10770: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10771: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10772: => figlet221.tar.gz doesn't seem to exist on this system.
10773: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10774: => [172219 bytes]
10775: Connected to ftp.plig.net.
10776: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10777: 331 Guest login ok, send your complete e-mail address as password.
10778: 230-You are user #5 of 500 simultaneous users allowed.
10779: 230-
1.68 rillig 10780: 230- ___ _ _ _
10781: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10782: 230- | _| _| . |_| . | | | . |_| . | _| . |
10783: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10784: 230- |_| |_| |___| |___|
10785: 230-
10786: 230-** Welcome to ftp.plig.org **
10787: 230-
10788: 230-Please note that all transfers from this FTP site are logged. If you
10789: 230-do not like this, please disconnect now.
10790: 230-
10791: 230-This arhive is available via
10792: 230-
10793: 230-HTTP: http://ftp.plig.org/
10794: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10795: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10796: 230-
10797: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10798: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10799: 230-
10800: 230-
10801: 230 Logged in anonymously.
10802: Remote system type is UNIX.
10803: Using binary mode to transfer files.
10804: 200 Type okay.
10805: 250 "/pub" is new cwd.
10806: 250-"/pub/figlet" is new cwd.
10807: 250-
10808: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10809: 250-
1.75 rillig 10810: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10811: 250-
10812: 250-The official FIGlet web page is:
1.75 rillig 10813: 250- http://www.figlet.org/
1.1 grant 10814: 250-
10815: 250-If you have questions, please mailto:info@figlet.org. If you want to
10816: 250-contribute a font or something else, you can email us.
1.68 rillig 10817: 250
1.1 grant 10818: 250 "/pub/figlet/program" is new cwd.
10819: 250 "/pub/figlet/program/unix" is new cwd.
10820: local: figlet221.tar.gz remote: figlet221.tar.gz
10821: 502 Unimplemented command.
10822: 227 Entering Passive Mode (195,40,6,41,246,104)
10823: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10824: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10825: 226 Transfer completed.
10826: 172219 bytes received in 00:02 (75.99 KB/s)
10827: 221 Goodbye.
10828: => Checksum OK for figlet221.tar.gz.
10829: ===> Extracting for figlet-2.2.1nb2
10830: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10831: ===> Patching for figlet-2.2.1nb2
10832: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10833: ===> Overriding tools for figlet-2.2.1nb2
10834: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10835: ===> Configuring for figlet-2.2.1nb2
10836: ===> Building for figlet-2.2.1nb2
10837: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10838: chmod a+x figlet
10839: gcc -O2 -o chkfont chkfont.c
10840: => Unwrapping files-to-be-installed.
1.14 xtraeme 10841: <code class="prompt">#</code>
1.75 rillig 10842: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10843: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10844: ===> Installing for figlet-2.2.1nb2
10845: install -d -o root -g wheel -m 755 /usr/pkg/bin
10846: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10847: mkdir -p /usr/pkg/share/figlet
10848: cp figlet /usr/pkg/bin
10849: cp chkfont /usr/pkg/bin
10850: chmod 555 figlist showfigfonts
10851: cp figlist /usr/pkg/bin
10852: cp showfigfonts /usr/pkg/bin
10853: cp fonts/*.flf /usr/pkg/share/figlet
10854: cp fonts/*.flc /usr/pkg/share/figlet
10855: cp figlet.6 /usr/pkg/man/man6
10856: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10857: <code class="prompt">#</code></pre>
10858: </div>
10859: <div class="sect1" lang="en">
10860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10861: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10862: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10863: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10864: ===> Packaging figlet-2.2.1nb2
10865: ===> Building binary package for figlet-2.2.1nb2
10866: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10867: Using SrcDir value of /usr/pkg
1.68 rillig 10868: Registering depends:.
1.75 rillig 10869: <code class="prompt">#</code></pre>
10870: </div>
10871: </div>
10872: <div class="appendix" lang="en">
10873: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10874: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10875: <div class="toc">
10876: <p><b>Table of Contents</b></p>
10877: <dl>
1.116 rillig 10878: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
10879: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
10880: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
10881: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
10882: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
10883: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
10884: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
10885: pkgsrc-200xQy:
1.76 rillig 10886: source packages</a></span></dt>
10887: </dl>
10888: </div>
10889: <p>As in other big projects, the directory layout of pkgsrc
10890: is quite complex for newbies. This chapter explains where you
10891: find things on the FTP server. The base directory on
1.110 hubertf 10892: <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 10893: On other servers it may be different, but inside this directory,
10894: everything should look the same, no matter on which server you
10895: are. This directory contains some subdirectories, which are
10896: explained below.</p>
1.76 rillig 10897: <div class="sect1" lang="en">
10898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10899: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.109 rillig 10900: <p>This directory used to contain binary packages of the
10901: package management tools for various platforms. For those
10902: package collections that need them, they are now stored near the
1.110 hubertf 10903: binary packages, so you should look <a class="link" href="#ftp-packages" title="C.5. packages: Binary packages">in the <code class="filename">packages</code>
1.109 rillig 10904: directory</a>.</p>
1.76 rillig 10905: </div>
10906: <div class="sect1" lang="en">
10907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10908: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10909: <p>The directory <code class="filename">distfiles</code> contains lots
10910: of archive files from all pkgsrc packages, which are mirrored
10911: here. The subdirectories are called after their package names
10912: and are used when the distributed files have names that don't
10913: explicitly contain a version number or are otherwise too generic
10914: (for example <code class="filename">release.tar.gz</code>).</p>
10915: </div>
10916: <div class="sect1" lang="en">
10917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10918: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10919: <p>This directory is currently not in use.</p>
10920: </div>
10921: <div class="sect1" lang="en">
10922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10923: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10924: <p>This directory contains things that individual pkgsrc
10925: developers find worth publishing.</p>
10926: </div>
10927: <div class="sect1" lang="en">
10928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102 rillig 10929: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
10930: <p>This directory contains binary packages for the various
10931: platforms that are supported by pkgsrc.
10932: 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>
10933: <div class="itemizedlist"><ul type="disc">
1.108 rillig 10934: <li><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10935: operating system for which the packages have been built. The
1.110 hubertf 10936: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10937: command, so it may differ from the one you are used to
10938: hear.</p></li>
1.108 rillig 10939: <li><p><code class="varname">ARCH</code> is the hardware
10940: architecture of the platform for which the packages have been
1.110 hubertf 10941: built. It also includes the <code class="varname">ABI</code> (Application
10942: Binary Interface) for platforms that have several of
10943: them.</p></li>
1.108 rillig 10944: <li><p><code class="varname">OSVERSION</code> is the version of
10945: the operating system. For version numbers that change often (for
10946: example NetBSD-current), the often-changing part should be
10947: replaced with an <code class="literal">x</code>, for example
10948: <code class="literal">4.99.x</code>.</p></li>
10949: <li><p><code class="varname">TAG</code> is either
10950: <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
10951: for a stable branch, or <code class="literal">head</code> for packages
10952: built from the HEAD branch. The latter should only be used when
10953: the packages are updated on a regular basis. Otherwise the date
10954: from checking out pkgsrc should be appended, for example
10955: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10956: </ul></div>
10957: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10958: can quickly click through the directories on the
10959: server and find the best binary packages for their machines. Since they
10960: usually know the operating system and the hardware architecture, OPSYS
10961: and ARCH are placed first. After these choices, they can select the
10962: best combination of OSVERSION and TAG together, since it is usually the
10963: case that packages stay compatible between different version of the
10964: operating system.</p>
10965: <p>In each of these directories, there is a
10966: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10967: <code class="filename">All</code> which contains all binary packages.
10968: Besides that, there are various category directories that
10969: contain symbolic links to the real binary packages.</p>
10970: </div>
10971: <div class="sect1" lang="en">
10972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 10973: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
10974: <p>Here are the reports from bulk builds, for those who want
10975: to fix packages that didn't build on some of the platforms. The
1.116 rillig 10976: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, “packages: Binary packages”</a>.</p>
1.108 rillig 10977: </div>
10978: <div class="sect1" lang="en">
10979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10980: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.93 rillig 10981: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10982: source packages</h2></div></div></div>
10983: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10984: that is the files that define how to create binary packages from
10985: source archives.</p>
10986: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10987: snapshot of the CVS repository, which is updated regularly. The
10988: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10989: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10990: <p>In the directories for the quarterly branches, there is an
10991: additional file called
10992: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10993: which contains the state of pkgsrc when it was branched.</p>
10994: </div>
1.75 rillig 10995: </div>
10996: <div class="appendix" lang="en">
10997: <div class="titlepage"><div><div><h2 class="title">
10998: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10999: <div class="toc">
11000: <p><b>Table of Contents</b></p>
11001: <dl>
1.79 rillig 11002: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 11003: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11004: </dl>
11005: </div>
1.79 rillig 11006: <p>This section contains information on editing the pkgsrc
11007: guide itself.</p>
1.75 rillig 11008: <div class="sect1" lang="en">
11009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 11010: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11011: <p>The pkgsrc guide's source code is stored in
11012: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11013: are created from it:</p>
11014: <div class="itemizedlist"><ul type="disc">
11015: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11016: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110 hubertf 11017: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
11018: <li><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 11019: The PDF version of the pkgsrc guide.</p></li>
1.110 hubertf 11020: <li><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 11021: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11022: </ul></div>
11023: </div>
11024: <div class="sect1" lang="en">
11025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11026: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11027: <p>The procedure to edit the pkgsrc guide is:</p>
11028: <div class="procedure"><ol type="1">
11029: <li><p>Make sure you have the packages needed to
1.83 wiz 11030: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 11031: documentation) installed. These are <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc</code></a> for creating the
11032: ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
1.79 rillig 11033: PostScript and PDF versions. You will need both packages
11034: installed, to make sure documentation is consistent across all
11035: formats.</p></li>
1.110 hubertf 11036: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 11037: right directory. All further steps will take place
11038: here.</p></li>
11039: <li><p>Edit the XML file(s) in
11040: <code class="filename">files/</code>.</p></li>
1.110 hubertf 11041: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 11042: guide for valid XML and to build the final output files. If you
11043: get any errors at this stage, you can just edit the files, as
11044: there are only symbolic links in the working directory, pointing
11045: to the files in <code class="filename">files/</code>.</p></li>
1.110 hubertf 11046: <li><p><span class="command"><strong>(cd files && cvs
1.79 rillig 11047: commit)</strong></span></p></li>
1.110 hubertf 11048: <li><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 11049: regenerate the output files with the proper RCS
11050: Ids.</p></li>
1.91 rillig 11051: <li>
1.110 hubertf 11052: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11053: commit the files in both <code class="filename">pkgsrc/doc</code> and
11054: <code class="filename">htdocs</code>.</p>
11055: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11056: <h3 class="title">Note</h3>
11057: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11058: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11059: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11060: directory.</p>
11061: </div>
11062: </li>
1.79 rillig 11063: </ol></div>
1.75 rillig 11064: </div>
11065: </div>
11066: </div></body>
1.1 grant 11067: </html>
CVSweb <webmaster@jp.NetBSD.org>