Annotation of pkgsrc/doc/pkgsrc.html, revision 1.127
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.123 snj 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.123 snj 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.123 snj 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.123 snj 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.123 snj 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.123 snj 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.118 imil 190: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 191: </dl></dd>
1.106 rillig 192: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
193: <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>
194: </dl></dd>
195: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
196: <dd><dl>
1.123 snj 197: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
198: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106 rillig 199: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
200: <dd><dl>
201: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
202: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
203: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
204: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
205: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
206: </dl></dd>
207: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
208: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
209: <dd><dl>
210: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
211: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
212: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
213: </dl></dd>
1.123 snj 214: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
215: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106 rillig 216: </dl></dd>
1.123 snj 217: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106 rillig 218: <dd><dl>
219: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.123 snj 220: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106 rillig 221: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
222: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
223: <dd><dl>
224: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
225: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
226: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
227: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
228: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
229: </dl></dd>
230: </dl></dd>
231: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
232: <dd><dl>
233: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.123 snj 234: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
235: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106 rillig 236: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
237: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.123 snj 238: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106 rillig 239: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
240: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
241: </dl></dd>
242: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
243: <dd><dl>
244: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.123 snj 245: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106 rillig 246: <dd><dl>
247: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.123 snj 248: <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 249: </dl></dd>
1.123 snj 250: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106 rillig 251: <dd><dl>
1.123 snj 252: <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 253: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
254: </dl></dd>
255: </dl></dd>
256: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
257: <dd><dl>
258: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
259: <dd><dl>
260: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
261: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
262: </dl></dd>
263: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
264: <dd><dl>
1.123 snj 265: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106 rillig 266: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
267: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
268: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
269: </dl></dd>
270: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
271: <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>
272: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
273: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
274: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
275: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
276: <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>
277: </dl></dd>
278: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.123 snj 281: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106 rillig 282: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 283: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 284: </dl></dd>
285: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
286: <dd><dl>
287: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
288: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
289: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
290: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.123 snj 291: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106 rillig 292: <dd><dl>
293: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
294: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
295: </dl></dd>
1.123 snj 296: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
299: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
301: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
302: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
303: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
304: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
305: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106 rillig 306: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
307: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
308: </dl></dd>
309: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
312: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
313: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
314: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
315: </dl></dd>
316: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
317: <dd><dl>
318: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
319: <dd><dl>
320: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.123 snj 321: <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 322: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
323: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
324: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
325: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
326: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
327: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
328: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
329: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
330: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
331: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
332: </dl></dd>
1.123 snj 333: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106 rillig 334: <dd><dl>
335: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
336: <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>
337: </dl></dd>
1.123 snj 338: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106 rillig 339: <dd><dl>
340: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
341: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
342: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
343: </dl></dd>
344: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
345: <dd><dl>
346: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
347: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
348: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
349: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
350: </dl></dd>
1.123 snj 351: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106 rillig 352: <dd><dl>
353: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
354: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.123 snj 355: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106 rillig 356: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
357: </dl></dd>
1.123 snj 358: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106 rillig 359: <dd><dl>
360: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
361: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
362: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
363: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
364: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
365: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
366: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
367: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 368: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 369: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 370: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
371: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
372: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
373: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
374: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
375: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
376: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
377: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 378: emulation</a></span></dt>
1.106 rillig 379: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
380: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 381: </dl></dd>
1.106 rillig 382: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 383: </dl></dd>
1.106 rillig 384: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
385: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 386: <dd><dl>
1.106 rillig 387: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
388: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
389: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
390: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
391: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 392: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
393: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 394: </dl></dd>
395: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
396: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
397: <dd><dl>
398: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
399: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
400: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
401: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 402: </dl></dd>
1.75 rillig 403: </dl></dd>
404: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
405: <dd><dl>
1.106 rillig 406: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 407: <dd><dl>
1.106 rillig 408: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
409: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
410: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 411: <dd><dl>
1.106 rillig 412: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
413: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 414: </dl></dd>
1.106 rillig 415: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
416: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 417: <dd><dl>
1.106 rillig 418: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
419: <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 420: </dl></dd>
1.106 rillig 421: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 422: <dd><dl>
1.123 snj 423: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
424: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75 rillig 425: </dl></dd>
426: </dl></dd>
1.106 rillig 427: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 428: <dd><dl>
1.106 rillig 429: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
430: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
431: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 432: <dd><dl>
1.106 rillig 433: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
434: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 435: </dl></dd>
436: </dl></dd>
1.106 rillig 437: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 438: <dd><dl>
1.106 rillig 439: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
440: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 441: </dl></dd>
442: </dl></dd>
443: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
444: <dd><dl>
445: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
446: <dd><dl>
447: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
448: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
449: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.123 snj 450: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 451: </dl></dd>
452: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
453: </dl></dd>
454: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
455: <dd><dl>
456: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
457: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
458: </dl></dd>
1.76 rillig 459: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
460: <dd><dl>
1.126 jakllsch 461: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. distfiles: The distributed source files</a></span></dt>
462: <dt><span class="sect1"><a href="#ftp-misc">C.2. misc: Miscellaneous things</a></span></dt>
463: <dt><span class="sect1"><a href="#ftp-packages">C.3. packages: Binary packages</a></span></dt>
464: <dt><span class="sect1"><a href="#ftp-reports">C.4. reports: Bulk build reports</a></span></dt>
465: <dt><span class="sect1"><a href="#ftp-source">C.5. current,
466: pkgsrc-20xxQy:
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.126 jakllsch 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.126 jakllsch 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.123 snj 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.123 snj 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.123 snj 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.123 snj 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.123 snj 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.123 snj 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.124 snj 933: <code class="literal">2009Q1</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.124 snj 947: <p>The tar file for the stable branch 2009Q1 is in the
948: directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
1.112 weinem 949: <p>To download a pkgsrc stable tarball, run:</p>
950: <pre class="screen">
1.126 jakllsch 951: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
952: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 953: stable branch to be downloaded, for example,
1.124 snj 954: “<span class="quote">pkgsrc-2009Q1</span>”.</p>
1.112 weinem 955: <p>Then, extract it with:</p>
1.126 jakllsch 956: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.112 weinem 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.126 jakllsch 1014: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong></pre>
1015: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.124 snj 1016: branch to be checked out, for example, “<span class="quote">pkgsrc-2009Q1</span>”</p>
1.112 weinem 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.126 jakllsch 1073: “<span class="quote">-rpkgsrc-2009Q3</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.126 jakllsch 1147: <p>Darwin 5.x and up are supported. Before you start, you
1148: will need to download and install the Mac OS X Developer Tools
1149: from Apple's Developer Connection. See
1150: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1151: for details. Also, make sure you install X11 (an optional
1152: package included with the Developer Tools) if you intend to
1153: build packages that use the X11 Window System.</p>
1.75 rillig 1154: </div>
1155: <div class="sect2" lang="en">
1156: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1157: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1158: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1159: other versions may work.</p>
1.75 rillig 1160: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1161: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1162: <div class="orderedlist"><ol type="1">
1163: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1164: <code class="filename">/var/db/pkg</code>. It is therefore
1165: recommended that you choose a different location (e.g.
1166: <code class="filename">/usr/pkgdb</code>) by
1167: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1168: <li>
1169: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1170: good idea to move them out of the way to avoid confusion, e.g.</p>
1171: <pre class="screen">
1172: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1173: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1174: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1175: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1176: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1177: </pre>
1.75 rillig 1178: </li>
1.110 hubertf 1179: <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 1180: <code class="filename">/etc/mk.conf.example</code> file
1181: when you use the bootstrap script.</p></li>
1.75 rillig 1182: </ol></div>
1183: </div>
1184: <div class="sect2" lang="en">
1185: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1186: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1187: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1188: providing a Unix-like environment with a tighter kernel integration than
1189: available with Cygwin. It is part of the Windows Services for Unix
1190: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1191: (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 1192: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1193: are not officially supported. (The main difference in 3.0/3.1 is lack
1194: of pthreads, but other parts of libc may also be lacking.)</p>
1195: <p>Services for Unix Applications (aka SUA) is an integrated component
1196: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1.95 tron 1197: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75 rillig 1198: <div class="sect3" lang="en">
1199: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1200: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1201: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1202: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1203: <div class="itemizedlist"><ul type="disc">
1204: <li><p>Utilities -> Base Utilities</p></li>
1205: <li><p>Interix GNU Components -> (all)</p></li>
1206: <li><p>Remote Connectivity</p></li>
1207: <li><p>Interix SDK</p></li>
1208: </ul></div>
1209: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1210: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1211: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1212: pkgsrc (or from a binary package).</p>
1.75 rillig 1213: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1214: not need to be installed, but Remote Connectivity itself should be
1215: installed in order to have a working inetd.</p>
1.75 rillig 1216: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1217: behavior for Interix programs, and whether to make pathnames default to
1218: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1219: enabled. (Without case-sensitivity, a large number of packages including
1220: perl will not build.)</p>
1.75 rillig 1221: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1222: works (via the Data Execution Prevention feature). In order to use
1223: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1224: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1225: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1226: support contract; however, Debian Interix Port has made most Interix
1227: 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 1228: <p>In addition to the hotfix noted above, it may be necessary to
1229: disable Data Execution Prevention entirely to make Interix functional.
1230: This may happen only with certain types of CPUs; the cause is not fully
1231: understood at this time. If gcc or other applications still segfault
1232: repeatedly after installing one of the hotfixes note above, the
1233: following option can be added to the appropriate "boot.ini" line on the
1234: Windows boot drive: /NoExecute=AlwaysOff
1235: (WARNING, this will disable DEP completely, which may be a security
1236: risk if applications are often run as a user in the Administrators
1237: group!)</p>
1.75 rillig 1238: </div>
1239: <div class="sect3" lang="en">
1240: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1241: <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 1242: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1243: with pkgsrc, note the following things.</p>
1.75 rillig 1244: <div class="itemizedlist"><ul type="disc">
1245: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1246: Windows Services for UNIX, then click Change. In the installer, choose
1247: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1248: <li>
1249: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1250: change the following registry key:</p>
1.75 rillig 1251: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1252: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1253: </li>
1254: <li>
1255: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1256: following registry key:</p>
1.75 rillig 1257: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1258: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1259: </li>
1260: </ul></div>
1261: </div>
1262: <div class="sect3" lang="en">
1263: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1264: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1265: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1266: running "pkg_add") must be a member of the local Administrators
1267: group. Such a user must also be used to run the bootstrap. This is
1268: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1269: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1270: automatically complain if this is not the case. This ensures that
1271: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1272: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1273: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1274: NOT be used in conjunction with pkgsrc. If you choose to use them at
1275: the same time as the pkgsrc packages, ensure that you use the proper
1276: pkg_* tools for each type of binary package.</p>
1.75 rillig 1277: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1278: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1279: don't have a termcap/terminfo entry for it, but the following .termcap
1280: entry provides adequate emulation in most cases:</p>
1.75 rillig 1281: <pre class="programlisting">
1.100 rillig 1282: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1283: </pre>
1.75 rillig 1284: </div>
1285: <div class="sect3" lang="en">
1286: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1287: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1288: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1289: for a full Unix-like platform, it has some drawbacks that should
1290: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1291: <div class="itemizedlist"><ul type="disc">
1292: <li>
1293: <p><span class="strong"><strong>X11:</strong></span></p>
1294: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1295: and can run X11 based applications, but it does
1296: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1297: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1298: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1299: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1300: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1301: and the free X11 server included with
1.110 hubertf 1302: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1303: </li>
1304: <li>
1305: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1306: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1307: Win32 applications, it does not currently support various X11
1308: protocol extensions for acceleration (such as MIT-SHM or DGA).
1309: Most interactive applications to a local X server will run
1310: reasonably fast, but full motion video and other graphics
1311: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1312: </li>
1313: <li>
1314: <p><span class="strong"><strong>Audio:</strong></span></p>
1315: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1316: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1317: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1318: <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 1319: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1320: server component. To output audio via an Interix host, the
1.91 rillig 1321: <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 1322: must also be installed.</p>
1.75 rillig 1323: </li>
1324: <li>
1325: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1326: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1327: is not currently possible to access CD/DVD drives, USB devices,
1328: or SCSI devices through non-filesystem means. Among other things,
1329: this makes it impossible to use Interix directly for CD/DVD
1330: burning.</p>
1.75 rillig 1331: </li>
1332: <li>
1333: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1334: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1335: drives are also not directly accessible in Interix. However,
1336: support is in work to make tape drive access possible by using
1337: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1338: esound server).</p>
1.75 rillig 1339: </li>
1340: </ul></div>
1341: </div>
1342: <div class="sect3" lang="en">
1343: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1344: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1345: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1346: Windows system; any member of the local Administrators group will
1347: suffice. However, some packages currently assume that the user
1348: named "root" is the privileged user. To accommodate these, you
1349: may create such a user; make sure it is in the local group
1350: Administrators (or your language equivalent).</p>
1.110 hubertf 1351: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1352: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1353: time being, install packages as the local Administrator (or
1354: your language equivalent), or run the following command after
1355: installing a package to work around the issue:</p>
1.75 rillig 1356: <pre class="screen">
1.87 wiz 1357: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1358: </pre>
1.75 rillig 1359: </div>
1360: </div>
1361: <div class="sect2" lang="en">
1362: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1363: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1364: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1365: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1366: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1367: 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 1368: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110 hubertf 1369: 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 1370: etc.</p>
1.86 schwarz 1371: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1372: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1373: you start out using "abi=n32", that's what all your packages will be built
1374: with.</p>
1375: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1376: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1377: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1378: try to link n32 object files with lib64 or vice versa. Check your
1379: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1380: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1381: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1382: as it appears that IRIX linker occasionally runs into issues when trying to
1383: link over a network-mounted file system.</p>
1.75 rillig 1384: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1385: as imake(1), but you may want to set some options depending on your local
1386: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1387: course, your compiler's man pages for details.</p>
1.75 rillig 1388: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1389:
1.87 wiz 1390: </p>
1.75 rillig 1391: <pre class="programlisting">
1.100 rillig 1392: PKGSRC_COMPILER= mipspro
1.87 wiz 1393: </pre>
1.75 rillig 1394: <p>
1.1 grant 1395:
1.110 hubertf 1396: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1397: are using gcc and may end up passing invalid flags to the compiler. Note that
1398: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1399: default.</p>
1.75 rillig 1400: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1401: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1402: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1403: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1404: '--preserve-path' flag.</p>
1.75 rillig 1405: </div>
1406: <div class="sect2" lang="en">
1407: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1408: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1409: <p>Some versions of Linux (for example Debian GNU/Linux) need
1410: either libtermcap or libcurses (libncurses). Installing the
1411: distributions libncurses-dev package (or equivalent) should fix
1412: the problem.</p>
1413: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1414: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1415: i386 have been tested.</p>
1.75 rillig 1416: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1417: directory:</p>
1.75 rillig 1418: <pre class="programlisting">
1.100 rillig 1419: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1420: ac_cv___attribute__=yes ./bootstrap
1.87 wiz 1421: </pre>
1.75 rillig 1422: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1423: <h3 class="title">Note</h3>
1424: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1425: </div>
1426: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1427: function, which icc does not support. #undef'ing __attribute__ has the
1428: unfortunate side-effect of breaking many of the Linux header files, which
1429: cannot be compiled properly without __attribute__. The test must be
1430: overridden so that __attribute__ is assumed supported by the
1431: compiler.</p>
1.75 rillig 1432: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110 hubertf 1433: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1434: <pre class="programlisting">
1.100 rillig 1435: PKGSRC_COMPILER= icc
1.87 wiz 1436: </pre>
1.75 rillig 1437: <p>The default installation directory for icc is
1.87 wiz 1438: <code class="filename">/opt/intel_cc_80</code>, which
1439: is also the pkgsrc default. If you have installed it into a different
1440: directory, set <code class="varname">ICCBASE</code> in
1.110 hubertf 1441: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1442: <pre class="programlisting">
1.100 rillig 1443: ICCBASE= /opt/icc
1.87 wiz 1444: </pre>
1.75 rillig 1445: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1446: provided by icc, so binaries can be run on other systems which do not
1447: have the shared libraries installed.</p>
1448: <p>Libtool, however, extracts a list of libraries from the
1.110 hubertf 1449: <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 1450: records it, throwing away the -Bstatic and -Bdynamic options
1451: interspersed between the libraries. This means that
1452: libtool-linked C++ shared libraries will have a runtime
1453: dependency on the icc libraries until this is fixed in
1454: libtool.</p>
1.75 rillig 1455: </div>
1456: <div class="sect2" lang="en">
1457: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1458: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1459: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1460: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1461: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1462: <div class="orderedlist"><ol type="1">
1463: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1464: <code class="filename">/var/db/pkg</code>. It is therefore
1465: recommended that you choose a different location (e.g.
1466: <code class="filename">/usr/pkgdb</code>) by
1467: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1468: <li>
1469: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1470: good idea to move them out of the way to avoid confusion, e.g.</p>
1471: <pre class="screen">
1472: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1473: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1474: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1475: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1476: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1477: </pre>
1.75 rillig 1478: </li>
1479: <li>
1.110 hubertf 1480: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1481: <code class="filename">/etc/mk.conf.example</code> file
1482: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1483: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1484: as well. You can work around this by enclosing all the pkgsrc-specific parts
1485: of the file with:</p>
1486: <pre class="programlisting">
1.100 rillig 1487: .ifdef BSD_PKG_MK
1488: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1489: .else
1490: # OpenBSD stuff
1491: .endif
1.87 wiz 1492: </pre>
1.75 rillig 1493: </li>
1494: </ol></div>
1495: </div>
1496: <div class="sect2" lang="en">
1497: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1498: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1499: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1500: You will need a working C compiler. Both gcc 2.95.3 and
1501: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1502: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1503: process and to build packages.</p>
1.75 rillig 1504: <div class="itemizedlist"><ul type="disc">
1505: <li><p>SUNWsprot</p></li>
1506: <li><p>SUNWarc</p></li>
1507: <li><p>SUNWbtool</p></li>
1508: <li><p>SUNWtoo</p></li>
1509: <li><p>SUNWlibm</p></li>
1510: </ul></div>
1.78 rillig 1511: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1512: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1513: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1514: your $prefix are in your <code class="varname">PATH</code>. This includes
1515: <code class="filename">/usr/ccs/{bin,lib}</code>
1516: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1517: <div class="sect3" lang="en">
1518: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1519: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1520: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1521: for building all packages.</p>
1.75 rillig 1522: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1523: then either build gcc from
1.91 rillig 1524: <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 1525: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1526: <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 1527: </div>
1528: <div class="sect3" lang="en">
1529: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1530: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1531: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1532: 5.0)</p>
1.75 rillig 1533: <div class="itemizedlist"><ul type="disc">
1534: <li><p>SPROcc
1.87 wiz 1535: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1536: <li><p>SPROcpl
1.87 wiz 1537: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1538: <li><p>SPROild
1.87 wiz 1539: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1540: <li><p>SPROlang
1.87 wiz 1541: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1542: </ul></div>
1.96 rillig 1543: <p>You should set the following variables in your
1.110 hubertf 1544: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1545: <pre class="programlisting">
1.100 rillig 1546: CC= cc
1547: CXX= CC
1548: CPP= cc -E
1549: CXXCPP= CC -E
1.96 rillig 1550: </pre>
1551: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1552: <h3 class="title">Note</h3>
1553: <p>The <code class="varname">CPP</code> setting might break some
1554: packages that use the C preprocessor for processing things other
1555: than C source code.</p>
1556: </div>
1.75 rillig 1557: </div>
1558: <div class="sect3" lang="en">
1559: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1560: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1561: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1562: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1563: <pre class="programlisting">
1.100 rillig 1564: PKGSRC_COMPILER= sunpro
1565: ABI= 64
1.96 rillig 1566: </pre>
1567: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1568: <h3 class="title">Note</h3>
1569: <p>This setting has been tested for the SPARC
1570: architecture. Intel and AMD machines need some more
1571: work.</p>
1572: </div>
1.75 rillig 1573: </div>
1574: <div class="sect3" lang="en">
1575: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1576: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110 hubertf 1577: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1578: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1579: The workaround is to use another shell for the configure
1.91 rillig 1580: 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 1581: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1582: <pre class="programlisting">
1.100 rillig 1583: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1584: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1585: </pre>
1.91 rillig 1586: <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 1587: </div>
1588: </div>
1589: </div>
1590: </div>
1591: <div class="chapter" lang="en">
1592: <div class="titlepage"><div><div><h2 class="title">
1593: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1594: <div class="toc">
1595: <p><b>Table of Contents</b></p>
1596: <dl>
1597: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1598: <dd><dl>
1599: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1600: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1601: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1602: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1603: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1604: <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>
1605: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1606: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1607: </dl></dd>
1608: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1609: <dd><dl>
1610: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1611: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1612: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1613: </dl></dd>
1614: </dl>
1615: </div>
1616: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1617: is to only install the package tools and to use binary packages
1618: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1619: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1620: of pkgsrc, too. Then you are able to build your own packages,
1621: and you can still use binary packages from someone else.</p>
1.75 rillig 1622: <div class="sect1" lang="en">
1623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1624: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1625: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1626: server and its mirrors, there are collections of binary packages,
1627: ready to be installed. These binary packages have been built using the
1628: default settings for the directories, that is:</p>
1629: <div class="itemizedlist"><ul type="disc">
1630: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1631: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1632: <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>
1633: </ul></div>
1634: <p>If you cannot use these directories for whatever reasons (maybe
1635: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1636: 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 1637: <div class="sect2" lang="en">
1638: <div class="titlepage"><div><div><h3 class="title">
1639: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1640: <p>To install binary packages, you first need to know from where
1641: to get them. The first place where you should look is on the main
1.110 hubertf 1642: 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 1643: <p>This directory contains binary packages for multiple
1644: platforms. First, select your operating system. (Ignore the
1645: directories with version numbers attached to it, they just exist for
1646: legacy reasons.) Then, select your hardware architecture, and in the
1.109 rillig 1647: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.</p>
1648: <p>In this directory, you often find a file called
1649: <code class="filename">bootstrap.tar.gz</code> which contains the package
1650: management tools. If the file is missing, it is likely that your
1651: operating system already provides those tools. Download the file and
1652: extract it in the <code class="filename">/</code> directory. It will create
1653: the directories <code class="filename">/usr/pkg</code> (containing the tools
1654: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1655: (the database of installed packages).</p>
1.75 rillig 1656: </div>
1657: <div class="sect2" lang="en">
1658: <div class="titlepage"><div><div><h3 class="title">
1659: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1660: <p>In the directory from the last section, there is a
1661: subdirectory called <code class="filename">All</code>, which contains all the
1662: binary packages that are available for the platform, excluding those
1663: that may not be distributed via FTP or CDROM (depending on which
1.127 ! spz 1664: medium you are using). There may be an extra directory for packages
! 1665: that have vulnerabilities and therefore are considered insecure to install
! 1666: without checking the implications first. This method has been replaced by
! 1667: setting CHECK_VULNERABILITIES=yes in pkg_install.conf so pkg_add will
! 1668: complain about vulnerabilities, instead.</p>
1.109 rillig 1669: <p>To install packages directly from an FTP or HTTP server, run
1670: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1671: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1672: <pre class="screen">
1673: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1674: <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>
1675: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1676: </pre>
1677: <p>Instead of URLs, you can also use local paths, for example if
1678: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1679: repository. If you want to install packages from multiple sources,
1680: you can separate them by a semicolon in
1681: <code class="varname">PKG_PATH</code>.</p>
1682: <p>After these preparations, installing a package is very
1683: easy:</p>
1684: <pre class="screen">
1685: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1686: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1687: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1688: </pre>
1.75 rillig 1689: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1690: package in question will be installed, too, assuming they are
1691: present where you install from.</p>
1.75 rillig 1692: <p>After you've installed packages, be sure to have
1.88 wiz 1693: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1694: <code class="varname">PATH</code> so you can actually start the just
1695: installed program.</p>
1.75 rillig 1696: </div>
1697: <div class="sect2" lang="en">
1698: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1699: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1700: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1701: installed from source code or from a binary package. The
1.110 hubertf 1702: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1703: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1704: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1705: name can be given with or without version number. Wildcards can
1706: also be used to deinstall a set of packages, for example
1707: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1708: so that the shell does not expand them before
1709: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1710: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1711: removes all the packages that require the package in question
1712: and then removes the package itself. For example:
1.82 rillig 1713:
1.88 wiz 1714: </p>
1.82 rillig 1715: <pre class="screen">
1.88 wiz 1716: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1717: </pre>
1.82 rillig 1718: <p>
1719:
1.88 wiz 1720: will remove jpeg and all the packages that used it; this allows
1721: upgrading the jpeg package.</p>
1.82 rillig 1722: </div>
1723: <div class="sect2" lang="en">
1724: <div class="titlepage"><div><div><h3 class="title">
1725: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1726: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1727: installed packages or binary package files.</p>
1.82 rillig 1728: </div>
1729: <div class="sect2" lang="en">
1730: <div class="titlepage"><div><div><h3 class="title">
1731: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1732: <p>
1.88 wiz 1733: The NetBSD Security-Officer and Packages Groups maintain a list of
1734: known security vulnerabilities to packages which are (or have been)
1735: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1736: 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 1737: </p>
1.82 rillig 1738: <p>
1.125 wiz 1739: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1740: this list can be downloaded
1741: automatically, and a security audit of all packages installed on a system
1742: can take place.
1743: </p>
1.82 rillig 1744: <p>
1.125 wiz 1745: There are two components to auditing. The first
1746: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1747: is for downloading
1.88 wiz 1748: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1749: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1750: installed packages are vulnerable. If a package is vulnerable, you
1751: will see output similar to the following:
1752: </p>
1.82 rillig 1753: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1754: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1755: <p>
1.125 wiz 1756: You may wish to have the
1.110 hubertf 1757: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1758: file downloaded daily so that
1759: it remains current. This may be done by adding an appropriate entry
1760: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1761: </p>
1762: <pre class="screen">
1763: # download vulnerabilities file
1764: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1765: </pre>
1766: <p>
1767: will update the vulnerability list every day at 3AM. You may wish to do
1768: this more often than once a day.
1769:
1770: In addition, you may wish to run the package audit from the daily
1771: security script. This may be accomplished by adding the following
1772: line to <code class="filename">/etc/security.local</code>:
1773: </p>
1774: <pre class="screen">
1775: /usr/sbin/pkg_admin audit
1776: </pre>
1777: <p>
1.88 wiz 1778: </p>
1.82 rillig 1779: </div>
1780: <div class="sect2" lang="en">
1781: <div class="titlepage"><div><div><h3 class="title">
1782: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1783: <p>
1.112 weinem 1784: 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 1785: <span class="command"><strong>lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
1.88 wiz 1786: argument to check if your packages are up-to-date, e.g.
1787: </p>
1788: <pre class="screen">
1789: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1790: ...
1.88 wiz 1791: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1792: </pre>
1.110 hubertf 1793: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1794: package on your system and rebuild any dependencies.
1795: </p>
1.82 rillig 1796: </div>
1797: <div class="sect2" lang="en">
1798: <div class="titlepage"><div><div><h3 class="title">
1799: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1800: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1801: administrative functions on the package system.</p>
1.82 rillig 1802: </div>
1803: <div class="sect2" lang="en">
1804: <div class="titlepage"><div><div><h3 class="title">
1805: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1806: <p>Please pay very careful attention to the warnings
1.110 hubertf 1807: 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 1808: inherent dangers of installing binary packages which you did
1809: not create yourself, and the security holes that can be
1810: introduced onto your system by indiscriminate adding of such
1811: files.</p>
1.75 rillig 1812: <p>The same warning of course applies to every package you
1.88 wiz 1813: install from source when you haven't completely read and
1814: understood the source code of the package, the compiler that
1815: is used to build the package and all the other tools that are
1816: involved.</p>
1.75 rillig 1817: </div>
1818: </div>
1819: <div class="sect1" lang="en">
1820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1821: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1822: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1823: directory now contains a set of packages, organized into
1824: categories. You can browse the online index of packages, or run
1.110 hubertf 1825: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1826: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1827: 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 1828: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1829: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1830: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1831: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1832: different <code class="varname">LOCALBASE</code> definitions on the same
1833: system (inside a chroot is an exception). </p>
1834: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1835: 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 1836: instructions how to create your own packages.</p>
1.75 rillig 1837: <div class="sect2" lang="en">
1838: <div class="titlepage"><div><div><h3 class="title">
1839: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1840: <p>To build packages from source, you need a working C
1.88 wiz 1841: compiler. On NetBSD, you need to install the
1842: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
1843: sets. If you want to build X11-related packages, the
1844: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
1845: sets are required, too.</p>
1.75 rillig 1846: </div>
1847: <div class="sect2" lang="en">
1848: <div class="titlepage"><div><div><h3 class="title">
1849: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1850: <p>The first step for building a package is downloading the
1.88 wiz 1851: distfiles (i.e. the unmodified source). If they have not yet been
1852: downloaded, pkgsrc will fetch them automatically.</p>
1853: <p>If you have all files that you need in the
1854: <code class="filename">distfiles</code> directory,
1855: you don't need to connect. If the distfiles are on CD-ROM, you can
1856: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1857: </p>
1.82 rillig 1858: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1859: <p>
1.110 hubertf 1860: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1861: <p>By default a list of distribution sites will be randomly
1862: intermixed to prevent huge load on servers which holding popular
1863: packages (for example, SourceForge.net mirrors). Thus, every
1864: time when you need to fetch yet another distfile all the mirrors
1865: will be tried in new (random) order. You can turn this feature
1866: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1867: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1868: <p>You can overwrite some of the major distribution sites to
1869: fit to sites that are close to your own. By setting one or two
1870: variables you can modify the order in which the master sites are
1871: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1872: delimited list of domain suffixes.
1873: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1874: contains a whitespace delimited list of regular expressions. It
1875: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1876: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1877: some examples. This may save some of your bandwidth and
1878: time.</p>
1.75 rillig 1879: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1880: if you want to keep the settings, by editing the
1.110 hubertf 1881: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1882: and adding the definitions there.</p>
1.82 rillig 1883: <p>
1.88 wiz 1884: If a package depends on many other packages (such as
1.93 rillig 1885: <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 1886: alternate between periods of
1887: downloading source, and compiling. To ensure you have all the source
1888: downloaded initially you can run the command:
1889: </p>
1.82 rillig 1890: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1891: <p>
1.88 wiz 1892: which will output and run a set of shell commands to fetch the
1893: necessary files into the <code class="filename">distfiles</code> directory. You can
1894: also choose to download the files manually.
1895: </p>
1.75 rillig 1896: </div>
1897: <div class="sect2" lang="en">
1898: <div class="titlepage"><div><div><h3 class="title">
1899: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1900: <p>
1.88 wiz 1901: Once the software has downloaded, any patches will be applied, then it
1902: will be compiled for you. This may take some time depending on your
1903: computer, and how many other packages the software depends on and their
1904: compile time.
1905: </p>
1.75 rillig 1906: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1907: <h3 class="title">Note</h3>
1908: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1909: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88 wiz 1910: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 1911: </div>
1.87 wiz 1912: <p>For example, type</p>
1.88 wiz 1913: <pre class="screen">
1914: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1915: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1916: </pre>
1.75 rillig 1917: <p>at the shell prompt to build the various components of the
1.88 wiz 1918: package.</p>
1.82 rillig 1919: <p>The next stage is to actually install the newly compiled
1.88 wiz 1920: program onto your system. Do this by entering:
1.82 rillig 1921:
1.88 wiz 1922: </p>
1.82 rillig 1923: <pre class="screen">
1.88 wiz 1924: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1925: </pre>
1.82 rillig 1926: <p>
1927:
1.88 wiz 1928: while you are still in the directory for whatever package you
1929: are installing.</p>
1.82 rillig 1930: <p>Installing the package on your system may require you to
1.88 wiz 1931: be root. However, pkgsrc has a
1932: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1933: to only become root for the actual installation step.</p>
1.82 rillig 1934: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1935: You can now enter:
1.82 rillig 1936:
1.88 wiz 1937: </p>
1.82 rillig 1938: <pre class="screen">
1.88 wiz 1939: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1940: </pre>
1.82 rillig 1941: <p>
1942:
1.88 wiz 1943: to remove the compiled files in the work directory, as you shouldn't need
1944: them any more. If other packages were also added to your system
1945: (dependencies) to allow your program to compile, you can tidy these up
1946: also with the command:</p>
1.82 rillig 1947: <pre class="screen">
1.88 wiz 1948: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1949: </pre>
1.75 rillig 1950: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 1951: 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 1952: <p>The program is installed under the default root of the
1953: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1954: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1955: variable in your environment, and it will use that value as the
1956: root of your packages tree. So, to use
1957: <code class="filename">/usr/local</code>, set
1958: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1959: Please note that you should use a directory which is dedicated to
1960: packages and not shared with other programs (i.e., do not try and
1961: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1962: to add any of your own files or directories (such as
1963: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1964: <code class="filename">pkgsrc/</code>) below the
1965: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1966: conflicts between programs and other files installed by the
1967: package system and whatever else may have been installed
1968: there.</p>
1.110 hubertf 1969: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1970: alter some configuration options at build time. Have a look at
1971: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1972: of what will be set there by default. Environment variables such
1973: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1974: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1975: set them each time you want to use pkgsrc.</p>
1976: <p>Occasionally, people want to “<span class="quote">look under the
1977: covers</span>” to see what is going on when a package is building
1978: or being installed. This may be for debugging purposes, or out of
1979: simple curiosity. A number of utility values have been added to
1980: help with this.</p>
1.75 rillig 1981: <div class="orderedlist"><ol type="1">
1982: <li>
1.110 hubertf 1983: <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 1984: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1985: information will be displayed. For example,</p>
1.75 rillig 1986: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1987: <p>will show all the commands that are invoked, up to and
1988: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 1989: </li>
1990: <li>
1.110 hubertf 1991: <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 1992: definition, then the <code class="varname">VARNAME</code> definition
1993: should be used, in conjunction with the show-var
1.110 hubertf 1994: 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 1995: variable <code class="varname">LOCALBASE</code>:</p>
1996: <pre class="screen">
1997: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1998: /usr/pkg
1999: <code class="prompt">%</code>
1.88 wiz 2000: </pre>
1.75 rillig 2001: </li>
2002: </ol></div>
2003: <p>If you want to install a binary package that you've either
1.88 wiz 2004: created yourself (see next section), that you put into
2005: pkgsrc/packages manually or that is located on a remote FTP
2006: server, you can use the "bin-install" target. This target will
1.110 hubertf 2007: 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>,
2008: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2009: sites searched is kept in the variable
2010: <code class="varname">BINPKG_SITES</code>, which defaults to
1.110 hubertf 2011: 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 2012: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2013: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2014: details.</p>
2015: <p>A final word of warning: If you set up a system that has a
2016: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2017: set that before any packages are installed, as you cannot use
2018: several directories for the same purpose. Doing so will result in
2019: pkgsrc not being able to properly detect your installed packages,
2020: and fail miserably. Note also that precompiled binary packages are
2021: usually built with the default <code class="varname">LOCALBASE</code> of
2022: <code class="filename">/usr/pkg</code>, and that you should
2023: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2024: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2025: </div>
2026: </div>
2027: </div>
2028: <div class="chapter" lang="en">
2029: <div class="titlepage"><div><div><h2 class="title">
2030: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2031: <div class="toc">
2032: <p><b>Table of Contents</b></p>
2033: <dl>
2034: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2035: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2036: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2037: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2038: <dd><dl>
1.103 wiz 2039: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.123 snj 2040: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
2041: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88 wiz 2042: </dl></dd>
1.103 wiz 2043: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2044: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2045: </dl>
2046: </div>
1.104 rillig 2047: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2048: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2049: that file depends on the installation. On NetBSD, when you use
1.110 hubertf 2050: <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 2051: <code class="filename">/etc/</code>. In all other cases the default location is
2052: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2053: bootstrap program to install the binary packages.</p>
2054: <p>During the bootstrap, an example configuration file is created. To
2055: use that, you have to create the directory
2056: <code class="filename">${PREFIX}/etc</code> and copy the example file
2057: there.</p>
2058: <p>The format of the configuration file is that of the usual
2059: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2060: is done by setting variables in this file. Note that you can define all
2061: kinds of variables, and no special error checking (for example for
2062: spelling mistakes) takes place, so you have to try it out to see if it
2063: works.</p>
1.75 rillig 2064: <div class="sect1" lang="en">
2065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2066: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2067: <p>In this section, you can find some variables that apply to all
1.89 rillig 2068: pkgsrc packages. A complete list of the variables that can be
2069: configured by the user is available in
2070: <code class="filename">mk/defaults/mk.conf</code>, together with some
2071: comments that describe each variable's intent.</p>
1.75 rillig 2072: <div class="itemizedlist"><ul type="disc">
2073: <li><p><code class="varname">LOCALBASE</code>: Where
2074: packages will be installed. The default is
1.76 rillig 2075: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2076: with different <code class="varname">LOCALBASE</code>s!</p></li>
2077: <li><p><code class="varname">CROSSBASE</code>: Where
2078: “<span class="quote">cross</span>” category packages will be
2079: installed. The default is
1.76 rillig 2080: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2081: <li><p><code class="varname">X11BASE</code>: Where
2082: X11 is installed on the system. The default is
1.76 rillig 2083: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2084: <li><p><code class="varname">DISTDIR</code>: Where to store the
2085: downloaded copies of the original source distributions used
2086: for building pkgsrc packages. The default is
1.76 rillig 2087: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97 rillig 2088: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2089: database about installed packages is stored. The default is
2090: <code class="filename">/var/db/pkg</code>.</p></li>
1.75 rillig 2091: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2092: If set, override the packages'
2093: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2094: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2095: Backup location(s) for distribution files and patch files
2096: if not found locally or in
1.76 rillig 2097: <code class="filename">${MASTER_SITES}</code> or
2098: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2099: The defaults are
1.76 rillig 2100: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2101: and
1.76 rillig 2102: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2103: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2104: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2105: <em class="replaceable"><code>arch</code></em> are replaced with OS
2106: release (“<span class="quote">2.0</span>”, etc.) and architecture
2107: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2108: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2109: List of acceptable licenses. License names are case-sensitive.
2110: Whenever you try to build a package whose license is not in this
2111: list, you will get an error message. If the license condition is
2112: simple enough, the error message will include specific
2113: instructions on how to change this variable.</p></li>
1.75 rillig 2114: </ul></div>
2115: </div>
2116: <div class="sect1" lang="en">
2117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2118: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2119: <p>XXX
2120: </p>
2121: <div class="itemizedlist"><ul type="disc">
2122: <li><p><code class="varname">PACKAGES</code>: The top level
2123: directory for the binary packages. The default is
1.76 rillig 2124: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2125: <li><p><code class="varname">WRKOBJDIR</code>:
2126: The top level directory where, if defined, the separate
2127: working directories will get created, and symbolically
1.76 rillig 2128: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2129: This is useful for building packages on several
1.76 rillig 2130: architectures, then <code class="filename">${PKGSRCDIR}</code>
2131: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2132: is local to every architecture. (It should be noted that
2133: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2134: — it is an internal definition which refers to the
1.75 rillig 2135: root of the pkgsrc tree. It is possible to have many
2136: pkgsrc tree instances.)</p></li>
2137: <li><p><code class="varname">LOCALPATCHES</code>:
2138: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2139: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2140: information.</p></li>
1.75 rillig 2141: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2142: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2143: BSD-style Makefile. If this is not set,
2144: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2145: <code class="filename">/dev/null</code> to avoid picking up
2146: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2147: <li><p><code class="varname">DEPENDS_TARGET</code>:
2148: By default, dependencies are only installed, and no binary
2149: package is created for them. You can set this variable to
2150: <code class="literal">package</code> to automatically create binary
2151: packages after installing dependencies.</p></li>
1.75 rillig 2152: </ul></div>
2153: </div>
2154: <div class="sect1" lang="en">
2155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2156: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103 wiz 2157: <p>A growing number of packages support installation into a
2158: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2159: to be built, before the actual filesystem is touched. DESTDIR
2160: support exists in two variations:</p>
2161: <div class="itemizedlist"><ul type="disc">
2162: <li><p>Basic DESTDIR support means that the package
2163: installation and packaging is still run as
2164: root.</p></li>
2165: <li><p>Full DESTDIR support can run the complete build,
2166: installation and packaging as normal user. Root privileges are
2167: only needed to add packages.</p></li>
2168: </ul></div>
1.123 snj 2169: <p>To use the DESTDIR support, set
2170: <code class="varname">USE_DESTDIR=yes</code> to get the full support for packages
2171: that support it and with fallback to basic support. </p>
1.103 wiz 2172: <p>DESTDIR support changes the behaviour of various targets
2173: slightly. To install a package after building it, use
2174: <code class="literal">package-install</code>. <code class="literal">package</code> and
2175: <code class="literal">install</code> don't do that any
2176: longer. <code class="literal">package-install</code> can be used as
2177: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2178: will ask for the root password to install the package and fail,
2179: <code class="literal">package-install</code> will ask again.</p>
2180: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2181: clean</code></strong> needs to be run as root.</p>
1.118 imil 2182: <p>Considering the <code class="filename">foo/bar</code> package,
2183: DESTDIR full support can be tested using the following commands
2184:
2185: </p>
2186: <pre class="programlisting">
2187: <code class="prompt">$</code> id
2188: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2189: <code class="prompt">$</code> mkdir $HOME/packages
2190: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2191: </pre>
2192: <p>
2193:
2194: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2195: should be needed
2196:
2197: </p>
2198: <pre class="programlisting">
1.123 snj 2199: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.118 imil 2200: </pre>
2201: <p>
2202:
2203: Create a package without root privileges
2204:
2205: </p>
2206: <pre class="programlisting">
1.123 snj 2207: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.118 imil 2208: </pre>
2209: <p>
2210:
2211: For the following command, you must be able to gain root
2212: privileges using <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>
2213:
2214: </p>
2215: <pre class="programlisting">
1.123 snj 2216: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.118 imil 2217: </pre>
2218: <p>
2219:
2220: Then, as a simple user
2221:
2222: </p>
2223: <pre class="programlisting">
2224: <code class="prompt">$</code> make clean
2225: </pre>
2226: <p>
2227:
2228: </p>
1.103 wiz 2229: </div>
2230: <div class="sect1" lang="en">
2231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2232: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78 rillig 2233: <div class="sect2" lang="en">
2234: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2235: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2236: <p>By default, pkgsrc will use GCC to build packages. This may be
2237: overridden by setting the following variables in /etc/mk.conf:</p>
2238: <div class="variablelist"><dl>
2239: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2240: <dd>
2241: <p>This is a list of values specifying the chain of
2242: compilers to invoke when building packages. Valid values
2243: are:</p>
2244: <div class="itemizedlist"><ul type="disc">
2245: <li><p><code class="varname">distcc</code>:
2246: distributed C/C++ (chainable)</p></li>
2247: <li><p><code class="varname">ccache</code>:
2248: compiler cache (chainable)</p></li>
2249: <li><p><code class="varname">gcc</code>:
2250: GNU C/C++ Compiler</p></li>
2251: <li><p><code class="varname">mipspro</code>:
2252: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2253: <li><p><code class="varname">mipspro</code>:
2254: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2255: <li><p><code class="varname">sunpro</code>:
2256: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2257: </ul></div>
2258: <p>The default is
2259: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2260: <code class="varname">ccache</code> and/or
2261: <code class="varname">distcc</code> with an appropriate
2262: <code class="varname">PKGSRC_COMPILER</code> setting,
2263: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2264: variable should always be terminated with a value for
2265: a real compiler. Note that only one real compiler
2266: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2267: is not allowed).</p>
1.89 rillig 2268: </dd>
2269: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2270: <dd><p>This specifies the minimum version of GCC to use
2271: when building packages. If the system GCC doesn't
2272: satisfy this requirement, then pkgsrc will build and
2273: install one of the GCC packages to use instead.</p></dd>
2274: </dl></div>
2275: </div>
2276: <div class="sect2" lang="en">
2277: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2278: <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 2279: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2280: please make sure to use the <code class="literal">+=</code> operator
2281: instead of the <code class="literal">=</code> operator:</p>
2282: <pre class="programlisting">
1.100 rillig 2283: CFLAGS+= -your -flags
1.78 rillig 2284: </pre>
2285: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.117 jnemeth 2286: “<span class="quote">+</span>”) may lead to problems with packages that
2287: need to add their own flags. You may want to take a look
2288: 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>
2289: package if you're interested in optimization for the current
2290: CPU. Setting <code class="varname">USE_CPUFLAGS</code> to yes in
2291: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use cpuflags.</p>
1.78 rillig 2292: </div>
1.88 wiz 2293: <div class="sect2" lang="en">
2294: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2295: <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 2296: <p>If you want to pass flags to the linker, both in the configure
2297: step and the build step, you can do this in two ways. Either set
2298: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2299: between the two is that <code class="varname">LIBS</code> will be appended to
2300: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2301: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2302: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2303: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2304: <code class="varname">CFLAGS</code>, if you do not wish to override these
2305: settings, use the <code class="literal">+=</code> operator:</p>
2306: <pre class="programlisting">
1.100 rillig 2307: LDFLAGS+= -your -linkerflags
1.88 wiz 2308: </pre>
2309: </div>
1.78 rillig 2310: </div>
2311: <div class="sect1" lang="en">
2312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2313: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2314: <p>XXX
2315: </p>
2316: <div class="itemizedlist"><ul type="disc">
2317: <li>
2318: <p><code class="varname">PKG_DEVELOPER</code>:
2319: Run some sanity checks that package developers want:
2320: </p>
2321: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2322: <li><p>make sure patches apply with zero
2323: fuzz</p></li>
2324: <li><p>run check-shlibs to see that all
2325: binaries will find their shared libs.</p></li>
1.75 rillig 2326: </ul></div>
2327: <p>
1.87 wiz 2328: </p>
1.75 rillig 2329: </li>
1.88 wiz 2330: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2331: of debugging output which is displayed whilst making and
2332: installing the package. The default value for this is 0,
2333: which will not display the commands as they are executed
2334: (normal, default, quiet operation); the value 1 will display
2335: all shell commands before their invocation, and the value 2
2336: will display both the shell commands before their invocation,
1.110 hubertf 2337: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2338: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2339: </ul></div>
2340: <p>
2341: </p>
2342: </div>
2343: <div class="sect1" lang="en">
2344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2345: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2346: <p>Some packages have build time options, usually to select
2347: between different dependencies, enable optional support for big
2348: dependencies or enable experimental features.</p>
1.75 rillig 2349: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2350: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2351: show-options</strong></span>, for example:</p>
1.75 rillig 2352: <pre class="programlisting">
2353: The following options are supported by this package:
2354: ssl Enable SSL support.
2355: Exactly one of the following gecko options is required:
2356: firefox Use firefox as gecko rendering engine.
2357: mozilla Use mozilla as gecko rendering engine.
2358: At most one of the following database options may be selected:
2359: mysql Enable support for MySQL database.
2360: pgsql Enable support for PostgreSQL database.
1.1 grant 2361:
1.75 rillig 2362: These options are enabled by default: firefox
2363: These options are currently enabled: mozilla ssl
1.1 grant 2364: </pre>
1.75 rillig 2365: <p>The following variables can be defined in
1.110 hubertf 2366: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2367: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2368: which can be used to select or disable options for all packages
2369: that support them, and
2370: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2371: which can be used to select or disable options specifically for
2372: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2373: these variables are selected, options preceded by “<span class="quote">-</span>”
2374: are disabled. A few examples:</p>
1.75 rillig 2375: <pre class="screen">
1.110 hubertf 2376: <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 2377: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2378: PKG_OPTIONS.kdebase= debug -sasl
2379: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2380: <p>It is important to note that options that were specifically
1.120 snj 2381: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2382: you do not wish to include the option. If you are unsure you can view
2383: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2384: <p>The following settings are consulted in the order given, and
2385: the last setting that selects or disables an option is
2386: used:</p>
1.75 rillig 2387: <div class="orderedlist"><ol type="1">
2388: <li><p>the default options as suggested by the package
1.88 wiz 2389: maintainer</p></li>
1.75 rillig 2390: <li><p>the options implied by the settings of legacy
1.88 wiz 2391: variables (see below)</p></li>
1.75 rillig 2392: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2393: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2394: </ol></div>
2395: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2396: selected is used, all others are automatically disabled. If an
2397: option of the group is explicitly disabled, the previously
2398: selected option, if any, is used. It is an error if no option
2399: from a required group of options is selected, and building the
2400: package will fail.</p>
2401: <p>Before the options framework was introduced, build options
2402: were selected by setting a variable (often named
2403: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2404: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2405: transition to the options framework for the user, these legacy
2406: variables are converted to the appropriate options setting
2407: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2408: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2409: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2410: directly. Support for the legacy variables will be removed
2411: eventually.</p>
1.75 rillig 2412: </div>
2413: </div>
2414: <div class="chapter" lang="en">
2415: <div class="titlepage"><div><div><h2 class="title">
2416: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2417: <div class="toc">
2418: <p><b>Table of Contents</b></p>
2419: <dl>
2420: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2421: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2422: </dl>
2423: </div>
2424: <div class="sect1" lang="en">
2425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2426: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2427: <p>Once you have built and installed a package, you can create
2428: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110 hubertf 2429: 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 2430: the same package on a group of hosts and wasting CPU time. It also
2431: provides a simple means for others to install your package, should
2432: you distribute it.</p>
2433: <p>To create a binary package, change into the appropriate
1.110 hubertf 2434: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2435: package</strong></span>:</p>
2436: <pre class="screen">
2437: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2438: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2439: </pre>
2440: <p>This will build and install your package (if not already done),
2441: and then build a binary package from what was installed. You can
1.110 hubertf 2442: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2443: it. Binary packages are created by default in
2444: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2445: 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 2446: 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 2447: <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 2448: such a binary package.</p>
1.75 rillig 2449: </div>
2450: <div class="sect1" lang="en">
2451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2452: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2453: <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 2454: </div>
2455: </div>
2456: <div class="chapter" lang="en">
2457: <div class="titlepage"><div><div><h2 class="title">
2458: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2459: builds)</h2></div></div></div>
2460: <div class="toc">
2461: <p><b>Table of Contents</b></p>
2462: <dl>
2463: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2464: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2465: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2466: <dd><dl>
2467: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2468: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2469: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2470: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2471: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2472: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2473: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2474: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2475: </dl></dd>
2476: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 2477: <dd><dl>
2478: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2479: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2480: </dl></dd>
1.106 rillig 2481: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2482: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2483: </dl>
2484: </div>
2485: <p>When you have multiple machines that should run the same packages,
2486: it is wasted time if they all build their packages themselves from
2487: source. There are two ways of getting a set of binary packages: The old
2488: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2489: system. This chapter describes how to set them up so that the packages
2490: are most likely to be usable later.</p>
2491: <div class="sect1" lang="en">
2492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2493: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2494: <p>Since a bulk build takes several days or even weeks to finish, you
2495: should think about the setup before you start everything. Pay attention
2496: to at least the following points:</p>
2497: <div class="itemizedlist"><ul type="disc">
2498: <li>
2499: <p>If you want to upload the binary packages to
2500: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2501: packages:</p>
2502: <div class="itemizedlist"><ul type="circle">
2503: <li><p>To end up on ftp.NetBSD.org, the packages must be built
2504: by a NetBSD developer on a trusted machine (that is, where you and only
2505: you have root access).</p></li>
2506: <li><p>Packages on ftp.NetBSD.org should only be created from
1.124 snj 2507: the stable branches (like 2009Q1), so that users browsing the available
1.106 rillig 2508: collections can see at a glance how old the packages
2509: are.</p></li>
2510: <li><p>The packages must be built as root, since some packages
2511: require set-uid binaries at runtime, and creating those packages as
2512: unprivileged user doesn't work well at the moment.</p></li>
2513: </ul></div>
2514: </li>
2515: <li><p>Make sure that the bulk build cannot break anything in
2516: your system. Most bulk builds run as root, so they should be run at least
2517: in a chroot environment or something even more restrictive, depending on
2518: what the operating system provides. There have been numerous cases where
2519: certain packages tried to install files outside the
2520: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2521: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2522: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2523: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2524: that you don't need any package during the build.</p></li>
2525: </ul></div>
2526: </div>
2527: <div class="sect1" lang="en">
2528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2529: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2530: <p>A complete bulk build requires lots of disk space. Some of the
2531: disk space can be read-only, some other must be writable. Some can be on
2532: remote filesystems (such as NFS) and some should be local. Some can be
2533: temporary filesystems, others must survive a sudden reboot.</p>
2534: <div class="itemizedlist"><ul type="disc">
2535: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2536: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2537: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2538: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2539: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2540: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2541: </ul></div>
1.75 rillig 2542: </div>
2543: <div class="sect1" lang="en">
2544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2545: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.116 rillig 2546: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2547: <h3 class="title">Note</h3>
2548: <p>There are two ways of doing a bulk build. The old-style
2549: one and the new-style “<span class="quote">pbulk</span>”. The latter is the recommended
2550: way.</p>
1.106 rillig 2551: </div>
1.75 rillig 2552: <div class="sect2" lang="en">
2553: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2554: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75 rillig 2555: <div class="sect3" lang="en">
2556: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2557: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93 rillig 2558: </h4></div></div></div>
1.76 rillig 2559: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2560: configuration file for bulk builds. You can configure how your
2561: copy of pkgsrc is kept up to date, how the distfiles are
2562: downloaded, how the packages are built and how the report is
2563: generated. You can find an annotated example file in
2564: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2565: it, copy <code class="filename">build.conf-example</code> to
2566: <code class="filename">build.conf</code> and edit it, following the
2567: comments in that file.</p>
1.75 rillig 2568: </div>
2569: <div class="sect3" lang="en">
2570: <div class="titlepage"><div><div><h4 class="title">
1.110 hubertf 2571: <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 2572: </h4></div></div></div>
1.110 hubertf 2573: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2574: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2575: details of the default settings. You will want to ensure that
2576: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.125 wiz 2577: As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.104 rillig 2578: completely bypasses the license check.</p>
1.87 wiz 2579: <pre class="programlisting">
1.100 rillig 2580: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2581: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2582: BSDSRCDIR= /usr/src
2583: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2584: OBJHOSTNAME?= yes # use work.`hostname`
2585: FAILOVER_FETCH= yes # insist on the correct checksum
2586: PKG_DEVELOPER?= yes
1.125 wiz 2587: SKIP_LICENSE_CHECK= yes
1.100 rillig 2588: </pre>
1.75 rillig 2589: <p>Some options that are especially useful for bulk builds
2590: can be found at the top lines of the file
1.76 rillig 2591: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2592: options of these are briefly described here.</p>
2593: <div class="itemizedlist"><ul type="disc">
2594: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2595: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2596: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2597: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2598: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2599: to the directory where all log files are created. Otherwise the
2600: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2601: <li><p>Another important variable is
1.87 wiz 2602: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2603: should be always available while building other
2604: packages.</p></li>
1.75 rillig 2605: </ul></div>
2606: <p>Some other options are scattered in the pkgsrc
2607: infrastructure:</p>
2608: <div class="itemizedlist"><ul type="disc">
2609: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2610: should be set to <code class="literal">yes</code>. The purpose of the bulk
2611: builds is creating binary packages, no matter if they are
1.127 ! spz 2612: vulnerable or not. Leaving this variable unset would prevent the bulk
1.87 wiz 2613: build system from even trying to build them, so possible
2614: building errors would not show up.</p></li>
1.75 rillig 2615: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2616: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2617: “<span class="quote">yes</span>” to check that the installed set of files
2618: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2619: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2620: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2621: “<span class="quote">yes</span>” to check that the installed
2622: “<span class="quote">#!</span>”-scripts will find their
2623: interpreter.</p></li>
1.91 rillig 2624: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2625: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2626: package's self-test before installing it. Note that some
2627: packages make heavy use of “<span class="quote">good</span>” random
2628: numbers, so you need to assure that the machine on which you
2629: are doing the bulk builds is not completely idle. Otherwise
2630: some test programs will seem to hang, while they are just
2631: waiting for new random data to be
2632: available.</p></li>
1.75 rillig 2633: </ul></div>
2634: </div>
2635: <div class="sect3" lang="en">
2636: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2637: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93 rillig 2638: </h4></div></div></div>
1.75 rillig 2639: <p>It is possible to configure the bulk build to perform
1.87 wiz 2640: certain site-specific tasks at the end of the pre-build
2641: stage. If the file
2642: <code class="filename">pre-build.local</code> exists in
2643: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110 hubertf 2644: (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 2645: stage. An example use of
2646: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2647: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2648: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2649: <p>to prevent the system from trying to build a particular package
1.87 wiz 2650: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2651: </div>
2652: </div>
2653: <div class="sect2" lang="en">
2654: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2655: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2656: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2657: deleted at the start of bulk builds, make sure your login
2658: shell is placed somewhere else. Either drop it into
2659: <code class="filename">/usr/local/bin</code> (and adjust your login
2660: shell in the passwd file), or (re-)install it via
1.110 hubertf 2661: <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 2662: you can login after a reboot (remember that your current
2663: process won't die if the package is removed, you just can't
2664: start any new instances of the shell any more). Also, if you
2665: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2666: version of ssh for some reason, be sure to install ssh before
2667: starting it from <code class="filename">rc.local</code>:</p>
2668: <pre class="programlisting">
1.100 rillig 2669: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2670: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2671: /usr/pkg/etc/rc.d/sshd
2672: fi
2673: </pre>
1.75 rillig 2674: <p>Not doing so will result in you being not able to log in
1.87 wiz 2675: via ssh after the bulk build is finished or if the machine
2676: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2677: </div>
2678: <div class="sect2" lang="en">
2679: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2680: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75 rillig 2681: <p>Make sure you don't need any of the packages still
1.87 wiz 2682: installed.</p>
1.75 rillig 2683: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2684: <h3 class="title">Warning</h3>
1.99 rillig 2685: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2686: configuration files and some more files from
2687: <code class="filename">/var</code>, <code class="filename">/home</code> and
2688: possibly other locations will be removed! So don't run a bulk
2689: build with privileges that might harm your
2690: system.</em></span></p>
1.75 rillig 2691: </div>
2692: <p>Be sure to remove all other things that might
1.87 wiz 2693: interfere with builds, like some libs installed in
2694: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2695: <pre class="screen">
2696: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2697: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2698: </pre>
1.75 rillig 2699: <p>If for some reason your last build didn't complete (power
1.87 wiz 2700: failure, system panic, ...), you can continue it by
2701: running:</p>
1.75 rillig 2702: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2703: <p>At the end of the bulk build, you will get a summary via mail,
2704: and find build logs in the directory specified by
2705: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2706: file.</p>
1.75 rillig 2707: </div>
2708: <div class="sect2" lang="en">
2709: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2710: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75 rillig 2711: <p>The bulk builds consist of three steps:</p>
2712: <div class="variablelist"><dl>
2713: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2714: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2715: cleans out any broken distfiles, and removes all
2716: packages installed.</p></dd>
1.75 rillig 2717: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2718: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2719: an optimised order in which packages will be
2720: built. Packages that don't require other packages will
2721: be built first, and packages with many dependencies will
2722: be built later.</p></dd>
1.75 rillig 2723: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2724: <dd><p>Generates a report that's placed in the directory
2725: specified in the <code class="filename">build.conf</code> file
2726: named <code class="filename">broken.html</code>, a short version
2727: of that report will also be mailed to the build's
2728: admin.</p></dd>
1.75 rillig 2729: </dl></div>
1.87 wiz 2730: <p>During the build, a list of broken packages will be compiled
2731: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2732: <code class="filename">.../.broken.${MACHINE}</code> if
2733: <code class="varname">OBJMACHINE</code> is set), individual build logs
2734: of broken builds can be found in the package's
2735: directory. These files are used by the bulk-targets to mark
2736: broken builds to not waste time trying to rebuild them, and
2737: they can be used to debug these broken package builds
2738: later.</p>
1.75 rillig 2739: </div>
2740: <div class="sect2" lang="en">
2741: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2742: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75 rillig 2743: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2744: NetBSD 2.0/i386:</p>
1.75 rillig 2745: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2746: <li><p>10 GB - distfiles (NFS ok)</p></li>
2747: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2748: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2749: </ul></div>
2750: <p>Note that all pkgs will be de-installed as soon as they are
2751: turned into a binary package, and that sources are removed,
2752: so there is no excessively huge demand to disk
2753: space. Afterwards, if the package is needed again, it will
1.110 hubertf 2754: 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 2755: there are no cycles wasted by recompiling.</p>
1.75 rillig 2756: </div>
2757: <div class="sect2" lang="en">
2758: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2759: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2760: <p>If you don't want all the packages nuked from a machine
2761: (rendering it useless for anything but pkg compiling), there
2762: is the possibility of doing the package bulk build inside a
2763: chroot environment.</p>
2764: <p>The first step is to set up a chroot sandbox,
2765: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2766: using null mounts, or manually.</p>
2767: <p>There is a shell script called
2768: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2769: up the sandbox environment using null mounts. It will also
2770: create a script called <code class="filename">sandbox</code> in the
2771: root of the sandbox environment, which will allow the null
1.110 hubertf 2772: mounts to be activated using the <span class="command"><strong>sandbox
1.87 wiz 2773: mount</strong></span> command and deactivated using the
1.110 hubertf 2774: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87 wiz 2775: <p>To set up a sandbox environment by hand, after extracting all
1.110 hubertf 2776: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87 wiz 2777: distribution DESTDIR=/usr/sandbox</strong></span> in
2778: <code class="filename">/usr/src/etc</code>, be sure the following items
2779: are present and properly configured:</p>
1.75 rillig 2780: <div class="procedure"><ol type="1">
2781: <li>
2782: <p>Kernel</p>
2783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2784: </li>
2785: <li>
1.76 rillig 2786: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2787: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2788: </li>
2789: <li>
1.91 rillig 2790: <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 2791: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2792: </li>
2793: <li>
2794: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2795: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2796: </li>
2797: <li>
1.91 rillig 2798: <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 2799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2800: </li>
2801: <li>
1.76 rillig 2802: <p><code class="filename">/usr/src</code> (system sources,
1.126 jakllsch 2803: 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 2804: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2805: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2806: </li>
2807: <li>
1.76 rillig 2808: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2809: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2810: </li>
2811: <li>
1.76 rillig 2812: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2813: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2814: </li>
2815: <li>
2816: <p>Checkout pkgsrc via cvs into
1.87 wiz 2817: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2818: <pre class="screen">
2819: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2820: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2821: </pre>
1.75 rillig 2822: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2823: you do development in, as this will likely cause problems!</p>
1.75 rillig 2824: </li>
2825: <li><p>Make
1.87 wiz 2826: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2827: <code class="filename">.../distfiles</code> point somewhere
2828: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.123 snj 2829: <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 2830: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2831: </ol></div>
2832: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2833: the build with the following steps:</p>
2834: <pre class="screen">
2835: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2836: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2837: </pre>
2838: <p>This will just jump inside the sandbox and start building. At
2839: the end of the build, mail will be sent with the results of
2840: the build. Created binary pkgs will be in
2841: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2842: (wherever that points/mounts to/from).</p>
1.75 rillig 2843: </div>
2844: <div class="sect2" lang="en">
2845: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2846: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2847: <p>In addition to building a complete set of all packages in
2848: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2849: may be used to build a subset of the packages contained in
2850: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.110 hubertf 2851: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75 rillig 2852: <div class="itemizedlist"><ul type="disc">
2853: <li><p>SITE_SPECIFIC_PKGS</p></li>
2854: <li><p>HOST_SPECIFIC_PKGS</p></li>
2855: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2856: <li><p>USER_SPECIFIC_PKGS</p></li>
2857: </ul></div>
1.87 wiz 2858: <p>will define the set of packages which should be built.
2859: The bulk build code will also include any packages which are
2860: needed as dependencies for the explicitly listed packages.</p>
2861: <p>One use of this is to do a bulk build with
2862: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2863: periodically to have a complete set of the binary packages
2864: needed for your site available without the overhead of
2865: building extra packages that are not needed.</p>
1.75 rillig 2866: </div>
2867: <div class="sect2" lang="en">
2868: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2869: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2870: <p>This section describes how pkgsrc developers can upload binary
2871: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2872: <p>If you would like to automatically create checksum files for the
2873: binary packages you intend to upload, remember to set
2874: <code class="varname">MKSUMS=yes</code> in your
2875: <code class="filename">mk/bulk/build.conf</code>.</p>
2876: <p>If you would like to PGP sign the checksum files (highly
2877: recommended!), remember to set
2878: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2879: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2880: your GPG password to sign the files before uploading everything.</p>
2881: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2882: set properly in your <code class="filename">mk/bulk/build.conf</code>
2883: file, i.e. adjust it to something like one of the following:</p>
1.126 jakllsch 2884: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload </pre>
2885: <p>Please use appropriate values for "packages-20xxQy",
1.87 wiz 2886: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2887: is different from your local login, write your login directly
2888: into the variable, e.g. my local account is "feyrer", but for my
2889: login "hubertf", I use:</p>
1.126 jakllsch 2890: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2891: <p>A separate <code class="filename">upload</code> directory is used
2892: here to allow "closing" the directory during upload. To do
2893: so, run the following command on ftp.NetBSD.org next:</p>
1.126 jakllsch 2894: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87 wiz 2895: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2896: only appropriate for packages for the NetBSD operating
2897: system. Binary packages for other operating systems should go
2898: into <code class="filename">/pub/pkgsrc</code>.</p>
2899: <p>Before uploading the binary pkgs, ssh authentication needs
2900: to be set up. This example shows how to set up temporary keys
2901: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2902: (assuming that no keys should be present there usually):</p>
2903: <pre class="screen">
2904: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2905: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2906: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 2907: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2908: </pre>
2909: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2910: append it to your <code class="filename">~/.ssh/authorized_keys</code>
2911: file on ftp.NetBSD.org. You can remove the key after the
2912: upload is done!</p>
2913: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 2914: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 2915: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2916: <p>Now after all this works, you can exit the sandbox and start
2917: the upload:</p>
2918: <pre class="screen">
2919: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 2920: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 2921: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2922: </pre>
1.110 hubertf 2923: <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
2924: <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 2925: upload. The upload script will take care of not uploading
1.127 ! spz 2926: restricted packages.</p>
1.75 rillig 2927: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 2928: Gdd:x! </pre>
2929: <p>Use whatever is needed to remove the key you've entered
2930: before! Last, move the uploaded packages out of the
2931: <code class="filename">upload</code> directory to have them accessible
2932: to everyone:</p>
2933: <pre class="screen">
1.126 jakllsch 2934: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 2935: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2936: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 2937: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
2938: </pre>
1.75 rillig 2939: </div>
2940: </div>
2941: <div class="sect1" lang="en">
2942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2943: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2944: <p>Running a pbulk-style bulk build works roughly as follows:</p>
2945: <div class="itemizedlist"><ul type="disc">
2946: <li><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2947: <li><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
2948: </ul></div>
2949: <div class="sect2" lang="en">
2950: <div class="titlepage"><div><div><h3 class="title">
2951: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117 jnemeth 2952: <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 2953: <pre class="screen">
2954: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2955: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2956: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2957: </pre>
2958: <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>
2959: <div class="itemizedlist"><ul type="disc">
2960: <li><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2961: <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>
2962: <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>
2963: <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>
1.125 wiz 2964: <li><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.116 rillig 2965: </ul></div>
2966: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2967: <pre class="screen">
2968: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2969: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2970: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2971: </pre>
2972: <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>
2973: </div>
1.106 rillig 2974: <div class="sect2" lang="en">
2975: <div class="titlepage"><div><div><h3 class="title">
1.116 rillig 2976: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114 jmcneill 2977: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116 rillig 2978: <p>TODO: continue writing</p>
1.106 rillig 2979: </div>
2980: </div>
2981: <div class="sect1" lang="en">
2982: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2983: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2984: <p>After your pkgsrc bulk-build has completed, you may wish to
2985: create a CD-ROM set of the resulting binary packages to assist
2986: in installing packages on other machines. The
1.91 rillig 2987: <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 2988: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2989: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2990: way that keeps all the dependencies for a given package on the same
2991: CD as that package.</p>
1.75 rillig 2992: <div class="sect2" lang="en">
2993: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2994: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2995: <p>Complete documentation for cdpack is found in the cdpack(1)
2996: man page. The following short example assumes that the binary
2997: packages are left in
2998: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2999: sufficient disk space exists in <code class="filename">/u2</code> to
3000: hold the ISO 9660 images.</p>
3001: <pre class="screen">
3002: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3003: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3004: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3005: </pre>
3006: <p>If you wish to include a common set of files
3007: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3008: etc.) on each CD in the collection, then you need to create a
3009: directory which contains these files. e.g.</p>
3010: <pre class="screen">
3011: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3012: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3013: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3014: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3015: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3016: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3017: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3018: </pre>
1.75 rillig 3019: <p>Now create the images:</p>
3020: <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 3021: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3022: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3023: in their root directories.</p>
1.75 rillig 3024: </div>
3025: </div>
3026: </div>
3027: <div class="chapter" lang="en">
3028: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3029: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 3030: <div class="toc">
3031: <p><b>Table of Contents</b></p>
3032: <dl>
1.123 snj 3033: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
3034: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.90 rillig 3035: </dl>
3036: </div>
3037: <p>The files that are installed by pkgsrc are organized in a way that
3038: is similar to what you find in the <code class="filename">/usr</code> directory
3039: of the base system. But some details are different. This is because
3040: pkgsrc initially came from FreeBSD and had adopted its file system
3041: hierarchy. Later it was largely influenced by NetBSD. But no matter
3042: which operating system you are using pkgsrc with, you can expect the
3043: same layout for pkgsrc.</p>
1.91 rillig 3044: <p>There are mainly four root directories for pkgsrc, which are all
3045: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3046: When pkgsrc has been installed as root, the default locations
3047: are:</p>
3048: <pre class="programlisting">
1.100 rillig 3049: LOCALBASE= /usr/pkg
3050: PKG_SYSCONFBASE= /usr/pkg/etc
3051: VARBASE= /var
3052: PKG_DBDIR= /var/db/pkg
1.91 rillig 3053: </pre>
3054: <p>In unprivileged mode (when pkgsrc has been installed as any other
3055: user), the default locations are:</p>
3056: <pre class="programlisting">
1.100 rillig 3057: LOCALBASE= ${HOME}/pkg
3058: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3059: VARBASE= ${HOME}/pkg/var
3060: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3061: </pre>
3062: <p>What these four directories are for, and what they look like is
3063: explained below.</p>
1.90 rillig 3064: <div class="itemizedlist"><ul type="disc">
3065: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3066: <code class="filename">/usr</code> directory in the base system. It is the
3067: “<span class="quote">main</span>” directory where the files are installed and contains
3068: the well-known subdirectories like <code class="filename">bin</code>,
3069: <code class="filename">include</code>, <code class="filename">lib</code>,
3070: <code class="filename">share</code> and
3071: <code class="filename">sbin</code>.</p></li>
3072: <li><p><code class="varname">VARBASE</code> corresponds to
3073: <code class="filename">/var</code> in the base system. Some programs (especially
3074: games, network daemons) need write access to it during normal
3075: operation.</p></li>
3076: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3077: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 3078: 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 3079: itself.</p></li>
3080: </ul></div>
3081: <div class="sect1" lang="en">
3082: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3083: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 3084: </h2></div></div></div>
1.90 rillig 3085: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3086: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3087: <div class="variablelist"><dl>
3088: <dt><span class="term"><code class="filename">bin</code></span></dt>
3089: <dd><p>Contains executable programs that are intended to be
3090: directly used by the end user.</p></dd>
3091: <dt><span class="term"><code class="filename">emul</code></span></dt>
3092: <dd><p>Contains files for the emulation layers of various other
3093: operating systems, especially for
3094: NetBSD.</p></dd>
3095: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3096: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3097: <dd><p>Contains
3098: the configuration files.</p></dd>
3099: <dt><span class="term"><code class="filename">include</code></span></dt>
3100: <dd><p>Contains headers for the C and C++ programming
3101: languages.</p></dd>
3102: <dt><span class="term"><code class="filename">info</code></span></dt>
3103: <dd><p>Contains GNU info files of various
3104: packages.</p></dd>
3105: <dt><span class="term"><code class="filename">lib</code></span></dt>
3106: <dd><p>Contains shared and static
3107: libraries.</p></dd>
3108: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3109: <dd><p>Contains data files that don't change after
3110: installation. Other data files belong into
3111: <code class="filename">${VARBASE}</code>.</p></dd>
3112: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3113: <dd><p>Contains programs that are not intended to be used by
3114: end users, such as helper programs or network
3115: daemons.</p></dd>
3116: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3117: <dd><p>Contains programs that are intended to be executed as
3118: CGI scripts by a web server.</p></dd>
3119: <dt><span class="term"><code class="filename">man</code> (the usual value of
3120: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3121: <dd><p>Contains brief
3122: documentation in form of manual pages.</p></dd>
3123: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3124: <dd><p>Contains programs that are intended to be used only by
3125: the super-user.</p></dd>
3126: <dt><span class="term"><code class="filename">share</code></span></dt>
3127: <dd><p>Contains platform-independent data files that don't
3128: change after installation.</p></dd>
3129: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3130: <dd><p>Contains documentation files provided by the
3131: packages.</p></dd>
3132: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3133: <dd><p>Contains example files provided by the packages. Among
3134: others, the original configuration files are saved here and copied to
3135: <code class="filename">${PKG_SYSCONFDIR}</code> during
3136: installation.</p></dd>
3137: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3138: <dd><p>Contains the original files for rc.d
3139: scripts.</p></dd>
3140: <dt><span class="term"><code class="filename">var</code> (the usual location of
3141: <code class="filename">${VARBASE}</code>)</span></dt>
3142: <dd><p>Contains files
3143: that may be modified after
3144: installation.</p></dd>
3145: </dl></div>
3146: </div>
3147: <div class="sect1" lang="en">
3148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3149: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 3150: </h2></div></div></div>
1.90 rillig 3151: <div class="variablelist"><dl>
3152: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3153: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3154: <dd><p>Contains
3155: information about the currently installed
3156: packages.</p></dd>
3157: <dt><span class="term"><code class="filename">games</code></span></dt>
3158: <dd><p>Contains highscore
3159: files.</p></dd>
3160: <dt><span class="term"><code class="filename">log</code></span></dt>
3161: <dd><p>Contains log files.</p></dd>
3162: <dt><span class="term"><code class="filename">run</code></span></dt>
3163: <dd><p>Contains informational files about daemons that are
3164: currently running.</p></dd>
3165: </dl></div>
3166: </div>
3167: </div>
3168: <div class="chapter" lang="en">
3169: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3170: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3171: <div class="toc">
3172: <p><b>Table of Contents</b></p>
3173: <dl>
1.106 rillig 3174: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3175: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3176: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3177: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3178: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3179: <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>
3180: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.123 snj 3181: <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 3182: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.123 snj 3183: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
3184: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
3185: <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 3186: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3187: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3188: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.123 snj 3189: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106 rillig 3190: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.123 snj 3191: <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 3192: </dl>
3193: </div>
3194: <p>This section contains hints, tips & tricks on special things in
3195: pkgsrc that we didn't find a better place for in the previous chapters, and
3196: it contains items for both pkgsrc users and developers.</p>
3197: <div class="sect1" lang="en">
3198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3199: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3200: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3201: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 3202: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 3203: This is a general purpose list for most issues regarding
3204: pkgsrc, regardless of platform, e.g. soliciting user help
3205: for pkgsrc configuration, unexpected build failures, using
3206: particular packages, upgrading pkgsrc installations,
3207: questions regarding the pkgsrc release branches, etc. General announcements or
3208: proposals for changes that impact the pkgsrc user community,
3209: e.g. major infrastructure changes, new features, package
3210: removals, etc., may also be posted.</p></li>
1.110 hubertf 3211: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 3212: A list where the results of pkgsrc bulk builds are sent and
3213: discussed.</p></li>
1.110 hubertf 3214: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 3215: This list is for those who are interested in getting a
3216: commit message for every change committed to pkgsrc. It is
3217: also available in digest form, meaning one daily message
3218: containing all commit messages for changes to the package
3219: source tree in that 24 hour period.</p></li>
3220: </ul></div>
3221: <p>To subscribe, do:</p>
3222: <pre class="programlisting">
1.100 rillig 3223: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3224: </pre>
3225: <p>Archives for all these mailing lists are available from
1.110 hubertf 3226: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 3227: </div>
3228: <div class="sect1" lang="en">
3229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3230: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3231: <p>Pkgviews is tightly integrated with buildlink. You can find a
3232: pkgviews User's guide in
1.76 rillig 3233: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3234: </div>
3235: <div class="sect1" lang="en">
3236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3237: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3238: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3239: a number of useful utilities for both users and developers of pkgsrc. This
3240: section attempts only to make the reader aware of the utilities and when
3241: they might be useful, and not to duplicate the documentation that comes
3242: with each package.</p>
3243: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3244: <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 3245: Symlinks for use by buildlink.</p></li></ul></div>
3246: <p>OS tool augmentation (automatically installed when needed):</p>
3247: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3248: <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 3249: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3250: <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 3251: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3252: <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 3253: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3254: <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 3255: Up-to-date replacement for
1.76 rillig 3256: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3257: systems where pkg_install is not present.</p></li>
3258: </ul></div>
3259: <p>Utilities used by pkgsrc (not automatically installed):</p>
3260: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3261: <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 3262: Create a binary package from an
1.110 hubertf 3263: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 3264: save the old package.</p></li>
1.91 rillig 3265: <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 3266: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3267: from multiple locations. It currently supports the following
3268: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3269: <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 3270: packages someplace else (enabled by default).</p></li>
1.117 jnemeth 3271: <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
3272: the best compiler flags to optimise code for your current
3273: CPU and compiler. Setting <code class="varname">USE_CPUFLAGS</code> to
3274: yes in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use
3275: cpuflags. </p></li>
1.75 rillig 3276: </ul></div>
3277: <p>Utilities for keeping track of installed packages, being up to date,
3278: etc:</p>
3279: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3280: <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 3281: packages whose installed versions do not match the latest pkgsrc
3282: entries.</p></li>
1.91 rillig 3283: <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 3284: dependency graphs of packages, to aid in choosing a strategy for
3285: updating.</p></li>
1.91 rillig 3286: <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
3287: 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>
3288: <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 3289: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
3290: <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 3291: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3292: <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 3293: packages you have installed.</p></li>
3294: </ul></div>
3295: <p>Utilities for people maintaining or creating individual packages:</p>
3296: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3297: <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 3298: making and maintaining patches for a package (includes pkgdiff,
3299: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3300: <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>,
3301: <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 3302: converting to pkgsrc.</p></li>
1.91 rillig 3303: <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 3304: pkgsrc to a Solaris package.</p></li>
3305: </ul></div>
3306: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3307: utilities)</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/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75 rillig 3310: packages in a chrooted area.</p></li>
1.91 rillig 3311: <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 3312: kernel version for chrooted cross builds.</p></li>
3313: </ul></div>
3314: </div>
3315: <div class="sect1" lang="en">
3316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3317: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3318: <p>If you want to use pkgsrc as non-root user, you can set some
3319: variables to make pkgsrc work under these conditions. At the very least,
3320: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3321: will turn on unprivileged mode and set multiple related variables to allow
3322: installation of packages as non-root.</p>
3323: <p>In case the defaults are not enough, you may want to tune some other
3324: variables used. For example, if the automatic user/group detection leads
3325: to incorrect values (or not the ones you would like to use), you can change
3326: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3327: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3328: <p>As regards bootstrapping, please note that the
1.110 hubertf 3329: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75 rillig 3330: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3331: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3332: installation targets. These directories can be overridden by the
1.75 rillig 3333: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3334: that allow finer tuning of the tree layout.</p>
3335: </div>
3336: <div class="sect1" lang="en">
3337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3338: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3339: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3340: enable this feature by adding the option
3341: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3342: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3343: distfile is found, pkgsrc will try to resume it.</p>
3344: <p>You can also
1.110 hubertf 3345: 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 3346: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3347: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3348: by using the value manual. A value of custom disables the system defaults
3349: and dependency tracking for the fetch program. In that case you have to
3350: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3351: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3352: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3353: <p>For example, if you want to use
1.117 jnemeth 3354: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3355: like:</p>
3356: <pre class="programlisting">
1.117 jnemeth 3357: FETCH_USING= wget
1.1 grant 3358: </pre>
1.75 rillig 3359: </div>
3360: <div class="sect1" lang="en">
3361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3362: <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 3363: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3364: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3365: you will have to add the following line into
1.110 hubertf 3366: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3367: <pre class="programlisting">
1.103 wiz 3368: X11_TYPE=modular
1.1 grant 3369: </pre>
1.75 rillig 3370: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3371: <h3 class="title">Note</h3>
1.103 wiz 3372: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3373: </p>
1.75 rillig 3374: </div>
3375: </div>
3376: <div class="sect1" lang="en">
3377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3378: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3379: <p>If you are sitting behind a firewall which does not allow direct
3380: connections to Internet hosts (i.e. non-NAT), you may specify the
3381: relevant proxy hosts. This is done using an environment variable in the
3382: form of a URL, e.g. in Amdahl, the machine
3383: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3384: port 80 as the proxy port number. So the proxy environment variables
3385: are:</p>
3386: <pre class="programlisting">
1.100 rillig 3387: ftp_proxy=ftp://orpheus.amdahl.com:80/
3388: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3389: </pre>
1.75 rillig 3390: </div>
3391: <div class="sect1" lang="en">
3392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 3393: <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 3394: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3395: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3396: the first available command from the following list:</p>
3397: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3398: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3399: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3400: </ul></div>
3401: <p>On a default NetBSD installation, this will be
1.76 rillig 3402: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3403: connections first, and falls back to active connections if the server
3404: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3405: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3406: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3407: <p>Having that option present will prevent
1.76 rillig 3408: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3409: transfers.</p>
3410: </div>
3411: <div class="sect1" lang="en">
3412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3413: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3414: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3415: from work or university, where you can't run a <span class="command"><strong>make
3416: 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 3417: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3418: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3419: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3420: resulting list to your machine at work/school and use it there. If you
1.110 hubertf 3421: 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 3422: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3423: URL:</p>
3424: <p>At home:</p>
3425: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3426: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3427: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3428: <p>At work:</p>
3429: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3430: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3431: home.</p>
3432: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3433: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3434: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3435: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3436: directly by running:</p>
1.75 rillig 3437: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3438: <p>If you even decide to ignore
3439: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3440: by running:</p>
3441: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3442: </div>
3443: <div class="sect1" lang="en">
3444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3445: <a name="tmac.andoc-missing"></a>9.10. What does “<span class="quote">Don't know how to make
1.75 rillig 3446: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3447: <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 3448: package, you get the error from make that it doesn't know how to make
1.76 rillig 3449: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3450: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3451: the NetBSD base distribution on your machine. It is recommended to do
3452: that to format man pages.</p>
1.91 rillig 3453: <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 3454: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3455: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3456: </div>
3457: <div class="sect1" lang="en">
3458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3459: <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 3460: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3461: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3462: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3463: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3464: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3465: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3466: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3467: -r</strong></span>).</p>
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="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3472: <p>When installing packages as non-root user and using the just-in-time
1.110 hubertf 3473: <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 3474: password for each required package installed. To avoid this, the sudo
3475: package can be used, which does password caching over a limited time. To
3476: use it, install sudo (either as binary package or from
1.98 wiz 3477: <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 3478: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3479: <span class="emphasis"><em>after</em></span> the definition of the
3480: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3481: <pre class="programlisting">
1.100 rillig 3482: .if exists(${LOCALBASE}/bin/sudo)
3483: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3484: .endif
1.1 grant 3485: </pre>
1.75 rillig 3486: </div>
3487: <div class="sect1" lang="en">
3488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3489: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3490: <p>As the system administrator, you can choose where configuration files
3491: are installed. The default settings make all these files go into
1.76 rillig 3492: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3493: be suboptimal depending on your expectations (e.g., a read-only,
3494: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3495: configuration of the provided packages).</p>
3496: <p>In order to change the defaults, you can modify the
3497: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3498: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3499: directory; some common examples include <code class="filename">/etc</code> or
3500: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3501: <p>Furthermore, you can change this value on a per-package basis by
3502: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3503: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3504: package you would like to modify, that is, the contents of
3505: <code class="varname">PKGBASE</code>.</p>
3506: <p>Note that after changing these settings, you must rebuild and
3507: reinstall any affected packages.</p>
3508: </div>
3509: <div class="sect1" lang="en">
3510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3511: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3512: <p>Please be aware that there can often be bugs in third-party software,
3513: and some of these bugs can leave a machine vulnerable to exploitation by
3514: attackers. In an effort to lessen the exposure, the NetBSD packages team
3515: maintains a database of known-exploits to packages which have at one time
3516: been included in pkgsrc. The database can be downloaded automatically, and
3517: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3518: do this, refer to the following two tools (installed as part of the
3519: <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 3520: <div class="orderedlist"><ol type="1">
3521: <li>
1.122 reed 3522: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3523: download a list of the security vulnerabilities information. This list
3524: is kept up to date by the NetBSD security officer and the NetBSD
3525: packages team, and is distributed from the NetBSD ftp server:</p>
1.110 hubertf 3526: <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 3527: </li>
1.122 reed 3528: <li><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
1.75 rillig 3529: current machine, checking each vulnerability which is known. If a
3530: vulnerable package is installed, it will be shown by output to stdout,
3531: including a description of the type of vulnerability, and a URL
3532: containing more information.</p></li>
3533: </ol></div>
1.114 jmcneill 3534: <p>Use of these tools is strongly recommended! After
3535: “<span class="quote">pkg_install</span>” is installed, please read
1.75 rillig 3536: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3537: pkg_install</code></strong>.</p>
1.87 wiz 3538: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3539: 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 3540: check.</p>
1.75 rillig 3541: </div>
3542: <div class="sect1" lang="en">
3543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3544: <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 3545: <p>When you add your own preferences to the
3546: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3547: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3548: environment variables to the <code class="filename">./configure</code>
1.110 hubertf 3549: 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 3550: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3551: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3552: package.</p>
3553: <p>Currently there is no solution to this problem. If you
3554: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3555: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3556: directory and then inspect any <code class="filename">Makefile</code> and
3557: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3558: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3559: these lines. But be aware that some “<span class="quote">smart</span>”
3560: programmers write so bad code that it only works for the
3561: specific combination of <code class="varname">CFLAGS</code> they have
3562: chosen.</p>
3563: </div>
1.80 rillig 3564: <div class="sect1" lang="en">
3565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3566: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3567: <div class="procedure"><ol type="1">
3568: <li><p>Make sure that your copy of pkgsrc is consistent. A
3569: case that occurs often is that people only update pkgsrc in
3570: parts, because of performance reasons. Since pkgsrc is one large
3571: system, not a collection of many small systems, there are
3572: sometimes changes that only work when the whole pkgsrc tree is
3573: updated.</p></li>
3574: <li><p>Make sure that you don't have any CVS conflicts.
3575: Search for “<span class="quote"><<<<<<</span>” or
3576: “<span class="quote">>>>>>></span>” in all your pkgsrc
3577: files.</p></li>
3578: <li><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3579: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3580: verify this.</p></li>
3581: <li><p>If the problem still exists, write a mail to the
3582: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3583: </ol></div>
3584: </div>
1.88 wiz 3585: <div class="sect1" lang="en">
3586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3587: <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 3588: <p>You have modified a file from pkgsrc, and someone else has
3589: modified that same file afterwards in the CVS repository. Both changes
3590: are in the same region of the file, so when you updated pkgsrc, the
3591: <code class="literal">cvs</code> command marked the conflicting changes in the
3592: file. Because of these markers, the file is no longer a valid
3593: <code class="filename">Makefile</code>.</p>
3594: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3595: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3596: -dP</strong></span> in that directory to download the current version.</p>
3597: </div>
1.75 rillig 3598: </div>
3599: </div>
3600: <div class="part" lang="en">
3601: <div class="titlepage"><div><div><h1 class="title">
3602: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3603: <div class="partintro" lang="en">
3604: <div></div>
3605: <p>This part of the book deals with creating and
3606: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3607: guide on creating a new package. The remaining chapters are more
3608: like a reference manual for pkgsrc.</p>
1.75 rillig 3609: <div class="toc">
3610: <p><b>Table of Contents</b></p>
3611: <dl>
1.106 rillig 3612: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3613: <dd><dl>
1.106 rillig 3614: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3615: <dd><dl>
1.106 rillig 3616: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3617: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3618: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3619: </dl></dd>
1.106 rillig 3620: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3621: <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>
3622: </dl></dd>
3623: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3624: <dd><dl>
1.123 snj 3625: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
3626: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106 rillig 3627: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3628: <dd><dl>
3629: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3630: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3631: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3632: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3633: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3634: </dl></dd>
3635: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3636: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3637: <dd><dl>
3638: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3639: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3640: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3641: </dl></dd>
1.123 snj 3642: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
3643: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106 rillig 3644: </dl></dd>
1.123 snj 3645: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106 rillig 3646: <dd><dl>
3647: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.123 snj 3648: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106 rillig 3649: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3650: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3651: <dd><dl>
3652: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3653: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3654: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3655: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3656: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3657: </dl></dd>
3658: </dl></dd>
3659: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3660: <dd><dl>
3661: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.123 snj 3662: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
3663: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106 rillig 3664: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3665: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.123 snj 3666: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106 rillig 3667: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3668: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3669: </dl></dd>
3670: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3671: <dd><dl>
3672: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.123 snj 3673: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106 rillig 3674: <dd><dl>
3675: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.123 snj 3676: <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 3677: </dl></dd>
1.123 snj 3678: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106 rillig 3679: <dd><dl>
1.123 snj 3680: <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 3681: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3682: </dl></dd>
3683: </dl></dd>
3684: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3685: <dd><dl>
3686: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3687: <dd><dl>
3688: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3689: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3690: </dl></dd>
3691: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3692: <dd><dl>
1.123 snj 3693: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106 rillig 3694: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3695: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3696: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3697: </dl></dd>
3698: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3699: <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>
3700: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3701: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3702: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3703: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3704: <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>
3705: </dl></dd>
3706: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3707: <dd><dl>
3708: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.123 snj 3709: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106 rillig 3710: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3711: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3712: </dl></dd>
3713: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3714: <dd><dl>
3715: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3716: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3717: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3718: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.123 snj 3719: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106 rillig 3720: <dd><dl>
3721: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3722: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3723: </dl></dd>
1.123 snj 3724: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
3725: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
3726: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
3727: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
3728: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
3729: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
3730: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
3731: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
3732: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
3733: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106 rillig 3734: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3735: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3736: </dl></dd>
3737: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3738: <dd><dl>
3739: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3740: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3741: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3742: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3743: </dl></dd>
3744: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3745: <dd><dl>
3746: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3747: <dd><dl>
3748: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.123 snj 3749: <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 3750: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3751: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3752: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3753: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3754: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3755: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3756: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3757: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3758: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3759: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3760: </dl></dd>
1.123 snj 3761: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106 rillig 3762: <dd><dl>
3763: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3764: <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>
3765: </dl></dd>
1.123 snj 3766: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106 rillig 3767: <dd><dl>
3768: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3769: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3770: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3771: </dl></dd>
3772: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3773: <dd><dl>
3774: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3775: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3776: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3777: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3778: </dl></dd>
1.123 snj 3779: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106 rillig 3780: <dd><dl>
3781: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3782: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.123 snj 3783: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106 rillig 3784: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3785: </dl></dd>
1.123 snj 3786: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106 rillig 3787: <dd><dl>
3788: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3789: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3790: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3791: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3792: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3793: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3794: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3795: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3796: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3797: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3798: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3799: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3800: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3801: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3802: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3803: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3804: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3805: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3806: emulation</a></span></dt>
1.106 rillig 3807: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3808: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3809: </dl></dd>
1.106 rillig 3810: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3811: </dl></dd>
1.106 rillig 3812: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3813: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3814: <dd><dl>
1.106 rillig 3815: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3816: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3817: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3818: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3819: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3820: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3821: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3822: </dl></dd>
3823: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3824: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3825: <dd><dl>
3826: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3827: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3828: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3829: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3830: </dl></dd>
1.75 rillig 3831: </dl>
3832: </div>
1.77 rillig 3833: </div>
3834: <div class="chapter" lang="en">
3835: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3836: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3837: <div class="toc">
3838: <p><b>Table of Contents</b></p>
3839: <dl>
1.106 rillig 3840: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3841: <dd><dl>
1.106 rillig 3842: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3843: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3844: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3845: </dl></dd>
1.106 rillig 3846: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3847: <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 3848: </dl>
3849: </div>
1.77 rillig 3850: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3851: most likely have a URL from where you can download the source
3852: code. Starting with this URL, creating a package involves only a
3853: few steps.</p>
1.77 rillig 3854: <div class="procedure"><ol type="1">
1.91 rillig 3855: <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 3856: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3857: category in which you want to place your package. You can also create a
3858: directory of your own (maybe called <code class="filename">local</code>). In that
3859: category directory, create another directory for your package and change
3860: into it.</p></li>
1.110 hubertf 3861: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3862: you for a URL. Enter the URL of the distribution file (in most cases a
3863: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3864: of your package are created automatically. The distribution file is
3865: extracted automatically to fill in some details in the
3866: <code class="filename">Makefile</code> that would otherwise have to be done
3867: manually.</p></li>
3868: <li>
3869: <p>Examine the extracted files to determine the dependencies of
3870: your package. Ideally, this is mentioned in some
3871: <code class="filename">README</code> file, but things may differ. For each of
3872: these dependencies, look where it exists in pkgsrc, and if there is a
3873: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3874: line to your package <code class="filename">Makefile</code> which includes that
3875: file just before the last line. If the
3876: <code class="filename">buildlink3.mk</code> file does not exist, add a
3877: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3878: version of the dependency and where it can be found in pkgsrc. This line
3879: should be placed in the third paragraph. If the dependency is only
3880: needed for building the package, but not when using it, use
3881: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3882: Your package may then look like this:</p>
1.77 rillig 3883: <pre class="programlisting">
1.100 rillig 3884: [...]
1.77 rillig 3885:
1.100 rillig 3886: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3887: DEPENDS+= screen-[0-9]*:../../misc/screen
3888: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3889:
1.100 rillig 3890: [...]
1.77 rillig 3891:
1.100 rillig 3892: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3893: .include "../../devel/glib2/buildlink3.mk"
3894: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3895: </pre>
3896: </li>
1.110 hubertf 3897: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91 rillig 3898: to be done to make your package a “<span class="quote">good</span>” one. If you don't
1.110 hubertf 3899: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3900: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3901: -e</strong></span>, which outputs additional
3902: explanations.</p></li>
3903: <li><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3904: 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 3905: over there, you can hopefully continue here.</p></li>
1.110 hubertf 3906: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3907: directory from the extracted files. Besides these files, a lot of cache
3908: files and other system information has been saved in the working
3909: directory, which may become wrong after you edited the
3910: <code class="filename">Makefile</code>.</p></li>
1.110 hubertf 3911: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
3912: 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 3913: <li><p>When the package builds fine, the next step is to install
1.110 hubertf 3914: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3915: everything works.</p></li>
3916: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3917: contains a list of the files that are installed by the package, is
1.110 hubertf 3918: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3919: >PLIST</strong></span> to generate a probably correct list. Check
3920: the file using your preferred text editor to see if the list of
3921: files looks plausible.</p></li>
1.110 hubertf 3922: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3923: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110 hubertf 3924: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3925: has been registered in the database of installed files, but with an
1.110 hubertf 3926: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3927: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3928: registered with the list of files from
3929: <code class="filename">PLIST</code>.</p></li>
1.110 hubertf 3930: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3931: package from the set of installed files.</p></li>
1.77 rillig 3932: </ol></div>
1.91 rillig 3933: <div class="sect1" lang="en">
3934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3935: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91 rillig 3936: <div class="sect2" lang="en">
3937: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3938: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3939: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3940: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3941: </div>
3942: <div class="sect2" lang="en">
3943: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3944: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91 rillig 3945: <p>KDE applications should always include
3946: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3947: settings that are typical of KDE packages.</p>
3948: </div>
1.118 imil 3949: <div class="sect2" lang="en">
3950: <div class="titlepage"><div><div><h3 class="title">
3951: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3952: <p>Python modules and programs packages are easily created using a
3953: set of predefined variables.</p>
3954: <p>Most Python packages use either “<span class="quote">distutils</span>” or
3955: easy-setup (“<span class="quote">eggs</span>”).
3956: If the software uses “<span class="quote">distutils</span>”, set the
3957: <code class="varname">PYDISTUTILSPKG</code> variable to “<span class="quote">yes</span>” so
3958: pkgsrc will make use of this framework.
3959: “<span class="quote">distutils</span>” uses a script called <code class="filename">setup.py</code>,
3960: if the “<span class="quote">distutils</span>” driver is not called
3961: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3962: to the name of the script.</p>
3963: <p>
3964: If the default Python versions are not supported by the software, set the
3965: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
3966: the software is known to work with, from the most recent to the older
3967: one, e.g.
3968: </p>
3969: <pre class="programlisting">
1.126 jakllsch 3970: PYTHON_VERSIONS_ACCEPTED= 25 24
1.118 imil 3971: </pre>
3972: <p>
3973: If the packaged software is a Python module, include
3974: “<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”.
3975: In this case, the package directory should be called
3976: “<span class="quote">py-software</span>” and <code class="varname">PKGNAME</code> should be set to
3977: “<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”, e.g.
3978: </p>
3979: <pre class="programlisting">
3980: DISTNAME= foopymodule-1.2.10
3981: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3982: </pre>
3983: <p>If it is an application, also include
3984: “<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”
3985: before “<span class="quote">extension.mk</span>”.</p>
3986: <p>If the packaged software, either it is an application or a module, is
3987: egg-aware, you only need to include
3988: “<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”.</p>
3989: <p>In order to correctly set the path to the Python interpreter, use the
3990: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
3991: that must be corrected. For example :
3992: </p>
3993: <pre class="programlisting">
3994: REPLACE_PYTHON= ${WRKSRC}/*.py
3995: </pre>
3996: </div>
1.91 rillig 3997: </div>
3998: <div class="sect1" lang="en">
3999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4000: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91 rillig 4001: <div class="sect2" lang="en">
4002: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4003: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91 rillig 4004: <div class="sect3" lang="en">
4005: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4006: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 4007: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4008: that the “<span class="quote">nvu</span>” package has not yet been imported into
4009: pkgsrc. As the description says it has to do with the web, the obvious
4010: choice for the category is “<span class="quote">www</span>”.</p>
4011: <pre class="programlisting">
1.100 rillig 4012: <code class="prompt">$</code> mkdir www/nvu
4013: <code class="prompt">$</code> cd www/nvu
1.91 rillig 4014: </pre>
4015: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 4016: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 4017: <pre class="programlisting">
1.100 rillig 4018: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4019: </pre>
4020: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4021: below the <code class="varname">DISTNAME</code> line, as the package name should
4022: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4023: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4024: <code class="varname">COMMENT</code> fields. Then the package
4025: <code class="filename">Makefile</code> looked like that:</p>
4026: <pre class="programlisting">
1.100 rillig 4027: # $NetBSD$
4028: #
1.91 rillig 4029:
1.100 rillig 4030: DISTNAME= nvu-1.0-sources
4031: PKGNAME= nvu-1.0
4032: CATEGORIES= www
4033: MASTER_SITES= http://cvs.nvu.com/download/
4034: EXTRACT_SUFX= .tar.bz2
4035:
4036: MAINTAINER= rillig@NetBSD.org
4037: HOMEPAGE= http://cvs.nvu.com/
4038: COMMENT= Web Authoring System
1.91 rillig 4039:
1.100 rillig 4040: # url2pkg-marker (please do not remove this line.)
4041: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4042: </pre>
4043: <p>Then, I quit the editor and watched pkgsrc downloading a large
4044: source archive:</p>
4045: <pre class="programlisting">
1.100 rillig 4046: url2pkg> Running "make makesum" ...
4047: => Required installed package digest>=20010302: digest-20060826 found
4048: => Fetching nvu-1.0-sources.tar.bz2
4049: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4050: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4051: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4052: url2pkg> Running "make extract" ...
4053: => Required installed package digest>=20010302: digest-20060826 found
4054: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4055: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4056: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4057: ===> Installing dependencies for nvu-1.0
4058: ===> Overriding tools for nvu-1.0
4059: ===> Extracting for nvu-1.0
4060: url2pkg> Adjusting the Makefile.
1.91 rillig 4061:
1.100 rillig 4062: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4063:
1.100 rillig 4064: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4065: </pre>
4066: </div>
4067: <div class="sect3" lang="en">
4068: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4069: <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 4070: <p>Now that the package has been extracted, let's see what's inside
4071: it. The package has a <code class="filename">README.txt</code>, but that only
4072: says something about mozilla, so it's probably useless for seeing what
4073: dependencies this package has. But since there is a GNU configure script
4074: in the package, let's hope that it will complain about everything it
4075: needs.</p>
4076: <pre class="programlisting">
1.100 rillig 4077: <code class="prompt">$</code> bmake
4078: => Required installed package digest>=20010302: digest-20060826 found
4079: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4080: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4081: ===> Patching for nvu-1.0
4082: ===> Creating toolchain wrappers for nvu-1.0
4083: ===> Configuring for nvu-1.0
4084: [...]
4085: configure: error: Perl 5.004 or higher is required.
4086: [...]
4087: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4088: [...]
1.91 rillig 4089: </pre>
4090: <p>That worked quite well. So I opened the package Makefile in my
4091: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4092: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4093: package have changed now, and since a perl wrapper is automatically
4094: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4095: from scratch.</p>
4096: <pre class="programlisting">
1.100 rillig 4097: <code class="prompt">$</code> bmake clean
4098: ===> Cleaning for nvu-1.0
4099: <code class="prompt">$</code> bmake
4100: [...]
4101: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4102: GNU Make. You will not be able to build Mozilla without GNU Make.
4103: [...]
1.91 rillig 4104: </pre>
4105: <p>So I added “<span class="quote">gmake</span>” to the
4106: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4107: <pre class="programlisting">
1.100 rillig 4108: [...]
4109: checking for GTK - version >= 1.2.0... no
4110: *** Could not run GTK test program, checking why...
4111: [...]
1.91 rillig 4112: </pre>
4113: <p>Now to the other dependencies. The first question is: Where is the
4114: GTK package hidden in pkgsrc?</p>
4115: <pre class="programlisting">
1.100 rillig 4116: <code class="prompt">$</code> echo ../../*/gtk*
4117: [many packages ...]
4118: <code class="prompt">$</code> echo ../../*/gtk
4119: ../../x11/gtk
4120: <code class="prompt">$</code> echo ../../*/gtk2
4121: ../../x11/gtk2
4122: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4123: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4124: </pre>
4125: <p>The first try was definitely too broad. The second one had exactly
4126: one result, which is very good. But there is one pitfall with GNOME
4127: packages. Before GNOME 2 had been released, there were already many
4128: GNOME 1 packages in pkgsrc. To be able to continue to use these
4129: packages, the GNOME 2 packages were imported as separate packages, and
4130: their names usually have a “<span class="quote">2</span>” appended. So I checked
4131: whether this was the case here, and indeed it was.</p>
4132: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4133: file, adding the dependency is very easy. I just inserted an
4134: <code class="literal">.include</code> line before the last line of the package
4135: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4136: <pre class="programlisting">
1.100 rillig 4137: [...]
4138: .include "../../x11/gtk2/buildlink3.mk"
4139: .include "../../mk/bsd.pkg.mk
1.91 rillig 4140: </pre>
1.110 hubertf 4141: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 4142: was:</p>
4143: <pre class="programlisting">
1.100 rillig 4144: [...]
4145: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4146: checking for GTK - version >= 1.2.0... no
4147: *** Could not run GTK test program, checking why...
4148: *** The test program failed to compile or link. See the file config.log for the
4149: *** exact error that occured. This usually means GTK was incorrectly installed
4150: *** or that you have moved GTK since it was installed. In the latter case, you
4151: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4152: configure: error: Test for GTK failed.
4153: [...]
1.91 rillig 4154: </pre>
4155: <p>In this particular case, the assumption that “<span class="quote">every package
4156: prefers GNOME 2</span>” had been wrong. The first of the lines above
4157: told me that this package really wanted to have the GNOME 1 version of
4158: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 4159: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 4160: So I changed the <code class="literal">x11/gtk2</code> to
4161: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4162: and tried again.</p>
4163: <pre class="programlisting">
1.100 rillig 4164: [...]
4165: 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
4166: In file included from xpidl.c:42:
4167: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4168: In file included from xpidl.c:42:
4169: xpidl.h:132: error: parse error before "IDL_ns"
4170: [...]
1.91 rillig 4171: </pre>
4172: <p>The package still does not find all of its dependencies. Now the
4173: question is: Which package provides the
4174: <code class="filename">libIDL/IDL.h</code> header file?</p>
4175: <pre class="programlisting">
1.100 rillig 4176: <code class="prompt">$</code> echo ../../*/*idl*
4177: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4178: <code class="prompt">$</code> echo ../../*/*IDL*
4179: ../../net/libIDL
1.91 rillig 4180: </pre>
4181: <p>Let's take the one from the second try. So I included the
4182: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4183: again. But the error didn't change. After digging through some of the
4184: code, I concluded that the build process of the package was broken and
4185: couldn't have ever worked, but since the Mozilla source tree is quite
4186: large, I didn't want to fix it. So I added the following to the package
4187: <code class="filename">Makefile</code> and tried again:</p>
4188: <pre class="programlisting">
1.100 rillig 4189: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4190: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4191: </pre>
4192: <p>The latter line is needed because the package expects the library
4193: <code class="filename">libIDL.so</code>, but only
4194: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4195: wrapper to rewrite that on the fly.</p>
4196: <p>The next problem was related to a recent change of the FreeType
4197: 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>
4198: which patch files were relevant for this issue and copied them to the
4199: <code class="filename">patches</code> directory. Then I retried, fixed the
4200: patches so that they applied cleanly and retried again. This time,
4201: everything worked.</p>
4202: </div>
4203: <div class="sect3" lang="en">
4204: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4205: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 4206: <pre class="programlisting">
1.100 rillig 4207: <code class="prompt">$</code> bmake CHECK_FILES=no install
4208: [...]
4209: <code class="prompt">$</code> bmake print-PLIST >PLIST
4210: <code class="prompt">$</code> bmake deinstall
4211: <code class="prompt">$</code> bmake install
1.91 rillig 4212: </pre>
4213: </div>
4214: </div>
4215: </div>
1.77 rillig 4216: </div>
1.75 rillig 4217: <div class="chapter" lang="en">
4218: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4219: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4220: <div class="toc">
4221: <p><b>Table of Contents</b></p>
4222: <dl>
1.123 snj 4223: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
4224: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106 rillig 4225: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4226: <dd><dl>
4227: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4228: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4229: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4230: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4231: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4232: </dl></dd>
4233: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4234: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4235: <dd><dl>
4236: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4237: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4238: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4239: </dl></dd>
1.123 snj 4240: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
4241: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.75 rillig 4242: </dl>
4243: </div>
1.87 wiz 4244: <p>Whenever you're preparing a package, there are a number of
4245: files involved which are described in the following
4246: sections.</p>
1.75 rillig 4247: <div class="sect1" lang="en">
4248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4249: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4250: </h2></div></div></div>
1.75 rillig 4251: <p>Building, installation and creation of a binary package are all
1.87 wiz 4252: controlled by the package's <code class="filename">Makefile</code>.
4253: The <code class="filename">Makefile</code> describes various things about
4254: a package, for example from where to get it, how to configure,
4255: build, and install it.</p>
1.76 rillig 4256: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4257: sections that describe the package.</p>
1.75 rillig 4258: <p>In the first section there are the following variables, which
1.87 wiz 4259: should appear exactly in the order given here. The order and
4260: grouping of the variables is mostly historical and has no further
4261: meaning.</p>
1.75 rillig 4262: <div class="itemizedlist"><ul type="disc">
4263: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4264: distribution file to be downloaded from the package's
4265: website.</p></li>
1.75 rillig 4266: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4267: package, as used by pkgsrc. You only need to provide it if
4268: <code class="varname">DISTNAME</code> (which is the default) is not a good
4269: name for the package in pkgsrc. Usually it is the pkgsrc
4270: directory name together with the version number. It must match the
4271: regular expression
4272: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4273: starts with a letter or digit, and contains only letters, digits,
4274: dashes, underscores, dots and plus signs.</p></li>
4275: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4276: the package file to create if the <code class="varname">PKGNAME</code>
4277: isn't unique on a SVR4 system. The default is
4278: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4279: <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 4280: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4281: does not produce an unique package name on a SVR4 system.
4282: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4283: characters.</p></li>
1.75 rillig 4284: <li>
4285: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4286: which the package fits in. You can choose any of the top-level
4287: directories of pkgsrc for it.</p>
1.75 rillig 4288: <p>Currently the following values are available for
1.87 wiz 4289: <code class="varname">CATEGORIES</code>. If more than
4290: one is used, they need to be separated by spaces:</p>
1.75 rillig 4291: <pre class="programlisting">
1.100 rillig 4292: archivers cross geography meta-pkgs security
4293: audio databases graphics misc shells
4294: benchmarks devel ham multimedia sysutils
4295: biology editors inputmethod net textproc
4296: cad emulators lang news time
4297: chat finance mail parallel wm
4298: comms fonts math pkgtools www
4299: converters games mbone print x11
4300: </pre>
1.75 rillig 4301: </li>
1.81 rillig 4302: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4303: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4304: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4305: and <code class="varname">DISTFILES</code> are discussed in detail in
1.123 snj 4306: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The fetch phase”</a>.</p></li>
1.75 rillig 4307: </ul></div>
4308: <p>The second section contains information about separately
1.87 wiz 4309: downloaded patches, if any.
4310: </p>
1.75 rillig 4311: <div class="itemizedlist"><ul type="disc">
4312: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4313: Name(s) of additional files that contain distribution patches.
4314: There is no default. pkgsrc will look for them at
4315: <code class="varname">PATCH_SITES</code>.
4316: They will automatically be uncompressed before patching if
4317: the names end with <code class="filename">.gz</code> or
4318: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4319: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4320: Primary location(s) for distribution patch files (see
4321: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4322: </ul></div>
4323: <p>The third section contains the following variables.
1.87 wiz 4324: </p>
1.75 rillig 4325: <div class="itemizedlist"><ul type="disc">
1.114 jmcneill 4326: <li><p><code class="varname">MAINTAINER</code> is the email
4327: address of the person who feels responsible for this package,
4328: and who is most likely to look at problems or questions regarding
4329: 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>.
4330: Other developers may contact the <code class="varname">MAINTAINER</code>
4331: before making changes to the package, but are not required to
4332: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4333: to yourself. If you really can't maintain the package for future
4334: updates, set it to
1.110 hubertf 4335: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.114 jmcneill 4336: <li><p><code class="varname">OWNER</code> should be used instead
4337: of <code class="varname">MAINTAINER</code> when you do not want other
4338: developers to update or change the package without contacting
4339: you first. A package Makefile should contain one of
4340: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4341: not both. </p></li>
1.75 rillig 4342: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4343: find more information about the package.</p></li>
1.75 rillig 4344: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4345: description of the package (should not include the package
4346: name).</p></li>
1.75 rillig 4347: </ul></div>
4348: <p>Other variables that affect the build:
1.87 wiz 4349: </p>
1.75 rillig 4350: <div class="itemizedlist"><ul type="disc"><li>
4351: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4352: interesting distribution files of the package are found. The
4353: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4354: works for most packages.</p>
1.75 rillig 4355: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4356: (most GNU software does, for instance), but extracts itself in
4357: the current directory, you should set
4358: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4359: <p>If a package doesn't create a subdirectory with the
4360: name of <code class="varname">DISTNAME</code> but some different name,
4361: set <code class="varname">WRKSRC</code> to point to the proper name in
4362: <code class="filename">${WRKDIR}</code>, for example
4363: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4364: <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 4365: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4366: taken from the <code class="varname">WRKDIR_BASENAME</code>
4367: variable. By default, its value is
4368: <code class="filename">work</code>. If you want to use the same
4369: pkgsrc tree for building different kinds of binary packages,
4370: you can change the variable according to your needs. Two
4371: other variables handle common cases of setting
4372: <code class="varname">WRKDIR_BASENAME</code> individually. If
4373: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4374: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4375: the host's name is attached to the directory name. If
4376: <code class="varname">OBJMACHINE</code> is defined, the platform name
4377: is attached, which might look like
4378: <code class="filename">work.i386</code> or
4379: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4380: </li></ul></div>
4381: <p>Please pay attention to the following gotchas:</p>
4382: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4383: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4384: installed in compressed form by the package. For packages using
4385: BSD-style makefiles which honor MANZ, there is
4386: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4387: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4388: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4389: below).</p></li>
1.110 hubertf 4390: <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 4391: </ul></div>
4392: </div>
4393: <div class="sect1" lang="en">
4394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4395: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4396: </h2></div></div></div>
1.76 rillig 4397: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4398: digest, or checksum, of each distfile needed for the package. This
4399: ensures that the distfiles retrieved from the Internet have not been
4400: corrupted during transfer or altered by a malign force to introduce
4401: a security hole. Due to recent rumor about weaknesses of digest
4402: algorithms, all distfiles are protected using both SHA1 and RMD160
4403: message digests, as well as the file size.</p>
1.76 rillig 4404: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4405: checksums for all the patches found in the
1.110 hubertf 4406: <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 4407: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4408: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4409: command.</p>
1.75 rillig 4410: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4411: 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 4412: <code class="filename">distinfo</code> file and care should be taken when
4413: upgrading such a package to ensure distfile information is not
4414: lost.</p>
1.75 rillig 4415: </div>
4416: <div class="sect1" lang="en">
4417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4418: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4419: <p>Many packages still don't work out-of-the box on the various
4420: platforms that are supported by pkgsrc. Therefore, a number of custom
4421: patch files are needed to make the package work. These patch files are
4422: found in the <code class="filename">patches/</code> directory.</p>
4423: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4424: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4425: 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 4426: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4427: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4428: <div class="sect2" lang="en">
4429: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4430: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4431: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4432: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4433: problems. (To force patches to apply with fuzz you can set
4434: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4435: should contain only changes for a single file, and no file should be
1.93 rillig 4436: patched by more than one patch file. This helps to keep future
4437: modifications simple.</p>
4438: <p>Each patch file is structured as follows: In the first line,
4439: there is the RCS Id of the patch itself. The second line should be
4440: empty for aesthetic reasons. After that, there should be a comment for
4441: each change that the patch does. There are a number of standard
4442: cases:</p>
4443: <div class="itemizedlist"><ul type="disc">
4444: <li><p>Patches that replace the <code class="literal">==</code>
1.110 hubertf 4445: 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 4446: are so common that they don't need a comment at all.</p></li>
1.93 rillig 4447: <li><p>Patches for commonly known vulnerabilities should
4448: mention the vulnerability ID (CAN, CVE).</p></li>
4449: <li><p>Patches that change source code should mention the
4450: platform and other environment (for example, the compiler) that the
4451: patch is needed for.</p></li>
4452: </ul></div>
4453: <p>In all other cases, the patch should be commented so that any
4454: developer who knows the code of the application can make some use of
4455: the patch. Special care should be taken for the upstream developers,
4456: since we generally want that they accept our patches, so we have less
4457: work in the future.</p>
4458: </div>
4459: <div class="sect2" lang="en">
4460: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4461: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4462: <p>One important thing to mention is to pay attention that no RCS
4463: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4464: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4465: <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 4466: problems.</p>
1.87 wiz 4467: <p>For even more automation, we recommend using
1.110 hubertf 4468: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4469: whole set of patches. You just have to backup files before you
4470: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4471: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4472: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4473: you upgrade a package this way, you can easily compare the new
4474: set of patches with the previously existing one with
1.110 hubertf 4475: <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87 wiz 4476: or update from the <code class="filename">work/.newpatches</code>
4477: directory to <code class="filename">patches/</code>.</p>
4478: <p>When you have finished a package, remember to generate
1.110 hubertf 4479: the checksums for the patch files by using the <span class="command"><strong>make
1.123 snj 4480: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “distinfo”</a>.</p>
1.87 wiz 4481: <p>When adding a patch that corrects a problem in the
4482: distfile (rather than e.g. enforcing pkgsrc's view of where
4483: man pages should go), send the patch as a bug report to the
4484: maintainer. This benefits non-pkgsrc users of the package,
4485: and usually makes it possible to remove the patch in future
4486: version.</p>
1.101 rillig 4487: <p>The file names of the patch files are usually of the form
4488: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4489: </div>
4490: <div class="sect2" lang="en">
4491: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4492: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4493: <p>If you want to share patches between multiple packages
4494: in pkgsrc, e.g. because they use the same distfiles, set
4495: <code class="varname">PATCHDIR</code> to the path where the patch files
4496: can be found, e.g.:</p>
4497: <pre class="programlisting">
1.100 rillig 4498: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4499: </pre>
1.75 rillig 4500: <p>Patch files that are distributed by the author or other
1.87 wiz 4501: maintainers can be listed in
4502: <code class="varname">PATCHFILES</code>.</p>
4503: <p>If it is desired to store any patches that should not be
4504: committed into pkgsrc, they can be kept outside the pkgsrc
4505: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4506: directory tree there is expected to have the same
4507: “<span class="quote">category/package</span>” structure as pkgsrc, and
4508: patches are expected to be stored inside these dirs (also
4509: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4510: example, if you want to keep a private patch for
4511: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4512: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4513: files in the named directory are expected to be patch files,
4514: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4515: applied</em></span>.</p>
1.93 rillig 4516: </div>
1.85 jmmv 4517: <div class="sect2" lang="en">
4518: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4519: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4520: <p>When fixing a portability issue in the code do not use
4521: preprocessor magic to check for the current operating system nor
4522: platform. Doing so hurts portability to other platforms because
4523: the OS-specific details are not abstracted appropriately.</p>
4524: <p>The general rule to follow is: instead of checking for the
4525: operating system the application is being built on, check for the
4526: specific <span class="emphasis"><em>features</em></span> you need. For example,
4527: instead of assuming that kqueue is available under NetBSD and
4528: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4529: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4530: yes, this generally involves patching the
1.110 hubertf 4531: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4532: that prevents some OSes from adopting interfaces from other OSes
4533: (e.g. Linux implementing kqueue), something that the above checks
4534: cannot take into account.</p>
4535: <p>Of course, checking for features generally involves more
4536: work on the developer's side, but the resulting changes are
1.87 wiz 4537: cleaner and there are chances they will work on many other
1.85 jmmv 4538: platforms. Not to mention that there are higher chances of being
4539: later integrated into the mainstream sources. Remember:
4540: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4541: <p>Some typical examples:</p>
4542: <div class="table">
1.106 rillig 4543: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4544: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4545: <colgroup>
4546: <col>
4547: <col>
4548: <col>
4549: </colgroup>
4550: <thead><tr>
4551: <th>Where</th>
4552: <th>Incorrect</th>
4553: <th>Correct</th>
4554: </tr></thead>
4555: <tbody>
4556: <tr>
4557: <td>configure script</td>
4558: <td>
1.100 rillig 4559: <pre class="programlisting">
4560: case ${target_os} in
4561: netbsd*) have_kvm=yes ;;
4562: *) have_kvm=no ;;
4563: esac
4564: </pre>
1.85 jmmv 4565: </td>
4566: <td>
1.100 rillig 4567: <pre class="programlisting">
4568: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4569: </pre>
1.85 jmmv 4570: </td>
4571: </tr>
4572: <tr>
4573: <td>C source file</td>
4574: <td>
1.100 rillig 4575: <pre class="programlisting">
4576: #if defined(__NetBSD__)
4577: # include <sys/event.h>
4578: #endif
4579: </pre>
1.85 jmmv 4580: </td>
4581: <td>
1.100 rillig 4582: <pre class="programlisting">
4583: #if defined(HAVE_SYS_EVENT_H)
4584: # include <sys/event.h>
4585: #endif
4586: </pre>
1.85 jmmv 4587: </td>
4588: </tr>
4589: <tr>
4590: <td>C source file</td>
4591: <td>
1.100 rillig 4592: <pre class="programlisting">
4593: int
4594: monitor_file(...)
4595: {
4596: #if defined(__NetBSD__)
4597: int fd = kqueue();
4598: ...
4599: #else
4600: ...
4601: #endif
4602: }
4603: </pre>
1.85 jmmv 4604: </td>
4605: <td>
1.100 rillig 4606: <pre class="programlisting">
4607: int
4608: monitor_file(...)
4609: {
4610: #if defined(HAVE_KQUEUE)
4611: int fd = kqueue();
4612: ...
4613: #else
4614: ...
4615: #endif
4616: }
4617: </pre>
1.85 jmmv 4618: </td>
4619: </tr>
4620: </tbody>
1.91 rillig 4621: </table></div>
1.85 jmmv 4622: </div>
1.91 rillig 4623: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4624: 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
4625: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4626: 2</a>). It summarizes multiple details on how to make
4627: software easier to package; all the suggestions in it were
4628: collected from our experience in pkgsrc work, so they are possibly
4629: helpful when creating patches too.</p>
4630: </div>
4631: <div class="sect2" lang="en">
4632: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4633: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4634: <p>Always, always, <span class="strong"><strong>always</strong></span>
4635: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4636: improvements you do to a package to the mainstream developers.
4637: This is the only way to get their attention on portability issues
4638: and to ensure that future versions can be built out-of-the box on
4639: NetBSD. Furthermore, any user that gets newer distfiles will get
4640: the fixes straight from the packaged code.</p>
1.93 rillig 4641: <p>This generally involves cleaning up the patches
4642: (because sometimes the patches that are
1.85 jmmv 4643: added to pkgsrc are quick hacks), filling bug reports in the
4644: appropriate trackers for the projects and working with the
4645: mainstream authors to accept your changes. It is
4646: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4647: the packages in pkgsrc are kept simple and thus further changes
4648: can be done without much hassle.</p>
4649: <p>Support the idea of free software!</p>
4650: </div>
1.75 rillig 4651: </div>
4652: <div class="sect1" lang="en">
4653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4654: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4655: <div class="variablelist"><dl>
1.76 rillig 4656: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4657: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4658: any credits where they are due. Please bear in mind that others do not
4659: share your sense of humour (or spelling idiosyncrasies), and that others
4660: will read everything that you write here.</p></dd>
1.76 rillig 4661: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4662: <dd><p>This file governs the files that are installed on your
4663: system: all the binaries, manual pages, etc. There are other
4664: directives which may be entered in this file, to control the
4665: creation and deletion of directories, and the location of
1.110 hubertf 4666: 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 4667: information.</p></dd>
1.75 rillig 4668: </dl></div>
4669: </div>
4670: <div class="sect1" lang="en">
4671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4672: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78 rillig 4673: <div class="sect2" lang="en">
4674: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4675: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4676: <div class="variablelist"><dl>
1.76 rillig 4677: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110 hubertf 4678: <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 4679: First time after package extraction and before files are
4680: moved in place, the second time after the files to install
4681: are moved in place. This can be used to do any custom
4682: procedures not possible with @exec commands in
1.110 hubertf 4683: <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
4684: <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 4685: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4686: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4687: this script's responsibility to clean up any additional messy details
4688: around the package's installation, since all pkg_delete knows is how to
4689: delete the files created in the original distribution.
1.110 hubertf 4690: 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>
4691: 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 4692: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4693: <dd>
4694: <p>This file is displayed after installation of the package.
1.87 wiz 4695: Useful for things like legal notices on almost-free
4696: software and hints for updating config files after
4697: installing modules for apache, PHP etc.
4698: Please note that you can modify variables in it easily by using
4699: <code class="varname">MESSAGE_SUBST</code> in the package's
4700: <code class="filename">Makefile</code>:</p>
1.75 rillig 4701: <pre class="programlisting">
1.100 rillig 4702: MESSAGE_SUBST+= SOMEVAR="somevalue"
4703: </pre>
1.75 rillig 4704: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4705: <code class="filename">MESSAGE</code>. By default, substitution is
4706: performed for <code class="varname">PKGNAME</code>,
4707: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4708: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4709: <code class="varname">X11BASE</code>,
4710: <code class="varname">PKG_SYSCONFDIR</code>,
4711: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4712: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4713: <p>You can display a different or additional files by
4714: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4715: default is <code class="filename">MESSAGE</code>, if the file
4716: exists.</p>
1.75 rillig 4717: </dd>
1.78 rillig 4718: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4719: <dd><p>FIXME: There is no documentation on the
4720: alternatives framework.</p></dd>
4721: </dl></div>
4722: </div>
4723: <div class="sect2" lang="en">
4724: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4725: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4726: <div class="variablelist"><dl>
4727: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4728: <dd><p>This file contains arbitrary things that could
4729: also go into a <code class="filename">Makefile</code>, but its purpose is
4730: to be used by more than one package. This file should only be
4731: used when the packages that will use the file are known in
4732: advance. For other purposes it is often better to write a
4733: <code class="filename">*.mk</code> file and give it a good name that
4734: describes what it does.</p></dd>
4735: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4736: <dd><p>This file contains the dependency information
1.110 hubertf 4737: 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 4738: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4739: <dd><p>This file contains workarounds for compiler bugs
4740: and similar things. It is included automatically by the pkgsrc
4741: infrastructure, so you don't need an extra
4742: <code class="literal">.include</code> line for
4743: it.</p></dd>
4744: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4745: <dd><p>This file contains the code for the
1.110 hubertf 4746: 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 4747: selected by the user. If a package has only one or two options,
4748: it is equally acceptable to put the code directly into the
4749: <code class="filename">Makefile</code>.</p></dd>
4750: </dl></div>
4751: </div>
4752: <div class="sect2" lang="en">
4753: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4754: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4755: <div class="variablelist"><dl>
4756: <dt><span class="term"><code class="filename">README*</code></span></dt>
4757: <dd><p>These files do not take place in the creation of
4758: a package and thus are purely informative to the package
4759: developer.</p></dd>
4760: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4761: <dd><p>This file contains things that need to be done
4762: to make the package even
4763: better.</p></dd>
1.75 rillig 4764: </dl></div>
4765: </div>
1.78 rillig 4766: </div>
1.75 rillig 4767: <div class="sect1" lang="en">
4768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4769: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4770: </h2></div></div></div>
1.110 hubertf 4771: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4772: unpacked into the directory denoted by
4773: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4774: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4775: directory is also used to keep various timestamp files.
4776: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4777: The default is <code class="filename">${.CURDIR}/work</code>
4778: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4779: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4780: </div>
4781: <div class="sect1" lang="en">
4782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4783: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4784: </h2></div></div></div>
1.75 rillig 4785: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4786: to configuration or building, you could place these files here and use
1.110 hubertf 4787: a <span class="command"><strong>${CP}</strong></span> command in the
1.87 wiz 4788: “<span class="quote">pre-configure</span>” target to achieve
4789: this. Alternatively, you could simply diff the file against
4790: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4791: the creation of this file.</p>
4792: <p>If you want to share files in this way with other
4793: packages, set the <code class="varname">FILESDIR</code> variable to point
4794: to the other package's <code class="filename">files</code> directory,
4795: e.g.:</p>
4796: <pre class="programlisting">
1.100 rillig 4797: FILESDIR=${.CURDIR}/../xemacs/files
4798: </pre>
1.75 rillig 4799: </div>
4800: </div>
4801: <div class="chapter" lang="en">
4802: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4803: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4804: <div class="toc">
4805: <p><b>Table of Contents</b></p>
4806: <dl>
1.106 rillig 4807: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.123 snj 4808: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106 rillig 4809: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4810: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4811: <dd><dl>
4812: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4813: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4814: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4815: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4816: <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 4817: </dl></dd>
4818: </dl>
4819: </div>
1.76 rillig 4820: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4821: each of which forms a well-defined part of the pkgsrc system. Using
1.110 hubertf 4822: 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 4823: like pkgsrc requires some discipline to keep the code correct and
4824: understandable.</p>
1.76 rillig 4825: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4826: programming are variables (which are actually macros) and shell
4827: commands. Among these shell commands may even be more complex ones
1.110 hubertf 4828: 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 4829: as intended it is necessary to quote all variables correctly when they
4830: are used.</p>
4831: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4832: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4833: with them.</p>
4834: <div class="sect1" lang="en">
4835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4836: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97 rillig 4837: <div class="itemizedlist"><ul type="disc"><li>
4838: <p>When you are creating a file as a
4839: target of a rule, always write the data to a temporary file first
4840: and finally rename that file. Otherwise there might occur an error
4841: in the middle of generating the file, and when the user runs
1.110 hubertf 4842: <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 4843: regenerated properly. Example:</p>
4844: <pre class="programlisting">
1.100 rillig 4845: wrong:
4846: @echo "line 1" > ${.TARGET}
4847: @echo "line 2" >> ${.TARGET}
4848: @false
4849:
4850: correct:
4851: @echo "line 1" > ${.TARGET}.tmp
4852: @echo "line 2" >> ${.TARGET}.tmp
4853: @false
4854: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4855: </pre>
1.110 hubertf 4856: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4857: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4858: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4859: correct</strong></span> gives an error message twice, as expected.</p>
1.110 hubertf 4860: <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 4861: <code class="literal">${.TARGET}</code> in case of error, but this only
4862: happens when it is interrupted, for example by pressing
4863: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110 hubertf 4864: 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 4865: </li></ul></div>
4866: </div>
4867: <div class="sect1" lang="en">
4868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4869: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4870: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4871: can be processed using the five operators ``='', ``+='', ``?='',
1.110 hubertf 4872: ``:='', 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 4873: page.</p>
4874: <p>When a variable's value is parsed from a
1.76 rillig 4875: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4876: backslash character ``\'' are handled specially. If a backslash is
4877: followed by a newline, any whitespace immediately in front of the
4878: backslash, the backslash, the newline, and any whitespace
4879: immediately behind the newline are replaced with a single space. A
4880: backslash character and an immediately following hash character are
4881: replaced with a single hash character. Otherwise, the backslash is
4882: passed as is. In a variable assignment, any hash character that is
4883: not preceded by a backslash starts a comment that continues upto the
4884: end of the logical line.</p>
4885: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4886: the only way to create a variable consisting of a single backslash
4887: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4888: <p>So far for defining variables. The other thing you can do with
4889: variables is evaluating them. A variable is evaluated when it is
4890: part of the right side of the ``:='' or the ``!='' operator, or
4891: directly before executing a shell command which the variable is part
1.110 hubertf 4892: 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 4893: is, variables are not evaluated until there's no other way. The
4894: ``modifiers'' mentioned in the man page also evaluate the
4895: variable.</p>
4896: <p>Some of the modifiers split the string into words and then
4897: operate on the words, others operate on the string as a whole. When
4898: a string is split into words, it is split as you would expect
1.110 hubertf 4899: 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.126 jakllsch 4900: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4901: loop does not follow the shell quoting rules but splits at sequences
4902: of whitespace.</p>
4903: <p>There are several types of variables that should be handled
4904: differently. Strings and two types of lists.</p>
4905: <div class="itemizedlist"><ul type="disc">
4906: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4907: characters. Nevertheless, you should restrict yourself to only
4908: using printable characters. Examples are
4909: <code class="varname">PREFIX</code> and
4910: <code class="varname">COMMENT</code>.</p></li>
4911: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4912: are never exported to any shell command. Their elements are
4913: separated by whitespace. Therefore, the elements themselves cannot
4914: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4915: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4916: Examples are <code class="varname">DEPENDS</code> and
4917: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4918: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4919: may be exported to a shell command. Their elements can contain any
4920: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4921: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4922: <code class="varname">DISTFILES</code> and
4923: <code class="varname">MASTER_SITES</code>.</p></li>
4924: </ul></div>
4925: <div class="sect2" lang="en">
4926: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4927: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75 rillig 4928: <div class="itemizedlist"><ul type="disc">
4929: <li><p>All variable names starting with an underscore
4930: are reserved for use by the pkgsrc infrastructure. They shall
4931: not be used by package
1.76 rillig 4932: <code class="filename">Makefile</code>s.</p></li>
1.110 hubertf 4933: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4934: lowercase variable names for the iteration
4935: variables.</p></li>
4936: <li><p>All list variables should have a ``plural''
4937: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4938: <code class="varname">DISTFILES</code>.</p></li>
4939: </ul></div>
4940: </div>
4941: </div>
4942: <div class="sect1" lang="en">
4943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4944: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4945: <p>This section presents you with some code snippets you should
4946: use in your own code. If you don't find anything appropriate here,
4947: you should test your code and add it here.</p>
4948: <div class="sect2" lang="en">
4949: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4950: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4951: <pre class="programlisting">
1.100 rillig 4952: STRING= foo * bar `date`
4953: INT_LIST= # empty
4954: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4955: EXT_LIST= # empty
4956: ANOTHER_EXT_LIST= a=b c=d
4957:
4958: INT_LIST+= ${STRING} # 1
4959: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4960: EXT_LIST+= ${STRING:Q} # 3
4961: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4962: </pre>
1.75 rillig 4963: <p>When you add a string to an external list (example 3), it
4964: must be quoted. In all other cases, you must not add a quoting
4965: level. You must not merge internal and external lists, unless you
4966: are sure that all entries are correctly interpreted in both
4967: lists.</p>
4968: </div>
4969: <div class="sect2" lang="en">
4970: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4971: <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 4972: <pre class="programlisting">
1.100 rillig 4973: EXT_LIST= # empty
4974: .for i in ${INT_LIST}
4975: EXT_LIST+= ${i:Q}""
4976: .endfor
1.1 grant 4977: </pre>
1.75 rillig 4978: <p>This code converts the internal list
4979: <code class="varname">INT_LIST</code> into the external list
4980: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4981: are unquoted they must be quoted here. The reason for appending
4982: <code class="varname">""</code> is explained below.</p>
4983: </div>
4984: <div class="sect2" lang="en">
4985: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4986: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4987: <p>Sometimes you may want to print an arbitrary string. There
4988: are many ways to get it wrong and only few that can handle every
4989: nastiness.</p>
1.75 rillig 4990: <pre class="programlisting">
1.100 rillig 4991: STRING= foo bar < > * `date` $$HOME ' "
4992: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4993:
1.100 rillig 4994: all:
4995: echo ${STRING} # 1
4996: echo "${STRING}" # 2
4997: echo "${STRING:Q}" # 3
4998: echo ${STRING:Q} # 4
4999: echo x${STRING:Q} | sed 1s,.,, # 5
5000: printf "%s\\n" ${STRING:Q}"" # 6
5001: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 5002: </pre>
1.75 rillig 5003: <p>Example 1 leads to a syntax error in the shell, as the
5004: characters are just copied.</p>
5005: <p>Example 2 leads to a syntax error too, and if you leave out
5006: the last " character from <code class="varname">${STRING}</code>,
1.110 hubertf 5007: <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 5008: variable would be evaluated, too.</p>
5009: <p>Example 3 outputs each space character preceded by a
5010: backslash (or not), depending on the implementation of the
1.110 hubertf 5011: <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 5012: <p>Example 4 handles correctly every string that does not start
5013: with a dash. In that case, the result depends on the
1.110 hubertf 5014: 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 5015: guarantee that your input does not start with a dash, this form is
5016: appropriate.</p>
5017: <p>Example 5 handles even the case of a leading dash
5018: correctly.</p>
1.79 rillig 5019: <p>Example 6 also works with every string and is the
5020: light-weight solution, since it does not involve a pipe, which has
5021: its own problems.</p>
1.75 rillig 5022: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5023: because the quoting has already been done when adding elements to
5024: the list.</p>
5025: <p>As internal lists shall not be passed to the shell, there is
5026: no example for it.</p>
5027: </div>
5028: <div class="sect2" lang="en">
5029: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5030: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5031: <p>There are many possible sources of wrongly quoted variables.
5032: This section lists some of the commonly known ones.</p>
5033: <div class="itemizedlist"><ul type="disc">
5034: <li>
5035: <p>Whenever you use the value of a list, think
5036: about what happens to leading or trailing whitespace. If the
5037: list is a well-formed shell expression, you can apply the
5038: <code class="varname">:M*</code> modifier to strip leading and trailing
5039: whitespace from each word. The <code class="varname">:M</code> operator
5040: first splits its argument according to the rules of the shell,
5041: and then creates a new list consisting of all words that match
5042: the shell glob expression <code class="varname">*</code>, that is: all.
5043: One class of situations where this is needed is when adding a
5044: variable like <code class="varname">CPPFLAGS</code> to
5045: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5046: invokes other configure scripts, it strips the leading and
5047: trailing whitespace from the variable and then passes it to the
5048: other configure scripts. But these configure scripts expect the
5049: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5050: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5051: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5052: here is how we do it:</p>
5053: <pre class="programlisting">
1.100 rillig 5054: CPPFLAGS= # empty
5055: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5056: CPPFLAGS+= ${MY_CPPFLAGS}
5057:
5058: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5059:
5060: all:
5061: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5062: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5063: </pre>
1.75 rillig 5064: </li>
5065: <li><p>The example above contains one bug: The
5066: <code class="varname">${PREFIX}</code> is a properly quoted shell
5067: expression, but there is the C compiler after it, which also
5068: expects a properly quoted string (this time in C syntax). The
5069: version above is therefore only correct if
5070: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5071: or double quotes. If you want to allow these, you have to add
5072: another layer of quoting to each variable that is used as a C
5073: string literal. You cannot use the <code class="varname">:Q</code>
5074: operator for it, as this operator only works for the
5075: shell.</p></li>
5076: <li>
5077: <p>Whenever a variable can be empty, the
5078: <code class="varname">:Q</code> operator can have surprising results. Here
5079: are two completely different cases which can be solved with the
5080: same trick.</p>
5081: <pre class="programlisting">
1.100 rillig 5082: EMPTY= # empty
5083: empty_test:
5084: for i in a ${EMPTY:Q} c; do \
5085: echo "$$i"; \
5086: done
5087:
5088: for_test:
5089: .for i in a:\ a:\test.txt
5090: echo ${i:Q}
5091: echo "foo"
5092: .endfor
1.1 grant 5093: </pre>
1.75 rillig 5094: <p>The first example will only print two of the three lines
5095: we might have expected. This is because
5096: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5097: the shell cannot see. The workaround is to write
5098: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5099: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5100: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5101: <p>The second example will only print three lines instead of
5102: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5103: This is because the backslash of the value
5104: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110 hubertf 5105: <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
5106: <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 5107: <code class="varname">${i:Q}""</code>.</p>
5108: </li>
5109: </ul></div>
5110: </div>
5111: <div class="sect2" lang="en">
5112: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5113: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5114: <p>The pkgsrc bmake program does not handle the following
5115: assignment correctly. In case <code class="varname">_othervar_</code>
5116: contains a ``-'' character, one of the closing braces is included
5117: in <code class="varname">${VAR}</code> after this code executes.</p>
5118: <pre class="programlisting">
1.100 rillig 5119: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5120: </pre>
1.75 rillig 5121: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5122: 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 5123: <code class="varname">bug1</code>.</p>
5124: </div>
5125: </div>
5126: </div>
5127: <div class="chapter" lang="en">
5128: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5129: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 5130: <div class="toc">
5131: <p><b>Table of Contents</b></p>
5132: <dl>
1.106 rillig 5133: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.123 snj 5134: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
5135: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106 rillig 5136: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5137: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.123 snj 5138: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106 rillig 5139: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5140: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5141: </dl>
5142: </div>
1.87 wiz 5143: <p>The <code class="filename">PLIST</code> file contains a package's
5144: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5145: the package (relative to the <code class="filename">${PREFIX}</code>
5146: directory it's been installed in) plus some additional statements
1.110 hubertf 5147: - 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 5148: This chapter addresses some issues that need attention when
5149: dealing with the <code class="filename">PLIST</code> file (or files, see
5150: below!).</p>
1.75 rillig 5151: <div class="sect1" lang="en">
5152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5153: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 5154: <p>Be sure to add a RCS ID line as the first thing in any
5155: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5156: <pre class="programlisting">
1.100 rillig 5157: @comment $NetBSD$
1.87 wiz 5158: </pre>
1.75 rillig 5159: </div>
5160: <div class="sect1" lang="en">
5161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5162: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 5163: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 5164: to output a PLIST that matches any new files since the package
1.110 hubertf 5165: 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 5166: more information on this target.</p>
1.75 rillig 5167: </div>
5168: <div class="sect1" lang="en">
5169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 5170: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 5171: </h2></div></div></div>
1.87 wiz 5172: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 5173: <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
5174: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 5175: <code class="varname">@comment</code>s instead of real
5176: <code class="varname">@dirrm</code> lines. You can also do this for
5177: specific directories and files, so that the results of that
5178: command are very close to reality. This helps <span class="emphasis"><em>a
5179: lot</em></span> during the update of packages.</p>
5180: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5181: of AWK patterns and actions that are used to filter the output of
5182: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5183: scripting you like to it, but be careful with quoting.</p>
5184: <p>For example, to get all files inside the
5185: <code class="filename">libdata/foo</code> directory removed from the
5186: resulting PLIST:</p>
5187: <pre class="programlisting">
1.100 rillig 5188: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5189: </pre>
5190: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5191: to a specific (shared) directory converted to
5192: <code class="varname">@comment</code>s:</p>
1.75 rillig 5193: <pre class="programlisting">
1.100 rillig 5194: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5195: </pre>
1.75 rillig 5196: </div>
5197: <div class="sect1" lang="en">
5198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5199: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5200: <p>A number of variables are substituted automatically in
5201: PLISTs when a package is installed on a system. This includes the
5202: following variables:</p>
1.75 rillig 5203: <div class="variablelist"><dl>
5204: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5205: <dd>
5206: <p>Some packages like emacs and perl embed information
1.87 wiz 5207: about which architecture they were built on into the
5208: pathnames where they install their files. To handle this
5209: case, PLIST will be preprocessed before actually used, and
5210: the symbol
5211: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
1.110 hubertf 5212: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5213: same is done if the string
5214: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5215: PLIST somewhere - use this on packages that have GNU
5216: autoconf-created configure scripts.</p>
1.75 rillig 5217: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5218: <h3 class="title">Legacy note</h3>
5219: <p>There used to be a symbol
1.87 wiz 5220: “<span class="quote"><code class="varname">$ARCH</code></span>” that
1.110 hubertf 5221: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5222: -m</strong></span>, but that's no longer supported and has
5223: been removed.</p>
1.75 rillig 5224: </div>
5225: </dd>
5226: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5227: <dd>
5228: <p>Some packages want to embed the OS name and version
1.87 wiz 5229: into some paths. To do this, use these variables in the
5230: <code class="filename">PLIST</code>:
5231: </p>
1.75 rillig 5232: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 5233: <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 5234: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
1.110 hubertf 5235: <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 5236: </ul></div>
5237: </dd>
5238: </dl></div>
1.87 wiz 5239: <p>For a complete list of values which are replaced by
5240: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5241: search for <code class="varname">PLIST_SUBST</code>).</p>
5242: <p>If you want to change other variables not listed above, you
5243: can add variables and their expansions to this variable in the
1.110 hubertf 5244: 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 5245: <pre class="programlisting">
1.100 rillig 5246: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5247: </pre>
1.75 rillig 5248: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5249: in the <code class="filename">PLIST</code> with
5250: “<span class="quote">somevalue</span>”.</p>
1.120 snj 5251: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 5252: the common case of conditionally including some
5253: <code class="filename">PLIST</code> entries. It can be done by adding
5254: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5255: setting the corresponding <code class="varname">PLIST.foo</code> variable
5256: to <code class="literal">yes</code> if the entry should be included.
1.119 mishka 5257: This will substitute “<span class="quote"><code class="varname">${PLIST.foo}</code></span>”
5258: in the <code class="filename">PLIST</code> with either
5259: “<span class="quote"><code class="literal">""</code></span>” or
5260: “<span class="quote"><code class="literal">"@comment "</code></span>”.
5261: For example, in <code class="filename">Makefile</code>:</p>
5262: <pre class="programlisting">
5263: PLIST_VARS+= foo
5264: .if <em class="replaceable"><code>condition</code></em>
5265: PLIST.foo= yes
5266: .else
5267: </pre>
5268: <p>And then in <code class="filename">PLIST</code>:</p>
5269: <pre class="programlisting">
5270: @comment $NetBSD$
5271: bin/bar
5272: man/man1/bar.1
5273: ${PLIST.foo}bin/foo
5274: ${PLIST.foo}man/man1/foo.1
5275: ${PLIST.foo}share/bar/foo.data
5276: ${PLIST.foo}@dirrm share/bar
5277: </pre>
1.75 rillig 5278: </div>
5279: <div class="sect1" lang="en">
5280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5281: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5282: <p>Man pages should be installed in compressed form if
1.87 wiz 5283: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5284: and uncompressed otherwise. To handle this in the
5285: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5286: appended/removed automatically for man pages according to
5287: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5288: or not, see above for details. This modification of the
5289: <code class="filename">PLIST</code> file is done on a copy of it, not
5290: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5291: </div>
5292: <div class="sect1" lang="en">
5293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5294: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5295: </h2></div></div></div>
1.76 rillig 5296: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5297: in generating the binary package, set the variable
5298: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110 hubertf 5299: 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 5300: important. The default for <code class="varname">PLIST_SRC</code> is
5301: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5302: </div>
5303: <div class="sect1" lang="en">
5304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5305: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5306: <p>Some packages decide to install a different set of files based on
1.87 wiz 5307: the operating system being used. These differences can be
5308: automatically handled by using the following files:</p>
1.75 rillig 5309: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5310: <li><p><code class="filename">PLIST.common</code></p></li>
5311: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5312: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5313: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5314: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5315: </ul></div>
5316: </div>
5317: <div class="sect1" lang="en">
5318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5319: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5320: <p>A “<span class="quote">shared directory</span>” is a directory where
5321: multiple (and unrelated) packages install files. These
1.125 wiz 5322: directories were problematic because you had to add special
5323: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5324: centralized package handle them.</p>
1.125 wiz 5325: <p>In pkgsrc, it is now easy: Each package should create
5326: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5327: will remove any directories left empty after uninstalling a
5328: package.</p>
5329: <p>If a package needs an empty directory to work, create
5330: the directory during installation as usual, and also add an
5331: entry to the PLIST:
5332: </p>
1.87 wiz 5333: <pre class="programlisting">
1.125 wiz 5334: @pkgdir path/to/empty/directory
1.87 wiz 5335: </pre>
1.125 wiz 5336: <p>
5337: </p>
1.75 rillig 5338: </div>
5339: </div>
5340: <div class="chapter" lang="en">
5341: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5342: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5343: <div class="toc">
5344: <p><b>Table of Contents</b></p>
5345: <dl>
1.106 rillig 5346: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.123 snj 5347: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.75 rillig 5348: <dd><dl>
1.106 rillig 5349: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.123 snj 5350: <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 5351: </dl></dd>
1.123 snj 5352: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.75 rillig 5353: <dd><dl>
1.123 snj 5354: <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 5355: <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 5356: </dl></dd>
5357: </dl>
5358: </div>
5359: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5360: are seen by a package's configure and build processes. This is implemented
5361: in a two step process:</p>
1.75 rillig 5362: <div class="orderedlist"><ol type="1">
5363: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5364: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5365: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5366: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5367: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5368: <code class="option">-L${LOCALBASE}/lib</code> into references to
5369: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5370: native compiler on some operating systems look like GCC, so that
5371: packages that expect GCC won't require modifications to build with
5372: those native compilers.</p></li>
1.75 rillig 5373: </ol></div>
5374: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5375: package may be built consistently despite what other software may be
5376: installed. Please note that the normal system header and library paths,
5377: e.g. <code class="filename">/usr/include</code>,
5378: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5379: designed to insulate the package build from non-system-supplied
5380: software.</p>
1.75 rillig 5381: <div class="sect1" lang="en">
5382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5383: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5384: <p>The process of converting packages to use the buildlink3
1.87 wiz 5385: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5386: The things to keep in mind are:</p>
1.75 rillig 5387: <div class="orderedlist"><ol type="1">
1.87 wiz 5388: <li><p>Ensure that the build always calls the wrapper scripts
5389: instead of the actual toolchain. Some packages are tricky,
5390: and the only way to know for sure is the check
5391: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5392: wrappers are being invoked.</p></li>
5393: <li><p>Don't override <code class="varname">PREFIX</code> from within
5394: the package Makefile, e.g. Java VMs, standalone shells,
5395: etc., because the code to symlink files into
5396: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5397: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5398: </p></li>
5399: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5400: <code class="filename">buildlink3.mk</code> files that you list in a
5401: package's Makefile are added as dependencies for that package.
5402: </p></li>
1.75 rillig 5403: </ol></div>
1.87 wiz 5404: <p>If a dependency on a particular package is required for its libraries and
5405: headers, then we replace:</p>
1.75 rillig 5406: <pre class="programlisting">
1.100 rillig 5407: DEPENDS+= foo>=1.1.0:../../category/foo
5408: </pre>
1.75 rillig 5409: <p>with</p>
5410: <pre class="programlisting">
1.100 rillig 5411: .include "../../category/foo/buildlink3.mk"
5412: </pre>
1.75 rillig 5413: <p>The buildlink3.mk files usually define the required dependencies.
5414: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5415: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5416: <pre class="programlisting">
1.100 rillig 5417: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5418: .include "../../category/foo/buildlink3.mk"
5419: </pre>
1.76 rillig 5420: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5421: files in <code class="filename">pkgsrc/mk</code>
5422: that handle special package issues:</p>
1.75 rillig 5423: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5424: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5425: the native or a pkgsrc Berkeley DB implementation based on
5426: the values of <code class="varname">BDB_ACCEPTED</code> and
5427: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5428: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5429: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5430: 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 5431: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5432: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5433: adding a dependency on Heimdal or MIT-krb5 for packages that
5434: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5435: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5436: system-provided Motif installation or adds a dependency on
1.91 rillig 5437: <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 5438: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5439: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5440: which Motif version will be used.</p></li>
1.76 rillig 5441: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5442: variables that may be used by packages that use the
5443: Open Sound System (OSS) API.</p></li>
1.76 rillig 5444: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5445: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5446: the file for more information.</p></li>
1.76 rillig 5447: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5448: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5449: 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 5450: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5451: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5452: library.</p></li>
1.75 rillig 5453: </ul></div>
1.76 rillig 5454: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5455: files provide a more complete
5456: description of how to use them properly.</p>
1.75 rillig 5457: </div>
5458: <div class="sect1" lang="en">
5459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5460: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5461: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5462: included by Makefiles to indicate the need to compile and link
5463: against header files and libraries provided by the package. A
5464: <code class="filename">buildlink3.mk</code> file should always provide
5465: enough information to add the correct type of dependency
5466: relationship and include any other
5467: <code class="filename">buildlink3.mk</code> files that it needs to find
5468: headers and libraries that it needs in turn.</p>
5469: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5470: 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 5471: package is highly recommended. For most packages, the following
5472: command will generate a good starting point for
5473: <code class="filename">buildlink3.mk</code> files:</p>
5474: <pre class="screen">
5475: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5476: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5477: </pre>
1.75 rillig 5478: <div class="sect2" lang="en">
5479: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5480: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5481: <p>The following real-life example
1.87 wiz 5482: <code class="filename">buildlink3.mk</code> is taken
5483: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5484: <pre class="programlisting">
1.120 snj 5485: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5486:
1.120 snj 5487: BUILDLINK_TREE+= tiff
1.1 grant 5488:
1.120 snj 5489: .if !defined(TIFF_BUILDLINK3_MK)
5490: TIFF_BUILDLINK3_MK:=
1.87 wiz 5491:
1.120 snj 5492: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5493: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5494: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5495:
1.100 rillig 5496: .include "../../devel/zlib/buildlink3.mk"
5497: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5498: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5499:
1.120 snj 5500: BUILDLINK_TREE+= -tiff
1.100 rillig 5501: </pre>
1.87 wiz 5502: <p>The header and footer manipulate
1.120 snj 5503: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5504: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5505: the dependency tree.</p>
5506: <p>The main section is protected from multiple inclusion
1.87 wiz 5507: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5508: added. Several important variables are set in the section:</p>
5509: <div class="itemizedlist"><ul type="disc">
5510: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5511: is the actual dependency recorded in the installed
5512: package; this should always be set using
1.110 hubertf 5513: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5514: we're appending to any pre-existing list of values. This
5515: variable should be set to the first version of the
5516: package that had an API change.
5517: </p></li>
5518: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5519: is the location of the <em class="replaceable"><code>pkg</code></em>
5520: pkgsrc directory.</p></li>
5521: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5522: (not shown above) controls whether we use
5523: <code class="varname">BUILD_DEPENDS</code> or
5524: <code class="varname">DEPENDS</code> to add the dependency on
5525: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5526: selected by setting
5527: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5528: to “<span class="quote">build</span>”. By default, the full dependency is
5529: used.</p></li>
5530: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5531: and
5532: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5533: (not shown above) are lists of subdirectories of
1.76 rillig 5534: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5535: to add to the header and library search paths. These
5536: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5537: respectively.</p></li>
5538: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5539: (not shown above) is the list of preprocessor flags to add
5540: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5541: configure and build phases. The “<span class="quote">-I</span>” option
5542: should be avoided and instead be handled using
5543: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5544: above.</p></li>
1.75 rillig 5545: </ul></div>
1.87 wiz 5546: <p>The following variables are all optionally defined within
5547: this second section (protected against multiple inclusion) and
5548: control which package files are symlinked into
5549: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5550: transformed during the symlinking:</p>
1.75 rillig 5551: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5552: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5553: (not shown above) is a shell glob pattern relative to
1.76 rillig 5554: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5555: to be symlinked into
1.76 rillig 5556: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5557: e.g. <code class="filename">include/*.h</code>.</p></li>
5558: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5559: (not shown above) is a shell pipeline that
5560: outputs to stdout a list of files relative to
5561: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5562: The resulting files are to be symlinked
5563: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5564: this takes the <code class="filename">+CONTENTS</code> of a
5565: <em class="replaceable"><code>pkg</code></em> and filters it through
5566: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5567: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5568: (not shown above) is a filter command that filters
1.76 rillig 5569: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5570: relative to
1.76 rillig 5571: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5572: on stdout. By default for overwrite packages,
5573: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5574: outputs the contents of the <code class="filename">include</code>
5575: and <code class="filename">lib</code> directories in the package
5576: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5577: it outputs any libtool archives in
1.87 wiz 5578: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5579: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5580: (not shown above) is a list of sed arguments used to
5581: transform the name of the source filename into a
1.110 hubertf 5582: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5583: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5584: </ul></div>
1.120 snj 5585: <p>This section can additionally include any
1.87 wiz 5586: <code class="filename">buildlink3.mk</code> needed for
5587: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5588: Including these <code class="filename">buildlink3.mk</code> files
5589: means that the headers and libraries for these
5590: dependencies are also symlinked into
5591: <code class="filename">${BUILDLINK_DIR}</code>
5592: whenever the <em class="replaceable"><code>pkg</code></em>
5593: <code class="filename">buildlink3.mk</code>
1.120 snj 5594: file is included. Dependencies are only added for directly
5595: include <code class="filename">buildlink3.mk</code> files.</p>
1.75 rillig 5596: </div>
5597: <div class="sect2" lang="en">
5598: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5599: <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 5600: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5601: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5602: after a package update is when the API or interface to the
1.87 wiz 5603: header files change.</p>
5604: <p>In this case,
5605: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5606: should be adjusted to require at least the new package
5607: version. In some cases, the packages that depend on this new
5608: version may need their <code class="varname">PKGREVISION</code>s
5609: increased and, if they have <code class="filename">buildlink3.mk</code>
5610: files, their
5611: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5612: adjusted, too. This is needed so pkgsrc will require the
5613: correct package dependency and not settle for an older one
5614: when building the source.</p>
5615: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5616: should be increased when the binary interface or sonames
5617: (major number of the library version) of any installed
5618: shared libraries change. This is needed so that binary
5619: packages made using it will require the correct package
5620: dependency and not settle for an older one which will not
1.87 wiz 5621: contain the necessary shared libraries.</p>
1.110 hubertf 5622: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.75 rillig 5623: more information about dependencies on other packages,
5624: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5625: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5626: <p>Please take careful consideration before adjusting
5627: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5628: or
5629: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5630: as we don't want to cause unneeded package deletions and
5631: rebuilds. In many cases, new versions of packages work just
5632: fine with older dependencies.</p>
5633: <p>Also it is not needed to set
1.75 rillig 5634: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5635: when it is identical to
1.87 wiz 5636: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5637: </div>
5638: </div>
5639: <div class="sect1" lang="en">
5640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5641: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5642: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5643: coincide with headers and libraries present in the base system.
1.76 rillig 5644: Aside from a <code class="filename">buildlink3.mk</code> file, these
5645: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5646: file that includes the necessary checks to decide whether using
5647: the built-in software or the pkgsrc software is
1.87 wiz 5648: appropriate.</p>
5649: <p>The only requirements of a builtin.mk file for
5650: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5651: <div class="orderedlist"><ol type="1">
1.87 wiz 5652: <li><p>It should set
5653: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5654: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5655: after it is included.</p></li>
5656: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5657: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5658: which is already set before the
5659: <code class="filename">builtin.mk</code> file is included.</p></li>
5660: <li><p>It should be written to allow multiple inclusion. This
5661: is <span class="emphasis"><em>very</em></span> important and takes careful
5662: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5663: </ol></div>
5664: <div class="sect2" lang="en">
5665: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5666: <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 5667: <p>The following is the recommended template for builtin.mk
1.87 wiz 5668: files:</p>
1.75 rillig 5669: <pre class="programlisting">
1.100 rillig 5670: .if !defined(IS_BUILTIN.foo)
5671: #
5672: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5673: # genuinely exists in the system or not.
5674: #
5675: IS_BUILTIN.foo?= no
5676:
5677: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5678: # version can be determined.
5679: #
5680: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5681: BUILTIN_PKG.foo?= foo-1.0
5682: . endif
5683: .endif # IS_BUILTIN.foo
5684:
5685: .if !defined(USE_BUILTIN.foo)
5686: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5687: . if defined(BUILTIN_PKG.foo)
5688: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5689: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5690: USE_BUILTIN.foo!= \
5691: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5692: && ${ECHO} "yes" || ${ECHO} "no"
5693: . endif
5694: . endfor
5695: . endif
5696: .endif # USE_BUILTIN.foo
5697:
5698: CHECK_BUILTIN.foo?= no
5699: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5700: #
5701: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5702: # "yes" or "no".
5703: #
5704: .endif # CHECK_BUILTIN.foo
5705: </pre>
1.87 wiz 5706: <p>The first section sets
5707: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5708: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5709: in the base system. This should not be a base system software
5710: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5711: it should only be “<span class="quote">yes</span>” if the actual package is
5712: included as part of the base system. This variable is only
5713: used internally within the <code class="filename">builtin.mk</code>
5714: file.</p>
5715: <p>The second section sets
5716: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5717: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5718: system if it exists (if
5719: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5720: is “<span class="quote">yes</span>”). This variable is only used internally
5721: within the <code class="filename">builtin.mk</code> file.</p>
5722: <p>The third section sets
5723: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5724: and is <span class="emphasis"><em>required</em></span> in all
5725: <code class="filename">builtin.mk</code> files. The code in this
5726: section must make the determination whether the built-in
5727: software is adequate to satisfy the dependencies listed in
5728: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5729: This is typically done by comparing
5730: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5731: against each of the dependencies in
5732: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5733: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5734: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5735: end of the <code class="filename">builtin.mk</code> file. Note that
5736: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5737: may be “<span class="quote">yes</span>” even if
5738: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5739: is “<span class="quote">no</span>” because we may make the determination
5740: that the built-in version of the software is similar enough to
5741: be used as a replacement.</p>
5742: <p>The last section is guarded by
5743: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5744: and includes code that uses the value of
5745: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5746: set in the previous section. This typically includes, e.g.,
5747: adding additional dependency restrictions and listing additional
5748: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5749: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5750: </div>
5751: <div class="sect2" lang="en">
5752: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5753: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5754: <p>When building packages, it's possible to choose whether to set
5755: a global preference for using either the built-in (native)
5756: version or the pkgsrc version of software to satisfy a
5757: dependency. This is controlled by setting
5758: <code class="varname">PREFER_PKGSRC</code> and
5759: <code class="varname">PREFER_NATIVE</code>. These variables take values
5760: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5761: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5762: use the pkgsrc versions of software, while
5763: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5764: built-in versions. Preferences are determined by the most
5765: specific instance of the package in either
5766: <code class="varname">PREFER_PKGSRC</code> or
5767: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5768: in neither or in both variables, then
5769: <code class="varname">PREFER_PKGSRC</code> has precedence over
5770: <code class="varname">PREFER_NATIVE</code>. For example, to require
5771: using pkgsrc versions of software for all but the most basic
5772: bits on a NetBSD system, you can set:</p>
5773: <pre class="programlisting">
1.100 rillig 5774: PREFER_PKGSRC= yes
5775: PREFER_NATIVE= getopt skey tcp_wrappers
5776: </pre>
1.87 wiz 5777: <p>A package <span class="emphasis"><em>must</em></span> have a
5778: <code class="filename">builtin.mk</code>
5779: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5780: otherwise it is simply ignored in that list.</p>
1.75 rillig 5781: </div>
5782: </div>
5783: </div>
5784: <div class="chapter" lang="en">
5785: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5786: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5787: <div class="toc">
5788: <p><b>Table of Contents</b></p>
5789: <dl>
1.106 rillig 5790: <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 5791: <dd><dl>
1.106 rillig 5792: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5793: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5794: </dl></dd>
1.106 rillig 5795: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5796: <dd><dl>
1.123 snj 5797: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106 rillig 5798: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5799: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5800: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5801: </dl></dd>
5802: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5803: <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>
5804: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5805: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5806: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5807: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5808: <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 5809: </dl>
5810: </div>
5811: <p>This chapter describes the framework known as
5812: <code class="literal">pkginstall</code>, whose key features are:</p>
5813: <div class="itemizedlist"><ul type="disc">
5814: <li><p>Generic installation and manipulation of directories and files
5815: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5816: <li><p>Automatic handling of configuration files during installation,
5817: provided that packages are correctly designed.</p></li>
5818: <li><p>Generation and installation of system startup scripts.</p></li>
5819: <li><p>Registration of system users and groups.</p></li>
5820: <li><p>Registration of system shells.</p></li>
5821: <li><p>Automatic updating of fonts databases.</p></li>
5822: </ul></div>
5823: <p>The following sections inspect each of the above points in detail.</p>
5824: <p>You may be thinking that many of the things described here could be
5825: easily done with simple code in the package's post-installation target
5826: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5827: as the code in them is only executed when building from source. Machines
5828: using binary packages could not benefit from it at all (as the code itself
5829: could be unavailable). Therefore, the only way to achieve any of the items
5830: described above is by means of the installation scripts, which are
5831: automatically generated by pkginstall.</p>
5832: <div class="sect1" lang="en">
5833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5834: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5835: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5836: of files and directories that belong to a package. The names used in it
1.76 rillig 5837: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5838: which means that it cannot register files outside this directory (absolute
5839: path names are not allowed). Despite this restriction, some packages need
5840: to install files outside this location; e.g., under
1.76 rillig 5841: <code class="filename">${VARBASE}</code> or
1.87 wiz 5842: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5843: is to create such files during installation time by using
5844: installation scripts.</p>
5845: <p>The generic installation scripts are shell scripts that can
5846: contain arbitrary code. The list of scripts to execute is taken from
5847: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5848: <code class="filename">INSTALL</code>. A similar variable exists for package
5849: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5850: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5851: commands, so they have the potential to create and manage files
5852: anywhere in the file system.</p>
5853: <p>Using these general installation files is not recommended, but
5854: may be needed in some special cases. One reason for avoiding them is
5855: that the user has to trust the packager that there is no unwanted or
5856: simply erroneous code included in the installation script. Also,
5857: previously there were many similar scripts for the same functionality,
5858: and fixing a common error involved finding and changing all of
5859: them.</p>
5860: <p>The pkginstall framework offers another, standardized way. It
5861: provides generic scripts to abstract the manipulation of such files
5862: and directories based on variables set in the package's
5863: <code class="filename">Makefile</code>. The rest of this section describes
5864: these variables.</p>
1.75 rillig 5865: <div class="sect2" lang="en">
5866: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5867: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5868: <p>The following variables can be set to request the creation of
5869: directories anywhere in the file system:</p>
5870: <div class="itemizedlist"><ul type="disc">
5871: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5872: contain a list of directories that should be created and should attempt
5873: to be destroyed by the installation scripts. The difference between
5874: the two is that the latter prompts the administrator to remove any
5875: directories that may be left after deinstallation (because they were
5876: not empty), while the former does not.</p></li>
5877: <li>
5878: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5879: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5880: which directories should be created and should attempt to be destroyed
5881: by the installation scripts. Each tuple holds the following values,
5882: separated by spaces: the directory name, its owner, its group and its
5883: numerical mode. For example:</p>
5884: <pre class="programlisting">
1.100 rillig 5885: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5886: </pre>
1.75 rillig 5887: <p>The difference between the two is exactly the same as their
5888: non-<code class="varname">PERMS</code> counterparts.</p>
5889: </li>
5890: </ul></div>
5891: </div>
5892: <div class="sect2" lang="en">
5893: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5894: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5895: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5896: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5897: To overcome this problem, the only solution is to extract the file in the
5898: known place (i.e., inside the installation prefix) and copy it to the
5899: appropriate location during installation (done by the installation scripts
5900: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5901: file</em></span> in the following paragraphs, which describe the variables
5902: that can be used to automatically and consistently handle files outside the
5903: installation prefix:</p>
5904: <div class="itemizedlist"><ul type="disc">
5905: <li>
5906: <p><code class="varname">CONF_FILES</code> and
5907: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5908: During installation time, the master file is copied to the target one
5909: if and only if the latter does not exist. Upon deinstallation, the
5910: target file is removed provided that it was not modified by the
5911: installation.</p>
5912: <p>The difference between the two is that the latter prompts the
5913: administrator to remove any files that may be left after
5914: deinstallation (because they were not empty), while the former does
5915: not.</p>
5916: </li>
5917: <li>
5918: <p><code class="varname">CONF_FILES_PERMS</code> and
5919: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5920: files as well as their target locations. For each of them, it also
5921: specifies their owner, their group and their numeric permissions, in
5922: this order. For example:</p>
5923: <pre class="programlisting">
1.100 rillig 5924: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5925: </pre>
1.75 rillig 5926: <p>The difference between the two is exactly the same as their
5927: non-<code class="varname">PERMS</code> counterparts.</p>
5928: </li>
5929: </ul></div>
5930: </div>
5931: </div>
5932: <div class="sect1" lang="en">
5933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5934: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5935: <p>Configuration files are special in the sense that they are installed
5936: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5937: need special treatment during installation (most of which is automated by
5938: pkginstall). The main concept you must bear in mind is that files marked
5939: as configuration files are automatically copied to the right place (somewhere
5940: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5941: and only if</em></span> they didn't exist before. Similarly, they will not
5942: be removed if they have local modifications. This ensures that
5943: administrators never lose any custom changes they may have made.</p>
5944: <div class="sect2" lang="en">
5945: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5946: <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 5947: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5948: specifies where configuration files shall be installed. Its contents are
5949: set based upon the following variables:</p>
5950: <div class="itemizedlist"><ul type="disc">
5951: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5952: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5953: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5954: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5955: Packages must not use it directly.</p></li>
5956: <li>
5957: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5958: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5959: for the package being built shall be installed. The definition of this
5960: variable only makes sense in the package's
1.76 rillig 5961: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5962: <p>As an example, consider the Apache package,
1.91 rillig 5963: <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 5964: configuration files under the
1.76 rillig 5965: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5966: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5967: Makefile.</p>
5968: </li>
5969: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5970: variable that holds this package's configuration directory (if
5971: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5972: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5973: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5974: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5975: directory where the configuration files for the package identified by
5976: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5977: </ul></div>
5978: <p>Based on the above variables, pkginstall determines the value of
5979: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5980: variable that can be used within a package to refer to its configuration
5981: directory. The algorithm used to set its value is basically the
5982: following:</p>
5983: <div class="orderedlist"><ol type="1">
5984: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5985: its value is used.</p></li>
5986: <li><p>If the previous variable is not defined but
5987: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5988: <code class="filename">Makefile</code>, the resulting value is
5989: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 5990: <li><p>Otherwise, it is set to
1.76 rillig 5991: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5992: </ol></div>
1.76 rillig 5993: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5994: 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
5995: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5996: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5997: </div>
5998: <div class="sect2" lang="en">
5999: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6000: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 6001: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6002: known place, you need to teach each package where it shall install its
6003: files. In some cases you will have to patch the package Makefiles to
6004: achieve it. If you are lucky, though, it may be as easy as passing an
6005: extra flag to the configuration script; this is the case of GNU Autoconf-
6006: generated files:</p>
6007: <pre class="programlisting">
1.100 rillig 6008: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 6009: </pre>
1.75 rillig 6010: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6011: for</em></span> its configuration files, not where they will be originally
6012: installed (although the difference is never explicit,
6013: unfortunately).</p>
6014: </div>
6015: <div class="sect2" lang="en">
6016: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6017: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6018: <p>As said before, pkginstall automatically handles configuration files.
6019: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6020: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6021: directly</strong></span>. Bad news is that many software installation scripts
6022: will, out of the box, mess with the contents of that directory. So what is
6023: the correct procedure to fix this issue?</p>
6024: <p>You must teach the package (usually by manually patching it) to
6025: install any configuration files under the examples hierarchy,
1.76 rillig 6026: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6027: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6028: has the original copies available.</p>
6029: <p>Once the required configuration files are in place (i.e., under the
6030: examples hierarchy), the pkginstall framework can use them as master copies
6031: during the package installation to update what is in
1.76 rillig 6032: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6033: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 6034: 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 6035: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6036: <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 6037: <pre class="programlisting">
1.100 rillig 6038: EGDIR= ${PREFIX}/share/doc/mutt/samples
6039: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6040: </pre>
1.75 rillig 6041: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6042: package and has no meaning outside it.</p>
6043: </div>
6044: <div class="sect2" lang="en">
6045: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6046: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6047: <p>The automatic copying of config files can be toggled by setting the
6048: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6049: installation.</p>
6050: </div>
6051: </div>
6052: <div class="sect1" lang="en">
6053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6054: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 6055: <p>System startup scripts are special files because they must be
6056: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 6057: 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 6058: can be used. However, pkginstall provides a special mechanism to handle
6059: these files.</p>
6060: <p>In order to provide system startup scripts, the package has
6061: to:</p>
6062: <div class="orderedlist"><ol type="1">
1.76 rillig 6063: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6064: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6065: <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 6066: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6067: <li>
6068: <p>Tell pkginstall to handle it, appending the name of the script,
6069: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6070: Continuing the previous example:</p>
6071: <pre class="programlisting">
1.100 rillig 6072: RCD_SCRIPTS+= cupsd
1.1 grant 6073: </pre>
1.75 rillig 6074: </li>
6075: </ol></div>
6076: <p>Once this is done, pkginstall will do the following steps for each
6077: script in an automated fashion:</p>
6078: <div class="orderedlist"><ol type="1">
6079: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6080: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6081: variable.</p></li>
6082: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6083: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6084: that this master file must be explicitly registered in the
1.76 rillig 6085: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6086: <li><p>Add code to the installation scripts to copy the startup script
6087: from the examples hierarchy into the system-wide startup scripts
6088: directory.</p></li>
6089: </ol></div>
6090: <div class="sect2" lang="en">
6091: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6092: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6093: <p>The automatic copying of config files can be toggled by setting the
6094: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6095: installation. Note that the scripts will be always copied inside the
1.76 rillig 6096: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6097: matter what the value of this variable is.</p>
6098: </div>
6099: </div>
6100: <div class="sect1" lang="en">
6101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6102: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 6103: <p>If a package needs to create special users and/or groups during
6104: installation, it can do so by using the pkginstall framework.</p>
6105: <p>Users can be created by adding entries to the
6106: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6107: syntax:</p>
6108: <pre class="programlisting">
1.100 rillig 6109: user:group
1.1 grant 6110: </pre>
1.87 wiz 6111: <p>Further specification of user details may be done by setting
6112: per-user variables.
6113: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6114: numeric UID for the user.
6115: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6116: user's description or comment.
6117: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6118: user's home directory, and defaults to
6119: <code class="filename">/nonexistent</code> if not specified.
6120: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6121: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6122: not specified.</p>
1.75 rillig 6123: <p>Similarly, groups can be created by adding entries to the
6124: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6125: <pre class="programlisting">
1.100 rillig 6126: group
1.1 grant 6127: </pre>
1.93 rillig 6128: <p>The numeric GID of the group may be set by defining
1.75 rillig 6129: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6130: <p>If a package needs to create the users and groups at an earlier
6131: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6132: either <code class="literal">configure</code> or <code class="literal">build</code> to
6133: indicate the phase before which the users and groups are created. In
6134: this case, the numeric UIDs and GIDs of the created users and groups
6135: are automatically hardcoded into the final installation scripts.</p>
6136: </div>
6137: <div class="sect1" lang="en">
6138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6139: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 6140: <p>Packages that install system shells should register them in the shell
1.76 rillig 6141: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6142: administrator. This must be done from the installation scripts to keep
6143: binary packages working on any system. pkginstall provides an easy way to
6144: accomplish this task.</p>
6145: <p>When a package provides a shell interpreter, it has to set the
6146: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6147: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6148: 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 6149: <pre class="programlisting">
1.100 rillig 6150: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6151: </pre>
1.75 rillig 6152: <div class="sect2" lang="en">
6153: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6154: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6155: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6156: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6157: environment variable to <code class="literal">NO</code>.</p>
6158: </div>
6159: </div>
6160: <div class="sect1" lang="en">
6161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6162: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 6163: <p>Packages that install X11 fonts should update the database files
6164: that index the fonts within each fonts directory. This can easily be
6165: accomplished within the pkginstall framework.</p>
6166: <p>When a package installs X11 fonts, it must list the directories in
6167: which fonts are installed in the
6168: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6169: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6170: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6171: installation scripts to run the appropriate commands to update the fonts
6172: database files within each of those directories. For convenience, if the
6173: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6174: 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 6175: <pre class="programlisting">
1.100 rillig 6176: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6177: </pre>
1.75 rillig 6178: <div class="sect2" lang="en">
6179: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6180: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6181: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6182: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6183: environment variable to <code class="literal">NO</code>.</p>
6184: </div>
6185: </div>
6186: </div>
6187: <div class="chapter" lang="en">
6188: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6189: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6190: <div class="toc">
6191: <p><b>Table of Contents</b></p>
6192: <dl>
1.106 rillig 6193: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.123 snj 6194: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106 rillig 6195: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6196: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6197: </dl>
6198: </div>
6199: <p>Many packages have the ability to be built to support different
1.76 rillig 6200: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6201: in pkgsrc that provides generic handling of those options that
6202: determine different ways in which the packages can be built. It's
6203: possible for the user to specify exactly which sets of options will be
6204: built into a package or to allow a set of global default options
6205: apply.</p>
1.107 rillig 6206: <p>There are two broad classes of behaviors that one might want to
6207: control via options. One is whether some particular feature is
6208: enabled in a program that will be built anyway, often by including or
6209: not including a dependency on some other package. The other is
6210: whether or not an additional program will be built as part of the
6211: package. Generally, it is better to make a split package for such
6212: additional programs instead of using options, because it enables
6213: binary packages to be built which can then be added separately. For
6214: example, the foo package might have minimal dependencies (those
6215: packages without which foo doesn't make sense), and then the foo-gfoo
6216: package might include the GTK frontend program gfoo. This is better
6217: than including a gtk option to foo that adds gfoo, because either that
6218: option is default, in which case binary users can't get foo without
6219: gfoo, or not default, in which case they can't get gfoo. With split
6220: packages, they can install foo without having GTK, and later decide to
6221: install gfoo (pulling in GTK at that time). This is an advantage to
6222: source users too, avoiding the need for rebuilds.</p>
6223: <p>Plugins with widely varying dependencies should usually be split
6224: instead of options.</p>
6225: <p>It is often more work to maintain split packages, especially if
6226: the upstream package does not support this. The decision of split
6227: vs. option should be made based on the likelihood that users will want
6228: or object to the various pieces, the size of the dependencies that are
6229: included, and the amount of work.</p>
6230: <p>A further consideration is licensing. Non-free parts, or parts
6231: that depend on non-free dependencies (especially plugins) should
6232: almost always be split if feasible.</p>
1.75 rillig 6233: <div class="sect1" lang="en">
6234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6235: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6236: <p>Global default options are listed in
6237: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6238: that should be built into every package if that option is supported.
1.110 hubertf 6239: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6240: </div>
6241: <div class="sect1" lang="en">
6242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6243: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6244: </h2></div></div></div>
1.75 rillig 6245: <p>The following example shows how
1.76 rillig 6246: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6247: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6248: <code class="filename">Makefile</code>, or in a file,
6249: e.g. <code class="filename">options.mk</code>, that is included by the
6250: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6251: <pre class="programlisting">
1.100 rillig 6252: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6253: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6254: PKG_OPTIONS_OPTIONAL_GROUPS= database
6255: PKG_OPTIONS_GROUP.database= mysql pgsql
6256: PKG_SUGGESTED_OPTIONS= wibble-foo
6257: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6258: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6259:
6260: .include "../../mk/bsd.prefs.mk"
6261:
6262: # this package was previously named wibble2
6263: .if defined(PKG_OPTIONS.wibble2)
6264: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6265: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6266: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6267: .endif
6268:
6269: .include "../../mk/bsd.options.mk"
6270:
6271: # Package-specific option-handling
6272:
6273: ###
6274: ### FOO support
6275: ###
6276: .if !empty(PKG_OPTIONS:Mwibble-foo)
6277: CONFIGURE_ARGS+= --enable-foo
6278: .endif
6279:
6280: ###
6281: ### LDAP support
6282: ###
6283: .if !empty(PKG_OPTIONS:Mldap)
6284: . include "../../databases/openldap-client/buildlink3.mk"
6285: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6286: .endif
6287:
6288: ###
6289: ### database support
6290: ###
6291: .if !empty(PKG_OPTIONS:Mmysql)
6292: . include "../../mk/mysql.buildlink3.mk"
6293: .endif
6294: .if !empty(PKG_OPTIONS:Mpgsql)
6295: . include "../../mk/pgsql.buildlink3.mk"
6296: .endif
1.75 rillig 6297: </pre>
6298: <p>The first section contains the information about which build
6299: options are supported by the package, and any default options settings
6300: if needed.</p>
6301: <div class="orderedlist"><ol type="1">
6302: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110 hubertf 6303: <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 6304: options. It should be set to
1.78 rillig 6305: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6306: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6307: at the point where the options are processed.</p></li>
1.75 rillig 6308: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6309: build options supported by the package.</p></li>
6310: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6311: list of names of groups of mutually exclusive options. The options in
6312: each group are listed in
6313: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6314: The most specific setting of any option from the group takes
6315: precedence over all other options in the group. Options from the
6316: groups will be automatically added to
6317: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6318: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6319: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6320: packages will fail if no option from the group is
6321: selected.</p></li>
6322: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6323: of names of sets of options. At least one option from each set must
6324: be selected. The options in each set are listed in
6325: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6326: Options from the sets will be automatically added to
6327: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6328: fail if no option from the set is selected.</p></li>
6329: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6330: build options which are enabled by default.</p></li>
6331: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6332: of
6333: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.110 hubertf 6334: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6335: their option counterparts. Pairs should be added with
6336: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6337: warning will be issued if the user uses a legacy
6338: variable.</p></li>
6339: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6340: of
6341: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6342: pairs that map options that have been renamed to their new
6343: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6344: the listing of global legacy options. A warning will be issued if
6345: the user uses a legacy option.</p></li>
6346: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6347: options implied by deprecated variables used. This can be used for
6348: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6349: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6350: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6351: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6352: a list of warnings about deprecated variables or options used, and
6353: what to use instead.</p></li>
6354: </ol></div>
6355: <p>A package should never modify
6356: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6357: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6358: To suggest a default set of options, use
6359: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6360: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6361: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6362: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6363: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6364: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6365: happen with platform-specific options if none of them is supported on
6366: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6367: empty list and the package is otherwise treated as not using the
6368: options framework.</p>
1.76 rillig 6369: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6370: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6371: build options, properly filtered to remove unsupported and duplicate
6372: options.</p>
6373: <p>The remaining sections contain the logic that is specific to
6374: each option. The correct way to check for an option is to check
6375: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6376: <pre class="programlisting">
1.100 rillig 6377: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6378: </pre>
6379: </div>
6380: <div class="sect1" lang="en">
6381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6382: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6383: <p>Options that enable similar features in different packages (like
6384: optional support for a library) should use a common name in all
6385: packages that support it (like the name of the library). If another
6386: package already has an option with the same meaning, use the same
6387: name.</p>
6388: <p>Options that enable features specific to one package, where it's
6389: unlikely that another (unrelated) package has the same (or a similar)
6390: optional feature, should use a name prefixed with
6391: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6392: <p>If a group of related packages share an optional feature
6393: specific to that group, prefix it with the name of the
6394: “<span class="quote">main</span>” package
6395: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6396: <p>For new options, add a line to
1.76 rillig 6397: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6398: fields, separated by tab. The first field is the option name, the
6399: second its description. The description should be a whole sentence
6400: (starting with an uppercase letter and ending with a period) that
6401: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6402: support.</span>” The file is sorted by option names.</p>
6403: </div>
1.107 rillig 6404: <div class="sect1" lang="en">
6405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6406: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6407: <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 6408: different dependencies based on the options with which the package was
6409: built. For querying these options, the file
6410: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6411: typical example looks like this:</p>
6412: <pre class="programlisting">
6413: pkgbase := libpurple
6414: .include "../../mk/pkg-build-options.mk"
6415:
6416: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6417: ...
6418: .endif
6419: </pre>
6420: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6421: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6422: options of the libpurple package, which can then be queried like
6423: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6424: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6425: details.</p>
6426: </div>
1.75 rillig 6427: </div>
6428: <div class="chapter" lang="en">
6429: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6430: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6431: <div class="toc">
6432: <p><b>Table of Contents</b></p>
6433: <dl>
1.106 rillig 6434: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6435: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6436: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6437: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.123 snj 6438: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106 rillig 6439: <dd><dl>
6440: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6441: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6442: </dl></dd>
1.123 snj 6443: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
6444: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
6445: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
6446: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
6447: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
6448: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
6449: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
6450: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
6451: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
6452: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106 rillig 6453: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6454: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6455: </dl>
6456: </div>
6457: <div class="sect1" lang="en">
6458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6459: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6460: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6461: built. Building a package is separated into different
6462: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6463: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6464: described in the following sections. Each phase is split into
1.87 wiz 6465: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6466: containing phase, prefixed by one of <code class="varname">pre-</code>,
6467: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6468: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6469: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6470: <p>Never override the regular targets (like
6471: <code class="varname">fetch</code>), if you have to, override the
6472: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6473: <p>The basic steps for building a program are always the same. First
1.87 wiz 6474: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6475: the local system and then extracted. After any pkgsrc-specific patches
6476: to compile properly are applied, the software can be configured, then
6477: built (usually by compiling), and finally the generated binaries, etc.
6478: can be put into place on the system.</p>
1.97 rillig 6479: <p>To get more details about what is happening at each step,
6480: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6481: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6482: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6483: </div>
6484: <div class="sect1" lang="en">
6485: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6486: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6487: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6488: the next section, here's a brief discussion on where programs are
6489: installed, and which variables influence this.</p>
1.75 rillig 6490: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6491: where all files of the final program shall be installed. It is
6492: usually set to <code class="varname">LOCALBASE</code>
6493: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6494: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6495: <code class="varname">PREFIX</code> needs to be put
6496: into the various places in the program's source where paths to
1.110 hubertf 6497: 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 6498: <p>When choosing which of these variables to use,
1.87 wiz 6499: follow the following rules:</p>
1.75 rillig 6500: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6501: <li><p><code class="varname">PREFIX</code> always points to the location
6502: where the current pkg will be installed. When referring to a
6503: pkg's own installation path, use
6504: “<span class="quote">${PREFIX}</span>”.</p></li>
6505: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6506: are installed. If you need to construct a -I or -L argument
6507: to the compiler to find includes and libraries installed by
6508: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6509: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6510: installed all packages in <code class="filename">/usr/local</code>. As
6511: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6512: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6513: <li><p><code class="varname">X11BASE</code> is where the actual X11
6514: distribution (from xsrc, etc.) is installed. When looking for
6515: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6516: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6517: <li>
6518: <p>X11-based packages are special in that they may be
6519: installed in either <code class="varname">X11BASE</code> or
6520: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6521: <p>Usually, X11 packages should be installed under
1.88 wiz 6522: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6523: will need to include
6524: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6525: request the presence of X11 and to get the right compilation
6526: flags.</p>
1.75 rillig 6527: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6528: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6529: files. These packages are special and they must be placed under
6530: <code class="varname">X11BASE</code>. To accomplish this, set either
6531: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6532: your package.</p>
1.75 rillig 6533: <p>Some notes: If you need
1.87 wiz 6534: to find includes or libraries installed by a pkg that has
6535: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6536: its pkg <code class="filename">Makefile</code>, you need to look in
6537: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6538: <code class="filename">${LOCALBASE}</code>. To force installation of
6539: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6540: <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 6541: is enabled by default.</p>
1.75 rillig 6542: </li>
1.88 wiz 6543: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6544: the installed location of an X11
6545: package. <code class="varname">X11PREFIX</code> will be set to
6546: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6547: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6548: installed.</p></li>
6549: <li>
6550: <p>If xpkgwedge is installed, it is possible to have some
6551: packages installed in <code class="varname">X11BASE</code> and some in
6552: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6553: installed package, the <code class="varname">EVAL_PREFIX</code>
6554: definition can be used. It takes pairs in the format
1.110 hubertf 6555: “<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 6556: variable <code class="varname">DIRNAME</code> will be set to the prefix
6557: of the installed package <package>, or
6558: “<span class="quote">${X11PREFIX}</span>” if the package is not
6559: installed.</p>
1.75 rillig 6560: <p>This is best illustrated by example.</p>
6561: <p>The following lines are taken from
1.87 wiz 6562: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6563: <pre class="programlisting">
1.100 rillig 6564: EVAL_PREFIX+= GTKDIR=gtk+
6565: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6566: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6567: CONFIGURE_ARGS+= --enable-multibyte
6568: </pre>
1.88 wiz 6569: <p>Specific defaults can be defined for the packages
6570: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6571: definition of the form:</p>
1.75 rillig 6572: <pre class="programlisting">
1.100 rillig 6573: GTKDIR_DEFAULT= ${LOCALBASE}
6574: </pre>
1.75 rillig 6575: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6576: to the first definition in
6577: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6578: </li>
1.76 rillig 6579: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110 hubertf 6580: 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 6581: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6582: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6583: </ul></div>
6584: </div>
6585: <div class="sect1" lang="en">
6586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6587: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6588: <p>When building a package, various directories are used to store
1.87 wiz 6589: source files, temporary files, pkgsrc-internal files, and so on. These
6590: directories are explained here.</p>
1.75 rillig 6591: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6592: are two common base directories for these relative directories:
6593: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6594: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6595: inside the package itself.</p>
1.75 rillig 6596: <div class="variablelist"><dl>
6597: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6598: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6599: root directory. Generally, you don't need
6600: it.</p></dd>
1.97 rillig 6601: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6602: <dd><p>This is an absolute pathname that points to the
6603: current package.</p></dd>
1.75 rillig 6604: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6605: <dd><p>This is a pathname relative to
1.87 wiz 6606: <code class="varname">PKGSRCDIR</code> that points to the current
6607: package.</p></dd>
1.75 rillig 6608: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6609: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6610: where all work takes place. The distfiles are extracted to this
1.87 wiz 6611: directory. It also contains temporary directories and log files used by
6612: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6613: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6614: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6615: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6616: where the distfiles are extracted. It is usually a direct subdirectory
6617: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6618: that isn't hidden. This variable may be changed by a package
6619: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6620: </dl></div>
1.114 jmcneill 6621: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6622: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6623: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6624: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6625: If users would like to have their pkgsrc trees behave in a
6626: read-only manner, then the value of
6627: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6628: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6629: </div>
6630: <div class="sect1" lang="en">
6631: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6632: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6633: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6634: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6635: phase. This will automatically run all phases that are required for this
6636: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6637: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6638: the package will be built, but not installed.</p>
1.75 rillig 6639: </div>
6640: <div class="sect1" lang="en">
6641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6642: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6643: <p>The first step in building a package is to fetch the
1.88 wiz 6644: distribution files (distfiles) from the sites that are providing
6645: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6646: phase.</p>
1.81 rillig 6647: <div class="sect2" lang="en">
6648: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6649: <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 6650: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6651: defines all URLs from where the distfile, whose name is
6652: derived from the <code class="varname">DISTNAME</code> variable, is
6653: fetched. The more complicated cases are described
6654: below.</p>
6655: <p>The variable <code class="varname">DISTFILES</code> specifies
6656: the list of distfiles that have to be fetched. Its value
6657: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6658: so that most packages don't need to define it at all.
6659: <code class="varname">EXTRACT_SUFX</code> is
6660: <code class="literal">.tar.gz</code> by default, but can be changed
6661: freely. Note that if your package requires additional
6662: distfiles to the default one, you cannot just append the
6663: additional filenames using the <code class="literal">+=</code>
6664: operator, but you have write for example:</p>
1.81 rillig 6665: <pre class="programlisting">
1.100 rillig 6666: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6667: </pre>
1.88 wiz 6668: <p>Each distfile is fetched from a list of sites, usually
6669: <code class="varname">MASTER_SITES</code>. If the package has multiple
6670: <code class="varname">DISTFILES</code> or multiple
6671: <code class="varname">PATCHFILES</code> from different sites, you can
6672: set
6673: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6674: to the list of URLs where the file
6675: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6676: (including the suffix) can be found.</p>
6677: <pre class="programlisting">
1.100 rillig 6678: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6679: DISTFILES+= foo-file.tar.gz
6680: SITES.foo-file.tar.gz= \
6681: http://www.somewhere.com/somehow/ \
6682: http://www.somewhereelse.com/mirror/somehow/
6683: </pre>
1.81 rillig 6684: <p>When actually fetching the distfiles, each item from
1.88 wiz 6685: <code class="varname">MASTER_SITES</code> or
6686: <code class="varname">SITES.*</code> gets the name of each distfile
6687: appended to it, without an intermediate slash. Therefore,
6688: all site values have to end with a slash or other separator
6689: character. This allows for example to set
6690: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6691: that gets the name of the distfile as a parameter. In this
6692: case, the definition would look like:</p>
1.81 rillig 6693: <pre class="programlisting">
1.100 rillig 6694: MASTER_SITES= http://www.example.com/download.cgi?file=
6695: </pre>
1.125 wiz 6696: <p> The exception to this rule are URLs starting with a dash.
6697: In that case the URL is taken as is, fetched and the result stored
6698: under the name of the distfile.</p>
1.81 rillig 6699: <p>There are some predefined values for
1.88 wiz 6700: <code class="varname">MASTER_SITES</code>, which can be used in
6701: packages. The names of the variables should speak for
6702: themselves.</p>
6703: <pre class="programlisting">
1.100 rillig 6704: ${MASTER_SITE_APACHE}
6705: ${MASTER_SITE_BACKUP}
6706: ${MASTER_SITE_CYGWIN}
6707: ${MASTER_SITE_DEBIAN}
6708: ${MASTER_SITE_FREEBSD}
6709: ${MASTER_SITE_FREEBSD_LOCAL}
6710: ${MASTER_SITE_GENTOO}
6711: ${MASTER_SITE_GNOME}
6712: ${MASTER_SITE_GNU}
6713: ${MASTER_SITE_GNUSTEP}
6714: ${MASTER_SITE_IFARCHIVE}
6715: ${MASTER_SITE_KDE}
6716: ${MASTER_SITE_MOZILLA}
6717: ${MASTER_SITE_MYSQL}
6718: ${MASTER_SITE_OPENOFFICE}
6719: ${MASTER_SITE_PERL_CPAN}
6720: ${MASTER_SITE_PGSQL}
6721: ${MASTER_SITE_R_CRAN}
6722: ${MASTER_SITE_SOURCEFORGE}
6723: ${MASTER_SITE_SOURCEFORGE_JP}
6724: ${MASTER_SITE_SUNSITE}
6725: ${MASTER_SITE_SUSE}
6726: ${MASTER_SITE_TEX_CTAN}
6727: ${MASTER_SITE_XCONTRIB}
6728: ${MASTER_SITE_XEMACS}
6729: </pre>
1.88 wiz 6730: <p>Some explanations for the less self-explaining ones:
6731: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110 hubertf 6732: 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
6733: 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 6734: <p>If you choose one of these predefined sites, you may
6735: want to specify a subdirectory of that site. Since these
6736: macros may expand to more than one actual site, you
6737: <span class="emphasis"><em>must</em></span> use the following construct to
6738: specify a subdirectory:</p>
1.81 rillig 6739: <pre class="programlisting">
1.100 rillig 6740: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6741: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6742: </pre>
1.81 rillig 6743: <p>Note the trailing slash after the subdirectory
1.88 wiz 6744: name.</p>
1.81 rillig 6745: </div>
6746: <div class="sect2" lang="en">
6747: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6748: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6749: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6750: all the distfiles exist in a local directory
1.93 rillig 6751: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6752: user). If the files do not exist, they are fetched using
6753: commands of the form</p>
1.75 rillig 6754: <pre class="programlisting">
1.100 rillig 6755: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6756: </pre>
1.88 wiz 6757: <p>where <code class="literal">${site}</code> varies through
6758: several possibilities in turn: first,
6759: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6760: sites specified in either <code class="varname">SITES.file</code> if
6761: defined, else <code class="varname">MASTER_SITES</code> or
6762: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6763: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6764: all except the first and the last can be optionally sorted
6765: by the user, via setting either
6766: <code class="varname">MASTER_SORT_RANDOM</code>, and
6767: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6768: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6769: <p> The specific command and arguments used depend on the
6770: <code class="varname">FETCH_USING</code> parameter. The example above is
6771: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6772: <p>The distfiles mirror run by the NetBSD Foundation uses the
6773: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6774: distfiles, if they are freely distributable. Packages setting
6775: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6776: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6777: mirrored.</p>
1.81 rillig 6778: </div>
1.75 rillig 6779: </div>
6780: <div class="sect1" lang="en">
6781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6782: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6783: <p>After the distfile(s) are fetched, their checksum is
6784: generated and compared with the checksums stored in the
6785: distinfo file. If the checksums don't match, the build is
6786: aborted. This is to ensure the same distfile is used for
6787: building, and that the distfile wasn't changed, e.g. by some
6788: malign force, deliberately changed distfiles on the master
6789: distribution site or network lossage.</p>
1.75 rillig 6790: </div>
6791: <div class="sect1" lang="en">
6792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6793: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6794: <p>When the distfiles are present on the local system, they
1.88 wiz 6795: need to be extracted, as they usually come in the form of some
6796: compressed archive format.</p>
1.75 rillig 6797: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6798: extracted. If you only need some of them, you can set the
6799: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6800: files.</p>
6801: <p>Extracting the files is usually done by a little
1.93 rillig 6802: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6803: already knows how to extract various archive formats, so most
6804: likely you will not need to change anything here. But if you
6805: need, the following variables may help you:</p>
1.75 rillig 6806: <div class="variablelist"><dl>
6807: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6808: <dd><p>Use these variables to override the default
1.88 wiz 6809: options for an extract command, which are defined in
1.93 rillig 6810: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6811: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6812: <dd><p>This variable can be set to
1.114 jmcneill 6813: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6814: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6815: absolute pathname pointing to the command with which tar
1.114 jmcneill 6816: archives should be extracted. It is preferred to choose bsdtar over gtar
6817: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6818: </dl></div>
1.88 wiz 6819: <p>If the <code class="filename">extract</code> program doesn't
6820: serve your needs, you can also override the
6821: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6822: command used for extracting the files. This command is
6823: executed in the <code class="filename">${WRKSRC}</code>
6824: directory. During execution of this command, the shell
6825: variable <code class="varname">extract_file</code> holds the absolute
6826: pathname of the file that is going to be extracted.</p>
1.75 rillig 6827: <p>And if that still does not suffice, you can override the
1.88 wiz 6828: <code class="varname">do-extract</code> target in the package
6829: Makefile.</p>
1.75 rillig 6830: </div>
6831: <div class="sect1" lang="en">
6832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6833: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6834: <p>After extraction, all the patches named by the
1.88 wiz 6835: <code class="varname">PATCHFILES</code>, those present in the patches
6836: subdirectory of the package as well as in
6837: $LOCALPATCHES/$PKGPATH (e.g.
6838: <code class="filename">/usr/local/patches/graphics/png</code>) are
6839: applied. Patchfiles ending in <code class="filename">.Z</code> or
6840: <code class="filename">.gz</code> are uncompressed before they are
6841: applied, files ending in <code class="filename">.orig</code> or
6842: <code class="filename">.rej</code> are ignored. Any special options to
1.110 hubertf 6843: <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
6844: <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>
6845: <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 6846: it fail if the patches apply with some lines of fuzz. Please
6847: fix (regen) the patches so that they apply cleanly. The
6848: rationale behind this is that patches that don't apply cleanly
6849: may end up being applied in the wrong place, and cause severe
6850: harm there.</p>
1.75 rillig 6851: </div>
6852: <div class="sect1" lang="en">
6853: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6854: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6855: <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 6856: </p>
1.75 rillig 6857: </div>
6858: <div class="sect1" lang="en">
6859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6860: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6861: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6862: linkers. The following variables can be used to tweak the
6863: wrappers.</p>
1.75 rillig 6864: <div class="variablelist"><dl>
6865: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6866: <dd><p>The command used to print progress
1.88 wiz 6867: messages. Does nothing by default. Set to
6868: <code class="literal">${ECHO}</code> to see the progress
6869: messages.</p></dd>
1.75 rillig 6870: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6871: <dd><p>This variable can be set to
1.88 wiz 6872: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6873: depending on whether you want additional information in the
6874: wrapper log file.</p></dd>
1.75 rillig 6875: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6876: <dd><p>This variable can be set to
1.88 wiz 6877: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6878: on whether the wrapper should use its cache, which will
6879: improve the speed. The default value is
6880: <code class="literal">yes</code>, but is forced to
6881: <code class="literal">no</code> if the platform does not support
6882: it.</p></dd>
1.75 rillig 6883: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6884: <dd><p>A list of reordering commands. A reordering
6885: command has the form
6886: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6887: It ensures that that
6888: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6889: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6890: </p></dd>
1.75 rillig 6891: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6892: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6893: investigate further]</p></dd>
1.75 rillig 6894: </dl></div>
6895: </div>
6896: <div class="sect1" lang="en">
6897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6898: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6899: <p>Most pieces of software need information on the header
6900: files, system calls, and library routines which are available
6901: on the platform they run on. The process of determining this
6902: information is known as configuration, and is usually
6903: automated. In most cases, a script is supplied with the
6904: distfiles, and its invocation results in generation of header
6905: files, Makefiles, etc.</p>
6906: <p>If the package contains a configure script, this can be
6907: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6908: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6909: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6910: “<span class="quote">yes</span>” instead. What happens in the
6911: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6912: <pre class="programlisting">
1.100 rillig 6913: .for d in ${CONFIGURE_DIRS}
6914: cd ${WRKSRC} \
6915: && cd ${d} \
6916: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6917: .endfor
6918: </pre>
1.88 wiz 6919: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6920: “<span class="quote">.</span>”) is a list of pathnames relative to
6921: <code class="varname">WRKSRC</code>. In each of these directories, the
6922: configure script is run with the environment
6923: <code class="varname">CONFIGURE_ENV</code> and arguments
6924: <code class="varname">CONFIGURE_ARGS</code>. The variables
6925: <code class="varname">CONFIGURE_ENV</code>,
6926: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6927: “<span class="quote">./configure</span>”) and
6928: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6929: package.</p>
6930: <p>If the program uses an <code class="filename">Imakefile</code>
6931: for configuration, the appropriate steps can be invoked by
6932: setting <code class="varname">USE_IMAKE</code> to
6933: “<span class="quote">yes</span>”. (If you only want the package installed in
6934: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6935: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6936: xmkmf's environment by adding them to the
6937: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6938: <p>If the program uses <code class="filename">cmake</code>
6939: for configuration, the appropriate steps can be invoked by
6940: setting <code class="varname">USE_CMAKE</code> to “<span class="quote">yes</span>”.
6941: You can add variables to cmake's environment by adding them to the
6942: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6943: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6944: The top directory argument is given by the
6945: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
6946: “<span class="quote">.</span>” (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6947: <p>If there is no configure step at all, set
6948: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6949: </div>
6950: <div class="sect1" lang="en">
6951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6952: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6953: <p>For building a package, a rough equivalent of the
6954: following code is executed.</p>
1.75 rillig 6955: <pre class="programlisting">
1.100 rillig 6956: .for d in ${BUILD_DIRS}
6957: cd ${WRKSRC} \
6958: && cd ${d} \
6959: && env ${MAKE_ENV} \
6960: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6961: -f ${MAKE_FILE} \
6962: ${BUILD_TARGET}
6963: .endfor
6964: </pre>
1.88 wiz 6965: <p><code class="varname">BUILD_DIRS</code> (default:
6966: “<span class="quote">.</span>”) is a list of pathnames relative to
6967: <code class="varname">WRKSRC</code>. In each of these directories,
6968: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6969: <code class="varname">MAKE_ENV</code> and arguments
6970: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6971: <code class="varname">MAKE_ENV</code>,
6972: <code class="varname">BUILD_MAKE_FLAGS</code>,
6973: <code class="varname">MAKE_FILE</code> and
6974: <code class="varname">BUILD_TARGET</code> may all be changed by the
6975: package.</p>
1.75 rillig 6976: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6977: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6978: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6979: default value of <code class="varname">MAKE_FILE</code> is
6980: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6981: defaults to “<span class="quote">all</span>”.</p>
1.97 rillig 6982: <p>If there is no build step at all, set
6983: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6984: </div>
6985: <div class="sect1" lang="en">
6986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6987: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6988: <p>[TODO]</p>
6989: </div>
6990: <div class="sect1" lang="en">
6991: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6992: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6993: <p>Once the build stage has completed, the final step is to
1.88 wiz 6994: install the software in public directories, so users can
6995: access the programs and files.</p>
1.75 rillig 6996: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6997: equivalent of the following code is executed. Additionally,
6998: before and after this code, much magic is performed to do
6999: consistency checks, registering the package, and so on.</p>
7000: <pre class="programlisting">
1.100 rillig 7001: .for d in ${INSTALL_DIRS}
7002: cd ${WRKSRC} \
7003: && cd ${d} \
7004: && env ${MAKE_ENV} \
7005: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7006: -f ${MAKE_FILE} \
7007: ${INSTALL_TARGET}
7008: .endfor
7009: </pre>
1.75 rillig 7010: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 7011: <span class="emphasis"><em>build</em></span> phase.
7012: <code class="varname">INSTALL_DIRS</code> defaults to
7013: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
7014: is “<span class="quote">install</span>” by default, plus
7015: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
7016: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7017: defined.</p>
1.75 rillig 7018: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 7019: variables are useful. They are all variations of the
1.110 hubertf 7020: <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 7021: permissions preset. <code class="varname">INSTALL</code> is the plain
7022: install command. The specialized variants, together with their
7023: intended use, are:</p>
1.75 rillig 7024: <div class="variablelist"><dl>
7025: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7026: <dd><p>directories that contain
7027: binaries</p></dd>
1.75 rillig 7028: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7029: <dd><p>directories that contain
7030: scripts</p></dd>
1.75 rillig 7031: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7032: <dd><p>directories that contain shared and static
7033: libraries</p></dd>
1.75 rillig 7034: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7035: <dd><p>directories that contain data
7036: files</p></dd>
1.75 rillig 7037: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7038: <dd><p>directories that contain man
7039: pages</p></dd>
1.75 rillig 7040: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7041: <dd><p>binaries that can be stripped from debugging
7042: symbols</p></dd>
1.75 rillig 7043: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7044: <dd><p>binaries that cannot be
7045: stripped</p></dd>
1.75 rillig 7046: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7047: <dd><p>game
7048: binaries</p></dd>
1.75 rillig 7049: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7050: <dd><p>shared and static
7051: libraries</p></dd>
1.75 rillig 7052: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7053: <dd><p>data files</p></dd>
7054: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7055: <dd><p>data files for
7056: games</p></dd>
1.75 rillig 7057: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7058: <dd><p>man pages</p></dd>
7059: </dl></div>
7060: <p>Some other variables are:</p>
7061: <div class="variablelist"><dl>
7062: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7063: <dd><p>A list of directories relative to
1.88 wiz 7064: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7065: beginning of the <span class="emphasis"><em>install</em></span> phase.
7066: The package is supposed to create all needed directories itself
7067: before installing files to it and list all other directories here.
7068: </p></dd>
1.75 rillig 7069: </dl></div>
1.97 rillig 7070: <p>In the rare cases that a package shouldn't install anything,
7071: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7072: mostly relevant for packages in the <code class="filename">regress</code>
7073: category.</p>
1.75 rillig 7074: </div>
7075: <div class="sect1" lang="en">
7076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7077: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7078: <p>Once the install stage has completed, a binary package of
7079: the installed files can be built. These binary packages can be
7080: used for quick installation without previous compilation, e.g. by
1.110 hubertf 7081: the <span class="command"><strong>make bin-install</strong></span> or by using
7082: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 7083: <p>By default, the binary packages are created in
7084: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7085: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7086: one for each category in the <code class="varname">CATEGORIES</code>
7087: variable. <code class="varname">PACKAGES</code> defaults to
7088: <code class="filename">pkgsrc/packages</code>.</p>
7089: </div>
7090: <div class="sect1" lang="en">
7091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7092: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 7093: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 7094: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 7095: to clean the work directories of all dependencies too, use
1.110 hubertf 7096: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 7097: </div>
7098: <div class="sect1" lang="en">
7099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7100: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7101: <div class="variablelist"><dl>
7102: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7103: <dd><p>For any of the main targets described in the
7104: previous section, two auxiliary targets exist with
1.87 wiz 7105: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7106: prefix for the main target's name. These targets are
1.88 wiz 7107: invoked before and after the main target is called,
7108: allowing extra configuration or installation steps be
7109: performed from a package's Makefile, for example, which
7110: a program's configure script or install target
7111: omitted.</p></dd>
1.75 rillig 7112: <dt><span class="term">do-*</span></dt>
1.88 wiz 7113: <dd><p>Should one of the main targets do the wrong thing,
7114: and should there be no variable to fix this, you can
7115: redefine it with the do-* target. (Note that redefining
7116: the target itself instead of the do-* target is a bad
7117: idea, as the pre-* and post-* targets won't be called
7118: anymore, etc.) You will not usually need to do
7119: this.</p></dd>
1.75 rillig 7120: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7121: <dd>
1.110 hubertf 7122: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 7123: you noticed some file was not installed properly, you
7124: can repeat the installation with this target, which will
7125: ignore the “<span class="quote">already installed</span>” flag.</p>
7126: <p>This is the default value of
7127: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 7128: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 7129: package</strong></span>, where the defaults are
7130: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7131: respectively.</p>
7132: </dd>
1.75 rillig 7133: <dt><span class="term">deinstall</span></dt>
7134: <dd>
1.110 hubertf 7135: <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 7136: current directory, effectively de-installing the
7137: package. The following variables can be used to tune the
7138: behaviour:</p>
1.75 rillig 7139: <div class="variablelist"><dl>
7140: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110 hubertf 7141: <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 7142: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7143: <dd><p>Remove all packages that require (depend on)
7144: the given package. This can be used to remove any
7145: packages that may have been pulled in by a given
1.110 hubertf 7146: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7147: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7148: <code class="filename">pkgsrc/x11/kde</code>, this is
7149: likely to remove whole KDE. Works by adding
1.110 hubertf 7150: “<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 7151: command line.</p></dd>
1.75 rillig 7152: </dl></div>
7153: </dd>
1.88 wiz 7154: <dt><span class="term">bin-install</span></dt>
7155: <dd><p>Install a binary package from local disk and via FTP
7156: from a list of sites (see the
7157: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7158: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7159: available anywhere. The arguments given to
1.110 hubertf 7160: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7161: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7162: operation, etc.</p></dd>
1.75 rillig 7163: <dt><span class="term">update</span></dt>
7164: <dd>
1.88 wiz 7165: <p>This target causes the current package to be
7166: updated to the latest version. The package and all
7167: depending packages first get de-installed, then current
7168: versions of the corresponding packages get compiled and
7169: installed. This is similar to manually noting which
7170: packages are currently installed, then performing a
1.110 hubertf 7171: series of <span class="command"><strong>make deinstall</strong></span> and
7172: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7173: <code class="varname">UPDATE_TARGET</code> is set to) for these
7174: packages.</p>
7175: <p>You can use the “<span class="quote">update</span>” target to
1.110 hubertf 7176: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7177: update</strong></span> was interrupted for some reason.
7178: However, in this case, make sure you don't call
1.110 hubertf 7179: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7180: list of dependent packages in <code class="varname">WRKDIR</code>.
7181: Otherwise, you lose the ability to automatically update
7182: the current package along with the dependent packages
7183: you have installed.</p>
1.110 hubertf 7184: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7185: update</strong></span> will only work as long as the package
7186: tree remains unchanged. If the source code for one of
7187: the packages to be updated has been changed, resuming
1.110 hubertf 7188: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7189: fail!</p>
7190: <p>The following variables can be used either on the
1.110 hubertf 7191: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7192: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7193: update</strong></span>:</p>
1.75 rillig 7194: <div class="variablelist"><dl>
7195: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7196: <dd><p>Install target to recursively use for the
7197: updated package and the dependent packages.
7198: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7199: set, “<span class="quote">install</span>” otherwise for
1.110 hubertf 7200: <span class="command"><strong>make update</strong></span>. Other good
1.88 wiz 7201: targets are “<span class="quote">package</span>” or
7202: “<span class="quote">bin-install</span>”. Do not set this to
7203: “<span class="quote">update</span>” or you will get stuck in an
7204: endless loop!</p></dd>
1.75 rillig 7205: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7206: <dd><p>Don't clean up after updating. Useful if
7207: you want to leave the work sources of the updated
7208: packages around for inspection or other purposes.
7209: Be sure you eventually clean up the source tree
7210: (see the “<span class="quote">clean-update</span>” target below)
7211: or you may run into troubles with old source code
7212: still lying around on your next
1.110 hubertf 7213: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7214: update</strong></span>.</p></dd>
1.75 rillig 7215: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7216: <dd><p>Deinstall each package before installing
7217: (making <code class="varname">DEPENDS_TARGET</code>). This
7218: may be necessary if the
7219: “<span class="quote">clean-update</span>” target (see below) was
1.110 hubertf 7220: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7221: update</strong></span>.</p></dd>
1.75 rillig 7222: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7223: <dd><p>Allows you to disable recursion and hardcode
7224: the target for packages. The default is
7225: “<span class="quote">update</span>” for the update target,
7226: facilitating a recursive update of prerequisite
7227: packages. Only set
7228: <code class="varname">DEPENDS_TARGET</code> if you want to
7229: disable recursive updates. Use
7230: <code class="varname">UPDATE_TARGET</code> instead to just
7231: set a specific target for each package to be
1.110 hubertf 7232: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7233: (see above).</p></dd>
1.75 rillig 7234: </dl></div>
7235: </dd>
7236: <dt><span class="term">clean-update</span></dt>
7237: <dd>
1.88 wiz 7238: <p>Clean the source tree for all packages that would
1.110 hubertf 7239: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7240: from the current directory. This target should not be
7241: used if the current package (or any of its depending
7242: packages) have already been de-installed (e.g., after
1.110 hubertf 7243: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7244: some packages you intended to update. As a rule of
7245: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7246: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7247: and only if you have a dirty package tree (e.g., if you
7248: used <code class="varname">NOCLEAN</code>).</p>
7249: <p>If you are unsure about whether your tree is
1.110 hubertf 7250: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7251: clean</strong></span> at the top of the tree, or use the
7252: following sequence of commands from the directory of the
7253: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7254: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7255: time, otherwise you lose all the packages you wanted to
7256: update!):</p>
1.87 wiz 7257: <pre class="screen">
7258: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7259: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7260: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7261: </pre>
1.88 wiz 7262: <p>The following variables can be used either on the
1.110 hubertf 7263: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7264: <span class="command"><strong>make clean-update</strong></span>:</p>
1.75 rillig 7265: <div class="variablelist"><dl>
7266: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7267: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7268: reconstruct the list of directories to update for
1.110 hubertf 7269: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7270: update</strong></span> successfully installed all
7271: packages you wanted to update. Normally, this is
1.110 hubertf 7272: done automatically on <span class="command"><strong>make
1.88 wiz 7273: update</strong></span>, but may have been suppressed by
7274: the <code class="varname">NOCLEAN</code> variable (see
7275: above).</p></dd>
1.75 rillig 7276: </dl></div>
7277: </dd>
1.88 wiz 7278: <dt><span class="term">replace</span></dt>
7279: <dd>
7280: <p>Update the installation of the current package. This
7281: differs from update in that it does not replace dependent
1.93 rillig 7282: 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 7283: target to work.</p>
7284: <p><span class="emphasis"><em>Be careful when using this
7285: target!</em></span> There are no guarantees that dependent
7286: packages will still work, in particular they will most
1.110 hubertf 7287: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7288: library package whose shared library major version changed
7289: between your installed version and the new one. For this
7290: reason, this target is not officially supported and only
7291: recommended for advanced users.</p>
7292: </dd>
1.75 rillig 7293: <dt><span class="term">info</span></dt>
1.110 hubertf 7294: <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 7295: package. You can use this to check which version of a
7296: package is installed.</p></dd>
7297: <dt><span class="term">index</span></dt>
7298: <dd>
7299: <p>This is a top-level command, i.e. it should be used in
7300: the <code class="filename">pkgsrc</code> directory. It creates a
7301: database of all packages in the local pkgsrc tree, including
7302: dependencies, comment, maintainer, and some other useful
7303: information. Individual entries are created by running
1.110 hubertf 7304: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7305: directories. This index file is saved as
7306: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7307: verbose format by running <span class="command"><strong>make
1.88 wiz 7308: print-index</strong></span>. You can search in it with
1.110 hubertf 7309: <span class="command"><strong>make search
1.88 wiz 7310: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7311: extract a list of all packages that depend on a particular
1.110 hubertf 7312: one by running <span class="command"><strong>make show-deps
1.88 wiz 7313: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7314: <p>Running this command takes a very long time, some
7315: hours even on fast machines!</p>
7316: </dd>
1.75 rillig 7317: <dt><span class="term">readme</span></dt>
1.88 wiz 7318: <dd>
7319: <p>This target generates a
7320: <code class="filename">README.html</code> file, which can be
1.91 rillig 7321: 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 7322: contain references to any packages which are in the
7323: <code class="varname">PACKAGES</code> directory on the local
7324: host. The generated files can be made to refer to URLs
7325: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7326: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7327: wanted to generate <code class="filename">README.html</code>
7328: files which pointed to binary packages on the local
7329: machine, in the directory
7330: <code class="filename">/usr/packages</code>, set
7331: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7332: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7333: <code class="varname">${PACKAGES}</code> directory and its
7334: subdirectories will be searched for all the binary
7335: packages.</p>
7336: <p>The target can be run at the toplevel or in category
7337: directories, in which case it descends recursively.</p>
7338: </dd>
1.75 rillig 7339: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7340: <dd><p>This is a top-level command, run it in
7341: <code class="filename">pkgsrc</code>. Use this target to create a
7342: file <code class="filename">README-all.html</code> which contains a
7343: list of all packages currently available in the NetBSD
7344: Packages Collection, together with the category they belong
7345: to and a short description. This file is compiled from the
7346: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7347: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7348: readme</strong></span>.</p></dd>
1.75 rillig 7349: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7350: <dd><p>This is very much the same as the
7351: “<span class="quote">readme</span>” target (see above), but is to be
7352: used when generating a pkgsrc tree to be written to a
7353: CD-ROM. This target also produces
7354: <code class="filename">README.html</code> files, and can be made
7355: to refer to URLs based on
7356: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7357: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7358: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7359: <dd><p>This target shows which distfiles and patchfiles
7360: are needed to build the package
7361: (<code class="varname">ALLFILES</code>, which contains all
7362: <code class="varname">DISTFILES</code> and
1.87 wiz 7363: <code class="varname">PATCHFILES</code>, but not
7364: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7365: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7366: <dd><p>This target shows nothing if the package is not
7367: installed. If a version of this package is installed,
7368: but is not the version provided in this version of
7369: pkgsrc, then a warning message is displayed. This target
7370: can be used to show which of your installed packages are
7371: downlevel, and so the old versions can be deleted, and
7372: the current ones added.</p></dd>
1.75 rillig 7373: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7374: <dd><p>This target shows the directory in the pkgsrc
7375: hierarchy from which the package can be built and
7376: installed. This may not be the same directory as the one
7377: from which the package was installed. This target is
7378: intended to be used by people who may wish to upgrade
7379: many packages on a single host, and can be invoked from
7380: the top-level pkgsrc Makefile by using the
1.87 wiz 7381: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7382: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7383: <dd><p>This target shows which installed packages match
7384: the current package's <code class="varname">DEPENDS</code>. Useful
7385: if out of date dependencies are causing build
7386: problems.</p></dd>
1.75 rillig 7387: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7388: <dd><p>After a package is installed, check all its
7389: binaries and (on ELF platforms) shared libraries to see
7390: if they find the shared libs they need. Run by default
1.110 hubertf 7391: 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 7392: <dt><span class="term">print-PLIST</span></dt>
7393: <dd>
7394: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7395: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7396: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7397: -newer work/.extract_done</strong></span>. An attempt is made
7398: to care for shared libs etc., but it is
1.87 wiz 7399: <span class="emphasis"><em>strongly</em></span> recommended to review the
7400: result before putting it into
7401: <code class="filename">PLIST</code>. On upgrades, it's useful to
7402: diff the output of this command against an already
7403: existing <code class="filename">PLIST</code> file.</p>
1.110 hubertf 7404: <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 7405: other methods that don't update file access times, be
7406: sure to add these files manually to your
1.87 wiz 7407: <code class="filename">PLIST</code>, as the “<span class="quote">find
7408: -newer</span>” command used by this target won't catch
7409: them!</p>
1.123 snj 7410: <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 7411: information on this target.</p>
1.75 rillig 7412: </dd>
7413: <dt><span class="term">bulk-package</span></dt>
7414: <dd>
1.88 wiz 7415: <p>Used to do bulk builds. If an appropriate binary
7416: package already exists, no action is taken. If not, this
7417: target will compile, install and package it (and its
7418: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110 hubertf 7419: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.88 wiz 7420: After creating the binary package, the sources, the
7421: just-installed package and its required packages are
7422: removed, preserving free disk space.</p>
7423: <p><span class="emphasis"><em>Beware that this target may deinstall
7424: all packages installed on a system!</em></span></p>
1.75 rillig 7425: </dd>
7426: <dt><span class="term">bulk-install</span></dt>
7427: <dd>
1.88 wiz 7428: <p>Used during bulk-installs to install required
7429: packages. If an up-to-date binary package is available,
1.110 hubertf 7430: 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,
7431: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7432: but the installed binary won't be removed.</p>
1.88 wiz 7433: <p>A binary package is considered
7434: “<span class="quote">up-to-date</span>” to be installed via
1.110 hubertf 7435: <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 7436: <div class="itemizedlist"><ul type="disc">
7437: <li><p>None of the package's files
7438: (<code class="filename">Makefile</code>, ...) were modified
7439: since it was built.</p></li>
7440: <li><p>None of the package's required (binary)
7441: packages were modified since it was built.</p></li>
1.75 rillig 7442: </ul></div>
1.88 wiz 7443: <p><span class="emphasis"><em>Beware that this target may deinstall
7444: all packages installed on a system!</em></span></p>
1.75 rillig 7445: </dd>
7446: </dl></div>
7447: </div>
7448: </div>
7449: <div class="chapter" lang="en">
7450: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7451: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7452: <div class="toc">
7453: <p><b>Table of Contents</b></p>
7454: <dl>
1.106 rillig 7455: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7456: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7457: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7458: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7459: </dl>
7460: </div>
1.87 wiz 7461: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7462: by pkgsrc and also for individual packages to define what commands
7463: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7464: or for later run-time of an installed packaged (such as
7465: <code class="varname">DEPENDS</code>).
7466: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7467: package will not be used.</p>
7468: <p>When building a package, the replacement tools are
1.75 rillig 7469: made available in a directory (as symlinks or wrapper scripts)
7470: that is early in the executable search path. Just like the buildlink
1.87 wiz 7471: system, this helps with consistent builds.</p>
7472: <p>A tool may be needed to help build a specific package. For example,
7473: perl, GNU make (gmake) or yacc may be needed.</p>
7474: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7475: tool may be inefficient for building a package with pkgsrc.
7476: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7477: yacc) or a better sed.</p>
7478: <p>The tools used by a package can be listed by running
1.110 hubertf 7479: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75 rillig 7480: <div class="sect1" lang="en">
7481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7482: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7483: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7484: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7485: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7486: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7487: These can be seen by running:
1.110 hubertf 7488: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7489: <p>If a package needs a specific program to build
1.75 rillig 7490: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7491: to define the tools needed.</p>
1.75 rillig 7492: </div>
7493: <div class="sect1" lang="en">
7494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7495: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7496: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7497: and not the native version for a build dependency.
7498: And the :run means that it is used for a
7499: run-time dependencies also (and becomes a DEPENDS).
7500: The default is a build dependency which can be set with
7501: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7502: and pkg-config:build.)</p>
1.75 rillig 7503: <pre class="programlisting">
7504: USE_TOOLS+= mktemp:pkgsrc
7505: USE_TOOLS+= gmake perl:run pkg-config
7506: </pre>
1.87 wiz 7507: <p>When using the tools framework, a
1.75 rillig 7508: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7509: which contains the full path to the appropriate tool. For example,
7510: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7511: on Linux systems.</p>
7512: <p>If you always need a pkgsrc version of the
1.75 rillig 7513: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7514: </p>
7515: </div>
7516: <div class="sect1" lang="en">
7517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7518: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7519: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7520: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7521: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7522: the name of the common tools. For example:</p>
7523: <pre class="programlisting">
7524: .if exists(/usr/bin/bzcat)
7525: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7526: .elif exists(/usr/bin/bzip2)
7527: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7528: .endif
1.69 rillig 7529:
1.75 rillig 7530: TOOLS_PLATFORM.true?= true # shell builtin
7531: </pre>
7532: </div>
1.97 rillig 7533: <div class="sect1" lang="en">
7534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7535: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97 rillig 7536: <div class="qandaset">
7537: <dl>
1.106 rillig 7538: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7539: </dt>
1.106 rillig 7540: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7541: tools?</a>
7542: </dt>
1.106 rillig 7543: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7544: package is using while being built? I want to know whether it
7545: uses sed or not.</a>
7546: </dt>
7547: </dl>
7548: <table border="0" summary="Q and A Set">
7549: <col align="left" width="1%">
7550: <tbody>
7551: <tr class="question">
7552: <td align="left" valign="top">
1.126 jakllsch 7553: <a name="tools.new"></a><a name="id52055318"></a><p><b>18.4.1.</b></p>
1.97 rillig 7554: </td>
7555: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7556: </tr>
7557: <tr class="answer">
7558: <td align="left" valign="top"></td>
7559: <td align="left" valign="top"><p>TODO</p></td>
7560: </tr>
7561: <tr class="question">
7562: <td align="left" valign="top">
1.126 jakllsch 7563: <a name="tools.listall"></a><a name="id52055326"></a><p><b>18.4.2.</b></p>
1.97 rillig 7564: </td>
7565: <td align="left" valign="top"><p>How do I get a list of all available
7566: tools?</p></td>
7567: </tr>
7568: <tr class="answer">
7569: <td align="left" valign="top"></td>
7570: <td align="left" valign="top"><p>TODO</p></td>
7571: </tr>
7572: <tr class="question">
7573: <td align="left" valign="top">
1.126 jakllsch 7574: <a name="tools.used"></a><a name="id52055335"></a><p><b>18.4.3.</b></p>
1.97 rillig 7575: </td>
7576: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7577: package is using while being built? I want to know whether it
7578: uses sed or not.</p></td>
7579: </tr>
7580: <tr class="answer">
7581: <td align="left" valign="top"></td>
7582: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7583: to do it.)</p></td>
7584: </tr>
7585: </tbody>
7586: </table>
7587: </div>
7588: </div>
1.75 rillig 7589: </div>
7590: <div class="chapter" lang="en">
7591: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7592: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7593: <div class="toc">
7594: <p><b>Table of Contents</b></p>
7595: <dl>
1.106 rillig 7596: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7597: <dd><dl>
1.106 rillig 7598: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.123 snj 7599: <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 7600: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7601: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7602: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7603: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7604: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7605: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7606: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7607: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7608: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7609: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7610: </dl></dd>
1.123 snj 7611: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106 rillig 7612: <dd><dl>
7613: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7614: <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>
7615: </dl></dd>
1.123 snj 7616: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106 rillig 7617: <dd><dl>
7618: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7619: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7620: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7621: </dl></dd>
7622: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7623: <dd><dl>
7624: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7625: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7626: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7627: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7628: </dl></dd>
1.123 snj 7629: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106 rillig 7630: <dd><dl>
7631: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7632: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.123 snj 7633: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106 rillig 7634: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7635: </dl></dd>
1.123 snj 7636: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106 rillig 7637: <dd><dl>
7638: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7639: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7640: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7641: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7642: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7643: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7644: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7645: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7646: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7647: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7648: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7649: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7650: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7651: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7652: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7653: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7654: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7655: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7656: emulation</a></span></dt>
1.106 rillig 7657: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7658: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7659: </dl></dd>
1.106 rillig 7660: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7661: </dl>
7662: </div>
7663: <div class="sect1" lang="en">
7664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7665: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75 rillig 7666: <div class="sect2" lang="en">
7667: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7668: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7669: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7670: different platforms. As a result, it is important to ensure,
7671: where possible, that packages in pkgsrc are portable. This
7672: chapter mentions some particular details you should pay
7673: attention to while working on pkgsrc.</p>
1.78 rillig 7674: </div>
7675: <div class="sect2" lang="en">
7676: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7677: <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 7678: </h3></div></div></div>
1.78 rillig 7679: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7680: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7681: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7682: want to use those variables in the preprocessor directives of
1.110 hubertf 7683: <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 7684: <code class="literal">.for</code>), you need to include the file
7685: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7686: loads the user preferences.</p>
1.78 rillig 7687: <p>But note that some variables may not be completely defined
1.87 wiz 7688: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7689: included, as they may contain references to variables that are
7690: not yet defined. In shell commands this is no problem, since
7691: variables are actually macros, which are only expanded when they
7692: are used. But in the preprocessor directives mentioned above and
7693: in dependency lines (of the form <code class="literal">target:
7694: dependencies</code>) the variables are expanded at load
7695: time.</p>
1.78 rillig 7696: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7697: <h3 class="title">Note</h3>
7698: <p>Currently there is no exhaustive list of all
1.87 wiz 7699: variables that tells you whether they can be used at load time
7700: or only at run time, but it is in preparation.</p>
1.78 rillig 7701: </div>
7702: </div>
7703: <div class="sect2" lang="en">
7704: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7705: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7706: <p>Occasionally, packages require interaction from the user,
7707: and this can be in a number of ways:</p>
1.78 rillig 7708: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7709: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7710: interaction such as entering username/password or accepting a
7711: license on a web page.</p></li>
1.88 wiz 7712: <li><p>When extracting the distfiles, some packages may ask for
7713: passwords.</p></li>
1.78 rillig 7714: <li><p>help to configure the package before it is built</p></li>
7715: <li><p>help during the build process</p></li>
7716: <li><p>help during the installation of a package</p></li>
7717: </ul></div>
1.88 wiz 7718: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7719: provided to notify the pkgsrc mechanism of an interactive stage
7720: which will be needed, and this should be set in the package's
7721: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7722: <pre class="programlisting">
1.100 rillig 7723: INTERACTIVE_STAGE= build
1.87 wiz 7724: </pre>
1.78 rillig 7725: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7726: <pre class="programlisting">
1.100 rillig 7727: INTERACTIVE_STAGE= configure install
1.87 wiz 7728: </pre>
1.88 wiz 7729: <p>The user can then decide to skip this package by setting the
7730: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7731: </div>
7732: <div class="sect2" lang="en">
7733: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7734: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7735: <p>Authors of software can choose the licence under which
7736: software can be copied. This is due to copyright law, and reasons
7737: for license choices are outside the scope of pkgsrc. The pkgsrc
7738: system recognizes that there are a number of licenses which some
7739: users may find objectionable or difficult or impossible to comply
7740: with. The Free Software Foundation has declared some licenses
7741: "Free", and the Open Source Initiative has a definition of "Open
7742: Source". The pkgsrc system, as a policy choice, does not label
7743: packages which have licenses that are Free or Open Source.
7744: However, packages without a license meeting either of those tests
7745: are labeled with a license tag denoting the license. Note that a
7746: package with no license to copy trivially does not meet either the
7747: Free or Open Source test.</p>
7748: <p>For packages which are not Free or Open Source, pkgsrc will
7749: not build the package unless the user has indicated to pkgsrc that
7750: packages with that particular license may be built. Note that
7751: this documentation avoids the term "accepted the license". The
7752: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7753: accidentally building a package with a non-free license;
1.98 wiz 7754: judgement and responsibility remain with the user. (Installation
7755: of binary packages are not currently subject to this mechanism;
7756: this is a bug.)</p>
7757: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7758: or the GPL, and not the other. The free licenses are added to the
7759: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7760: user can override the default by setting the
7761: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7762: of "+=". The licenses accepted by default are:
7763: </p>
7764: <pre class="programlisting">
7765: public-domain
7766: gnu-gpl-v2 gnu-lgpl-v2
7767: gnu-gpl-v3 gnu-lgpl-v3
7768: original-bsd modified-bsd
7769: x11
7770: apache-2.0
7771: cddl-1.0
7772: open-font-license
7773: </pre>
7774: <p>
7775: </p>
1.78 rillig 7776: <p>The license tag mechanism is intended to address
1.87 wiz 7777: copyright-related issues surrounding building, installing and
7778: using a package, and not to address redistribution issues (see
7779: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7780: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7781: Packages with redistribution restrictions should set these
7782: tags.</p>
1.98 wiz 7783: <p>Denoting that a package may be copied according to a
7784: particular license is done by placing the license in
1.87 wiz 7785: <code class="filename">pkgsrc/licenses</code> and setting the
7786: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7787: 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 7788: <pre class="programlisting">
1.100 rillig 7789: LICENSE= xv-license
1.87 wiz 7790: </pre>
7791: <p>When trying to build, the user will get a notice that the
1.98 wiz 7792: package is covered by a license which has not been placed in the
7793: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7794: <pre class="programlisting">
1.100 rillig 7795: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7796: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7797: ===> To view the license, enter "/usr/bin/make show-license".
7798: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7799: ===> ACCEPTABLE_LICENSES+=xv-license
7800: *** Error code 1
1.87 wiz 7801: </pre>
1.110 hubertf 7802: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7803: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7804: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7805: convey to pkgsrc that it should not in the future fail because of
7806: that license:</p>
1.78 rillig 7807: <pre class="programlisting">
1.100 rillig 7808: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7809: </pre>
1.98 wiz 7810: <p>When adding a package with a new license, the license text
7811: should be added to <code class="filename">pkgsrc/licenses</code> for
7812: displaying. A list of known licenses can be seen in this
1.91 rillig 7813: directory.</p>
1.98 wiz 7814: <p>When the license changes (in a way other than formatting),
7815: please make sure that the new license has a different name (e.g.,
7816: append the version number if it exists, or the date). Just
7817: because a user told pkgsrc to build programs under a previous
7818: version of a license does not mean that pkgsrc should build
1.99 rillig 7819: programs under the new licenses. The higher-level point is that
1.98 wiz 7820: pkgsrc does not evaluate licenses for reasonableness; the only
7821: test is a mechanistic test of whether a particular text has been
7822: approved by either of two bodies.</p>
1.78 rillig 7823: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7824: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7825: is deprecated because it does not crisply refer to a particular
7826: license text. Another problem with such usage is that it does not
7827: enable a user to tell pkgsrc to proceed for a single package
7828: without also telling pkgsrc to proceed for all packages with that
7829: tag.</p>
1.75 rillig 7830: </div>
7831: <div class="sect2" lang="en">
7832: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7833: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7834: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7835: Because a license tag is required unless the package is Free or
7836: Open Source, all packages with restrictions should have license
7837: tags. By declaring the restrictions, package tools can
7838: automatically refrain from e.g. placing binary packages on FTP
7839: sites.</p>
7840: <p>There are four restrictions that may be encoded, which are
7841: the cross product of sources (distfiles) and binaries not being
7842: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7843: language in any license, and because non-Free licenses tend to be
7844: different from each other, pkgsrc adopts a definition of FTP and
7845: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7846: should not be made available over the Internet at no charge.
7847: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7848: made available on some kind of media, together with other source
7849: and binary packages, and which is sold for a distribution charge.
7850: </p>
7851: <p>In order to encode these restrictions, the package system
1.87 wiz 7852: defines five make variables that can be set to note these
7853: restrictions:</p>
1.75 rillig 7854: <div class="itemizedlist"><ul type="disc">
7855: <li>
7856: <p><code class="varname">RESTRICTED</code></p>
7857: <p>This variable should be set whenever a restriction
1.87 wiz 7858: exists (regardless of its kind). Set this variable to a
1.98 wiz 7859: string containing the reason for the restriction. It should
7860: be understood that those wanting to understand the restriction
7861: will have to read the license, and perhaps seek advice of
7862: counsel.</p>
1.75 rillig 7863: </li>
7864: <li>
7865: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7866: <p>Binaries may not be placed on CD-ROM containing other
7867: binary packages, for which a distribution charge may be made.
7868: In this case, set this variable to
7869: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7870: </li>
7871: <li>
7872: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7873: <p>Binaries may not made available on the Internet without
7874: charge. In this case, set this variable to
7875: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7876: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7877: </li>
7878: <li>
7879: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7880: <p>Distfiles may not be placed on CD-ROM, together with
7881: other distfiles, for which a fee may be charged. In this
7882: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7883: </p>
1.75 rillig 7884: </li>
7885: <li>
7886: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7887: <p>Distfiles may not made available via FTP at no charge.
7888: In this case, set this variable to
7889: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7890: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7891: </li>
7892: </ul></div>
7893: </div>
7894: <div class="sect2" lang="en">
7895: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7896: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7897: <p>Your package may depend on some other package being present
1.88 wiz 7898: - and there are various ways of expressing this dependency.
7899: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7900: <code class="varname">DEPENDS</code> definitions, the
7901: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7902: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7903: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7904: 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 7905: <p>The basic difference between the two variables is as
1.87 wiz 7906: follows: The <code class="varname">DEPENDS</code> definition registers
7907: that pre-requisite in the binary package so it will be pulled in
7908: when the binary package is later installed, whilst the
7909: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7910: dependency that is only needed for building the package.</p>
1.75 rillig 7911: <p>This means that if you only need a package present whilst
1.87 wiz 7912: you are building, it should be noted as a
7913: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7914: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7915: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7916: <pre class="programlisting">
1.100 rillig 7917: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7918: </pre>
1.75 rillig 7919: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7920: may include any of the wildcard version numbers recognized by
1.110 hubertf 7921: <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 7922: <div class="orderedlist"><ol type="1">
7923: <li>
7924: <p>If your package needs another package's binaries or
1.87 wiz 7925: libraries to build or run, and if that package has a
7926: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7927: <pre class="programlisting">
1.100 rillig 7928: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7929: </pre>
1.75 rillig 7930: </li>
7931: <li>
7932: <p>If your package needs to use another package to build
1.87 wiz 7933: itself and there is no <code class="filename">buildlink3.mk</code>
7934: file available, use the <code class="varname">BUILD_DEPENDS</code>
7935: definition:</p>
1.75 rillig 7936: <pre class="programlisting">
1.100 rillig 7937: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7938: </pre>
1.75 rillig 7939: </li>
7940: <li>
7941: <p>If your package needs a library with which to link and
1.76 rillig 7942: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7943: available, this is specified using the
7944: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7945: <pre class="programlisting">
1.100 rillig 7946: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7947: </pre>
1.109 rillig 7948: <p>You can also use wildcards in package dependencies:</p>
1.75 rillig 7949: <pre class="programlisting">
1.100 rillig 7950: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7951: </pre>
1.75 rillig 7952: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7953: creating binary packages. The dependency is checked when
7954: installing the binary package and any package which matches
7955: the pattern will be used. Wildcard dependencies should be
7956: used with care.</p>
1.75 rillig 7957: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7958: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7959: such as “<span class="quote">tk-postgresql</span>” matching a
7960: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7961: <p>Wildcards can also be used to specify that a package
1.87 wiz 7962: will only build against a certain minimum version of a
7963: pre-requisite:</p>
1.75 rillig 7964: <pre class="programlisting">
1.100 rillig 7965: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7966: </pre>
1.75 rillig 7967: <p>This means that the package will build against version
1.87 wiz 7968: 3.5.4 of the tiff library or newer. Such a dependency may
7969: be warranted if, for example, the API of the library has
7970: changed with version 3.5.4 and a package would not compile
7971: against an earlier version of tiff.</p>
1.75 rillig 7972: <p>Please note that such dependencies should only be
1.87 wiz 7973: updated if a package requires a newer pre-requisite, but
1.93 rillig 7974: not to denote recommendations such as
1.87 wiz 7975: ABI changes that do not prevent a package from building
7976: correctly. Such recommendations can be expressed using
7977: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7978: <pre class="programlisting">
1.100 rillig 7979: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7980: </pre>
1.75 rillig 7981: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7982: line, this denotes that while a package will build against
7983: tiff>=3.5.4, at least version 3.6.1 is recommended.
7984: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7985: dependencies unless explicitly ignored (in which case a
7986: warning will be printed).</p>
1.75 rillig 7987: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7988: use the required <code class="varname">DEPENDS</code>, set
7989: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7990: it easier and faster to update packages built using pkgsrc,
7991: since older compatible dependencies can continue to be
7992: used. This is useful for people who watch their rebuilds
7993: very carefully; it is not very good as a general-purpose
7994: hammer. If you use it, you need to be mindful of possible
7995: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7996: <p>Packages that are built with recommendations ignored
1.87 wiz 7997: may not be uploaded to ftp.NetBSD.org by developers and
7998: should not be used across different systems that may have
7999: different versions of binary packages installed.</p>
1.75 rillig 8000: <p>For security fixes, please update the package
1.110 hubertf 8001: 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 8002: information.</p>
1.75 rillig 8003: </li>
8004: <li>
8005: <p>If your package needs some executable to be able to run
1.87 wiz 8006: correctly and if there's no
8007: <code class="filename">buildlink3.mk</code> file, this is specified
8008: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 8009: <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 8010: be able to execute the latex binary from the teTeX package
8011: when it runs, and that is specified:</p>
1.75 rillig 8012: <pre class="programlisting">
1.100 rillig 8013: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 8014: </pre>
1.75 rillig 8015: <p>The comment about wildcard dependencies from previous
1.87 wiz 8016: paragraph applies here, too.</p>
1.75 rillig 8017: </li>
8018: </ol></div>
8019: <p>If your package needs files from another package to build,
1.87 wiz 8020: add the relevant distribution files to
8021: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8022: 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 8023: (It relies on the jpeg sources being present in source form
8024: during the build.)</p>
1.75 rillig 8025: </div>
8026: <div class="sect2" lang="en">
8027: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8028: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8029: <p>Your package may conflict with other packages a user might
1.87 wiz 8030: already have installed on his system, e.g. if your package
1.88 wiz 8031: installs the same set of files as another package in the pkgsrc
8032: tree.</p>
1.75 rillig 8033: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8034: space-separated list of packages (including version string) your
8035: package conflicts with.</p>
1.91 rillig 8036: <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>
8037: 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 8038: install the same shared library, thus you set in
8039: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8040: <pre class="programlisting">
1.100 rillig 8041: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8042: </pre>
8043: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8044: <pre class="programlisting">
1.100 rillig 8045: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8046: </pre>
1.75 rillig 8047: <p>Packages will automatically conflict with other packages
1.87 wiz 8048: with the name prefix and a different version
8049: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8050: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 8051: </div>
8052: <div class="sect2" lang="en">
8053: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8054: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8055: <p>There are several reasons why a package might be
1.88 wiz 8056: instructed to not build under certain circumstances. If the
1.87 wiz 8057: package builds and runs on most platforms, the exceptions
8058: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8059: the package builds and runs on a small handful of platforms,
8060: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8061: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8062: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8063: (OS-version-platform) that can use glob-style
8064: wildcards.</p>
1.88 wiz 8065: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8066: 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 8067: backwards compatible with other versions of the OS, and should be
8068: uploaded to a version specific directory on the FTP server. Mark
8069: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8070: “<span class="quote">yes</span>”. This variable is not currently used by any of
8071: the package system internals, but may be used in the
8072: future.</p>
1.75 rillig 8073: <p>If the package should be skipped (for example, because it
1.87 wiz 8074: provides functionality already provided by the system), set
1.88 wiz 8075: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8076: the package should fail because some preconditions are not met,
8077: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8078: message.</p>
1.75 rillig 8079: </div>
8080: <div class="sect2" lang="en">
8081: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8082: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8083: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8084: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8085: be set in the package Makefile. This will be carried into any
8086: binary package that is made from this pkgsrc entry. A
8087: “<span class="quote">preserved</span>” package will
1.110 hubertf 8088: 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 8089: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 8090: </div>
8091: <div class="sect2" lang="en">
8092: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8093: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8094: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8095: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110 hubertf 8096: and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87 wiz 8097: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8098: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8099: <code class="varname">PKGREVISION</code> should be increased (this
8100: is of course not necessary if the problem is fixed by using
8101: a newer release of the software).</p>
1.75 rillig 8102: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8103: branch, be sure to submit a pullup request!</p>
1.75 rillig 8104: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8105: semi-automatically by a weekly cron job.</p>
1.75 rillig 8106: </div>
8107: <div class="sect2" lang="en">
8108: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8109: <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 8110: <p>When making fixes to an existing package it can be useful
1.87 wiz 8111: to change the version number in <code class="varname">PKGNAME</code>. To
8112: avoid conflicting with future versions by the original author, a
8113: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8114: on package versions by setting <code class="varname">PKGREVISION=1</code>
8115: (2, ...). The “<span class="quote">nb</span>” is treated like a
8116: “<span class="quote">.</span>” by the package tools. e.g.</p>
8117: <pre class="programlisting">
1.100 rillig 8118: DISTNAME= foo-17.42
8119: PKGREVISION= 9
1.87 wiz 8120: </pre>
1.75 rillig 8121: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 8122: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8123: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8124: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8125: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8126: <p>When a new release of the package is released, the
1.87 wiz 8127: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8128: minor release of the above package, things should be like:</p>
1.75 rillig 8129: <pre class="programlisting">
1.100 rillig 8130: DISTNAME= foo-17.43
1.87 wiz 8131: </pre>
8132: <p><code class="varname">PKGREVISION</code> should be incremented for any
8133: non-trivial change in the resulting binary package. Without a
8134: <code class="varname">PKGREVISION</code> bump, someone with the previous
8135: version installed has no way of knowing that their package is out
8136: of date. Thus, changes without increasing
8137: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8138: trivial that no reasonable person would want to upgrade", and this
8139: is the rough test for when increasing
8140: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8141: changes that do not merit increasing
8142: <code class="varname">PKGREVISION</code> are:</p>
1.100 rillig 8143: <div class="itemizedlist"><ul type="disc">
1.114 jmcneill 8144: <li><p>Changing <code class="varname">HOMEPAGE</code>,
8145: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8146: or comments in Makefile.</p></li>
8147: <li><p>
8148: Changing build variables if the resulting binary package is the same.</p></li>
8149: <li><p>
8150: Changing <code class="filename">DESCR</code>.</p></li>
8151: <li><p>
8152: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8153: </ul></div>
1.87 wiz 8154: <p>Examples of changes that do merit an increase to
8155: <code class="varname">PKGREVISION</code> include:</p>
1.100 rillig 8156: <div class="itemizedlist"><ul type="disc">
8157: <li><p>
8158: Security fixes</p></li>
8159: <li><p>
8160: Changes or additions to a patch file</p></li>
8161: <li><p>
8162: Changes to the <code class="filename">PLIST</code></p></li>
1.112 weinem 8163: <li><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8164: </ul></div>
1.78 rillig 8165: <p>PKGREVISION must also be incremented when dependencies have ABI
8166: changes.</p>
1.75 rillig 8167: </div>
1.79 rillig 8168: <div class="sect2" lang="en">
8169: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8170: <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 8171: <p>When you want to replace the same text in multiple files
1.87 wiz 8172: or when the replacement text varies, patches alone cannot help.
8173: This is where the SUBST framework comes in. It provides an
8174: easy-to-use interface for replacing text in files.
8175: Example:</p>
8176: <pre class="programlisting">
1.100 rillig 8177: SUBST_CLASSES+= fix-paths
8178: SUBST_STAGE.fix-paths= pre-configure
8179: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8180: SUBST_FILES.fix-paths= src/*.c
8181: SUBST_FILES.fix-paths+= scripts/*.sh
8182: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8183: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8184: </pre>
1.79 rillig 8185: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8186: that are used to identify the different SUBST blocks that are
8187: defined. The SUBST framework is heavily used by pkgsrc, so it is
8188: important to always use the <code class="literal">+=</code> operator with
8189: this variable. Otherwise some substitutions may be
8190: skipped.</p>
1.79 rillig 8191: <p>The remaining variables of each SUBST block are
1.87 wiz 8192: parameterized with the identifier from the first line
8193: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8194: parameters to a function call.</p>
1.79 rillig 8195: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8196: which the replacement will take place. All combinations of
8197: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8198: <code class="literal">post-</code> together with a phase name are
8199: possible, though only few are actually used. Most commonly used
8200: are <code class="literal">post-patch</code> and
8201: <code class="literal">pre-configure</code>. Of these two,
8202: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8203: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8204: have the state after applying the patches but before making any
8205: other changes. This is especially useful when you are debugging
8206: a package in order to create new patches for it. Similarly,
8207: <code class="literal">post-build</code> is preferred over
8208: <code class="literal">pre-install</code>, because the install phase should
8209: generally be kept as simple as possible. When you use
8210: <code class="literal">post-build</code>, you have the same files in the
8211: working directory that will be installed later, so you can check
8212: if the substitution has succeeded.</p>
1.79 rillig 8213: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8214: that is printed just before the substitution is done.</p>
1.79 rillig 8215: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8216: globbing patterns that specifies the files in which the
8217: substitution will take place. The patterns are interpreted
8218: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8219: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110 hubertf 8220: <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 8221: command should be prefixed with <code class="literal">-e</code>, so that
8222: all SUBST blocks look uniform.</p>
1.79 rillig 8223: <p>There are some more variables, but they are so seldomly
1.87 wiz 8224: used that they are only documented in the
8225: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8226: </div>
1.75 rillig 8227: </div>
8228: <div class="sect1" lang="en">
8229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8230: <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 8231: <div class="sect2" lang="en">
8232: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8233: <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 8234: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8235: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8236: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8237: with the name of each file to download as an argument, expecting
8238: it to output the URL of the directory from which to download
1.91 rillig 8239: 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 8240: example of this usage.</p>
1.75 rillig 8241: <p>If the download can't be automated, because the user must
1.87 wiz 8242: submit personal information to apply for a password, or must pay
8243: for the source, or whatever, you can set
8244: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8245: displayed to the user before aborting the build. Example:</p>
8246: <pre class="programlisting">
1.100 rillig 8247: FETCH_MESSAGE= "Please download the files"
8248: FETCH_MESSAGE+= " "${DISTFILES:Q}
8249: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8250: </pre>
1.75 rillig 8251: </div>
8252: <div class="sect2" lang="en">
8253: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8254: <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 8255: <p>Sometimes authors of a software package make some
1.87 wiz 8256: modifications after the software was released, and they put up a
8257: new distfile without changing the package's version number. If a
8258: package is already in pkgsrc at that time, the checksum will
8259: no longer match. The contents of the new distfile should be
8260: compared against the old one before changing anything, to make
8261: sure the distfile was really updated on purpose, and that
8262: no trojan horse or so crept in.
1.97 rillig 8263: Please mention that the distfiles were compared and what was found
8264: in your commit message.
1.87 wiz 8265: Then, the correct way to work around this is to
8266: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8267: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8268: <code class="varname">DISTFILES</code> and
1.93 rillig 8269: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8270: subdirectory of the local distfiles directory.
1.110 hubertf 8271: (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 8272: In case this
1.87 wiz 8273: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8274: including the <code class="filename">nbX</code> suffix) or a date stamp
8275: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8276: Do not forget regenerating the <code class="filename">distinfo</code> file
8277: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8278: path in the filenames.
1.97 rillig 8279: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8280: Furthermore, a mail to the package's authors seems appropriate
8281: telling them that changing distfiles after releases without
8282: changing the file names is not good practice.</p>
1.75 rillig 8283: </div>
8284: </div>
8285: <div class="sect1" lang="en">
8286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8287: <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 8288: <div class="sect2" lang="en">
8289: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8290: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8291: <p>pkgsrc supports many different machines, with different
1.87 wiz 8292: object formats like a.out and ELF, and varying abilities to do
8293: shared library and dynamic loading at all. To accompany this,
8294: varying commands and options have to be passed to the
8295: compiler, linker, etc. to get the Right Thing, which can be
8296: pretty annoying especially if you don't have all the machines
8297: at your hand to test things. The
1.91 rillig 8298: <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 8299: can help here, as it just “<span class="quote">knows</span>” how to build
8300: both static and dynamic libraries from a set of source files,
8301: thus being platform-independent.</p>
8302: <p>Here's how to use libtool in a package in seven simple
8303: steps:</p>
1.75 rillig 8304: <div class="orderedlist"><ol type="1">
8305: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8306: Makefile.</p></li>
1.75 rillig 8307: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8308: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8309: add it to the definition of <code class="varname">CC</code>, if only
8310: libraries are being built in a given Makefile. This one command
8311: will build both PIC and non-PIC library objects, so you need not
8312: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8313: <li>
8314: <p>For the linking of the library, remove any
1.87 wiz 8315: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8316: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8317: <pre class="programlisting">
1.100 rillig 8318: ${LIBTOOL} --mode=link \
8319: ${CC} -o ${.TARGET:.a=.la} \
8320: ${OBJS:.o=.lo} \
8321: -rpath ${PREFIX}/lib \
8322: -version-info major:minor
1.87 wiz 8323: </pre>
1.75 rillig 8324: <p>Note that the library is changed to have a
1.87 wiz 8325: <code class="filename">.la</code> extension, and the objects are
8326: changed to have a <code class="filename">.lo</code>
8327: extension. Change <code class="varname">OBJS</code> as
8328: necessary. This automatically creates all of the
8329: <code class="filename">.a</code>,
8330: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8331: necessary) in the build directory. Be sure to include
8332: “<span class="quote">-version-info</span>”, especially when major and
8333: minor are zero, as libtool will otherwise strip off the
8334: shared library version.</p>
1.75 rillig 8335: <p>From the libtool manual:</p>
8336: <pre class="programlisting">
1.100 rillig 8337: So, libtool library versions are described by three integers:
1.69 rillig 8338:
1.100 rillig 8339: CURRENT
8340: The most recent interface number that this library implements.
1.69 rillig 8341:
1.100 rillig 8342: REVISION
8343: The implementation number of the CURRENT interface.
1.69 rillig 8344:
1.100 rillig 8345: AGE
8346: The difference between the newest and oldest interfaces that
8347: this library implements. In other words, the library implements
8348: all the interface numbers in the range from number `CURRENT -
8349: AGE' to `CURRENT'.
1.1 grant 8350:
1.100 rillig 8351: If two libraries have identical CURRENT and AGE numbers, then the
8352: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8353: </pre>
1.75 rillig 8354: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8355: different results for a.out and ELF (excluding symlinks)
8356: in only one case. An ELF library of the form
8357: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8358: will have a symlink of
8359: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8360: on an a.out platform. This is handled
8361: automatically.</p>
1.75 rillig 8362: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8363: directory of the library being built.</p>
1.76 rillig 8364: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8365: <code class="filename">.la</code> file, the other files will be
8366: added automatically.</p>
1.75 rillig 8367: </li>
8368: <li>
1.76 rillig 8369: <p>When linking shared object (<code class="filename">.so</code>)
1.110 hubertf 8370: 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 8371: shared libraries, use “<span class="quote">-module
8372: -avoid-version</span>” to prevent them getting version
8373: tacked on.</p>
1.76 rillig 8374: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8375: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8376: </li>
8377: <li>
8378: <p>When linking programs that depend on these libraries
1.87 wiz 8379: <span class="emphasis"><em>before</em></span> they are installed, preface
1.110 hubertf 8380: 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 8381: --mode=link</span>”, and it will find the correct
8382: libraries (static or shared), but please be aware that
8383: libtool will not allow you to specify a relative path in
8384: -L (such as “<span class="quote">-L../somelib</span>”), because it
8385: expects you to change that argument to be the
8386: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8387: <pre class="programlisting">
1.100 rillig 8388: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8389: </pre>
1.75 rillig 8390: <p>should be changed to:</p>
8391: <pre class="programlisting">
1.100 rillig 8392: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8393: </pre>
1.75 rillig 8394: <p>and it will do the right thing with the libraries.</p>
8395: </li>
8396: <li>
1.110 hubertf 8397: <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>
8398: 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 8399: --mode=install</span>”, and change the library name to
8400: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8401: <pre class="programlisting">
1.126 jakllsch 8402: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8403: </pre>
1.76 rillig 8404: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8405: shared library, any needed symlinks, and run
1.110 hubertf 8406: <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 8407: </li>
1.76 rillig 8408: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8409: the <code class="filename">.la</code>
8410: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8411: </ol></div>
8412: </div>
8413: <div class="sect2" lang="en">
8414: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8415: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8416: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8417: package Makefile. This will override the package's own libtool
8418: in most cases. For older libtool using packages, libtool is
8419: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8420: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8421: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8422: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8423: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8424: default, it is set to “<span class="quote">libtool */libtool
8425: */*/libtool</span>”. If this does not match the location of the
8426: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8427: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8428: libraries built and installed, then use
8429: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8430: <p>If your package makes use of the platform-independent library
1.87 wiz 8431: for loading dynamic shared objects, that comes with libtool
8432: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8433: <p>Some packages use libtool incorrectly so that the package
8434: may not work or build in some circumstances. Some of the more
8435: common errors are:</p>
1.75 rillig 8436: <div class="itemizedlist"><ul type="disc">
8437: <li>
8438: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8439: executable or library. This in itself isn't a problem if one of two things
8440: has been done:</p>
1.75 rillig 8441: <div class="orderedlist"><ol type="1">
8442: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8443: <code class="filename">libfoo.la</code>, not
8444: <code class="filename">foo.la</code></p></li>
1.75 rillig 8445: <li><p>The -dlopen option is used when linking an executable.</p></li>
8446: </ol></div>
8447: </li>
8448: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8449: The function lt_dlinit() should be called and the macro
8450: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8451: executables.</p></li>
1.75 rillig 8452: </ul></div>
8453: </div>
8454: <div class="sect2" lang="en">
8455: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8456: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8457: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8458: to regenerate the configure script and Makefile.in makefile
8459: templates, then they should be executed in a pre-configure
8460: target.</p>
1.75 rillig 8461: <p>For packages that need only autoconf:</p>
8462: <pre class="programlisting">
1.100 rillig 8463: AUTOCONF_REQD= 2.50 # if default version is not good enough
8464: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8465: ...
1.1 grant 8466:
1.100 rillig 8467: pre-configure:
8468: cd ${WRKSRC} && autoconf
1.1 grant 8469:
1.100 rillig 8470: ...
1.87 wiz 8471: </pre>
1.75 rillig 8472: <p>and for packages that need automake and autoconf:</p>
8473: <pre class="programlisting">
1.100 rillig 8474: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8475: USE_TOOLS+= automake # use "automake14" for automake-1.4
8476: ...
8477:
8478: pre-configure:
8479: set -e; cd ${WRKSRC}; \
8480: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8481:
1.100 rillig 8482: ...
1.87 wiz 8483: </pre>
1.75 rillig 8484: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8485: require GNU Make.</p>
1.75 rillig 8486: <p>There are times when the configure process makes
1.87 wiz 8487: additional changes to the generated files, which then causes
8488: the build process to try to re-execute the automake sequence.
8489: This is prevented by touching various files in the configure
8490: stage. If this causes problems with your package you can set
8491: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8492: Makefile.</p>
1.75 rillig 8493: </div>
8494: </div>
8495: <div class="sect1" lang="en">
8496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8497: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87 wiz 8498: <div class="sect2" lang="en">
8499: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8500: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8501: <p>Compilers for the C, C++, and Fortran languages comes with
8502: the NetBSD base system. By default, pkgsrc assumes that a package
8503: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8504: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8505: <p>To declare which language's compiler a package needs, set
8506: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8507: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8508: “<span class="quote">fortran</span>” (and any combination). The default is
8509: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8510: written in C++, usually need a C compiler for the configure
8511: phase.</p>
8512: </div>
8513: <div class="sect2" lang="en">
8514: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8515: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8516: <p>If a program is written in Java, use the Java framework in
8517: pkgsrc. The package must include
8518: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8519: provides the following variables:</p>
8520: <div class="itemizedlist"><ul type="disc">
8521: <li><p><code class="varname">USE_JAVA</code> defines if a build
8522: dependency on the JDK is added. If
8523: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8524: there is only a runtime dependency on the JDK. The default is
8525: “<span class="quote">yes</span>”, which also adds a build dependency on the
8526: JDK.</p></li>
8527: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8528: a package needs a Java2 implementation. The supported values
8529: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8530: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8531: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8532: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8533: above. This variable is not set by default.</p></li>
8534: </ul></div>
8535: </div>
8536: <div class="sect2" lang="en">
8537: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8538: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8539: <p>If your package contains interpreted perl scripts, add
8540: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8541: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8542: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8543: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8544: that you want adjusted. Every occurrence of
8545: <code class="filename">*/bin/perl</code> will be replaced with the full
8546: path to the perl executable.</p>
8547: <p>If a particular version of perl is needed, set the
8548: <code class="varname">PERL5_REQD</code> variable to the version number. The
8549: default is “<span class="quote">5.0</span>”.</p>
1.110 hubertf 8550: <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 8551: about handling perl modules.</p>
8552: </div>
8553: <div class="sect2" lang="en">
8554: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8555: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8556: <p>Currently, there is no special handling for other languages
8557: in pkgsrc. If a compiler package provides a
8558: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8559: just add a (build) dependency on the appropriate compiler
8560: package.</p>
8561: </div>
8562: </div>
8563: <div class="sect1" lang="en">
8564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8565: <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 8566: <p>The most common failures when building a package are that
8567: some platforms do not provide certain header files, functions or
8568: libraries, or they provide the functions in a library that the
8569: original package author didn't know. To work around this, you
8570: can rewrite the source code in most cases so that it does not
8571: use the missing functions or provides a replacement function.</p>
8572: <div class="sect2" lang="en">
8573: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8574: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8575: <p>If a package already comes with a GNU configure script, the
8576: preferred way to fix the build failure is to change the
8577: configure script, not the code. In the other cases, you can
8578: utilize the C preprocessor, which defines certain macros
8579: depending on the operating system and hardware architecture it
8580: compiles for. These macros can be queried using for example
8581: <code class="varname">#if defined(__i386)</code>. Almost every operating
8582: system, hardware architecture and compiler has its own macro.
8583: For example, if the macros <code class="varname">__GNUC__</code>,
8584: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8585: are all defined, you know that you are using NetBSD on an i386
8586: compatible CPU, and your compiler is GCC.</p>
8587: <p>The list of the following macros for hardware and
8588: operating system depends on the compiler that is used. For
8589: example, if you want to conditionally compile code on Solaris,
8590: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8591: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8592: <div class="sect3" lang="en">
8593: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8594: <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 8595: <p>To distinguish between 4.4 BSD-derived systems and the
8596: rest of the world, you should use the following code.</p>
8597: <pre class="programlisting">
1.100 rillig 8598: #include <sys/param.h>
8599: #if (defined(BSD) && BSD >= 199306)
8600: /* BSD-specific code goes here */
8601: #else
8602: /* non-BSD-specific code goes here */
8603: #endif
1.75 rillig 8604: </pre>
1.77 rillig 8605: <p>If this distinction is not fine enough, you can also test
8606: for the following macros.</p>
1.75 rillig 8607: <pre class="programlisting">
1.100 rillig 8608: FreeBSD __FreeBSD__
8609: DragonFly __DragonFly__
8610: Interix __INTERIX
8611: IRIX __sgi (TODO: get a definite source for this)
8612: Linux linux, __linux, __linux__
8613: NetBSD __NetBSD__
8614: OpenBSD __OpenBSD__
8615: Solaris sun, __sun
1.75 rillig 8616: </pre>
8617: </div>
8618: <div class="sect3" lang="en">
8619: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8620: <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 8621: <pre class="programlisting">
1.100 rillig 8622: i386 i386, __i386, __i386__
8623: MIPS __mips
8624: SPARC sparc, __sparc
1.75 rillig 8625: </pre>
8626: </div>
8627: <div class="sect3" lang="en">
8628: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8629: <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 8630: <pre class="programlisting">
1.100 rillig 8631: GCC __GNUC__ (major version), __GNUC_MINOR__
8632: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8633: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8634: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8635: </pre>
8636: </div>
8637: </div>
1.78 rillig 8638: <div class="sect2" lang="en">
8639: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8640: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8641: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8642: combinations of compiler version and architecture and almost
8643: always relation to optimisation being enabled. Common symptoms
8644: are gcc internal errors or never finishing compiling a
1.78 rillig 8645: file.</p>
8646: <p>Typically, a workaround involves testing the
8647: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8648: optimisation for that combination of file,
8649: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8650: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8651: number of examples.</p>
8652: </div>
8653: <div class="sect2" lang="en">
8654: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8655: <a name="undefined-reference"></a>19.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8656: <p>This error message often means that a package did not
1.78 rillig 8657: link to a shared library it needs. The following functions are
8658: known to cause this error message over and over.</p>
8659: <div class="informaltable">
8660: <a name="undefined-reference-functions"></a><table border="1">
8661: <colgroup>
8662: <col>
8663: <col>
8664: <col>
8665: </colgroup>
8666: <thead><tr>
8667: <th>Function</th>
8668: <th>Library</th>
8669: <th>Affected platforms</th>
8670: </tr></thead>
8671: <tbody>
8672: <tr>
8673: <td>accept, bind, connect</td>
8674: <td>-lsocket</td>
8675: <td>Solaris</td>
8676: </tr>
8677: <tr>
8678: <td>crypt</td>
8679: <td>-lcrypt</td>
8680: <td>DragonFly, NetBSD</td>
8681: </tr>
8682: <tr>
8683: <td>dlopen, dlsym</td>
8684: <td>-ldl</td>
8685: <td>Linux</td>
8686: </tr>
8687: <tr>
8688: <td>gethost*</td>
8689: <td>-lnsl</td>
8690: <td>Solaris</td>
8691: </tr>
8692: <tr>
8693: <td>inet_aton</td>
8694: <td>-lresolv</td>
8695: <td>Solaris</td>
8696: </tr>
8697: <tr>
8698: <td>nanosleep, sem_*, timer_*</td>
8699: <td>-lrt</td>
8700: <td>Solaris</td>
8701: </tr>
8702: <tr>
8703: <td>openpty</td>
8704: <td>-lutil</td>
8705: <td>Linux</td>
8706: </tr>
8707: </tbody>
8708: </table>
8709: </div>
8710: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8711: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8712: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8713: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8714: bmake</strong></span>.</p>
1.92 rillig 8715: <div class="sect3" lang="en">
8716: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8717: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8718: <p>When you are using the SunPro compiler, there is another
8719: possibility. That compiler cannot handle the following code:</p>
8720: <pre class="programlisting">
1.100 rillig 8721: extern int extern_func(int);
1.93 rillig 8722:
1.100 rillig 8723: static inline int
8724: inline_func(int x)
8725: {
1.92 rillig 8726: return extern_func(x);
1.100 rillig 8727: }
1.93 rillig 8728:
1.100 rillig 8729: int main(void)
8730: {
1.92 rillig 8731: return 0;
1.100 rillig 8732: }
1.92 rillig 8733: </pre>
8734: <p>It generates the code for <code class="function">inline_func</code> even if
8735: that function is never used. This code then refers to
8736: <code class="function">extern_func</code>, which can usually not be resolved. To
8737: solve this problem you can try to tell the package to disable inlining
8738: of functions.</p>
8739: </div>
1.87 wiz 8740: </div>
8741: <div class="sect2" lang="en">
8742: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8743: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8744: <p>Sometimes packages fail to build because the compiler runs
8745: into an operating system specific soft limit. With the
8746: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8747: to unlimit the resources. Currently, the allowed values are
8748: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8749: Setting this variable is similar to running the shell builtin
1.110 hubertf 8750: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8751: segment size or maximum stack size of a process, respectively, to
8752: their hard limits.</p>
1.78 rillig 8753: </div>
1.75 rillig 8754: </div>
8755: <div class="sect1" lang="en">
8756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8757: <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 8758: <div class="sect2" lang="en">
8759: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8760: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8761: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8762: with some operating systems cannot create more than one
8763: directory at a time. As such, you should call
8764: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8765: <pre class="programlisting">
1.100 rillig 8766: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8767: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8768: </pre>
1.78 rillig 8769: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8770: dir2</code></span>” to the
8771: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8772: automatically do the right thing.</p>
1.75 rillig 8773: </div>
8774: <div class="sect2" lang="en">
8775: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8776: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8777: <p>In general, documentation should be installed into
1.87 wiz 8778: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8779: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8780: includes the version number of the package).</p>
1.84 wiz 8781: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8782: directory where HTML documentation is installed with the
8783: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8784: is needed because otherwise the documentation ends up in
8785: <code class="filename">${PREFIX}/share/doc/html</code> or other
8786: places.</p>
8787: <p>An exception to the above is that library API documentation
1.91 rillig 8788: 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 8789: browsers (devhelp) should be left at their default location, which
8790: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8791: documentation can be recognized from files ending in
8792: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8793: (It is also acceptable to install such files in
8794: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8795: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8796: <code class="filename">.devhelp*</code> file must be directly in that
8797: directory then, no additional subdirectory level is allowed in
8798: this case. This is usually achieved by using
8799: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8800: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8801: though.)</p>
1.75 rillig 8802: </div>
8803: <div class="sect2" lang="en">
8804: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8805: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8806: <p>Certain packages, most of them in the games category, install
1.87 wiz 8807: a score file that allows all users on the system to record their
8808: highscores. In order for this to work, the binaries need to be
8809: installed setgid and the score files owned by the appropriate
8810: group and/or owner (traditionally the "games" user/group). The
8811: following variables, documented in more detail in
8812: <code class="filename">mk/defaults/mk.conf</code>, control this
8813: behaviour: <code class="varname">SETGIDGAME</code>,
8814: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8815: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8816: <p>Note that per default, setgid installation of games is
1.87 wiz 8817: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8818: the other variables accordingly.</p>
1.114 jmcneill 8819: <p>A package should therefore never hard code file ownership or
1.87 wiz 8820: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8821: <code class="varname">INSTALL_GAME_DATA</code> to set these
8822: correctly.</p>
1.75 rillig 8823: </div>
8824: <div class="sect2" lang="en">
8825: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8826: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8827: <p><code class="varname">DESTDIR</code> support means that a package
8828: installs into a staging directory, not the final location of the
8829: files. Then a binary package is created which can be used for
8830: installation as usual. There are two ways: Either the package must
8831: install as root (“<span class="quote">destdir</span>”) or the package can
8832: install as non-root user (“<span class="quote">user-destdir</span>”).</p>
8833: <div class="itemizedlist"><ul type="disc">
8834: <li><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
8835: set to “<span class="quote">destdir</span>” or “<span class="quote">user-destdir</span>”. If
8836: bsd.prefs.mk is included in the Makefile,
8837: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8838: the inclusion.</p></li>
1.103 wiz 8839: <li><p>All installation operations have to be prefixed with
8840: <code class="filename">${DESTDIR}</code>.</p></li>
8841: <li><p>automake gets this DESTDIR mostly right
8842: automatically. Many manual rules and pre/post-install often are
8843: incorrect; fix them.</p></li>
8844: <li><p>If files are installed with special owner/group
1.118 imil 8845: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.103 wiz 8846: <li><p>In general, packages should support
8847: <code class="varname">UNPRIVILEGED</code> to be able to use
8848: DESTDIR.</p></li>
8849: </ul></div>
8850: </div>
8851: <div class="sect2" lang="en">
8852: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8853: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8854: <p>Your package may also contain scripts with hardcoded paths to
8855: other interpreters besides (or as well as) perl. To correct the
8856: full pathname to the script interpreter, you need to set the
8857: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8858: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8859: <pre class="programlisting">
1.100 rillig 8860: REPLACE_INTERPRETER+= tcl
8861: REPLACE.tcl.old= .*/bin/tclsh
8862: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8863: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8864: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8865: </pre>
1.75 rillig 8866: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8867: <h3 class="title">Note</h3>
8868: <p>Before March 2006, these variables were called
1.87 wiz 8869: <code class="varname">_REPLACE.*</code> and
8870: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8871: </div>
8872: </div>
8873: <div class="sect2" lang="en">
8874: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8875: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8876: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8877: the Makefile fragment
8878: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8879: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8880: configuration for such modules as well as various hooks to tune
8881: this configuration. See comments in this file for
8882: details.</p>
1.75 rillig 8883: <p>Perl5 modules will install into different places depending
1.87 wiz 8884: on the version of perl used during the build process. To
8885: address this, pkgsrc will append lines to the
8886: <code class="filename">PLIST</code> corresponding to the files listed in
8887: the installed <code class="filename">.packlist</code> file generated by
8888: most perl5 modules. This is invoked by defining
8889: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8890: paths to packlist files, e.g.:</p>
1.75 rillig 8891: <pre class="programlisting">
1.100 rillig 8892: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8893: </pre>
1.75 rillig 8894: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8895: <code class="varname">PERL5_SITEARCH</code>, and
8896: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8897: in which perl5 modules may be installed, and may be used by
8898: perl5 packages that don't have a packlist. These three
8899: variables are also substituted for in the
8900: <code class="filename">PLIST</code>.</p>
1.75 rillig 8901: </div>
8902: <div class="sect2" lang="en">
8903: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8904: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8905: <p>Some packages install info files or use the
1.87 wiz 8906: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8907: commands. <code class="varname">INFO_FILES</code> should be defined in
8908: the package Makefile so that <code class="filename">INSTALL</code> and
8909: <code class="filename">DEINSTALL</code> scripts will be generated to
8910: handle registration of the info files in the Info directory
8911: file. The “<span class="quote">install-info</span>” command used for the info
8912: files registration is either provided by the system, or by a
8913: special purpose package automatically added as dependency if
8914: needed.</p>
1.75 rillig 8915: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8916: <code class="filename">${PREFIX}</code> where info files are primarily
8917: located. <code class="varname">PKGINFODIR</code> defaults to
8918: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8919: <p>The info files for the package should be listed in the
1.87 wiz 8920: package <code class="filename">PLIST</code>; however any split info files
8921: need not be listed.</p>
1.75 rillig 8922: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8923: at build time must add “<span class="quote">makeinfo</span>” to
8924: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8925: version of the “<span class="quote">makeinfo</span>” command is needed it
8926: should be noted with the <code class="varname">TEXINFO_REQD</code>
8927: variable in the package <code class="filename">Makefile</code>. By
8928: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8929: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8930: does not match the required minimum, a build dependency on the
1.91 rillig 8931: <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 8932: be added automatically.</p>
1.75 rillig 8933: <p>The build and installation process of the software provided
1.87 wiz 8934: by the package should not use the
1.110 hubertf 8935: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8936: info files is the task of the package
8937: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8938: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8939: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8940: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8941: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8942: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8943: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8944: no effect except the logging of a message. The script overriding
1.110 hubertf 8945: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8946: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8947: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8948: </div>
8949: <div class="sect2" lang="en">
8950: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8951: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8952: <p>All packages that install manual pages should install them
1.87 wiz 8953: into the same directory, so that there is one common place to look
8954: for them. In pkgsrc, this place is
8955: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8956: should be used in packages. The default for
8957: <code class="varname">PKGMANDIR</code> is
8958: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8959: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8960: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8961: <h3 class="title">Note</h3>
1.87 wiz 8962: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8963: is far from complete.</p>
1.75 rillig 8964: </div>
1.81 rillig 8965: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8966: <code class="filename">man/</code> as the top level directory for the man
8967: page file entries, and the pkgsrc framework will convert as
8968: needed. In all other places, the correct
8969: <code class="varname">PKGMANDIR</code> must be used.</p>
8970: <p>Packages that are
8971: configured with <code class="varname">GNU_CONFIGURE</code> set as
8972: “<span class="quote">yes</span>”, by default will use the
8973: <code class="filename">./configure</code>
8974: --mandir switch to set where the man pages should be installed.
8975: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8976: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8977: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8978: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8979: to “<span class="quote">no</span>”.
8980: Or if the <code class="filename">./configure</code> script uses
8981: a non-standard use of --mandir, you can set
8982: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8983: <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 8984: information on installation of compressed manual pages.</p>
1.75 rillig 8985: </div>
8986: <div class="sect2" lang="en">
8987: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8988: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8989: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8990: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8991: you need to take some extra steps to make sure they get registered
8992: in the database:</p>
1.75 rillig 8993: <div class="orderedlist"><ol type="1">
1.107 rillig 8994: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8995: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8996: takes care of rebuilding the GConf database at installation and
1.87 wiz 8997: deinstallation time, and tells the package where to install
1.107 rillig 8998: GConf data files using some standard configure arguments. It
1.87 wiz 8999: also disallows any access to the database directly from the
9000: package.</p></li>
1.75 rillig 9001: <li><p>Ensure that the package installs its
1.87 wiz 9002: <code class="filename">.schemas</code> files under
9003: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9004: installed under <code class="filename">${PREFIX}/etc</code>, you will
9005: need to manually patch the package.</p></li>
1.75 rillig 9006: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 9007: directory, as they will be handled automatically. See
1.110 hubertf 9008: <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 9009: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 9010: your <code class="filename">Makefile</code> with a list of all
9011: <code class="filename">.schemas</code> files installed by the package, if
9012: any. Names must not contain any directories in them.</p></li>
1.107 rillig 9013: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 9014: your <code class="filename">Makefile</code> with a
9015: list of all <code class="filename">.entries</code> files installed by the
9016: package, if any. Names must not contain any directories in
9017: them.</p></li>
1.75 rillig 9018: </ol></div>
9019: </div>
9020: <div class="sect2" lang="en">
9021: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 9022: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 9023: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 9024: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 9025: get registered in the database:</p>
1.75 rillig 9026: <div class="orderedlist"><ol type="1">
9027: <li><p>Include
1.119 mishka 9028: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9029: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 9030: takes care of rebuilding the scrollkeeper database at
9031: installation and deinstallation time, and disallows any access
9032: to it directly from the package.</p></li>
1.75 rillig 9033: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9034: <code class="filename">libdata/scrollkeeper</code> directory, as they
9035: will be handled automatically.</p></li>
1.76 rillig 9036: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 9037: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9038: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 9039: </ol></div>
9040: </div>
9041: <div class="sect2" lang="en">
9042: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9043: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9044: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9045: the fonts database in the directory where they get installed at
9046: installation and deinstallation time. This can be automatically
9047: done by using the pkginstall framework.</p>
1.75 rillig 9048: <p>You can list the directories where fonts are installed in the
1.87 wiz 9049: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9050: variables, where <em class="replaceable"><code>type</code></em> can be one of
9051: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
9052: Also make sure that the database file
9053: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9054: <p>Note that you should not create new directories for fonts;
1.87 wiz 9055: instead use the standard ones to avoid that the user needs to
9056: manually configure his X server to find them.</p>
1.75 rillig 9057: </div>
9058: <div class="sect2" lang="en">
9059: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9060: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9061: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9062: take some extra steps to get them registered in the GTK2 database
9063: properly:</p>
1.75 rillig 9064: <div class="orderedlist"><ol type="1">
9065: <li><p>Include
1.87 wiz 9066: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9067: <code class="filename">buildlink3.mk</code> file. This takes care of
9068: rebuilding the database at installation and deinstallation time.</p></li>
9069: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9070: your package installs GTK2 immodules.</p></li>
9071: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9072: GTK2 loaders.</p></li>
1.75 rillig 9073: <li>
1.87 wiz 9074: <p>Patch the package to not touch any of the GTK2
9075: databases directly. These are:</p>
1.75 rillig 9076: <div class="itemizedlist"><ul type="disc">
1.76 rillig 9077: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9078: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9079: </ul></div>
9080: </li>
1.87 wiz 9081: <li><p>Check the <code class="filename">PLIST</code> and remove
9082: any entries under the <code class="filename">libdata/gtk-2.0</code>
9083: directory, as they will be handled automatically.</p></li>
1.75 rillig 9084: </ol></div>
9085: </div>
9086: <div class="sect2" lang="en">
9087: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9088: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9089: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9090: registered in system-wide catalogs (like DTDs, sub-catalogs,
9091: etc.), you need to take some extra steps:</p>
1.75 rillig 9092: <div class="orderedlist"><ol type="1">
9093: <li><p>Include
1.87 wiz 9094: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9095: your <code class="filename">Makefile</code>, which takes care of
9096: registering those files in system-wide catalogs at
9097: installation and deinstallation time.</p></li>
1.75 rillig 9098: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9099: any SGML catalogs installed by the package.</p></li>
1.75 rillig 9100: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9101: any XML catalogs installed by the package.</p></li>
1.75 rillig 9102: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9103: to be added to the SGML catalog. These come in groups of
9104: three strings; see xmlcatmgr(1) for more information
9105: (specifically, arguments recognized by the 'add' action).
9106: Note that you will normally not use this variable.</p></li>
1.75 rillig 9107: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9108: to be added to the XML catalog. These come in groups of three
9109: strings; see xmlcatmgr(1) for more information (specifically,
9110: arguments recognized by the 'add' action). Note that you will
9111: normally not use this variable.</p></li>
1.75 rillig 9112: </ol></div>
9113: </div>
9114: <div class="sect2" lang="en">
9115: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9116: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9117: <p>If a package provides extensions to the MIME database by
1.87 wiz 9118: installing <code class="filename">.xml</code> files inside
9119: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9120: need to take some extra steps to ensure that the database is kept
9121: consistent with respect to these new files:</p>
1.75 rillig 9122: <div class="orderedlist"><ol type="1">
9123: <li><p>Include
1.87 wiz 9124: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9125: (avoid using the <code class="filename">buildlink3.mk</code> file from
9126: this same directory, which is reserved for inclusion from
9127: other <code class="filename">buildlink3.mk</code> files). It takes
9128: care of rebuilding the MIME database at installation and
9129: deinstallation time, and disallows any access to it directly
9130: from the package.</p></li>
1.75 rillig 9131: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9132: <code class="filename">share/mime</code> directory,
9133: <span class="emphasis"><em>except</em></span> for files saved under
9134: <code class="filename">share/mime/packages</code>. The former are
9135: handled automatically by
9136: the update-mime-database program, but the latter are
9137: package-dependent and must be removed by the package that
9138: installed them in the first place.</p></li>
1.76 rillig 9139: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9140: from the PLIST. They will be handled by the shared-mime-info
9141: package.</p></li>
1.75 rillig 9142: </ol></div>
9143: </div>
9144: <div class="sect2" lang="en">
9145: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9146: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9147: <p>If a package uses intltool during its build, add
9148: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9149: which forces it to use the intltool package provided by pkgsrc,
9150: instead of the one bundled with the distribution file.</p>
1.75 rillig 9151: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9152: latest available version; this way, the package benefits of any
9153: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9154: </div>
9155: <div class="sect2" lang="en">
9156: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9157: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9158: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9159: the startup directory by default, but you can enable it, by adding
9160: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9161: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9162: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9163: it will automatically remove the scripts when the package is
9164: deinstalled.</p>
1.75 rillig 9165: </div>
9166: <div class="sect2" lang="en">
9167: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9168: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9169: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9170: the <code class="filename">ls-R</code> database of the tree needs to be
9171: updated.</p>
1.75 rillig 9172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9173: <h3 class="title">Note</h3>
1.125 wiz 9174: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9175: packages should install files
1.125 wiz 9176: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9177: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9178: </div>
9179: <div class="orderedlist"><ol type="1">
9180: <li><p>Include
1.125 wiz 9181: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9182: takes care of rebuilding the <code class="filename">ls-R</code>
9183: database at installation and deinstallation time.</p></li>
1.75 rillig 9184: <li>
9185: <p>If your package installs files into a texmf
1.87 wiz 9186: tree other than the one
1.125 wiz 9187: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9188: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9189: trees that need database update.</p>
1.75 rillig 9190: <p>If your package also installs font map files that need
1.110 hubertf 9191: to be registered using <span class="command"><strong>updmap</strong></span>,
1.125 wiz 9192: include <code class="filename">../../print/texlive-tetex/map.mk</code> and
9193: set <code class="varname">TEX_MAP_FILES</code> and/or
9194: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9195: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9196: be run automatically at installation/deinstallation to
9197: enable/disable font map files for TeX output
9198: drivers.</p>
1.75 rillig 9199: </li>
1.76 rillig 9200: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9201: databases are included in <code class="filename">PLIST</code>, as
9202: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9203: </ol></div>
9204: </div>
1.85 jmmv 9205: <div class="sect2" lang="en">
9206: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9207: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9208: emulation</h3></div></div></div>
9209: <p>There are some packages that provide libraries and
9210: executables for running binaries from a one operating system
9211: on a different one (if the latter supports it). One example
9212: is running Linux binaries on NetBSD.</p>
1.91 rillig 9213: <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 9214: helps in extracting and packaging Linux rpm packages.</p>
9215: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9216: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9217: if all libraries for each installed executable can be found by
9218: the dynamic linker. Since the standard dynamic linker is run,
9219: this fails for emulation packages, because the libraries used
9220: by the emulation are not in the standard directories.</p>
9221: </div>
9222: <div class="sect2" lang="en">
9223: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9224: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9225: <p>If a package installs images under the
1.87 wiz 9226: <code class="filename">share/icons/hicolor</code> and/or updates the
9227: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9228: database, you need to take some extra steps to make sure that the
9229: shared theme directory is handled appropriately and that the cache
9230: database is rebuilt:</p>
1.85 jmmv 9231: <div class="orderedlist"><ol type="1">
9232: <li><p>Include
1.87 wiz 9233: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9234: <li><p>Check the <code class="filename">PLIST</code> and remove the
9235: entry that refers to the theme cache.</p></li>
1.85 jmmv 9236: <li><p>Ensure that the PLIST does not remove the shared icon
9237: directories from the <code class="filename">share/icons/hicolor</code>
9238: hierarchy because they will be handled automatically.</p></li>
9239: </ol></div>
9240: <p>The best way to verify that the PLIST is correct with
9241: respect to the last two points is to regenerate it using
1.110 hubertf 9242: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9243: </div>
9244: <div class="sect2" lang="en">
9245: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9246: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9247: <p>If a package installs <code class="filename">.desktop</code> files
9248: under <code class="filename">share/applications</code> and these include
9249: MIME information, you need to take extra steps to ensure that they
9250: are registered into the MIME database:</p>
9251: <div class="orderedlist"><ol type="1">
9252: <li><p>Include
9253: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9254: <li><p>Check the PLIST and remove the entry that refers to the
9255: <code class="filename">share/applications/mimeinfo.cache</code> file.
9256: It will be handled automatically.</p></li>
9257: </ol></div>
9258: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9259: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9260: print-PLIST</strong></span>.</p>
1.75 rillig 9261: </div>
9262: </div>
1.87 wiz 9263: <div class="sect1" lang="en">
9264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9265: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9266: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9267: immediately. In this case, one can plainly mark a package as broken. For
9268: this, one just sets the variable <code class="varname">BROKEN</code> to the
9269: reason why the package is broken (similar to the
9270: <code class="varname">RESTRICTED</code> variable). A user trying to build
9271: the package will immediately be shown this message, and the build
9272: will not be even tried.</p>
9273: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9274: intervals.</p>
9275: </div>
1.75 rillig 9276: </div>
9277: <div class="chapter" lang="en">
9278: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9279: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9280: <p>To check out all the gotchas when building a package, here are
9281: the steps that I do in order to get a package working. Please note
9282: this is basically the same as what was explained in the previous
9283: sections, only with some debugging aids.</p>
1.75 rillig 9284: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 9285: <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 9286: <li>
1.91 rillig 9287: <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 9288: create a directory for a new package, change into it, then run
1.110 hubertf 9289: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9290: <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>
9291: <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>
9292: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9293: </li>
1.76 rillig 9294: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9295: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110 hubertf 9296: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75 rillig 9297: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9298: configure step to the package's
9299: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9300: <li>
9301: <p>Make the package compile, doing multiple rounds of</p>
9302: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9303: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9304: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9305: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9306: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9307: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9308: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9309: <p>Doing this step as non-root user will ensure that no files
9310: are modified that shouldn't be, especially during the build
1.110 hubertf 9311: phase. <span class="command"><strong>mkpatches</strong></span>,
9312: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9313: 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 9314: package.</p>
1.75 rillig 9315: </li>
1.88 wiz 9316: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.123 snj 9317: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “Makefile”</a>.</p></li>
1.75 rillig 9318: <li>
1.76 rillig 9319: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9320: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9321: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9322: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9323: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9324: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9325: <p>You usually need to be <code class="username">root</code> to do
9326: this. Look if there are any files left:</p>
1.75 rillig 9327: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9328: <p>If this reveals any files that are missing in
1.88 wiz 9329: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9330: </li>
9331: <li>
1.88 wiz 9332: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9333: package again and make a binary package:</p>
1.75 rillig 9334: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9335: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9336: </li>
9337: <li>
9338: <p>Delete the installed package:</p>
1.88 wiz 9339: <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 9340: </li>
9341: <li>
1.110 hubertf 9342: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9343: command, which shouldn't find anything now:</p>
1.75 rillig 9344: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9345: </li>
9346: <li>
9347: <p>Reinstall the binary package:</p>
1.93 rillig 9348: <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 9349: </li>
1.88 wiz 9350: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9351: <li>
1.110 hubertf 9352: <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 9353: reports:</p>
1.75 rillig 9354: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9355: </li>
1.110 hubertf 9356: <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 9357: </ul></div>
9358: </div>
9359: <div class="chapter" lang="en">
9360: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9361: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9362: <div class="toc">
9363: <p><b>Table of Contents</b></p>
9364: <dl>
1.106 rillig 9365: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9366: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9367: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9368: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9369: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9370: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9371: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9372: </dl>
9373: </div>
9374: <div class="sect1" lang="en">
9375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9376: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9377: <p>Our policy is that we accept binaries only from pkgsrc
9378: developers to guarantee that the packages don't contain any
9379: trojan horses etc. This is not to annoy anyone but rather to
9380: protect our users! You're still free to put up your home-made
9381: binary packages and tell the world where to get them. NetBSD
9382: developers doing bulk builds and wanting to upload them please
1.110 hubertf 9383: 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 9384: </div>
9385: <div class="sect1" lang="en">
9386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9387: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9388: <p>First, check that your package is complete, compiles and
1.110 hubertf 9389: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9390: 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 9391: archive that contains all files that make up the package.
1.87 wiz 9392: Finally, send this package to the pkgsrc bug tracking system,
1.110 hubertf 9393: 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 9394: that, go to the web page
1.110 hubertf 9395: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 9396: which contains some instructions and a link to a form where you
9397: can submit packages. The
9398: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
9399: also available as a substitute for either of the above two tools.
9400: </p>
1.87 wiz 9401: <p>In the form of the problem report, the category should be
9402: “<span class="quote">pkg</span>”, the synopsis should include the package name
9403: and version number, and the description field should contain a
9404: short description of your package (contents of the COMMENT
9405: variable or DESCR file are OK). The uuencoded package data should
9406: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9407: <p>If you want to submit several packages, please send a
9408: separate PR for each one, it's easier for us to track things
9409: that way.</p>
9410: <p>Alternatively, you can also import new packages into
9411: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
1.110 hubertf 9412: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9413: for details.</p>
9414: </div>
9415: <div class="sect1" lang="en">
9416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9417: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9418: <p>Please note all package additions, updates, moves, and
1.93 rillig 9419: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9420: important to keep this file up to date and conforming to the
9421: existing format, because it will be used by scripts to
1.110 hubertf 9422: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9423: sites. Additionally, check the
1.76 rillig 9424: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9425: for the package you updated or removed, in case it was mentioned
9426: there.</p>
9427: <p>When the <code class="varname">PKGREVISION</code> of a package is
9428: bumped, the change should appear in
1.93 rillig 9429: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9430: related or otherwise relevant. Mass bumps that result from a
9431: dependency being updated should not be mentioned. In all other
9432: cases it's the developer's decision.</p>
9433: <p>There is a make target that helps in creating proper
1.110 hubertf 9434: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9435: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9436: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9437: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9438: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9439: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9440: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9441: For new packages, or package moves or removals, set the
9442: <code class="varname">CTYPE</code> variable on the command line to "Added",
9443: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9444: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9445: not the same as your NetBSD login name. The target also automatically
9446: removes possibly existing entries for the package in the
9447: <code class="filename">TODO</code> file. Don't forget to commit
9448: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
1.126 jakllsch 9449: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9450: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9451: makes the cvs commands use the main repository.
9452: </p>
1.75 rillig 9453: </div>
9454: <div class="sect1" lang="en">
9455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9456: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9457: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9458: access to the pkgsrc repository. Please remember that cvs
9459: imports files relative to the current working directory, and that
9460: the pathname that you
1.110 hubertf 9461: give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75 rillig 9462: to place the files in the repository. Newly created packages should be
9463: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9464: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9465: <pre class="programlisting">
1.100 rillig 9466: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9467: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9468: </pre>
1.87 wiz 9469: <p>Remember to move the directory from which you imported out of
1.75 rillig 9470: the way, or cvs will complain the next time you “<span class="quote">cvs
9471: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9472: package to the category's <code class="filename">Makefile</code>.</p>
9473: <p>The commit message of the initial import should include part of the
1.76 rillig 9474: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9475: what the package is/does.</p>
9476: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9477: add</span>” because the former gets everything with a single command,
1.87 wiz 9478: and provides a consistent tag.</p>
1.75 rillig 9479: </div>
9480: <div class="sect1" lang="en">
9481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9482: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9483: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9484: changes between old and new versions into the commit log when updating
1.87 wiz 9485: a package. There are various reasons for this:</p>
1.75 rillig 9486: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9487: <li><p>A URL is volatile, and can change over time. It may go away completely
9488: or its information may be overwritten by newer information.</p></li>
9489: <li><p>Having the change information between old and new versions in our CVS
9490: repository is very useful for people who use either cvs or anoncvs.</p></li>
9491: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9492: repository is very useful for people who read the pkgsrc-changes mailing
9493: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9494: the package.</p></li>
1.75 rillig 9495: </ul></div>
1.87 wiz 9496: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9497: has been released, it should not automatically be upgraded in the CVS
9498: repository. We prefer to be conservative in the packages that are
9499: included in pkgsrc - development or beta packages are not really the
9500: best thing for most places in which pkgsrc is used. Please use your
9501: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9502: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9503: </div>
9504: <div class="sect1" lang="en">
9505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9506: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9507: <p>Renaming packages is not recommended.</p>
9508: <p>When renaming packages, be sure to fix any references to old name
9509: in other Makefiles, options, buildlink files, etc.</p>
9510: <p>Also When renaming a package, please define
9511: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9512: pattern(s) of the previous package name.
9513: This may be repeated for multiple renames.
9514: The new package would be an exact replacement.
9515: </p>
9516: <p>Note that “<span class="quote">successor</span>” in the
9517: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9518: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9519: not be an exact replacement but is a suggestion for the replaced
9520: functionality.</p>
9521: </div>
9522: <div class="sect1" lang="en">
9523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9524: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9525: <p>It is preferred that packages are not renamed or moved, but if needed
9526: please follow these steps.
9527: </p>
1.75 rillig 9528: <div class="orderedlist"><ol type="1">
9529: <li><p>Make a copy of the directory somewhere else.</p></li>
9530: <li>
9531: <p>Remove all CVS dirs.</p>
1.87 wiz 9532: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9533: <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 9534: <p>and use that for further work.</p>
1.75 rillig 9535: </li>
9536: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9537: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9538: instead of “<span class="quote">../../category/package</span>”.</p></li>
1.122 reed 9539: <li><p>In the modified package's Makefile, consider setting
9540: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9541: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9542: for doing an update using pkgsrc building; for example, it can
9543: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
9544: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9545: new <code class="varname">PKGPATH</code> for that moved package. Note that
9546: it may have multiple matches, so the tool should also check on the
9547: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9548: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9549: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.110 hubertf 9550: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9551: place.</p></li>
9552: <li>
9553: <p>Check if any package depends on it:
9554: </p>
9555: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9556: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9557: </li>
9558: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110 hubertf 9559: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9560: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9561: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9562: <li>
9563: <p>Commit the changed and removed files:</p>
9564: <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 9565: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9566: </li>
9567: </ol></div>
9568: </div>
9569: </div>
9570: <div class="chapter" lang="en">
9571: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9572: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9573: <p>This section contains the answers to questions that may
9574: arise when you are writing a package. If you don't find your
9575: question answered here, first have a look in the other chapters,
9576: and if you still don't have the answer, ask on the
9577: <code class="literal">pkgsrc-users</code> mailing list.</p>
9578: <div class="qandaset">
9579: <dl>
1.106 rillig 9580: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9581: MAKEFLAGS, .MAKEFLAGS and
9582: MAKE_FLAGS?</a>
9583: </dt>
1.106 rillig 9584: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9585: MAKE, GMAKE and
9586: MAKE_PROGRAM?</a>
9587: </dt>
1.106 rillig 9588: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9589: CC, PKG_CC and
9590: PKGSRC_COMPILER?</a>
9591: </dt>
1.106 rillig 9592: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9593: BUILDLINK_LDFLAGS,
9594: BUILDLINK_LDADD and
9595: BUILDLINK_LIBS?</a>
9596: </dt>
1.106 rillig 9597: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9598: VARNAME=BUILDLINK_PREFIX.foo
9599: say it's empty?</a>
9600: </dt>
1.106 rillig 9601: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9602: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9603: don't understand the := inside
9604: it.</a>
9605: </dt>
1.106 rillig 9606: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9607: developers?</a>
9608: </dt>
1.106 rillig 9609: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9610: documentation?</a>
9611: </dt>
1.106 rillig 9612: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9613: do?</a>
9614: </dt>
1.75 rillig 9615: </dl>
9616: <table border="0" summary="Q and A Set">
9617: <col align="left" width="1%">
9618: <tbody>
9619: <tr class="question">
9620: <td align="left" valign="top">
1.126 jakllsch 9621: <a name="devfaq.makeflags"></a><a name="id52060368"></a><p><b>22.1.</b></p>
1.75 rillig 9622: </td>
9623: <td align="left" valign="top"><p>What is the difference between
9624: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9625: <code class="varname">MAKE_FLAGS</code>?</p></td>
9626: </tr>
9627: <tr class="answer">
1.91 rillig 9628: <td align="left" valign="top"></td>
1.75 rillig 9629: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110 hubertf 9630: 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 9631: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9632: the <code class="varname">MAKE_PROGRAM</code> when building the
9633: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9634: </tr>
9635: <tr class="question">
9636: <td align="left" valign="top">
1.126 jakllsch 9637: <a name="devfaq.make"></a><a name="id52060403"></a><p><b>22.2.</b></p>
1.75 rillig 9638: </td>
9639: <td align="left" valign="top"><p>What is the difference between
9640: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9641: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9642: </tr>
9643: <tr class="answer">
1.91 rillig 9644: <td align="left" valign="top"></td>
1.75 rillig 9645: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110 hubertf 9646: <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 9647: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9648: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9649: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9650: Make program that is used for building the
9651: package.</p></td>
9652: </tr>
9653: <tr class="question">
9654: <td align="left" valign="top">
1.126 jakllsch 9655: <a name="devfaq.cc"></a><a name="id52060441"></a><p><b>22.3.</b></p>
1.75 rillig 9656: </td>
9657: <td align="left" valign="top"><p>What is the difference between
9658: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9659: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9660: </tr>
9661: <tr class="answer">
1.91 rillig 9662: <td align="left" valign="top"></td>
1.75 rillig 9663: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9664: compiler, which can be configured by the pkgsrc user.
9665: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9666: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9667: path to a compiler, but the type of compiler that should be
1.76 rillig 9668: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9669: information about the latter variable.</p></td>
9670: </tr>
9671: <tr class="question">
9672: <td align="left" valign="top">
1.126 jakllsch 9673: <a name="devfaq.bl3flags"></a><a name="id52060476"></a><p><b>22.4.</b></p>
1.75 rillig 9674: </td>
9675: <td align="left" valign="top"><p>What is the difference between
9676: <code class="varname">BUILDLINK_LDFLAGS</code>,
9677: <code class="varname">BUILDLINK_LDADD</code> and
9678: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9679: </tr>
9680: <tr class="answer">
1.91 rillig 9681: <td align="left" valign="top"></td>
1.75 rillig 9682: <td align="left" valign="top"><p>[FIXME]</p></td>
9683: </tr>
9684: <tr class="question">
9685: <td align="left" valign="top">
1.126 jakllsch 9686: <a name="devfaq.bl3prefix"></a><a name="id52060494"></a><p><b>22.5.</b></p>
1.75 rillig 9687: </td>
1.110 hubertf 9688: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9689: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9690: say it's empty?</p></td>
9691: </tr>
9692: <tr class="answer">
1.91 rillig 9693: <td align="left" valign="top"></td>
1.75 rillig 9694: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9695: available in the “<span class="quote">wrapper</span>” phase and later. To
9696: “<span class="quote">simulate</span>” the wrapper phase, append
1.110 hubertf 9697: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9698: command.</p></td>
9699: </tr>
1.78 rillig 9700: <tr class="question">
9701: <td align="left" valign="top">
1.126 jakllsch 9702: <a name="devfaq.master_sites"></a><a name="id52060521"></a><p><b>22.6.</b></p>
1.78 rillig 9703: </td>
9704: <td align="left" valign="top"><p>What does
9705: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9706: don't understand the <code class="literal">:=</code> inside
9707: it.</p></td>
9708: </tr>
9709: <tr class="answer">
1.91 rillig 9710: <td align="left" valign="top"></td>
1.78 rillig 9711: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9712: assignment operator, like you might expect at first sight.
9713: Instead, it is a degenerate form of
9714: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110 hubertf 9715: 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 9716: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9717: case of <code class="varname">MASTER_SITE_*</code>,
9718: <em class="replaceable"><code>old_string</code></em> is the empty string and
9719: <em class="replaceable"><code>new_string</code></em> is
9720: <code class="literal">package/</code>. That's where the
9721: <code class="literal">:</code> and the <code class="literal">=</code> fall
9722: together.</p></td>
9723: </tr>
9724: <tr class="question">
9725: <td align="left" valign="top">
1.126 jakllsch 9726: <a name="devfaq.mailinglists"></a><a name="id52060587"></a><p><b>22.7.</b></p>
1.78 rillig 9727: </td>
9728: <td align="left" valign="top"><p>Which mailing lists are there for package
9729: developers?</p></td>
9730: </tr>
9731: <tr class="answer">
1.91 rillig 9732: <td align="left" valign="top"></td>
1.78 rillig 9733: <td align="left" valign="top"><div class="variablelist"><dl>
1.110 hubertf 9734: <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 9735: <dd><p>This is a list for technical discussions related
9736: to pkgsrc development, e.g. soliciting feedback for changes to
9737: pkgsrc infrastructure, proposed new features, questions related
9738: to porting pkgsrc to a new platform, advice for maintaining a
9739: package, patches that affect many packages, help requests moved
9740: from pkgsrc-users when an infrastructure bug is found,
9741: etc.</p></dd>
1.110 hubertf 9742: <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 9743: <dd><p>All bug reports in category "pkg" sent with
1.110 hubertf 9744: <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 9745: directly; use one of the other mailing
9746: lists.</p></dd>
9747: </dl></div></td>
9748: </tr>
1.80 rillig 9749: <tr class="question">
9750: <td align="left" valign="top">
1.126 jakllsch 9751: <a name="devfaq.documentation"></a><a name="id52060621"></a><p><b>22.8.</b></p>
1.80 rillig 9752: </td>
9753: <td align="left" valign="top"><p>Where is the pkgsrc
9754: documentation?</p></td>
9755: </tr>
9756: <tr class="answer">
1.91 rillig 9757: <td align="left" valign="top"></td>
1.80 rillig 9758: <td align="left" valign="top">
9759: <p>There are many places where you can find
9760: documentation about pkgsrc:</p>
9761: <div class="itemizedlist"><ul type="disc">
9762: <li><p>The pkgsrc guide (this document) is a collection
9763: of chapters that explain large parts of pkgsrc, but some
9764: chapters tend to be outdated. Which ones they are is hard to
9765: say.</p></li>
1.110 hubertf 9766: <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 9767: about certain features, announcements of new parts of the pkgsrc
9768: infrastructure and sometimes even announcements that a certain
9769: feature has been marked as obsolete. The benefit here is that
9770: each message has a date appended to it.</p></li>
9771: <li><p>Many of the files in the
9772: <code class="filename">mk/</code> directory start with a comment that
9773: describes the purpose of the file and how it can be used by the
1.92 rillig 9774: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9775: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9776: help</strong></span>.</p></li>
1.80 rillig 9777: <li><p>The CVS log messages are a rich source of
9778: information, but they tend to be highly abbreviated, especially
9779: for actions that occur often. Some contain a detailed
9780: description of what has changed, but they are geared towards the
9781: other pkgsrc developers, not towards an average pkgsrc user.
9782: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9783: don't know what has been before, these messages may not be worth
9784: too much to you.</p></li>
9785: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9786: documented</span>”, that is the documentation exists only in the
9787: mind of the developer who wrote the code. To get this
1.110 hubertf 9788: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9789: to see who has written it and ask on the
9790: <code class="literal">tech-pkg</code> mailing list, so that others can
9791: find your questions later (see above). To be sure that the
9792: developer in charge reads the mail, you may CC him or
9793: her.</p></li>
9794: </ul></div>
9795: </td>
9796: </tr>
1.92 rillig 9797: <tr class="question">
9798: <td align="left" valign="top">
1.126 jakllsch 9799: <a name="devfaq.too-much-time"></a><a name="id52060812"></a><p><b>22.9.</b></p>
1.92 rillig 9800: </td>
9801: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9802: do?</p></td>
9803: </tr>
9804: <tr class="answer">
9805: <td align="left" valign="top"></td>
9806: <td align="left" valign="top">
1.93 rillig 9807: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9808: anyway.</p>
9809: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 9810: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9811: <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
9812: will tell you about newer versions of installed packages that are
9813: available, but not yet updated in pkgsrc.</p></li>
9814: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9815: — it contains a list of suggested new packages and a list of
1.92 rillig 9816: cleanups and enhancements for pkgsrc that would be nice to
9817: have.</p></li>
9818: <li><p>Review packages for which review was requested on
1.110 hubertf 9819: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 9820: mailing list.</p></li>
9821: </ul></div>
9822: </td>
9823: </tr>
1.75 rillig 9824: </tbody>
9825: </table>
9826: </div>
9827: </div>
1.85 jmmv 9828: <div class="chapter" lang="en">
9829: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9830: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9831: <div class="toc">
9832: <p><b>Table of Contents</b></p>
9833: <dl>
1.106 rillig 9834: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9835: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9836: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9837: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9838: </dl>
9839: </div>
1.110 hubertf 9840: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9841: site</a>:</p>
9842: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9843: environment, an intuitive and attractive desktop for users, and the
9844: GNOME development platform, an extensive framework for building
9845: applications that integrate into the rest of the desktop.</p></blockquote></div>
9846: <p>pkgsrc provides a seamless way to automatically build and install
9847: a complete GNOME environment <span class="emphasis"><em>under many different
9848: platforms</em></span>. We can say with confidence that pkgsrc is one of
9849: the most advanced build and packaging systems for GNOME due to its
9850: included technologies buildlink3, the wrappers and tools framework and
9851: automatic configuration file management. Lots of efforts are put into
9852: achieving a completely clean deinstallation of installed software
9853: components.</p>
1.110 hubertf 9854: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9855: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9856: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9857: pkgsrc as its preferred packaging system, contributing lots of
9858: portability fixes to make GNOME build and install under it.</p>
9859: <p>This chapter is aimed at pkgsrc developers and other people
9860: interested in helping our GNOME porting and packaging efforts. It
9861: provides instructions on how to manage the existing packages and some
9862: important information regarding their internals.</p>
9863: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9864: <h3 class="title">We need your help!</h3>
9865: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9866: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9867: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9868: work</a> list! There is still a long way to go to get a
9869: fully-functional GNOME desktop under NetBSD and we need your help to
9870: achieve it!</p>
9871: </div>
9872: <div class="sect1" lang="en">
9873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9874: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9875: <p>pkgsrc includes three GNOME-related meta packages:</p>
9876: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9877: <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 9878: the core GNOME desktop environment. It only includes the necessary
9879: bits to get it to boot correctly, although it may lack important
9880: functionality for daily operation. The idea behind this package is
9881: to let end users build their own configurations on top of this one,
9882: first installing this meta package to achieve a functional setup and
9883: then adding individual applications.</p></li>
1.91 rillig 9884: <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 9885: complete installation of the GNOME platform and desktop as defined
9886: by the GNOME project; this is based on the components distributed in
9887: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9888: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9889: official FTP server. Developer-only tools found in those
9890: directories are not installed unless required by some other
9891: component to work properly. Similarly, packages from the bindings
9892: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9893: in unless required as a dependency for an end-user component. This
1.91 rillig 9894: 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>
9895: <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 9896: Installs all the tools required to build a GNOME component when
9897: fetched from the CVS repository. These are required to let the
1.110 hubertf 9898: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9899: </ul></div>
9900: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9901: sorted in a way that eases updates: a package may depend on other
9902: packages listed before it but not on any listed after it. It is very
9903: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9904: change it to alphabetical sorting!</em></span></p>
9905: </div>
9906: <div class="sect1" lang="en">
9907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9908: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9909: <p>Almost all GNOME applications are written in C and use a common
9910: set of tools as their build system. Things get different with the new
9911: bindings to other languages (such as Python), but the following will
9912: give you a general idea on the minimum required tools:</p>
9913: <div class="itemizedlist"><ul type="disc">
9914: <li>
9915: <p>Almost all GNOME applications use the GNU Autotools as their
9916: build system. As a general rule you will need to tell this to your
9917: package:</p>
1.100 rillig 9918: <pre class="programlisting">
9919: GNU_CONFIGURE=yes
1.85 jmmv 9920: USE_LIBTOOL=yes
1.100 rillig 9921: USE_TOOLS+=gmake
9922: </pre>
1.85 jmmv 9923: </li>
9924: <li>
9925: <p>If the package uses pkg-config to detect dependencies, add this
9926: tool to the list of required utilities:</p>
9927: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9928: <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 9929: the end of the build process to ensure that you did not miss to
9930: specify any dependency in your package and that the version
9931: requirements are all correct.</p>
9932: </li>
1.93 rillig 9933: <li><p>If the package uses intltool, be sure to add
9934: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9935: to handle dependencies and to force the package to use the latest
9936: available version.</p></li>
9937: <li>
9938: <p>If the package uses gtk-doc (a documentation generation
9939: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9940: tool is rather big and the distfile should come with pregenerated
9941: documentation anyway; if it does not, it is a bug that you ought to
9942: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9943: the default):</p>
9944: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9945: <p>The default location of installed HTML files
9946: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9947: and should not be changed unless the package insists on installing
9948: them somewhere else. Otherwise programs as
1.110 hubertf 9949: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9950: do that with an entry similar to:</p>
9951: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9952: </li>
9953: </ul></div>
9954: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9955: files under the installation prefix to maintain databases. In this
9956: context, shared means that those exact same directories and files are
9957: used among several different packages, leading to conflicts in the
9958: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9959: handle the most common cases, so you have to forget about using
9960: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9961: omitting shared files from them. If you find yourself doing those,
9962: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9963: <p>The following table lists the common situations that result in
9964: using shared directories or files. For each of them, the appropriate
9965: solution is given. After applying the solution be sure to
9966: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9967: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9968: <div class="table">
1.106 rillig 9969: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9970: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9971: <colgroup>
9972: <col>
9973: <col>
9974: </colgroup>
9975: <thead><tr>
9976: <th>If the package...</th>
9977: <th>Then...</th>
9978: </tr></thead>
9979: <tbody>
9980: <tr>
9981: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9982: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.85 jmmv 9983: </tr>
9984: <tr>
9985: <td>Installs icons under the
9986: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9987: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9988: <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 9989: </tr>
9990: <tr>
9991: <td>Installs files under
9992: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9993: <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 9994: </tr>
9995: <tr>
9996: <td>Installs <code class="filename">.desktop</code> files under
9997: <code class="filename">share/applications</code> and these include MIME
9998: information.</td>
1.110 hubertf 9999: <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 10000: </tr>
10001: </tbody>
1.91 rillig 10002: </table></div>
1.85 jmmv 10003: </div>
1.91 rillig 10004: <br class="table-break">
1.85 jmmv 10005: </div>
10006: <div class="sect1" lang="en">
10007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10008: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 10009: <p>When seeing GNOME as a whole, there are two kinds of
10010: updates:</p>
10011: <div class="variablelist"><dl>
10012: <dt><span class="term">Major update</span></dt>
10013: <dd>
10014: <p>Given that there is still a very long way for GNOME 3 (if it
10015: ever appears), we consider a major update one that goes from a
10016: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10017: where <code class="literal">Y</code> is even and greater than
10018: <code class="literal">X</code>. These are hard to achieve because they
10019: introduce lots of changes in the components' code and almost all
10020: GNOME distfiles are updated to newer versions. Some of them can
10021: even break API and ABI compatibility with the previous major
10022: version series. As a result, the update needs to be done all at
10023: once to minimize breakage.</p>
10024: <p>A major update typically consists of around 80 package
10025: updates and the addition of some new ones.</p>
10026: </dd>
10027: <dt><span class="term">Minor update</span></dt>
10028: <dd>
10029: <p>We consider a minor update one that goes from a
10030: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10031: one where <code class="literal">Y</code> is greater than
10032: <code class="literal">X</code>. These are easy to achieve because they do
10033: not update all GNOME components, can be done in an incremental way
10034: and do not break API nor ABI compatibility.</p>
10035: <p>A minor update typically consists of around 50 package
10036: updates, although the numbers here may vary a lot.</p>
10037: </dd>
10038: </dl></div>
10039: <p>In order to update the GNOME components in pkgsrc to a new stable
10040: release (either major or minor), the following steps should be
10041: followed:</p>
10042: <div class="orderedlist"><ol type="1">
10043: <li>
10044: <p>Get a list of all the tarballs that form the new release by
10045: using the following commands. These will leave the full list of the
1.120 snj 10046: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 10047: file:</p>
1.88 wiz 10048: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10049: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10050: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10051: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10052: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10053: awk '{ print $9 }' >>list.txt</code></strong></pre>
10054: </li>
10055: <li><p>Open each meta package's <code class="filename">Makefile</code> and
10056: bump their version to the release you are updating them to. The
10057: three meta packages should be always consistent with versioning.
10058: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10059: in them.</p></li>
10060: <li>
10061: <p>For each meta package, update all its
10062: <code class="varname">DEPENDS</code> lines to match the latest versions as
10063: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10064: newer version (even if found in the FTP) because the meta packages
10065: are supposed to list the exact versions that form a specific GNOME
10066: release. Exceptions are permitted here if a newer version solves a
10067: serious issue in the overall desktop experience; these typically
10068: come in the form of a revision bump in pkgsrc, not in newer versions
10069: from the developers.</p>
10070: <p>Packages not listed in the <code class="filename">list.txt</code> file
10071: should be updated to the latest version available (if found in
10072: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10073: 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 10074: </li>
10075: <li>
10076: <p>Generate a patch from the modified meta packages and extract the
10077: list of "new" lines. This will provide you an outline on what
10078: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10079: <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 10080: </li>
10081: <li><p>For major desktop updates it is recommended to zap all your
10082: installed packages and start over from scratch at this point.</p></li>
10083: <li><p>Now comes the longest step by far: iterate over the contents
10084: of <code class="filename">todo.txt</code> and update the packages listed in
10085: it in order. For major desktop updates none of these should be
1.93 rillig 10086: committed until the entire set is completed because there are chances
1.85 jmmv 10087: of breaking not-yet-updated packages.</p></li>
10088: <li><p>Once the packages are up to date and working, commit them to
10089: the tree one by one with appropriate log messages. At the end,
10090: commit the three meta package updates and all the corresponding
10091: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10092: <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>
10093: </ol></div>
10094: </div>
10095: <div class="sect1" lang="en">
10096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10097: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10098: <p>GNOME is a very big component in pkgsrc which approaches 100
10099: packages. Please, it is very important that you always, always,
10100: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10101: 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 10102: their attention on portability issues and to ensure that future versions
10103: can be built out-of-the box on NetBSD. The less custom patches in
10104: pkgsrc, the easier further updates are. Those developers in charge of
10105: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10106: <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 10107: Bugzilla</a>. Not all components use these to track bugs, but most
10108: of them do. Do not be short on your reports: always provide detailed
10109: explanations of the current failure, how it can be improved to achieve
10110: maximum portability and, if at all possible, provide a patch against CVS
10111: head. The more verbose you are, the higher chances of your patch being
10112: accepted.</p>
10113: <p>Also, please avoid using preprocessor magic to fix portability
10114: issues. While the FreeBSD GNOME people are doing a great job in porting
10115: GNOME to their operating system, the official GNOME sources are now
10116: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10117: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10118: 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 10119: details.</p>
10120: </div>
10121: </div>
1.75 rillig 10122: </div>
10123: <div class="part" lang="en">
10124: <div class="titlepage"><div><div><h1 class="title">
10125: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10126: <div class="partintro" lang="en">
10127: <div></div>
10128: <p>This part of the guide deals with everything
10129: from the infrastructure that is behind the interfaces described
10130: in the developer's guide. A casual package maintainer should not
10131: need anything from this part.</p>
10132: <div class="toc">
10133: <p><b>Table of Contents</b></p>
10134: <dl>
1.106 rillig 10135: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10136: <dd><dl>
1.106 rillig 10137: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10138: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10139: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10140: <dd><dl>
1.106 rillig 10141: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10142: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10143: </dl></dd>
1.106 rillig 10144: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10145: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10146: <dd><dl>
1.106 rillig 10147: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10148: <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 10149: </dl></dd>
1.106 rillig 10150: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10151: <dd><dl>
1.123 snj 10152: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
10153: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75 rillig 10154: </dl></dd>
10155: </dl></dd>
1.106 rillig 10156: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10157: <dd><dl>
1.106 rillig 10158: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10159: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10160: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10161: <dd><dl>
1.106 rillig 10162: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10163: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10164: </dl></dd>
10165: </dl></dd>
1.106 rillig 10166: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10167: <dd><dl>
1.106 rillig 10168: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10169: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10170: </dl></dd>
10171: </dl>
10172: </div>
10173: </div>
10174: <div class="chapter" lang="en">
10175: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10176: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10177: <div class="toc">
10178: <p><b>Table of Contents</b></p>
10179: <dl>
1.106 rillig 10180: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10181: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10182: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10183: <dd><dl>
1.106 rillig 10184: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10185: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10186: </dl></dd>
1.106 rillig 10187: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10188: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10189: <dd><dl>
1.106 rillig 10190: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10191: <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 10192: </dl></dd>
1.106 rillig 10193: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10194: <dd><dl>
1.123 snj 10195: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
10196: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75 rillig 10197: </dl></dd>
10198: </dl>
10199: </div>
10200: <p>The pkgsrc infrastructure consists of many small Makefile
10201: fragments. Each such fragment needs a properly specified
10202: interface. This chapter explains how such an interface looks
10203: like.</p>
10204: <div class="sect1" lang="en">
10205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10206: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10207: <p>Whenever a variable is defined in the pkgsrc
10208: infrastructure, the location and the way of definition provide
10209: much information about the intended use of that variable.
10210: Additionally, more documentation may be found in a header
10211: comment or in this pkgsrc guide.</p>
10212: <p>A special file is
10213: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10214: variables that are intended to be user-defined. They are either
10215: defined using the <code class="literal">?=</code> operator or they are
10216: left undefined because defining them to anything would
10217: effectively mean “<span class="quote">yes</span>”. All these variables may be
10218: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10219: file.</p>
10220: <p>Outside this file, the following conventions apply:
10221: Variables that are defined using the <code class="literal">?=</code>
10222: operator may be overridden by a package.</p>
10223: <p>Variables that are defined using the <code class="literal">=</code>
10224: operator may be used read-only at run-time.</p>
10225: <p>Variables whose name starts with an underscore must not be
10226: accessed outside the pkgsrc infrastructure at all. They may
10227: change without further notice.</p>
10228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10229: <h3 class="title">Note</h3>
10230: <p>These conventions are currently not applied
10231: consistently to the complete pkgsrc
10232: infrastructure.</p>
10233: </div>
10234: </div>
10235: <div class="sect1" lang="en">
10236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10237: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10238: <p>All variables that contain lists of things should default
10239: to being empty. Two examples that do not follow this rule are
10240: <code class="varname">USE_LANGUAGES</code> and
10241: <code class="varname">DISTFILES</code>. These variables cannot simply be
10242: modified using the <code class="literal">+=</code> operator in package
10243: <code class="filename">Makefile</code>s (or other files included by
10244: them), since there is no guarantee whether the variable is
10245: already set or not, and what its value is. In the case of
10246: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10247: the default value and just define it as in the following
10248: example.</p>
10249: <pre class="programlisting">
1.100 rillig 10250: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10251: </pre>
10252: <p>Because of the selection of this default value, the same
10253: value appears in many package Makefiles. Similarly for
10254: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10255: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10256: doesn't stand out. Nevertheless it is mentioned in many
10257: files.</p>
10258: </div>
10259: <div class="sect1" lang="en">
10260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10261: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75 rillig 10262: <div class="sect2" lang="en">
10263: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10264: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10265: <p>Variable evaluation takes place either at load time or at
10266: runtime, depending on the context in which they occur. The
10267: contexts where variables are evaluated at load time are:</p>
10268: <div class="itemizedlist"><ul type="disc">
10269: <li><p>The right hand side of the <code class="literal">:=</code>
10270: and <code class="literal">!=</code> operators,</p></li>
10271: <li><p>Make directives like <code class="literal">.if</code> or
10272: <code class="literal">.for</code>,</p></li>
10273: <li><p>Dependency lines.</p></li>
10274: </ul></div>
10275: <p>A special exception are references to the iteration
10276: variables of <code class="literal">.for</code> loops, which are expanded
10277: inline, no matter in which context they appear.</p>
10278: <p>As the values of variables may change during load time,
10279: care must be taken not to evaluate them by accident. Typical
10280: examples for variables that should not be evaluated at load time
10281: are <code class="varname">DEPENDS</code> and
10282: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10283: clear, here is an example:</p>
10284: <pre class="programlisting">
1.100 rillig 10285: CONFIGURE_ARGS= # none
10286: CFLAGS= -O
10287: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10288:
1.100 rillig 10289: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10290:
1.100 rillig 10291: CFLAGS+= -Wall
1.75 rillig 10292: </pre>
10293: <p>This code shows how the use of the <code class="literal">:=</code>
10294: operator can quickly lead to unexpected results. The first
10295: paragraph is fairly common code. The second paragraph evaluates
10296: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10297: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10298: <code class="literal">-Wall</code> is appended to the
10299: <code class="varname">CFLAGS</code>, but this addition will not appear in
10300: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10301: paragraphs from above typically occur in completely unrelated
10302: files.</p>
10303: </div>
10304: <div class="sect2" lang="en">
10305: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10306: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10307: <p>After all the files have been loaded, the values of the
10308: variables cannot be changed anymore. Variables that are used in
10309: the shell commands are expanded at this point.</p>
10310: </div>
10311: </div>
10312: <div class="sect1" lang="en">
10313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10314: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10315: <p>There are many ways in which the definition and use of a
10316: variable can be restricted in order to detect bugs and
10317: violations of the (mostly unwritten) policies. See the
10318: <code class="literal">pkglint</code> developer's documentation for further
10319: details.</p>
10320: </div>
10321: <div class="sect1" lang="en">
10322: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10323: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10324: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10325: of the following classes. Cases where a file falls into more
10326: than one class should be avoided as it often leads to subtle
10327: bugs.</p>
10328: <div class="sect2" lang="en">
10329: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10330: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10331: <p>In a traditional imperative programming language some of
1.76 rillig 10332: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10333: procedures. They take some input parameters and—after
10334: inclusion—provide a result in output parameters. Since all
1.76 rillig 10335: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10336: care must be taken not to use parameter names that have already
10337: another meaning. For example, <code class="varname">PKGNAME</code> is a
10338: bad choice for a parameter name.</p>
10339: <p>Procedures are completely evaluated at preprocessing time.
10340: That is, when calling a procedure all input parameters must be
10341: completely resolvable. For example,
10342: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10343: parameter since it is very likely that further text will be
10344: added after calling the procedure, which would effectively apply
10345: the procedure to only a part of the variable. Also, references
10346: to other variables wit will be modified after calling the
10347: procedure.</p>
10348: <p>A procedure can declare its output parameters either as
10349: suitable for use in preprocessing directives or as only
10350: available at runtime. The latter alternative is for variables
10351: that contain references to other runtime variables.</p>
10352: <p>Procedures shall be written such that it is possible to
10353: call the procedure more than once. That is, the file must not
10354: contain multiple-inclusion guards.</p>
10355: <p>Examples for procedures are
1.76 rillig 10356: <code class="filename">mk/bsd.options.mk</code> and
10357: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10358: that the parameters are evaluated at load time, they should be
10359: assigned using the <code class="literal">:=</code> operator, which should
10360: be used only for this purpose.</p>
10361: </div>
10362: <div class="sect2" lang="en">
10363: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10364: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10365: <p>Action files take some input parameters and may define
10366: runtime variables. They shall not define loadtime variables.
10367: There are action files that are included implicitly by the
10368: pkgsrc infrastructure, while other must be included
10369: explicitly.</p>
10370: <p>An example for action files is
1.76 rillig 10371: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10372: </div>
10373: </div>
1.81 rillig 10374: <div class="sect1" lang="en">
10375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10376: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10377: <p>Package <code class="filename">Makefile</code>s usually consist of
10378: a set of variable definitions, and include the file
10379: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10380: Before that, they may also include various other
10381: <code class="filename">*.mk</code> files if they need to query the
10382: availability of certain features like the type of compiler or
10383: the X11 implementation. Due to the heavy use of preprocessor
10384: directives like <code class="literal">.if</code> and
10385: <code class="literal">.for</code>, the order in which the files are loaded
10386: matters.</p>
10387: <p>This section describes at which point the various files
10388: are loaded and gives reasons for that order.</p>
10389: <div class="sect2" lang="en">
10390: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10391: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10392: </h3></div></div></div>
10393: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10394: is to define some essential variables like
10395: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10396: <code class="varname">MACHINE_ARCH</code>.</p>
10397: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10398: 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 10399: After that, those variables
1.81 rillig 10400: that have not been overridden by the user are loaded from
10401: <code class="filename">mk/defaults/mk.conf</code>.</p>
10402: <p>After the user settings, the system settings and platform
10403: settings are loaded, which may override the user
10404: settings.</p>
10405: <p>Then, the tool definitions are loaded. The tool wrappers
10406: are not yet in effect. This only happens when building a
10407: package, so the proper variables must be used instead of the
10408: direct tool names.</p>
10409: <p>As the last steps, some essential variables from the
10410: wrapper and the package system flavor are loaded, as well as the
10411: variables that have been cached in earlier phases of a package
10412: build.</p>
10413: </div>
10414: <div class="sect2" lang="en">
10415: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10416: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10417: </h3></div></div></div>
1.81 rillig 10418: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10419: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10420: loaded, which fill default values for those variables that have
1.93 rillig 10421: not been defined by the package. These variables may later
1.81 rillig 10422: be used even in unrelated files.</p>
10423: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10424: provides the target <code class="literal">error-check</code> that is added
10425: as a special dependency to all other targets that use
10426: <code class="varname">DELAYED_ERROR_MSG</code> or
10427: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10428: <p>Then, the package-specific hacks from
10429: <code class="filename">hacks.mk</code> are included.</p>
10430: <p>Then, various other files follow. Most of them don't have
10431: any dependencies on what they need to have included before or
10432: after them, though some do.</p>
10433: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10434: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10435: restricts the use of these variables to all the files that have
10436: been included before. Appearances in later files will be
10437: silently ignored.</p>
10438: <p>Then, the files for the main targets are included, in the
10439: order of later execution, though the actual order should not
10440: matter.</p>
10441: <p>At last, some more files are included that don't set any
10442: interesting variables but rather just define make targets to be
10443: executed.</p>
10444: </div>
10445: </div>
1.75 rillig 10446: </div>
10447: <div class="chapter" lang="en">
10448: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10449: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10450: <div class="toc">
10451: <p><b>Table of Contents</b></p>
10452: <dl>
1.106 rillig 10453: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10454: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10455: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10456: <dd><dl>
1.106 rillig 10457: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10458: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10459: </dl></dd>
10460: </dl>
10461: </div>
10462: <p>The pkgsrc infrastructure consists of a large codebase,
10463: and there are many corners where every little bit of a file is
10464: well thought out, making pkgsrc likely to fail as soon as
10465: anything is changed near those parts. To prevent most changes
10466: from breaking anything, a suite of regression tests should go
10467: along with every important part of the pkgsrc infrastructure.
10468: This chapter describes how regression tests work in pkgsrc and
10469: how you can add new tests.</p>
10470: <div class="sect1" lang="en">
10471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10472: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10473: <p></p>
10474: </div>
10475: <div class="sect1" lang="en">
10476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10477: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10478: <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 10479: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10480: can simply run that command, which will run all tests in the
1.76 rillig 10481: <code class="filename">regress</code> category.</p>
1.75 rillig 10482: </div>
10483: <div class="sect1" lang="en">
10484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10485: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10486: <p>Every directory in the <code class="filename">regress</code>
10487: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10488: is considered a regression test. This file is a shell program
1.110 hubertf 10489: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10490: The following functions can be overridden to suit your
10491: needs.</p>
10492: <div class="sect2" lang="en">
10493: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10494: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10495: <p>These functions do not take any parameters. They are all
10496: called in “<span class="quote">set -e</span>” mode, so you should be careful
10497: to check the exitcodes of any commands you run in the
10498: test.</p>
10499: <div class="variablelist"><dl>
10500: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10501: <dd><p>This function prepares the environment for the
10502: test. By default it does nothing.</p></dd>
10503: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10504: <dd><p>This function runs the actual test. By default,
10505: it calls <code class="varname">TEST_MAKE</code> with the arguments
10506: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10507: error messages into the file
10508: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10509: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10510: <dd><p>This function is run after the test and is
10511: typically used to compare the actual output from the one that is
10512: expected. It can make use of the various helper functions from
10513: the next section.</p></dd>
10514: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10515: <dd><p>This function cleans everything up after the
10516: test has been run. By default it does nothing.</p></dd>
10517: </dl></div>
10518: </div>
10519: <div class="sect2" lang="en">
10520: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10521: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10522: <div class="variablelist"><dl>
10523: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10524: <dd><p>This function compares the exitcode of the
1.110 hubertf 10525: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10526: If they differ, the test will fail.</p></dd>
10527: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10528: <dd><p>This function checks for each of its parameters
1.110 hubertf 10529: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10530: extended regular expression. If it does not, the test will
10531: fail.</p></dd>
10532: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10533: <dd><p>This function checks for each of its parameters
1.110 hubertf 10534: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10535: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10536: If any of the regular expressions matches, the test will
10537: fail.</p></dd>
10538: </dl></div>
10539: </div>
10540: </div>
10541: </div>
10542: <div class="chapter" lang="en">
10543: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10544: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10545: <div class="toc">
10546: <p><b>Table of Contents</b></p>
10547: <dl>
1.106 rillig 10548: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10549: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10550: </dl>
10551: </div>
10552: <p>The pkgsrc system has already been ported to many
10553: operating systems, hardware architectures and compilers. This
10554: chapter explains the necessary steps to make pkgsrc even more
10555: portable.</p>
10556: <div class="sect1" lang="en">
10557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10558: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10559: <p>To port pkgsrc to a new operating system (called
10560: <code class="literal">MyOS</code> in this example), you need to touch the
10561: following files:</p>
10562: <div class="variablelist"><dl>
1.93 rillig 10563: <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 10564: <dd><p>This file contains some basic definitions, for
10565: example the name of the C
10566: compiler.</p></dd>
1.76 rillig 10567: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10568: <dd><p>Insert code that defines the variables
10569: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10570: <code class="varname">LOWER_OS_VERSION</code>,
10571: <code class="varname">LOWER_VENDOR</code>,
10572: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10573: <code class="varname">APPEND_ELF</code>, and the other variables that
10574: appear in this file.</p></dd>
1.93 rillig 10575: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10576: <dd><p>This file contains the platform-specific
10577: definitions that are used by pkgsrc. Start by copying one of the
10578: other files and edit it to your
10579: needs.</p></dd>
1.93 rillig 10580: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10581: <dd><p>This file contains a list of directories,
10582: together with their permission bits and ownership. These
10583: directories will be created automatically with every package
1.98 wiz 10584: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10585: be removed.</p></dd>
1.93 rillig 10586: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10587: <dd><p>Just copy one of the pre-existing x11.dist files
10588: to your
1.76 rillig 10589: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10590: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10591: <dd><p>On some operating systems, the tools that are
10592: provided with the base system are not good enough for pkgsrc.
1.110 hubertf 10593: 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 10594: narrow limit on the line length they can process. Therefore
10595: pkgsrc brings its own tools, which can be enabled
10596: here.</p></dd>
1.93 rillig 10597: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10598: <dd><p>This file defines the paths to all the tools
10599: that are needed by one or the other package in pkgsrc, as well
10600: as by pkgsrc itself. Find out where these tools are on your
10601: platform and add them.</p></dd>
10602: </dl></div>
10603: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10604: <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 10605: </div>
10606: <div class="sect1" lang="en">
10607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10608: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10609: <p>TODO</p>
10610: </div>
10611: </div>
10612: </div>
10613: <div class="appendix" lang="en">
10614: <div class="titlepage"><div><div><h2 class="title">
10615: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10616: <div class="toc">
10617: <p><b>Table of Contents</b></p>
10618: <dl>
10619: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10620: <dd><dl>
10621: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10622: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10623: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.123 snj 10624: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10625: </dl></dd>
10626: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10627: </dl>
10628: </div>
10629: <p>We checked to find a piece of software that wasn't in the packages
10630: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10631: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10632: present in the tree is beyond us, but it's useful for the purposes of
10633: this exercise.</p>
10634: <div class="sect1" lang="en">
10635: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10636: <a name="example-files"></a>A.1. files</h2></div></div></div>
10637: <div class="sect2" lang="en">
10638: <div class="titlepage"><div><div><h3 class="title">
10639: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10640: <pre class="programlisting">
1.100 rillig 10641: # $NetBSD$
10642: #
1.1 grant 10643:
1.100 rillig 10644: DISTNAME= bison-1.25
10645: CATEGORIES= devel
10646: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10647:
1.100 rillig 10648: MAINTAINER= thorpej@NetBSD.org
10649: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10650: COMMENT= GNU yacc clone
1.1 grant 10651:
1.100 rillig 10652: GNU_CONFIGURE= yes
10653: INFO_FILES= bison.info
1.1 grant 10654:
1.100 rillig 10655: .include "../../mk/bsd.pkg.mk"
1.1 grant 10656: </pre>
1.75 rillig 10657: </div>
10658: <div class="sect2" lang="en">
10659: <div class="titlepage"><div><div><h3 class="title">
10660: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10661: <pre class="programlisting">
1.100 rillig 10662: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.110 hubertf 10663: 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 10664: of the NetBSD source tree is beyond me.
1.1 grant 10665: </pre>
1.75 rillig 10666: </div>
10667: <div class="sect2" lang="en">
10668: <div class="titlepage"><div><div><h3 class="title">
10669: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10670: <pre class="programlisting">
1.100 rillig 10671: @comment $NetBSD$
10672: bin/bison
10673: man/man1/bison.1.gz
10674: share/bison.simple
10675: share/bison.hairy
1.1 grant 10676: </pre>
1.75 rillig 10677: </div>
10678: <div class="sect2" lang="en">
10679: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10680: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10681: </h3></div></div></div>
1.75 rillig 10682: <p>The NetBSD package system comes with
1.91 rillig 10683: <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 10684: which helps to check the contents of these
10685: files. After installation it is quite easy to use, just change to the
10686: directory of the package you wish to examine and execute
1.110 hubertf 10687: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10688: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10689: looks fine.</pre>
10690: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10691: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10692: -Wall</strong></span> for a very thorough check.</p>
10693: </div>
10694: </div>
10695: <div class="sect1" lang="en">
10696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10697: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10698: <p>Create the directory where the package lives,
10699: plus any auxiliary directories:</p>
10700: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10701: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10702: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10703: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10704: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10705: <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 10706: then continue with fetching the distfile:</p>
10707: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10708: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10709: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10710: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10711: ftp: Error retrieving file: 500 Internal error
10712:
10713: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10714: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10715: ftp: Error retrieving file: 500 Internal error
10716:
10717: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10718: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10719: Successfully retrieved file.</pre>
10720: <p>Generate the checksum of the distfile into
1.76 rillig 10721: <code class="filename">distinfo</code>:</p>
1.88 wiz 10722: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10723: <p>Now compile:</p>
10724: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10725: >> Checksum OK for bison-1.25.tar.gz.
10726: ===> Extracting for bison-1.25
10727: ===> Patching for bison-1.25
10728: ===> Ignoring empty patch directory
10729: ===> Configuring for bison-1.25
10730: creating cache ./config.cache
10731: checking for gcc... cc
10732: checking whether we are using GNU C... yes
10733: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10734: checking how to run the C preprocessor... cc -E
10735: checking for minix/config.h... no
10736: checking for POSIXized ISC... no
10737: checking whether cross-compiling... no
10738: checking for ANSI C header files... yes
10739: checking for string.h... yes
10740: checking for stdlib.h... yes
10741: checking for memory.h... yes
10742: checking for working const... yes
10743: checking for working alloca.h... no
10744: checking for alloca... yes
10745: checking for strerror... yes
10746: updating cache ./config.cache
10747: creating ./config.status
10748: creating Makefile
10749: ===> Building for bison-1.25
10750: 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
10751: 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
10752: 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
10753: 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
10754: 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 10755: 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 10756: 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
10757: 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
10758: 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
10759: 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
10760: 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
10761: 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
10762: 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
10763: 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
10764: 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
10765: 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
10766: 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
10767: 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
10768: 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
10769: 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
10770: 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
10771: 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
10772: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10773: rm -f bison.s1
1.75 rillig 10774: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10775: <p>Everything seems OK, so install the files:</p>
10776: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10777: >> Checksum OK for bison-1.25.tar.gz.
10778: ===> Installing for bison-1.25
10779: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10780: rm -f /usr/pkg/bin/bison
10781: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10782: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10783: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10784: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10785: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10786: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10787: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10788: ===> Registering installation for bison-1.25</pre>
10789: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10790: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10791: binary package, do this now:</p>
10792: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10793: >> Checksum OK for bison-1.25.tar.gz.
10794: ===> Building package for bison-1.25
10795: Creating package bison-1.25.tgz
10796: Registering depends:.
1.75 rillig 10797: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10798: <p>Now that you don't need the source and object files
10799: any more, clean up:</p>
10800: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10801: ===> Cleaning for bison-1.25</pre>
10802: </div>
10803: </div>
10804: <div class="appendix" lang="en">
10805: <div class="titlepage"><div><div><h2 class="title">
10806: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10807: <div class="toc">
10808: <p><b>Table of Contents</b></p>
10809: <dl>
10810: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10811: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10812: </dl>
10813: </div>
10814: <div class="sect1" lang="en">
10815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10816: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10817: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10818: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10819: => figlet221.tar.gz doesn't seem to exist on this system.
10820: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10821: => [172219 bytes]
10822: Connected to ftp.plig.net.
10823: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10824: 331 Guest login ok, send your complete e-mail address as password.
10825: 230-You are user #5 of 500 simultaneous users allowed.
10826: 230-
1.68 rillig 10827: 230- ___ _ _ _
10828: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10829: 230- | _| _| . |_| . | | | . |_| . | _| . |
10830: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10831: 230- |_| |_| |___| |___|
10832: 230-
10833: 230-** Welcome to ftp.plig.org **
10834: 230-
10835: 230-Please note that all transfers from this FTP site are logged. If you
10836: 230-do not like this, please disconnect now.
10837: 230-
1.120 snj 10838: 230-This archive is available via
1.1 grant 10839: 230-
10840: 230-HTTP: http://ftp.plig.org/
10841: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10842: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10843: 230-
10844: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10845: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10846: 230-
10847: 230-
10848: 230 Logged in anonymously.
10849: Remote system type is UNIX.
10850: Using binary mode to transfer files.
10851: 200 Type okay.
10852: 250 "/pub" is new cwd.
10853: 250-"/pub/figlet" is new cwd.
10854: 250-
10855: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10856: 250-
1.75 rillig 10857: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10858: 250-
10859: 250-The official FIGlet web page is:
1.75 rillig 10860: 250- http://www.figlet.org/
1.1 grant 10861: 250-
10862: 250-If you have questions, please mailto:info@figlet.org. If you want to
10863: 250-contribute a font or something else, you can email us.
1.68 rillig 10864: 250
1.1 grant 10865: 250 "/pub/figlet/program" is new cwd.
10866: 250 "/pub/figlet/program/unix" is new cwd.
10867: local: figlet221.tar.gz remote: figlet221.tar.gz
10868: 502 Unimplemented command.
10869: 227 Entering Passive Mode (195,40,6,41,246,104)
10870: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10871: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10872: 226 Transfer completed.
10873: 172219 bytes received in 00:02 (75.99 KB/s)
10874: 221 Goodbye.
10875: => Checksum OK for figlet221.tar.gz.
10876: ===> Extracting for figlet-2.2.1nb2
10877: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10878: ===> Patching for figlet-2.2.1nb2
10879: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10880: ===> Overriding tools for figlet-2.2.1nb2
10881: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10882: ===> Configuring for figlet-2.2.1nb2
10883: ===> Building for figlet-2.2.1nb2
10884: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10885: chmod a+x figlet
10886: gcc -O2 -o chkfont chkfont.c
10887: => Unwrapping files-to-be-installed.
1.14 xtraeme 10888: <code class="prompt">#</code>
1.75 rillig 10889: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10890: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10891: ===> Installing for figlet-2.2.1nb2
10892: install -d -o root -g wheel -m 755 /usr/pkg/bin
10893: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10894: mkdir -p /usr/pkg/share/figlet
10895: cp figlet /usr/pkg/bin
10896: cp chkfont /usr/pkg/bin
10897: chmod 555 figlist showfigfonts
10898: cp figlist /usr/pkg/bin
10899: cp showfigfonts /usr/pkg/bin
10900: cp fonts/*.flf /usr/pkg/share/figlet
10901: cp fonts/*.flc /usr/pkg/share/figlet
10902: cp figlet.6 /usr/pkg/man/man6
10903: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10904: <code class="prompt">#</code></pre>
10905: </div>
10906: <div class="sect1" lang="en">
10907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10908: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10909: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10910: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10911: ===> Packaging figlet-2.2.1nb2
10912: ===> Building binary package for figlet-2.2.1nb2
10913: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10914: Using SrcDir value of /usr/pkg
1.68 rillig 10915: Registering depends:.
1.75 rillig 10916: <code class="prompt">#</code></pre>
10917: </div>
10918: </div>
10919: <div class="appendix" lang="en">
10920: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10921: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10922: <div class="toc">
10923: <p><b>Table of Contents</b></p>
10924: <dl>
1.126 jakllsch 10925: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. distfiles: The distributed source files</a></span></dt>
10926: <dt><span class="sect1"><a href="#ftp-misc">C.2. misc: Miscellaneous things</a></span></dt>
10927: <dt><span class="sect1"><a href="#ftp-packages">C.3. packages: Binary packages</a></span></dt>
10928: <dt><span class="sect1"><a href="#ftp-reports">C.4. reports: Bulk build reports</a></span></dt>
10929: <dt><span class="sect1"><a href="#ftp-source">C.5. current,
10930: pkgsrc-20xxQy:
1.76 rillig 10931: source packages</a></span></dt>
10932: </dl>
10933: </div>
10934: <p>As in other big projects, the directory layout of pkgsrc
10935: is quite complex for newbies. This chapter explains where you
10936: find things on the FTP server. The base directory on
1.110 hubertf 10937: <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 10938: On other servers it may be different, but inside this directory,
10939: everything should look the same, no matter on which server you
10940: are. This directory contains some subdirectories, which are
10941: explained below.</p>
1.76 rillig 10942: <div class="sect1" lang="en">
10943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10944: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10945: <p>The directory <code class="filename">distfiles</code> contains lots
10946: of archive files from all pkgsrc packages, which are mirrored
10947: here. The subdirectories are called after their package names
10948: and are used when the distributed files have names that don't
10949: explicitly contain a version number or are otherwise too generic
10950: (for example <code class="filename">release.tar.gz</code>).</p>
10951: </div>
10952: <div class="sect1" lang="en">
10953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10954: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10955: <p>This directory contains things that individual pkgsrc
10956: developers find worth publishing.</p>
10957: </div>
10958: <div class="sect1" lang="en">
10959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10960: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10961: <p>This directory contains binary packages for the various
10962: platforms that are supported by pkgsrc.
10963: 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>
10964: <div class="itemizedlist"><ul type="disc">
1.108 rillig 10965: <li><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10966: operating system for which the packages have been built. The
1.110 hubertf 10967: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10968: command, so it may differ from the one you are used to
10969: hear.</p></li>
1.108 rillig 10970: <li><p><code class="varname">ARCH</code> is the hardware
10971: architecture of the platform for which the packages have been
1.110 hubertf 10972: built. It also includes the <code class="varname">ABI</code> (Application
10973: Binary Interface) for platforms that have several of
10974: them.</p></li>
1.108 rillig 10975: <li><p><code class="varname">OSVERSION</code> is the version of
10976: the operating system. For version numbers that change often (for
10977: example NetBSD-current), the often-changing part should be
10978: replaced with an <code class="literal">x</code>, for example
10979: <code class="literal">4.99.x</code>.</p></li>
10980: <li><p><code class="varname">TAG</code> is either
1.126 jakllsch 10981: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10982: for a stable branch, or <code class="literal">head</code> for packages
10983: built from the HEAD branch. The latter should only be used when
10984: the packages are updated on a regular basis. Otherwise the date
10985: from checking out pkgsrc should be appended, for example
10986: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10987: </ul></div>
10988: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10989: can quickly click through the directories on the
10990: server and find the best binary packages for their machines. Since they
10991: usually know the operating system and the hardware architecture, OPSYS
10992: and ARCH are placed first. After these choices, they can select the
10993: best combination of OSVERSION and TAG together, since it is usually the
10994: case that packages stay compatible between different version of the
10995: operating system.</p>
10996: <p>In each of these directories, there is a
10997: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10998: <code class="filename">All</code> which contains all binary packages.
10999: Besides that, there are various category directories that
11000: contain symbolic links to the real binary packages.</p>
11001: </div>
11002: <div class="sect1" lang="en">
11003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11004: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11005: <p>Here are the reports from bulk builds, for those who want
11006: to fix packages that didn't build on some of the platforms. The
1.126 jakllsch 11007: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “packages: Binary packages”</a>.</p>
1.108 rillig 11008: </div>
11009: <div class="sect1" lang="en">
11010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11011: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
11012: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11013: source packages</h2></div></div></div>
11014: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
11015: that is the files that define how to create binary packages from
11016: source archives.</p>
11017: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11018: snapshot of the CVS repository, which is updated regularly. The
11019: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11020: directory, ready to be downloaded as a whole.</p>
1.76 rillig 11021: <p>In the directories for the quarterly branches, there is an
11022: additional file called
1.126 jakllsch 11023: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76 rillig 11024: which contains the state of pkgsrc when it was branched.</p>
11025: </div>
1.75 rillig 11026: </div>
11027: <div class="appendix" lang="en">
11028: <div class="titlepage"><div><div><h2 class="title">
11029: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11030: <div class="toc">
11031: <p><b>Table of Contents</b></p>
11032: <dl>
1.79 rillig 11033: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 11034: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11035: </dl>
11036: </div>
1.79 rillig 11037: <p>This section contains information on editing the pkgsrc
11038: guide itself.</p>
1.75 rillig 11039: <div class="sect1" lang="en">
11040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 11041: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11042: <p>The pkgsrc guide's source code is stored in
11043: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11044: are created from it:</p>
11045: <div class="itemizedlist"><ul type="disc">
11046: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11047: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110 hubertf 11048: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
11049: <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 11050: The PDF version of the pkgsrc guide.</p></li>
1.110 hubertf 11051: <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 11052: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11053: </ul></div>
11054: </div>
11055: <div class="sect1" lang="en">
11056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11057: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11058: <p>The procedure to edit the pkgsrc guide is:</p>
11059: <div class="procedure"><ol type="1">
11060: <li><p>Make sure you have the packages needed to
1.83 wiz 11061: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 11062: 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
11063: 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 11064: PostScript and PDF versions. You will need both packages
11065: installed, to make sure documentation is consistent across all
11066: formats.</p></li>
1.110 hubertf 11067: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 11068: right directory. All further steps will take place
11069: here.</p></li>
11070: <li><p>Edit the XML file(s) in
11071: <code class="filename">files/</code>.</p></li>
1.110 hubertf 11072: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 11073: guide for valid XML and to build the final output files. If you
11074: get any errors at this stage, you can just edit the files, as
11075: there are only symbolic links in the working directory, pointing
11076: to the files in <code class="filename">files/</code>.</p></li>
1.110 hubertf 11077: <li><p><span class="command"><strong>(cd files && cvs
1.79 rillig 11078: commit)</strong></span></p></li>
1.110 hubertf 11079: <li><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 11080: regenerate the output files with the proper RCS
11081: Ids.</p></li>
1.91 rillig 11082: <li>
1.110 hubertf 11083: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11084: commit the files in both <code class="filename">pkgsrc/doc</code> and
11085: <code class="filename">htdocs</code>.</p>
11086: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11087: <h3 class="title">Note</h3>
11088: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11089: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11090: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11091: directory.</p>
11092: </div>
11093: </li>
1.79 rillig 11094: </ol></div>
1.75 rillig 11095: </div>
11096: </div>
11097: </div></body>
1.1 grant 11098: </html>
CVSweb <webmaster@jp.NetBSD.org>